httplib.h 804 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501
  1. //
  2. // httplib.h
  3. //
  4. // Copyright (c) 2026 Yuji Hirose. All rights reserved.
  5. // MIT License
  6. //
  7. #ifndef CPPHTTPLIB_HTTPLIB_H
  8. #define CPPHTTPLIB_HTTPLIB_H
  9. #define CPPHTTPLIB_VERSION "0.61.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003d00"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. #if defined(__SANITIZE_THREAD__)
  18. #define CPPHTTPLIB_THREAD_SANITIZER
  19. #elif defined(__has_feature)
  20. #if __has_feature(thread_sanitizer)
  21. #define CPPHTTPLIB_THREAD_SANITIZER
  22. #endif
  23. #endif
  24. /*
  25. * Configuration
  26. */
  27. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  28. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  29. #endif
  30. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  31. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  32. #endif
  33. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  34. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  35. #endif
  36. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  37. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  38. #endif
  39. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  40. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  41. #endif
  42. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  43. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  44. #endif
  45. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  46. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  47. #endif
  48. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  49. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  50. #endif
  51. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  52. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  53. #endif
  54. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  55. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  56. #endif
  57. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  58. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  59. #endif
  60. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  61. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  62. #endif
  63. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  64. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  65. #endif
  66. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  67. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  68. #endif
  69. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  70. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  71. #endif
  72. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  73. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  74. #endif
  75. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  76. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  77. #endif
  78. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  79. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  80. #endif
  81. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  82. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  83. #endif
  84. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  85. #ifdef _WIN32
  86. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  87. #else
  88. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  89. #endif
  90. #endif
  91. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  92. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  93. #endif
  94. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  95. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  96. #endif
  97. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  98. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  99. #endif
  100. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  101. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  102. #endif
  103. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  104. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  105. #endif
  106. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  107. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  108. #endif
  109. #ifndef CPPHTTPLIB_SSE_MAX_EVENT_LENGTH
  110. #define CPPHTTPLIB_SSE_MAX_EVENT_LENGTH (16 * 1024 * 1024) // 16MB
  111. #endif
  112. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  113. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  114. #endif
  115. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  116. // 1400 rather than a round number: a body that already fits in one 1500-byte
  117. // MTU gains nothing from being made smaller.
  118. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  119. #endif
  120. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  121. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  122. #endif
  123. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  124. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  125. #endif
  126. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  127. // recurses roughly once per matched character for quantified patterns such
  128. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  129. // a default ~8MB thread stack that has been observed to take on the order of
  130. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  131. // margin below that (well under the 8192-byte request URI limit) while still
  132. // fitting any realistic route segment; raise it if a route legitimately needs
  133. // longer paths. Regex routes are never applied to paths longer than this.
  134. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  135. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  136. #endif
  137. #ifndef CPPHTTPLIB_TCP_NODELAY
  138. #define CPPHTTPLIB_TCP_NODELAY false
  139. #endif
  140. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  141. #define CPPHTTPLIB_IPV6_V6ONLY false
  142. #endif
  143. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  144. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  145. #endif
  146. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  147. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  148. #endif
  149. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  150. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  151. #endif
  152. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  153. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  154. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  155. ? std::thread::hardware_concurrency() - 1 \
  156. : 0))
  157. #endif
  158. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  159. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  160. #endif
  161. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  162. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  163. #endif
  164. #ifndef CPPHTTPLIB_RECV_FLAGS
  165. #define CPPHTTPLIB_RECV_FLAGS 0
  166. #endif
  167. #ifndef CPPHTTPLIB_SEND_FLAGS
  168. #define CPPHTTPLIB_SEND_FLAGS 0
  169. #endif
  170. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  171. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  172. #endif
  173. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  174. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  175. #endif
  176. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  177. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  178. #endif
  179. // One macro used to set the read timeout for both sides. They want different
  180. // defaults: a client's read timeout is the caller's own tool (it waits forever
  181. // until asked not to), while a server keeps a ceiling that reclaims a worker
  182. // from a peer that has gone quiet. The old name still works and sets both.
  183. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  184. #pragma message( \
  185. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  186. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  187. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  188. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  189. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  190. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  194. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  195. #endif
  196. #endif
  197. // 0 waits forever. A read timeout is how a caller gets control back to send on
  198. // the same connection; it is not a liveness check (that is ping/pong). Only a
  199. // timeout set at runtime through set_read_timeout() is reported as
  200. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  201. // ws::Fail and closes the connection.
  202. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  203. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  204. #endif
  205. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  206. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  207. #endif
  208. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  209. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  210. #endif
  211. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  212. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  213. #endif
  214. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  215. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  216. #endif
  217. /*
  218. * Headers
  219. */
  220. #ifdef _WIN32
  221. #ifndef _CRT_SECURE_NO_WARNINGS
  222. #define _CRT_SECURE_NO_WARNINGS
  223. #endif //_CRT_SECURE_NO_WARNINGS
  224. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  225. #define _CRT_NONSTDC_NO_DEPRECATE
  226. #endif //_CRT_NONSTDC_NO_DEPRECATE
  227. #if defined(_MSC_VER)
  228. #if _MSC_VER < 1900
  229. #error Sorry, Visual Studio versions prior to 2015 are not supported
  230. #endif
  231. #pragma comment(lib, "ws2_32.lib")
  232. #ifndef _SSIZE_T_DEFINED
  233. using ssize_t = __int64;
  234. #define _SSIZE_T_DEFINED
  235. #endif
  236. #endif // _MSC_VER
  237. #ifndef S_ISREG
  238. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  239. #endif // S_ISREG
  240. #ifndef S_ISDIR
  241. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  242. #endif // S_ISDIR
  243. #ifndef NOMINMAX
  244. #define NOMINMAX
  245. #endif // NOMINMAX
  246. #include <io.h>
  247. #include <winsock2.h>
  248. #include <ws2tcpip.h>
  249. #if defined(__has_include)
  250. #if __has_include(<afunix.h>)
  251. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  252. #include <afunix.h>
  253. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  254. #endif
  255. #endif
  256. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  257. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  258. #endif
  259. using nfds_t = unsigned long;
  260. using socket_t = SOCKET;
  261. using socklen_t = int;
  262. #else // not _WIN32
  263. #include <arpa/inet.h>
  264. #if !defined(_AIX) && !defined(__MVS__)
  265. #include <ifaddrs.h>
  266. #endif
  267. #ifdef __MVS__
  268. #include <strings.h>
  269. #ifndef NI_MAXHOST
  270. #define NI_MAXHOST 1025
  271. #endif
  272. #endif
  273. #include <net/if.h>
  274. #include <netdb.h>
  275. #include <netinet/in.h>
  276. #ifdef __linux__
  277. #include <resolv.h>
  278. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  279. #endif
  280. #include <csignal>
  281. #include <netinet/tcp.h>
  282. #include <poll.h>
  283. #include <pthread.h>
  284. #include <sys/mman.h>
  285. #include <sys/socket.h>
  286. #include <sys/un.h>
  287. #include <unistd.h>
  288. using socket_t = int;
  289. #ifndef INVALID_SOCKET
  290. #define INVALID_SOCKET (-1)
  291. #endif
  292. #endif //_WIN32
  293. #if defined(__APPLE__)
  294. #include <TargetConditionals.h>
  295. #endif
  296. #include <algorithm>
  297. #include <array>
  298. #include <atomic>
  299. #include <cassert>
  300. #include <chrono>
  301. #include <climits>
  302. #include <condition_variable>
  303. #include <cstdlib>
  304. #include <cstring>
  305. #include <errno.h>
  306. #include <exception>
  307. #include <fcntl.h>
  308. #include <fstream>
  309. #include <functional>
  310. #include <iomanip>
  311. #include <iostream>
  312. #include <iterator>
  313. #include <list>
  314. #include <map>
  315. #include <memory>
  316. #include <mutex>
  317. #include <random>
  318. #include <regex>
  319. #include <set>
  320. #include <sstream>
  321. #include <string>
  322. #include <sys/stat.h>
  323. #include <system_error>
  324. #include <thread>
  325. #include <type_traits>
  326. #include <unordered_map>
  327. #include <unordered_set>
  328. #include <utility>
  329. #include <vector>
  330. // On macOS with a TLS backend, enable Keychain root certificates by default
  331. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  332. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  333. // only; on those platforms the user must provide a CA bundle explicitly.
  334. #if defined(__APPLE__) && defined(__clang__) && \
  335. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  336. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  337. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  338. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  339. #if TARGET_OS_OSX
  340. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  341. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  342. #endif
  343. #endif
  344. #endif
  345. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  346. defined(__APPLE__) && !TARGET_OS_OSX
  347. #error \
  348. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  349. #endif
  350. // On Windows, enable Schannel certificate verification by default
  351. // unless the user explicitly opts out.
  352. #if defined(_WIN32) && \
  353. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  354. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  355. #endif
  356. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  357. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  358. #if TARGET_OS_MAC && defined(__clang__)
  359. #include <CFNetwork/CFHost.h>
  360. #include <CoreFoundation/CoreFoundation.h>
  361. #endif
  362. #endif
  363. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  364. #ifdef _WIN32
  365. #include <wincrypt.h>
  366. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  367. // used
  368. #undef X509_NAME
  369. #undef X509_CERT_PAIR
  370. #undef X509_EXTENSIONS
  371. #undef PKCS7_SIGNER_INFO
  372. #ifdef _MSC_VER
  373. #pragma comment(lib, "crypt32.lib")
  374. #endif
  375. #endif // _WIN32
  376. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  377. #if TARGET_OS_OSX
  378. #include <Security/Security.h>
  379. #endif
  380. #endif
  381. #include <openssl/err.h>
  382. #include <openssl/evp.h>
  383. #include <openssl/ssl.h>
  384. #include <openssl/x509v3.h>
  385. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  386. #include <openssl/applink.c>
  387. #endif
  388. #include <iostream>
  389. #include <sstream>
  390. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  391. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  392. #error Please use OpenSSL or a current version of BoringSSL
  393. #endif
  394. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  395. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  396. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  397. #endif
  398. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  399. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  400. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  401. // in with this first include group so the version gating below can use it.
  402. #include <mbedtls/error.h>
  403. #include <mbedtls/net_sockets.h>
  404. #include <mbedtls/oid.h>
  405. #include <mbedtls/pk.h>
  406. #include <mbedtls/ssl.h>
  407. #include <mbedtls/version.h>
  408. #include <mbedtls/x509_crt.h>
  409. #if MBEDTLS_VERSION_MAJOR >= 4
  410. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  411. #include <psa/crypto.h>
  412. #else
  413. #include <mbedtls/ctr_drbg.h>
  414. #include <mbedtls/entropy.h>
  415. #include <mbedtls/md5.h>
  416. #include <mbedtls/sha1.h>
  417. #include <mbedtls/sha256.h>
  418. #include <mbedtls/sha512.h>
  419. #endif
  420. #ifdef _WIN32
  421. #include <wincrypt.h>
  422. #ifdef _MSC_VER
  423. #pragma comment(lib, "crypt32.lib")
  424. #endif
  425. #endif // _WIN32
  426. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  427. #if TARGET_OS_OSX
  428. #include <Security/Security.h>
  429. #endif
  430. #endif
  431. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  432. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  433. #if MBEDTLS_VERSION_MAJOR >= 4
  434. #define CPPHTTPLIB_MBEDTLS_V4
  435. #endif
  436. #if MBEDTLS_VERSION_MAJOR >= 3
  437. #define CPPHTTPLIB_MBEDTLS_V3
  438. #endif
  439. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  440. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  441. #include <wolfssl/options.h>
  442. #include <wolfssl/openssl/x509v3.h>
  443. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  444. #ifndef WOLFSSL_GEN_EMAIL
  445. #define WOLFSSL_GEN_EMAIL 1
  446. #endif
  447. #ifndef WOLFSSL_GEN_DNS
  448. #define WOLFSSL_GEN_DNS 2
  449. #endif
  450. #ifndef WOLFSSL_GEN_URI
  451. #define WOLFSSL_GEN_URI 6
  452. #endif
  453. #ifndef WOLFSSL_GEN_IPADD
  454. #define WOLFSSL_GEN_IPADD 7
  455. #endif
  456. #include <wolfssl/ssl.h>
  457. #include <wolfssl/wolfcrypt/hash.h>
  458. #include <wolfssl/wolfcrypt/md5.h>
  459. #include <wolfssl/wolfcrypt/sha256.h>
  460. #include <wolfssl/wolfcrypt/sha512.h>
  461. #ifdef _WIN32
  462. #include <wincrypt.h>
  463. #ifdef _MSC_VER
  464. #pragma comment(lib, "crypt32.lib")
  465. #endif
  466. #endif // _WIN32
  467. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  468. #if TARGET_OS_OSX
  469. #include <Security/Security.h>
  470. #endif
  471. #endif
  472. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  473. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  474. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  475. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  476. #define CPPHTTPLIB_SSL_ENABLED
  477. #endif
  478. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  479. #include <zlib.h>
  480. #endif
  481. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  482. #include <brotli/decode.h>
  483. #include <brotli/encode.h>
  484. #endif
  485. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  486. #include <zstd.h>
  487. #endif
  488. /*
  489. * Declaration
  490. */
  491. namespace httplib {
  492. namespace ws {
  493. class WebSocket;
  494. } // namespace ws
  495. namespace detail {
  496. /*
  497. * Backport std::make_unique from C++14.
  498. *
  499. * NOTE: This code came up with the following stackoverflow post:
  500. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  501. *
  502. */
  503. template <class T, class... Args>
  504. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  505. make_unique(Args &&...args) {
  506. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  507. }
  508. template <class T>
  509. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  510. make_unique(std::size_t n) {
  511. typedef typename std::remove_extent<T>::type RT;
  512. return std::unique_ptr<T>(new RT[n]);
  513. }
  514. // Locale-independent ASCII character classification. The <cctype>
  515. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  516. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  517. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  518. // classified without regard to the locale.
  519. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  520. inline bool is_ascii_alpha(char c) {
  521. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  522. }
  523. inline bool is_ascii_alnum(char c) {
  524. return is_ascii_digit(c) || is_ascii_alpha(c);
  525. }
  526. namespace case_ignore {
  527. inline unsigned char to_lower(int c) {
  528. const static unsigned char table[256] = {
  529. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  530. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  531. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  532. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  533. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  534. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  535. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  536. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  537. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  538. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  539. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  540. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  541. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  542. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  543. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  544. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  545. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  546. 255,
  547. };
  548. return table[(unsigned char)(char)c];
  549. }
  550. inline std::string to_lower(const std::string &s) {
  551. std::string result = s;
  552. std::transform(
  553. result.begin(), result.end(), result.begin(),
  554. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  555. return result;
  556. }
  557. inline bool equal(const std::string &a, const std::string &b) {
  558. return a.size() == b.size() &&
  559. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  560. return to_lower(ca) == to_lower(cb);
  561. });
  562. }
  563. struct equal_to {
  564. bool operator()(const std::string &a, const std::string &b) const {
  565. return equal(a, b);
  566. }
  567. };
  568. struct hash {
  569. size_t operator()(const std::string &key) const {
  570. size_t h = 0;
  571. for (auto c : key) {
  572. // Unsets the 6 high bits of h, therefore no overflow happens
  573. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  574. static_cast<unsigned char>(to_lower(c));
  575. }
  576. return h;
  577. }
  578. };
  579. template <typename T>
  580. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  581. detail::case_ignore::equal_to>;
  582. } // namespace case_ignore
  583. // This is based on
  584. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  585. struct scope_exit {
  586. explicit scope_exit(std::function<void(void)> &&f)
  587. : exit_function(std::move(f)), execute_on_destruction{true} {}
  588. scope_exit(scope_exit &&rhs) noexcept
  589. : exit_function(std::move(rhs.exit_function)),
  590. execute_on_destruction{rhs.execute_on_destruction} {
  591. rhs.release();
  592. }
  593. ~scope_exit() {
  594. if (execute_on_destruction) { this->exit_function(); }
  595. }
  596. void release() { this->execute_on_destruction = false; }
  597. private:
  598. scope_exit(const scope_exit &) = delete;
  599. void operator=(const scope_exit &) = delete;
  600. scope_exit &operator=(scope_exit &&) = delete;
  601. std::function<void(void)> exit_function;
  602. bool execute_on_destruction;
  603. };
  604. // Simple from_chars implementation for integer and double types (C++17
  605. // substitute)
  606. template <typename T> struct from_chars_result {
  607. const char *ptr;
  608. std::errc ec;
  609. };
  610. template <typename T>
  611. inline from_chars_result<T> from_chars(const char *first, const char *last,
  612. T &value, int base = 10) {
  613. value = 0;
  614. const char *p = first;
  615. bool negative = false;
  616. if (p != last && *p == '-') {
  617. negative = true;
  618. ++p;
  619. }
  620. if (p == last) { return {first, std::errc::invalid_argument}; }
  621. T result = 0;
  622. for (; p != last; ++p) {
  623. char c = *p;
  624. int digit = -1;
  625. if (is_ascii_digit(c)) {
  626. digit = c - '0';
  627. } else if ('a' <= c && c <= 'z') {
  628. digit = c - 'a' + 10;
  629. } else if ('A' <= c && c <= 'Z') {
  630. digit = c - 'A' + 10;
  631. } else {
  632. break;
  633. }
  634. if (digit < 0 || digit >= base) { break; }
  635. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  636. return {p, std::errc::result_out_of_range};
  637. }
  638. result = result * base + digit;
  639. }
  640. if (p == first || (negative && p == first + 1)) {
  641. return {first, std::errc::invalid_argument};
  642. }
  643. value = negative ? T(0) - result : result;
  644. return {p, std::errc{}};
  645. }
  646. // from_chars for double (hand-written, locale-independent)
  647. //
  648. // The only double consumed by this library is the HTTP quality value, whose
  649. // grammar is (RFC 9110 12.4.2):
  650. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  651. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  652. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  653. // '.' always the decimal separator (std::strtod would instead read it from the
  654. // global C locale, mis-parsing q-values once an embedder calls
  655. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  656. // the result to [0, 1], so inputs outside that range need not be distinguished
  657. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  658. // cases that exponent and wide-range handling would introduce.
  659. inline from_chars_result<double> from_chars(const char *first, const char *last,
  660. double &value) {
  661. value = 0.0;
  662. const char *p = first;
  663. // Each 1eN is exactly representable, so a single final division by the
  664. // matching entry yields a correctly-rounded result.
  665. static const double powers_of_ten[] = {
  666. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  667. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  668. const int max_frac_digits =
  669. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  670. // Accumulate digits into a 64-bit integer and remember how many were
  671. // fractional. Two independent caps keep this bounded and safe:
  672. // * accumulation saturates before mantissa could overflow uint64_t, and
  673. // * frac_digits is capped at max_frac_digits so it is always a valid index
  674. // into powers_of_ten (without this an input like "0.000...0" would never
  675. // grow mantissa, so the saturation cap alone would not bound it).
  676. // Both caps only drop digits far beyond the precision a q-value needs; any
  677. // value they would change is well outside [0, 1] and rejected by the caller.
  678. uint64_t mantissa = 0;
  679. int frac_digits = 0;
  680. bool seen_digit = false;
  681. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  682. auto accumulate = [&](char c) {
  683. if (mantissa <= limit) {
  684. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  685. return true;
  686. }
  687. return false;
  688. };
  689. for (; p != last && is_ascii_digit(*p); ++p) {
  690. seen_digit = true;
  691. accumulate(*p);
  692. }
  693. if (p != last && *p == '.') {
  694. ++p;
  695. for (; p != last && is_ascii_digit(*p); ++p) {
  696. seen_digit = true;
  697. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  698. }
  699. }
  700. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  701. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  702. return {p, std::errc{}};
  703. }
  704. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  705. int &out) {
  706. int val = 0;
  707. auto r = from_chars(s, s + len, val);
  708. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  709. return false;
  710. }
  711. out = val;
  712. return true;
  713. }
  714. inline bool parse_port(const char *s, size_t len, int &port) {
  715. return parse_int_in_range(s, len, 1, 65535, port);
  716. }
  717. inline bool parse_port(const std::string &s, int &port) {
  718. return parse_port(s.data(), s.size(), port);
  719. }
  720. struct UrlComponents {
  721. std::string scheme;
  722. std::string host;
  723. std::string port;
  724. std::string path;
  725. std::string query;
  726. };
  727. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  728. uc = {};
  729. size_t pos = 0;
  730. auto sep = url.find("://");
  731. if (sep != std::string::npos) {
  732. uc.scheme = url.substr(0, sep);
  733. // Scheme must be [a-z]+ only
  734. if (uc.scheme.empty()) { return false; }
  735. for (auto c : uc.scheme) {
  736. if (c < 'a' || c > 'z') { return false; }
  737. }
  738. pos = sep + 3;
  739. } else if (url.compare(0, 2, "//") == 0) {
  740. pos = 2;
  741. }
  742. auto has_authority_prefix = pos > 0;
  743. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  744. url[0] != '?' && url[0] != '#');
  745. if (has_authority) {
  746. // userinfo is not supported, and a backslash that some parsers take for
  747. // '/' would leave them seeing another host than this one.
  748. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  749. return false;
  750. }
  751. if (pos < url.size() && url[pos] == '[') {
  752. auto close = url.find(']', pos);
  753. if (close == std::string::npos) { return false; }
  754. uc.host = url.substr(pos + 1, close - pos - 1);
  755. // IPv6 host must be [a-fA-F0-9:]+ only
  756. if (uc.host.empty()) { return false; }
  757. for (auto c : uc.host) {
  758. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  759. (c >= 'A' && c <= 'F') || c == ':')) {
  760. return false;
  761. }
  762. }
  763. pos = close + 1;
  764. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  765. // path, query or fragment delimiter (or the end of input). Otherwise the
  766. // trailing bytes would be folded into the path while the connection
  767. // still targets the bracketed address.
  768. if (pos < url.size()) {
  769. auto c = url[pos];
  770. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  771. }
  772. } else {
  773. auto end = url.find_first_of(":/?#", pos);
  774. if (end == std::string::npos) { end = url.size(); }
  775. uc.host = url.substr(pos, end - pos);
  776. pos = end;
  777. }
  778. if (pos < url.size() && url[pos] == ':') {
  779. ++pos;
  780. auto end = url.find_first_of("/?#", pos);
  781. if (end == std::string::npos) { end = url.size(); }
  782. uc.port = url.substr(pos, end - pos);
  783. pos = end;
  784. }
  785. // Without :// or //, the entire input must be consumed as host[:port].
  786. // If there is leftover (path, query, etc.), this is not a valid
  787. // host[:port] string — clear and reparse as a plain path.
  788. if (!has_authority_prefix && pos < url.size()) {
  789. uc.host.clear();
  790. uc.port.clear();
  791. pos = 0;
  792. }
  793. }
  794. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  795. auto end = url.find_first_of("?#", pos);
  796. if (end == std::string::npos) { end = url.size(); }
  797. uc.path = url.substr(pos, end - pos);
  798. pos = end;
  799. }
  800. if (pos < url.size() && url[pos] == '?') {
  801. auto end = url.find('#', pos);
  802. if (end == std::string::npos) { end = url.size(); }
  803. uc.query = url.substr(pos, end - pos);
  804. }
  805. return true;
  806. }
  807. // Resolves a relative-path or query-only Location value against the path of
  808. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  809. // references starting with '/' are returned unchanged.
  810. inline std::string resolve_relative_location(const std::string &location,
  811. const std::string &base) {
  812. if (location.empty() || location[0] == '/') { return location; }
  813. // A ':' in the first segment means the value has a scheme.
  814. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  815. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  816. auto base_path = base.substr(0, base.find_first_of("?#"));
  817. if (location[0] == '?') { return base_path + location; }
  818. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  819. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  820. // Remove "." and ".." segments from the merged path.
  821. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  822. std::string path;
  823. size_t i = 0;
  824. while (i < path_end) {
  825. auto next = (std::min)(merged.find('/', i + 1), path_end);
  826. auto segment = merged.substr(i + 1, next - i - 1);
  827. auto is_last = next == path_end;
  828. if (segment == "." || segment == "..") {
  829. if (segment == "..") {
  830. path.erase((std::min)(path.rfind('/'), path.size()));
  831. }
  832. if (is_last) { path += '/'; }
  833. } else {
  834. path += '/';
  835. path += segment;
  836. }
  837. i = next;
  838. }
  839. if (path.empty()) { path = "/"; }
  840. return path + merged.substr(path_end);
  841. }
  842. } // namespace detail
  843. enum class SSLVerifierResponse {
  844. // no decision has been made, use the built-in certificate verifier
  845. NoDecisionMade,
  846. // connection certificate is verified and accepted
  847. CertificateAccepted,
  848. // connection certificate was processed but is rejected
  849. CertificateRejected
  850. };
  851. // System CA loading policy for SSL clients. Auto (the default) loads system
  852. // CA certs only when no custom CA is configured; enable_system_ca() switches
  853. // to an explicit policy.
  854. enum class SystemCAMode { Auto, Enabled, Disabled };
  855. enum StatusCode {
  856. // Information responses
  857. Continue_100 = 100,
  858. SwitchingProtocol_101 = 101,
  859. Processing_102 = 102,
  860. EarlyHints_103 = 103,
  861. // Successful responses
  862. OK_200 = 200,
  863. Created_201 = 201,
  864. Accepted_202 = 202,
  865. NonAuthoritativeInformation_203 = 203,
  866. NoContent_204 = 204,
  867. ResetContent_205 = 205,
  868. PartialContent_206 = 206,
  869. MultiStatus_207 = 207,
  870. AlreadyReported_208 = 208,
  871. IMUsed_226 = 226,
  872. // Redirection messages
  873. MultipleChoices_300 = 300,
  874. MovedPermanently_301 = 301,
  875. Found_302 = 302,
  876. SeeOther_303 = 303,
  877. NotModified_304 = 304,
  878. UseProxy_305 = 305,
  879. unused_306 = 306,
  880. TemporaryRedirect_307 = 307,
  881. PermanentRedirect_308 = 308,
  882. // Client error responses
  883. BadRequest_400 = 400,
  884. Unauthorized_401 = 401,
  885. PaymentRequired_402 = 402,
  886. Forbidden_403 = 403,
  887. NotFound_404 = 404,
  888. MethodNotAllowed_405 = 405,
  889. NotAcceptable_406 = 406,
  890. ProxyAuthenticationRequired_407 = 407,
  891. RequestTimeout_408 = 408,
  892. Conflict_409 = 409,
  893. Gone_410 = 410,
  894. LengthRequired_411 = 411,
  895. PreconditionFailed_412 = 412,
  896. PayloadTooLarge_413 = 413,
  897. UriTooLong_414 = 414,
  898. UnsupportedMediaType_415 = 415,
  899. RangeNotSatisfiable_416 = 416,
  900. ExpectationFailed_417 = 417,
  901. ImATeapot_418 = 418,
  902. MisdirectedRequest_421 = 421,
  903. UnprocessableContent_422 = 422,
  904. Locked_423 = 423,
  905. FailedDependency_424 = 424,
  906. TooEarly_425 = 425,
  907. UpgradeRequired_426 = 426,
  908. PreconditionRequired_428 = 428,
  909. TooManyRequests_429 = 429,
  910. RequestHeaderFieldsTooLarge_431 = 431,
  911. UnavailableForLegalReasons_451 = 451,
  912. // Server error responses
  913. InternalServerError_500 = 500,
  914. NotImplemented_501 = 501,
  915. BadGateway_502 = 502,
  916. ServiceUnavailable_503 = 503,
  917. GatewayTimeout_504 = 504,
  918. HttpVersionNotSupported_505 = 505,
  919. VariantAlsoNegotiates_506 = 506,
  920. InsufficientStorage_507 = 507,
  921. LoopDetected_508 = 508,
  922. NotExtended_510 = 510,
  923. NetworkAuthenticationRequired_511 = 511,
  924. };
  925. namespace detail {
  926. // A multimap that keeps its entries in the order they were inserted.
  927. //
  928. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  929. // fields sharing a field name significant and forbids a proxy from reordering
  930. // them, and a query string's parameters are meaningful in the order the caller
  931. // wrote them. Neither standard container expresses it: std::unordered_multimap
  932. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  933. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  934. // key, which would drop control data such as Host behind whatever else the
  935. // message carries and alphabetise a query string.
  936. //
  937. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  938. // scan, which beats hashing for the handful of entries a message carries
  939. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  940. //
  941. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  942. // Params, whose parameter names are case-sensitive, not.
  943. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  944. public:
  945. using key_type = std::string;
  946. using mapped_type = Mapped;
  947. using value_type = std::pair<std::string, Mapped>;
  948. using size_type = std::size_t;
  949. using difference_type = std::ptrdiff_t;
  950. using reference = value_type &;
  951. using const_reference = const value_type &;
  952. private:
  953. static size_type npos() { return static_cast<size_type>(-1); }
  954. static bool keys_equal(const std::string &a, const std::string &b) {
  955. return KeyEqual()(a, b);
  956. }
  957. // Iterating yields every entry in insertion order, but equal_range() and
  958. // find() have to walk only the entries sharing one key, which are not
  959. // adjacent. Both are the same iterator type: key_idx_ selects between the
  960. // two traversals, and since equality compares only the position, an iterator
  961. // restricted to one key still compares equal to end().
  962. template <typename V> class iterator_t {
  963. public:
  964. using iterator_category = std::bidirectional_iterator_tag;
  965. using value_type = insertion_ordered_multimap::value_type;
  966. using difference_type = insertion_ordered_multimap::difference_type;
  967. using pointer = V *;
  968. using reference = V &;
  969. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  970. template <typename U,
  971. typename std::enable_if<std::is_convertible<U *, V *>::value,
  972. int>::type = 0>
  973. iterator_t(const iterator_t<U> &rhs)
  974. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  975. key_idx_(rhs.key_idx_) {}
  976. reference operator*() const { return data_[idx_]; }
  977. pointer operator->() const { return data_ + idx_; }
  978. iterator_t &operator++() {
  979. // Saturating, so that advancing past the last entry of a key stays at
  980. // end() instead of running off the container.
  981. if (idx_ >= size_) { return *this; }
  982. ++idx_;
  983. if (key_idx_ != npos()) {
  984. while (idx_ < size_ && !matches(idx_)) {
  985. ++idx_;
  986. }
  987. }
  988. return *this;
  989. }
  990. iterator_t operator++(int) {
  991. auto tmp = *this;
  992. ++*this;
  993. return tmp;
  994. }
  995. iterator_t &operator--() {
  996. if (idx_ == 0) { return *this; }
  997. --idx_;
  998. if (key_idx_ != npos()) {
  999. while (idx_ > 0 && !matches(idx_)) {
  1000. --idx_;
  1001. }
  1002. }
  1003. return *this;
  1004. }
  1005. iterator_t operator--(int) {
  1006. auto tmp = *this;
  1007. --*this;
  1008. return tmp;
  1009. }
  1010. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1011. return idx_ == rhs.idx_;
  1012. }
  1013. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1014. return idx_ != rhs.idx_;
  1015. }
  1016. private:
  1017. friend class insertion_ordered_multimap;
  1018. template <typename> friend class iterator_t;
  1019. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1020. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1021. bool matches(size_type i) const {
  1022. return keys_equal(data_[i].first, data_[key_idx_].first);
  1023. }
  1024. V *data_;
  1025. size_type idx_;
  1026. size_type size_;
  1027. size_type key_idx_;
  1028. };
  1029. public:
  1030. using iterator = iterator_t<value_type>;
  1031. using const_iterator = iterator_t<const value_type>;
  1032. insertion_ordered_multimap() = default;
  1033. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1034. : entries_(il) {}
  1035. template <typename InputIt>
  1036. insertion_ordered_multimap(InputIt first, InputIt last)
  1037. : entries_(first, last) {}
  1038. iterator begin() { return make_iter(0, npos()); }
  1039. iterator end() { return make_iter(entries_.size(), npos()); }
  1040. const_iterator begin() const { return make_citer(0, npos()); }
  1041. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1042. const_iterator cbegin() const { return begin(); }
  1043. const_iterator cend() const { return end(); }
  1044. bool empty() const { return entries_.empty(); }
  1045. size_type size() const { return entries_.size(); }
  1046. void clear() { entries_.clear(); }
  1047. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1048. iterator insert(const value_type &val) {
  1049. entries_.push_back(val);
  1050. return make_iter(entries_.size() - 1, npos());
  1051. }
  1052. iterator insert(value_type &&val) {
  1053. entries_.push_back(std::move(val));
  1054. return make_iter(entries_.size() - 1, npos());
  1055. }
  1056. template <typename... Args> iterator emplace(Args &&...args) {
  1057. entries_.emplace_back(std::forward<Args>(args)...);
  1058. return make_iter(entries_.size() - 1, npos());
  1059. }
  1060. // For entries that have to lead the message, such as the Host header field
  1061. // (RFC 9110 5.3 recommends sending control data first).
  1062. template <typename... Args> iterator emplace_front(Args &&...args) {
  1063. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1064. return make_iter(0, npos());
  1065. }
  1066. iterator find(const std::string &key) {
  1067. auto i = index_of(key);
  1068. return i == npos() ? end() : make_iter(i, i);
  1069. }
  1070. const_iterator find(const std::string &key) const {
  1071. auto i = index_of(key);
  1072. return i == npos() ? end() : make_citer(i, i);
  1073. }
  1074. size_type count(const std::string &key) const {
  1075. size_type n = 0;
  1076. for (const auto &entry : entries_) {
  1077. if (keys_equal(entry.first, key)) { n++; }
  1078. }
  1079. return n;
  1080. }
  1081. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1082. auto i = index_of(key);
  1083. return i == npos() ? std::make_pair(end(), end())
  1084. : std::make_pair(make_iter(i, i), end());
  1085. }
  1086. std::pair<const_iterator, const_iterator>
  1087. equal_range(const std::string &key) const {
  1088. auto i = index_of(key);
  1089. return i == npos() ? std::make_pair(end(), end())
  1090. : std::make_pair(make_citer(i, i), end());
  1091. }
  1092. size_type erase(const std::string &key) {
  1093. auto before = entries_.size();
  1094. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1095. [&](const value_type &entry) {
  1096. return keys_equal(entry.first, key);
  1097. }),
  1098. entries_.end());
  1099. return before - entries_.size();
  1100. }
  1101. iterator erase(const_iterator pos) {
  1102. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1103. return make_iter(pos.idx_, npos());
  1104. }
  1105. // Erases what iterating [first, last) would actually visit, so erasing an
  1106. // equal_range() removes only the entries with that key, not everything
  1107. // positioned between them.
  1108. iterator erase(const_iterator first, const_iterator last) {
  1109. auto from = first.idx_;
  1110. auto to = last.idx_;
  1111. if (from >= to) { return make_iter(from, npos()); }
  1112. auto begin_it = entries_.begin();
  1113. auto from_it = begin_it + static_cast<difference_type>(from);
  1114. auto to_it = begin_it + static_cast<difference_type>(to);
  1115. if (first.key_idx_ == npos()) {
  1116. entries_.erase(from_it, to_it);
  1117. } else {
  1118. auto key = entries_[first.key_idx_].first;
  1119. auto keep = from_it;
  1120. for (auto it = from_it; it != to_it; ++it) {
  1121. if (!keys_equal(it->first, key)) {
  1122. if (keep != it) { *keep = std::move(*it); }
  1123. ++keep;
  1124. }
  1125. }
  1126. if (keep != to_it) {
  1127. keep = std::move(to_it, entries_.end(), keep);
  1128. } else {
  1129. keep = entries_.end();
  1130. }
  1131. entries_.erase(keep, entries_.end());
  1132. }
  1133. return make_iter(from, npos());
  1134. }
  1135. friend bool operator==(const insertion_ordered_multimap &lhs,
  1136. const insertion_ordered_multimap &rhs) {
  1137. return lhs.entries_ == rhs.entries_;
  1138. }
  1139. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1140. const insertion_ordered_multimap &rhs) {
  1141. return !(lhs == rhs);
  1142. }
  1143. private:
  1144. size_type index_of(const std::string &key) const {
  1145. for (size_type i = 0; i < entries_.size(); i++) {
  1146. if (keys_equal(entries_[i].first, key)) { return i; }
  1147. }
  1148. return npos();
  1149. }
  1150. iterator make_iter(size_type idx, size_type key_idx) {
  1151. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1152. }
  1153. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1154. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1155. }
  1156. std::vector<value_type> entries_;
  1157. };
  1158. } // namespace detail
  1159. using Headers =
  1160. detail::insertion_ordered_multimap<std::string,
  1161. detail::case_ignore::equal_to>;
  1162. // Query parameter names are case-sensitive, unlike header field names.
  1163. using Params =
  1164. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1165. using Match = std::smatch;
  1166. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1167. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1168. /*
  1169. * detail: type-erased storage used by UserData.
  1170. * ABI-stable regardless of C++ standard — always uses this custom
  1171. * implementation instead of std::any.
  1172. */
  1173. namespace detail {
  1174. using any_type_id = const void *;
  1175. template <typename T> any_type_id any_typeid() noexcept {
  1176. static const char id = 0;
  1177. return &id;
  1178. }
  1179. struct any_storage {
  1180. virtual ~any_storage() = default;
  1181. virtual std::unique_ptr<any_storage> clone() const = 0;
  1182. virtual any_type_id type_id() const noexcept = 0;
  1183. };
  1184. template <typename T> struct any_value final : any_storage {
  1185. T value;
  1186. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1187. std::unique_ptr<any_storage> clone() const override {
  1188. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1189. }
  1190. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1191. };
  1192. } // namespace detail
  1193. class UserData {
  1194. public:
  1195. UserData() = default;
  1196. UserData(UserData &&) noexcept = default;
  1197. UserData &operator=(UserData &&) noexcept = default;
  1198. UserData(const UserData &o) {
  1199. for (const auto &e : o.entries_) {
  1200. if (e.second) { entries_[e.first] = e.second->clone(); }
  1201. }
  1202. }
  1203. UserData &operator=(const UserData &o) {
  1204. if (this != &o) {
  1205. entries_.clear();
  1206. for (const auto &e : o.entries_) {
  1207. if (e.second) { entries_[e.first] = e.second->clone(); }
  1208. }
  1209. }
  1210. return *this;
  1211. }
  1212. template <typename T> void set(const std::string &key, T &&value) {
  1213. using D = typename std::decay<T>::type;
  1214. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1215. }
  1216. template <typename T> T *get(const std::string &key) noexcept {
  1217. auto it = entries_.find(key);
  1218. if (it == entries_.end() || !it->second) { return nullptr; }
  1219. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1220. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1221. }
  1222. template <typename T> const T *get(const std::string &key) const noexcept {
  1223. auto it = entries_.find(key);
  1224. if (it == entries_.end() || !it->second) { return nullptr; }
  1225. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1226. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1227. }
  1228. bool has(const std::string &key) const noexcept {
  1229. return entries_.find(key) != entries_.end();
  1230. }
  1231. void erase(const std::string &key) { entries_.erase(key); }
  1232. void clear() noexcept { entries_.clear(); }
  1233. private:
  1234. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1235. entries_;
  1236. };
  1237. struct Response;
  1238. using ResponseHandler = std::function<bool(const Response &response)>;
  1239. struct FormData {
  1240. std::string name;
  1241. std::string content;
  1242. std::string filename;
  1243. std::string content_type;
  1244. Headers headers;
  1245. };
  1246. struct FormField {
  1247. std::string name;
  1248. std::string content;
  1249. Headers headers;
  1250. };
  1251. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1252. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1253. // should see the parts as they were sent. A std::multimap sorts by field name
  1254. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1255. // than the case-insensitive predicate Headers uses.
  1256. using FormFields =
  1257. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1258. using FormFiles =
  1259. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1260. struct MultipartFormData {
  1261. FormFields fields; // Text fields from multipart
  1262. FormFiles files; // Files from multipart
  1263. // Text field access
  1264. std::string get_field(const std::string &key, size_t id = 0) const;
  1265. std::vector<std::string> get_fields(const std::string &key) const;
  1266. bool has_field(const std::string &key) const;
  1267. size_t get_field_count(const std::string &key) const;
  1268. // File access
  1269. FormData get_file(const std::string &key, size_t id = 0) const;
  1270. std::vector<FormData> get_files(const std::string &key) const;
  1271. bool has_file(const std::string &key) const;
  1272. size_t get_file_count(const std::string &key) const;
  1273. };
  1274. struct UploadFormData {
  1275. std::string name;
  1276. std::string content;
  1277. std::string filename;
  1278. std::string content_type;
  1279. };
  1280. using UploadFormDataItems = std::vector<UploadFormData>;
  1281. class DataSink {
  1282. public:
  1283. DataSink() : os(&sb_), sb_(*this) {}
  1284. DataSink(const DataSink &) = delete;
  1285. DataSink &operator=(const DataSink &) = delete;
  1286. DataSink(DataSink &&) = delete;
  1287. DataSink &operator=(DataSink &&) = delete;
  1288. std::function<bool(const char *data, size_t data_len)> write;
  1289. // Only `write` is mandatory. The rest are defaulted so that a provider
  1290. // calling one on a writer that does not set it gets sensible behaviour
  1291. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1292. // `this` is safe: DataSink is neither copyable nor movable.
  1293. std::function<bool()> is_writable = []() { return true; };
  1294. std::function<void()> done = []() {};
  1295. std::function<void(const Headers &trailer)> done_with_trailer =
  1296. [this](const Headers & /*trailer*/) { done(); };
  1297. std::ostream os;
  1298. private:
  1299. class data_sink_streambuf final : public std::streambuf {
  1300. public:
  1301. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1302. protected:
  1303. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1304. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1305. return 0;
  1306. }
  1307. private:
  1308. DataSink &sink_;
  1309. };
  1310. data_sink_streambuf sb_;
  1311. };
  1312. using ContentProvider =
  1313. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1314. using ContentProviderWithoutLength =
  1315. std::function<bool(size_t offset, DataSink &sink)>;
  1316. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1317. struct FormDataProvider {
  1318. std::string name;
  1319. ContentProviderWithoutLength provider;
  1320. std::string filename;
  1321. std::string content_type;
  1322. };
  1323. using FormDataProviderItems = std::vector<FormDataProvider>;
  1324. inline FormDataProvider
  1325. make_file_provider(const std::string &name, const std::string &filepath,
  1326. const std::string &filename = std::string(),
  1327. const std::string &content_type = std::string()) {
  1328. FormDataProvider fdp;
  1329. fdp.name = name;
  1330. fdp.filename = filename.empty() ? filepath : filename;
  1331. fdp.content_type = content_type;
  1332. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1333. std::ifstream f(filepath, std::ios::binary);
  1334. if (!f) { return false; }
  1335. if (offset > 0) {
  1336. f.seekg(static_cast<std::streamoff>(offset));
  1337. if (!f.good()) {
  1338. sink.done();
  1339. return true;
  1340. }
  1341. }
  1342. char buf[8192];
  1343. f.read(buf, sizeof(buf));
  1344. auto n = static_cast<size_t>(f.gcount());
  1345. if (n > 0) { return sink.write(buf, n); }
  1346. sink.done(); // EOF
  1347. return true;
  1348. };
  1349. return fdp;
  1350. }
  1351. inline std::pair<size_t, ContentProvider>
  1352. make_file_body(const std::string &filepath) {
  1353. size_t size = 0;
  1354. {
  1355. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1356. if (!f) { return {0, ContentProvider{}}; }
  1357. size = static_cast<size_t>(f.tellg());
  1358. }
  1359. ContentProvider provider = [filepath](size_t offset, size_t length,
  1360. DataSink &sink) -> bool {
  1361. std::ifstream f(filepath, std::ios::binary);
  1362. if (!f) { return false; }
  1363. f.seekg(static_cast<std::streamoff>(offset));
  1364. if (!f.good()) { return false; }
  1365. char buf[8192];
  1366. while (length > 0) {
  1367. auto to_read = (std::min)(sizeof(buf), length);
  1368. f.read(buf, static_cast<std::streamsize>(to_read));
  1369. auto n = static_cast<size_t>(f.gcount());
  1370. // The file is shorter than the size make_file_body() measured, which the
  1371. // caller has already committed to as Content-Length. The body cannot be
  1372. // completed, so fail as every other error here does.
  1373. if (n == 0) { return false; }
  1374. if (!sink.write(buf, n)) { return false; }
  1375. length -= n;
  1376. }
  1377. return true;
  1378. };
  1379. return {size, std::move(provider)};
  1380. }
  1381. using ContentReceiverWithProgress = std::function<bool(
  1382. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1383. using ContentReceiver =
  1384. std::function<bool(const char *data, size_t data_length)>;
  1385. using FormDataHeader = std::function<bool(const FormData &file)>;
  1386. class ContentReader {
  1387. public:
  1388. using Reader = std::function<bool(ContentReceiver receiver)>;
  1389. using FormDataReader =
  1390. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1391. ContentReader(Reader reader, FormDataReader multipart_reader)
  1392. : reader_(std::move(reader)),
  1393. formdata_reader_(std::move(multipart_reader)) {}
  1394. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1395. return formdata_reader_(std::move(header), std::move(receiver));
  1396. }
  1397. bool operator()(ContentReceiver receiver) const {
  1398. return reader_(std::move(receiver));
  1399. }
  1400. Reader reader_;
  1401. FormDataReader formdata_reader_;
  1402. };
  1403. using Range = std::pair<ssize_t, ssize_t>;
  1404. using Ranges = std::vector<Range>;
  1405. #ifdef CPPHTTPLIB_SSL_ENABLED
  1406. // TLS abstraction layer - public type definitions and API
  1407. namespace tls {
  1408. // Opaque handles (defined as void* for abstraction)
  1409. using ctx_t = void *;
  1410. using session_t = void *;
  1411. using const_session_t = const void *; // For read-only session access
  1412. using cert_t = void *;
  1413. using ca_store_t = void *;
  1414. // TLS versions
  1415. enum class Version {
  1416. TLS1_2 = 0x0303,
  1417. TLS1_3 = 0x0304,
  1418. };
  1419. // Subject Alternative Names (SAN) entry types
  1420. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1421. // SAN entry structure
  1422. struct SanEntry {
  1423. SanType type;
  1424. std::string value;
  1425. };
  1426. // Verification context for certificate verification callback
  1427. struct VerifyContext {
  1428. session_t session; // TLS session handle
  1429. cert_t cert; // Current certificate being verified
  1430. int depth; // Certificate chain depth (0 = leaf)
  1431. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1432. long error_code; // Backend-specific error code (0 = no error)
  1433. const char *error_string; // Human-readable error description
  1434. // Certificate introspection methods
  1435. std::string subject_cn() const;
  1436. std::string issuer_name() const;
  1437. bool check_hostname(const char *hostname) const;
  1438. std::vector<SanEntry> sans() const;
  1439. bool validity(time_t &not_before, time_t &not_after) const;
  1440. std::string serial() const;
  1441. };
  1442. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1443. // TlsError codes for TLS operations (backend-independent)
  1444. enum class ErrorCode : int {
  1445. Success = 0,
  1446. WantRead, // Non-blocking: need to wait for read
  1447. WantWrite, // Non-blocking: need to wait for write
  1448. PeerClosed, // Peer closed the connection
  1449. Fatal, // Unrecoverable error
  1450. SyscallError, // System call error (check sys_errno)
  1451. CertVerifyFailed, // Certificate verification failed
  1452. HostnameMismatch, // Hostname verification failed
  1453. };
  1454. // TLS error information
  1455. struct TlsError {
  1456. ErrorCode code = ErrorCode::Fatal;
  1457. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1458. int sys_errno = 0; // errno when SyscallError
  1459. // Convert verification error code to human-readable string
  1460. static std::string verify_error_to_string(long error_code);
  1461. };
  1462. // RAII wrapper for peer certificate
  1463. class PeerCert {
  1464. public:
  1465. PeerCert();
  1466. PeerCert(PeerCert &&other) noexcept;
  1467. PeerCert &operator=(PeerCert &&other) noexcept;
  1468. ~PeerCert();
  1469. PeerCert(const PeerCert &) = delete;
  1470. PeerCert &operator=(const PeerCert &) = delete;
  1471. explicit operator bool() const;
  1472. std::string subject_cn() const;
  1473. std::string issuer_name() const;
  1474. bool check_hostname(const char *hostname) const;
  1475. std::vector<SanEntry> sans() const;
  1476. bool validity(time_t &not_before, time_t &not_after) const;
  1477. std::string serial() const;
  1478. private:
  1479. explicit PeerCert(cert_t cert);
  1480. cert_t cert_ = nullptr;
  1481. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1482. };
  1483. // Callback for TLS context setup (used by SSLServer constructor)
  1484. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1485. } // namespace tls
  1486. #endif
  1487. struct Request {
  1488. std::string method;
  1489. std::string path;
  1490. std::string matched_route;
  1491. Params params;
  1492. Headers headers;
  1493. Headers trailers;
  1494. std::string body;
  1495. std::string remote_addr;
  1496. int remote_port = -1;
  1497. std::string local_addr;
  1498. int local_port = -1;
  1499. // for server
  1500. std::string version;
  1501. std::string target;
  1502. MultipartFormData form;
  1503. Ranges ranges;
  1504. Match matches;
  1505. std::unordered_map<std::string, std::string> path_params;
  1506. std::function<bool()> is_connection_closed = []() { return true; };
  1507. // for client
  1508. std::vector<std::string> accept_content_types;
  1509. ResponseHandler response_handler;
  1510. ContentReceiverWithProgress content_receiver;
  1511. DownloadProgress download_progress;
  1512. UploadProgress upload_progress;
  1513. bool has_header(const std::string &key) const;
  1514. std::string get_header_value(const std::string &key, const char *def = "",
  1515. size_t id = 0) const;
  1516. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1517. size_t id = 0) const;
  1518. size_t get_header_value_count(const std::string &key) const;
  1519. void set_header(const std::string &key, const std::string &val);
  1520. bool has_trailer(const std::string &key) const;
  1521. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1522. size_t get_trailer_value_count(const std::string &key) const;
  1523. bool has_param(const std::string &key) const;
  1524. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1525. std::vector<std::string> get_param_values(const std::string &key) const;
  1526. size_t get_param_value_count(const std::string &key) const;
  1527. bool is_multipart_form_data() const;
  1528. // private members...
  1529. bool body_read_started_ = false;
  1530. bool body_consumed_ = false;
  1531. bool expect_100_continue_pending_ = false;
  1532. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1533. size_t content_length_ = 0;
  1534. ContentProvider content_provider_;
  1535. bool is_chunked_content_provider_ = false;
  1536. size_t authorization_count_ = 0;
  1537. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1538. (std::chrono::steady_clock::time_point::min)();
  1539. #ifdef CPPHTTPLIB_SSL_ENABLED
  1540. tls::const_session_t ssl = nullptr;
  1541. tls::PeerCert peer_cert() const;
  1542. std::string sni() const;
  1543. #endif
  1544. };
  1545. namespace detail {
  1546. // Declared up here, away from the rest of the compression helpers, because
  1547. // `Response` stores one.
  1548. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1549. } // namespace detail
  1550. struct Response {
  1551. std::string version;
  1552. int status = -1;
  1553. std::string reason;
  1554. Headers headers;
  1555. Headers trailers;
  1556. std::string body;
  1557. std::string location; // Redirect location
  1558. // User-defined context — set by pre-routing/pre-request handlers and read
  1559. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1560. UserData user_data;
  1561. bool has_header(const std::string &key) const;
  1562. std::string get_header_value(const std::string &key, const char *def = "",
  1563. size_t id = 0) const;
  1564. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1565. size_t id = 0) const;
  1566. size_t get_header_value_count(const std::string &key) const;
  1567. void set_header(const std::string &key, const std::string &val);
  1568. bool has_trailer(const std::string &key) const;
  1569. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1570. size_t get_trailer_value_count(const std::string &key) const;
  1571. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1572. void set_content(const char *s, size_t n, const std::string &content_type);
  1573. void set_content(const std::string &s, const std::string &content_type);
  1574. void set_content(std::string &&s, const std::string &content_type);
  1575. void set_content_provider(
  1576. size_t length, const std::string &content_type, ContentProvider provider,
  1577. ContentProviderResourceReleaser resource_releaser = nullptr);
  1578. void set_content_provider(
  1579. const std::string &content_type, ContentProviderWithoutLength provider,
  1580. ContentProviderResourceReleaser resource_releaser = nullptr);
  1581. void set_chunked_content_provider(
  1582. const std::string &content_type, ContentProviderWithoutLength provider,
  1583. ContentProviderResourceReleaser resource_releaser = nullptr);
  1584. void set_file_content(const std::string &path,
  1585. const std::string &content_type);
  1586. void set_file_content(const std::string &path);
  1587. Response() = default;
  1588. Response(const Response &) = default;
  1589. Response &operator=(const Response &) = default;
  1590. Response(Response &&) = default;
  1591. Response &operator=(Response &&) = default;
  1592. ~Response() {
  1593. if (content_provider_resource_releaser_) {
  1594. content_provider_resource_releaser_(content_provider_success_);
  1595. }
  1596. }
  1597. // private members...
  1598. size_t content_length_ = 0;
  1599. ContentProvider content_provider_;
  1600. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1601. bool is_chunked_content_provider_ = false;
  1602. bool is_file_content_provider_ = false;
  1603. bool content_provider_success_ = false;
  1604. std::string file_content_path_;
  1605. std::string file_content_content_type_;
  1606. // Content coding chosen for the response body, decided once so that the
  1607. // headers and the body cannot disagree: where the file is opened for a
  1608. // file-backed content provider (keeping the ETag honest), and in
  1609. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1610. // for every other kind of response.
  1611. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1612. };
  1613. enum class Error {
  1614. Success = 0,
  1615. Unknown,
  1616. Connection,
  1617. BindIPAddress,
  1618. Read,
  1619. Write,
  1620. ExceedRedirectCount,
  1621. Canceled,
  1622. SSLConnection,
  1623. SSLLoadingCerts,
  1624. SSLServerVerification,
  1625. SSLServerHostnameVerification,
  1626. UnsupportedMultipartBoundaryChars,
  1627. Compression,
  1628. ConnectionTimeout,
  1629. ProxyConnection,
  1630. ConnectionClosed,
  1631. Timeout,
  1632. ResourceExhaustion,
  1633. TooManyFormDataFiles,
  1634. ExceedMaxPayloadSize,
  1635. ExceedUriMaxLength,
  1636. ExceedMaxSocketDescriptorCount,
  1637. InvalidRequestLine,
  1638. InvalidHTTPMethod,
  1639. InvalidHTTPVersion,
  1640. InvalidHeaders,
  1641. MultipartParsing,
  1642. OpenFile,
  1643. Listen,
  1644. GetSockName,
  1645. UnsupportedAddressFamily,
  1646. HTTPParsing,
  1647. InvalidRangeHeader,
  1648. UnsupportedContentEncoding,
  1649. WebSocketHandshake,
  1650. UserCallbackException,
  1651. // For internal use only
  1652. SSLPeerCouldBeClosed_,
  1653. };
  1654. std::string to_string(Error error);
  1655. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1656. class Stream {
  1657. public:
  1658. virtual ~Stream() = default;
  1659. virtual bool is_readable() const = 0;
  1660. virtual bool wait_readable() const = 0;
  1661. virtual bool wait_writable() const = 0;
  1662. virtual bool is_peer_alive() const { return wait_writable(); }
  1663. virtual ssize_t read(char *ptr, size_t size) = 0;
  1664. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1665. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1666. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1667. virtual socket_t socket() const = 0;
  1668. virtual time_t duration() const = 0;
  1669. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1670. (void)sec;
  1671. (void)usec;
  1672. }
  1673. // Bytes already pulled off the socket and sitting in this stream's own
  1674. // buffer. Exposing them lets a line reader scan for a terminator in one
  1675. // pass instead of asking for a byte at a time. A stream that does no
  1676. // buffering of its own reports none, and readers fall back to read().
  1677. virtual const char *buffered_data(size_t &size) const {
  1678. size = 0;
  1679. return nullptr;
  1680. }
  1681. // Discards `size` bytes previously returned by buffered_data().
  1682. virtual void consume_buffered(size_t size) { (void)size; }
  1683. ssize_t write(const char *ptr);
  1684. ssize_t write(const std::string &s);
  1685. Error get_error() const { return error_; }
  1686. protected:
  1687. Error error_ = Error::Success;
  1688. };
  1689. class TaskQueue {
  1690. public:
  1691. TaskQueue() = default;
  1692. virtual ~TaskQueue() = default;
  1693. virtual bool enqueue(std::function<void()> fn) = 0;
  1694. virtual void shutdown() = 0;
  1695. virtual void on_idle() {}
  1696. };
  1697. class ThreadPool final : public TaskQueue {
  1698. public:
  1699. explicit ThreadPool(
  1700. size_t n, size_t max_n = 0, size_t mqr = 0,
  1701. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1702. ThreadPool(const ThreadPool &) = delete;
  1703. ~ThreadPool() override = default;
  1704. bool enqueue(std::function<void()> fn) override;
  1705. void shutdown() override;
  1706. private:
  1707. void worker(bool is_dynamic);
  1708. void move_to_finished(std::thread::id id);
  1709. void cleanup_finished_threads();
  1710. size_t base_thread_count_;
  1711. size_t max_thread_count_;
  1712. size_t max_queued_requests_;
  1713. time_t idle_timeout_sec_;
  1714. size_t idle_thread_count_;
  1715. bool shutdown_;
  1716. std::list<std::function<void()>> jobs_;
  1717. std::vector<std::thread> threads_; // base threads
  1718. std::list<std::thread> dynamic_threads_; // dynamic threads
  1719. std::vector<std::thread>
  1720. finished_threads_; // exited dynamic threads awaiting join
  1721. std::condition_variable cond_;
  1722. std::mutex mutex_;
  1723. };
  1724. using Logger = std::function<void(const Request &, const Response &)>;
  1725. // Forward declaration for Error type
  1726. enum class Error;
  1727. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1728. using SocketOptions = std::function<void(socket_t sock)>;
  1729. void default_socket_options(socket_t sock);
  1730. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1731. const char *status_message(int status);
  1732. std::string to_string(Error error);
  1733. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1734. std::string get_bearer_token_auth(const Request &req);
  1735. namespace detail {
  1736. class MatcherBase {
  1737. public:
  1738. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1739. virtual ~MatcherBase() = default;
  1740. const std::string &pattern() const { return pattern_; }
  1741. // Match request path and populate its matches and
  1742. virtual bool match(Request &request) const = 0;
  1743. private:
  1744. std::string pattern_;
  1745. };
  1746. /**
  1747. * Captures parameters in request path and stores them in Request::path_params
  1748. *
  1749. * Capture name is a substring of a pattern from : to /.
  1750. * The rest of the pattern is matched against the request path directly
  1751. * Parameters are captured starting from the next character after
  1752. * the end of the last matched static pattern fragment until the next /.
  1753. *
  1754. * Example pattern:
  1755. * "/path/fragments/:capture/more/fragments/:second_capture"
  1756. * Static fragments:
  1757. * "/path/fragments/", "more/fragments/"
  1758. *
  1759. * Given the following request path:
  1760. * "/path/fragments/:1/more/fragments/:2"
  1761. * the resulting capture will be
  1762. * {{"capture", "1"}, {"second_capture", "2"}}
  1763. */
  1764. class PathParamsMatcher final : public MatcherBase {
  1765. public:
  1766. PathParamsMatcher(const std::string &pattern);
  1767. bool match(Request &request) const override;
  1768. private:
  1769. // Treat segment separators as the end of path parameter capture
  1770. // Does not need to handle query parameters as they are parsed before path
  1771. // matching
  1772. static constexpr char separator = '/';
  1773. // Contains static path fragments to match against, excluding the '/' after
  1774. // path params
  1775. // Fragments are separated by path params
  1776. std::vector<std::string> static_fragments_;
  1777. // Stores the names of the path parameters to be used as keys in the
  1778. // Request::path_params map
  1779. std::vector<std::string> param_names_;
  1780. };
  1781. /**
  1782. * Performs std::regex_match on request path
  1783. * and stores the result in Request::matches
  1784. *
  1785. * Note that regex match is performed directly on the whole request.
  1786. * This means that wildcard patterns may match multiple path segments with /:
  1787. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1788. */
  1789. class RegexMatcher final : public MatcherBase {
  1790. public:
  1791. RegexMatcher(const std::string &pattern)
  1792. : MatcherBase(pattern), regex_(pattern) {}
  1793. bool match(Request &request) const override;
  1794. private:
  1795. std::regex regex_;
  1796. };
  1797. int close_socket(socket_t sock) noexcept;
  1798. bool is_accept_resource_error();
  1799. bool is_accept_transient_error();
  1800. ssize_t write_headers(Stream &strm, const Headers &headers);
  1801. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1802. time_t usec);
  1803. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1804. const std::string &boundary);
  1805. ContentProvider
  1806. make_multipart_content_provider(const UploadFormDataItems &items,
  1807. const std::string &boundary);
  1808. } // namespace detail
  1809. bool is_valid_multipart_boundary(const std::string &boundary);
  1810. // Serializer for multipart/form-data request bodies. The boundary is owned
  1811. // by the writer so that per-part framing and the final terminator always
  1812. // agree. Field names and filenames are escaped following the WHATWG HTML
  1813. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1814. // in content types.
  1815. class MultipartFormDataWriter {
  1816. public:
  1817. MultipartFormDataWriter();
  1818. // precondition: is_valid_multipart_boundary(boundary)
  1819. explicit MultipartFormDataWriter(std::string boundary);
  1820. const std::string &boundary() const;
  1821. std::string content_type() const;
  1822. // In-memory items -> whole body (known length)
  1823. std::string serialize(const UploadFormDataItems &items) const;
  1824. size_t content_length(const UploadFormDataItems &items) const;
  1825. // Per-part framing for streaming via a content provider
  1826. std::string item_begin(const UploadFormData &item) const;
  1827. static std::string item_end();
  1828. std::string finish() const;
  1829. private:
  1830. std::string boundary_;
  1831. };
  1832. class Server {
  1833. public:
  1834. using Handler = std::function<void(const Request &, Response &)>;
  1835. using ExceptionHandler =
  1836. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1837. enum class HandlerResponse {
  1838. Handled,
  1839. Unhandled,
  1840. };
  1841. using HandlerWithResponse =
  1842. std::function<HandlerResponse(const Request &, Response &)>;
  1843. using HandlerWithContentReader = std::function<void(
  1844. const Request &, Response &, const ContentReader &content_reader)>;
  1845. using Expect100ContinueHandler =
  1846. std::function<int(const Request &, Response &)>;
  1847. using StartHandler = std::function<void()>;
  1848. using WebSocketHandler =
  1849. std::function<void(const Request &, ws::WebSocket &)>;
  1850. using SubProtocolSelector =
  1851. std::function<std::string(const std::vector<std::string> &protocols)>;
  1852. Server();
  1853. virtual ~Server();
  1854. virtual bool is_valid() const;
  1855. Server &Get(const std::string &pattern, Handler handler);
  1856. Server &Post(const std::string &pattern, Handler handler);
  1857. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1858. Server &Put(const std::string &pattern, Handler handler);
  1859. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1860. Server &Patch(const std::string &pattern, Handler handler);
  1861. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1862. Server &Delete(const std::string &pattern, Handler handler);
  1863. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1864. Server &Options(const std::string &pattern, Handler handler);
  1865. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1866. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1867. // server accept it; an unregistered method is still rejected with 400.
  1868. // `method` must be a valid HTTP method token and must not be one of the
  1869. // built-in methods, which have their own registration functions above. A
  1870. // rejected registration makes is_valid() return false, so listen() fails.
  1871. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1872. Handler handler);
  1873. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1874. HandlerWithContentReader handler);
  1875. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1876. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1877. SubProtocolSelector sub_protocol_selector);
  1878. bool set_base_dir(const std::string &dir,
  1879. const std::string &mount_point = std::string());
  1880. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1881. Headers headers = Headers());
  1882. bool remove_mount_point(const std::string &mount_point);
  1883. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1884. const std::string &mime);
  1885. Server &set_default_file_mimetype(const std::string &mime);
  1886. Server &set_file_request_handler(Handler handler);
  1887. template <class ErrorHandlerFunc>
  1888. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1889. return set_error_handler_core(
  1890. std::forward<ErrorHandlerFunc>(handler),
  1891. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1892. }
  1893. Server &set_exception_handler(ExceptionHandler handler);
  1894. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1895. Server &set_post_routing_handler(Handler handler);
  1896. Server &set_pre_request_handler(HandlerWithResponse handler);
  1897. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1898. Server &set_start_handler(StartHandler handler);
  1899. Server &set_logger(Logger logger);
  1900. Server &set_pre_compression_logger(Logger logger);
  1901. Server &set_error_logger(ErrorLogger error_logger);
  1902. Server &set_address_family(int family);
  1903. Server &set_tcp_nodelay(bool on);
  1904. Server &set_ipv6_v6only(bool on);
  1905. Server &set_socket_options(SocketOptions socket_options);
  1906. Server &set_default_headers(Headers headers);
  1907. Server &
  1908. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1909. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1910. Server &set_keep_alive_max_count(size_t count);
  1911. Server &set_keep_alive_timeout(time_t sec);
  1912. template <class Rep, class Period>
  1913. Server &
  1914. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1915. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1916. template <class Rep, class Period>
  1917. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1918. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1919. template <class Rep, class Period>
  1920. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1921. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1922. template <class Rep, class Period>
  1923. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1924. Server &set_payload_max_length(size_t length);
  1925. Server &set_static_file_compression(bool on);
  1926. Server &set_static_file_compression_min_length(size_t length);
  1927. Server &set_static_file_compression_max_length(size_t length);
  1928. Server &set_websocket_ping_interval(time_t sec);
  1929. template <class Rep, class Period>
  1930. Server &set_websocket_ping_interval(
  1931. const std::chrono::duration<Rep, Period> &duration);
  1932. Server &set_websocket_max_missed_pongs(int count);
  1933. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1934. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1935. bool listen_after_bind();
  1936. bool listen(const std::string &host, int port, int socket_flags = 0);
  1937. bool is_running() const;
  1938. void wait_until_ready() const;
  1939. void stop() noexcept;
  1940. void decommission();
  1941. std::function<TaskQueue *(void)> new_task_queue;
  1942. protected:
  1943. bool process_request(Stream &strm, const std::string &remote_addr,
  1944. int remote_port, const std::string &local_addr,
  1945. int local_port, bool close_connection,
  1946. bool &connection_closed,
  1947. const std::function<void(Request &)> &setup_request,
  1948. bool *websocket_upgraded = nullptr);
  1949. // Runs the per-connection serving loop and stops an exception thrown by a
  1950. // user callback from escaping the worker thread.
  1951. //
  1952. // process_request() wraps only routing() in a try/catch. Content providers,
  1953. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1954. // handlers all run outside it, and the task queue calls the job without a
  1955. // catch, so an exception from any of those would terminate the process.
  1956. //
  1957. // No 500 is possible here: by the time a content provider runs, the status
  1958. // line and headers are already on the wire. Report it through the error
  1959. // logger and drop the connection, which is what the peer observes either
  1960. // way. Other connections are unaffected.
  1961. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1962. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1963. return serve();
  1964. #else
  1965. try {
  1966. return serve();
  1967. } catch (...) {
  1968. // The error logger is a user callback too, so it must not be able to
  1969. // throw the guard back open.
  1970. try {
  1971. output_error_log(Error::UserCallbackException, nullptr);
  1972. } catch (...) {}
  1973. return false;
  1974. }
  1975. #endif
  1976. }
  1977. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1978. std::vector<std::string> trusted_proxies_;
  1979. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1980. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1981. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1982. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1983. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1984. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1985. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1986. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1987. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1988. bool static_file_compression_ = false;
  1989. size_t static_file_compression_min_length_ =
  1990. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1991. size_t static_file_compression_max_length_ =
  1992. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1993. time_t websocket_ping_interval_sec_ =
  1994. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1995. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1996. private:
  1997. using Handlers =
  1998. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1999. using HandlersForContentReader =
  2000. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2001. HandlerWithContentReader>>;
  2002. // Both handler tables for one custom method live in a single entry, so that
  2003. // routing() needs only one map lookup per request to reach either of them.
  2004. struct CustomHandlerEntry {
  2005. Handlers handlers;
  2006. HandlersForContentReader handlers_for_content_reader;
  2007. };
  2008. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2009. static std::unique_ptr<detail::MatcherBase>
  2010. make_matcher(const std::string &pattern);
  2011. static const std::set<std::string> &builtin_methods();
  2012. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2013. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2014. template <typename H>
  2015. Server &add_handler(
  2016. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2017. const std::string &pattern, H handler) {
  2018. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2019. return *this;
  2020. }
  2021. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2022. Server &set_error_handler_core(Handler handler, std::false_type);
  2023. socket_t create_server_socket(const std::string &host, int port,
  2024. int socket_flags,
  2025. SocketOptions socket_options) const;
  2026. int bind_internal(const std::string &host, int port, int socket_flags);
  2027. bool listen_internal();
  2028. bool routing(Request &req, Response &res, Stream &strm);
  2029. bool handle_file_request(Request &req, Response &res);
  2030. bool check_if_not_modified(const Request &req, Response &res,
  2031. const std::string &etag, time_t mtime) const;
  2032. bool check_if_range(Request &req, const std::string &etag,
  2033. time_t mtime) const;
  2034. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2035. Stream &strm);
  2036. bool dispatch_request_for_content_reader(
  2037. Request &req, Response &res, ContentReader content_reader,
  2038. const HandlersForContentReader &handlers) const;
  2039. bool parse_request_line(const char *s, Request &req) const;
  2040. detail::EncodingType static_file_encoding(const Request &req,
  2041. const Response &res,
  2042. const std::string &content_type,
  2043. size_t length) const;
  2044. bool apply_static_file_compression(const Request &req, Response &res) const;
  2045. void apply_ranges(const Request &req, Response &res,
  2046. std::string &content_type, std::string &boundary) const;
  2047. bool write_response(Stream &strm, bool close_connection, Request &req,
  2048. Response &res);
  2049. bool write_response_with_content(Stream &strm, bool close_connection,
  2050. const Request &req, Response &res);
  2051. bool write_response_core(Stream &strm, bool close_connection,
  2052. const Request &req, Response &res,
  2053. bool need_apply_ranges);
  2054. bool write_content_with_provider(Stream &strm, const Request &req,
  2055. Response &res, const std::string &boundary,
  2056. const std::string &content_type);
  2057. bool read_content(Stream &strm, Request &req, Response &res);
  2058. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2059. Response &res,
  2060. ContentReceiver receiver,
  2061. FormDataHeader multipart_header,
  2062. ContentReceiver multipart_receiver);
  2063. bool read_content_core(Stream &strm, Request &req, Response &res,
  2064. ContentReceiver receiver,
  2065. FormDataHeader multipart_header,
  2066. ContentReceiver multipart_receiver) const;
  2067. virtual bool process_and_close_socket(socket_t sock);
  2068. void output_log(const Request &req, const Response &res) const;
  2069. void output_pre_compression_log(const Request &req,
  2070. const Response &res) const;
  2071. void output_error_log(const Error &err, const Request *req) const;
  2072. std::atomic<bool> is_running_{false};
  2073. std::atomic<bool> is_decommissioned{false};
  2074. // Set when CustomRoute() refuses a registration. Written before listen(),
  2075. // read by is_valid() on the same thread, so it needs no synchronization.
  2076. bool has_invalid_registration_ = false;
  2077. struct MountPointEntry {
  2078. std::string mount_point;
  2079. std::string base_dir;
  2080. std::string resolved_base_dir;
  2081. Headers headers;
  2082. };
  2083. std::vector<MountPointEntry> base_dirs_;
  2084. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2085. std::string default_file_mimetype_ = "application/octet-stream";
  2086. Handler file_request_handler_;
  2087. Handlers get_handlers_;
  2088. Handlers post_handlers_;
  2089. HandlersForContentReader post_handlers_for_content_reader_;
  2090. Handlers put_handlers_;
  2091. HandlersForContentReader put_handlers_for_content_reader_;
  2092. Handlers patch_handlers_;
  2093. HandlersForContentReader patch_handlers_for_content_reader_;
  2094. Handlers delete_handlers_;
  2095. HandlersForContentReader delete_handlers_for_content_reader_;
  2096. Handlers options_handlers_;
  2097. CustomHandlers custom_handlers_;
  2098. struct WebSocketHandlerEntry {
  2099. std::unique_ptr<detail::MatcherBase> matcher;
  2100. WebSocketHandler handler;
  2101. SubProtocolSelector sub_protocol_selector;
  2102. };
  2103. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2104. WebSocketHandlers websocket_handlers_;
  2105. HandlerWithResponse error_handler_;
  2106. ExceptionHandler exception_handler_;
  2107. HandlerWithResponse pre_routing_handler_;
  2108. Handler post_routing_handler_;
  2109. HandlerWithResponse pre_request_handler_;
  2110. Expect100ContinueHandler expect_100_continue_handler_;
  2111. StartHandler start_handler_;
  2112. mutable std::mutex logger_mutex_;
  2113. Logger logger_;
  2114. Logger pre_compression_logger_;
  2115. ErrorLogger error_logger_;
  2116. int address_family_ = AF_UNSPEC;
  2117. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2118. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2119. SocketOptions socket_options_ = default_socket_options;
  2120. Headers default_headers_;
  2121. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2122. detail::write_headers;
  2123. };
  2124. class Result {
  2125. public:
  2126. Result() = default;
  2127. Result(std::unique_ptr<Response> &&res, Error err,
  2128. Headers &&request_headers = Headers{})
  2129. : res_(std::move(res)), err_(err),
  2130. request_headers_(std::move(request_headers)) {}
  2131. // Response
  2132. operator bool() const { return res_ != nullptr; }
  2133. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2134. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2135. const Response &value() const { return *res_; }
  2136. Response &value() { return *res_; }
  2137. const Response &operator*() const { return *res_; }
  2138. Response &operator*() { return *res_; }
  2139. const Response *operator->() const { return res_.get(); }
  2140. Response *operator->() { return res_.get(); }
  2141. // Error
  2142. Error error() const { return err_; }
  2143. // Request Headers
  2144. bool has_request_header(const std::string &key) const;
  2145. std::string get_request_header_value(const std::string &key,
  2146. const char *def = "",
  2147. size_t id = 0) const;
  2148. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2149. size_t id = 0) const;
  2150. size_t get_request_header_value_count(const std::string &key) const;
  2151. private:
  2152. std::unique_ptr<Response> res_;
  2153. Error err_ = Error::Unknown;
  2154. Headers request_headers_;
  2155. #ifdef CPPHTTPLIB_SSL_ENABLED
  2156. public:
  2157. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2158. int ssl_error)
  2159. : res_(std::move(res)), err_(err),
  2160. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2161. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2162. int ssl_error, uint64_t ssl_backend_error)
  2163. : res_(std::move(res)), err_(err),
  2164. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2165. ssl_backend_error_(ssl_backend_error) {}
  2166. int ssl_error() const { return ssl_error_; }
  2167. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2168. private:
  2169. int ssl_error_ = 0;
  2170. uint64_t ssl_backend_error_ = 0;
  2171. #endif
  2172. };
  2173. struct ClientConnection {
  2174. socket_t sock = INVALID_SOCKET;
  2175. bool is_open() const { return sock != INVALID_SOCKET; }
  2176. ClientConnection() = default;
  2177. ~ClientConnection();
  2178. ClientConnection(const ClientConnection &) = delete;
  2179. ClientConnection &operator=(const ClientConnection &) = delete;
  2180. ClientConnection(ClientConnection &&other) noexcept
  2181. : sock(other.sock)
  2182. #ifdef CPPHTTPLIB_SSL_ENABLED
  2183. ,
  2184. session(other.session)
  2185. #endif
  2186. {
  2187. other.sock = INVALID_SOCKET;
  2188. #ifdef CPPHTTPLIB_SSL_ENABLED
  2189. other.session = nullptr;
  2190. #endif
  2191. }
  2192. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2193. if (this != &other) {
  2194. sock = other.sock;
  2195. other.sock = INVALID_SOCKET;
  2196. #ifdef CPPHTTPLIB_SSL_ENABLED
  2197. session = other.session;
  2198. other.session = nullptr;
  2199. #endif
  2200. }
  2201. return *this;
  2202. }
  2203. #ifdef CPPHTTPLIB_SSL_ENABLED
  2204. tls::session_t session = nullptr;
  2205. #endif
  2206. };
  2207. namespace detail {
  2208. struct ChunkedDecoder;
  2209. struct BodyReader {
  2210. Stream *stream = nullptr;
  2211. bool has_content_length = false;
  2212. size_t content_length = 0;
  2213. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2214. size_t bytes_read = 0;
  2215. bool chunked = false;
  2216. bool eof = false;
  2217. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2218. Error last_error = Error::Success;
  2219. ssize_t read(char *buf, size_t len);
  2220. bool has_error() const { return last_error != Error::Success; }
  2221. };
  2222. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2223. size_t len) {
  2224. (void)stream;
  2225. return br.read(buf, len);
  2226. }
  2227. class decompressor;
  2228. enum class NoProxyKind {
  2229. Wildcard, // "*"
  2230. HostnameSuffix, // "example.com" or ".example.com"
  2231. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2232. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2233. };
  2234. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2235. // Lets one CIDR matcher cover both families.
  2236. using IPBytes = std::array<uint8_t, 16>;
  2237. struct NoProxyEntry {
  2238. NoProxyKind kind = NoProxyKind::Wildcard;
  2239. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2240. IPBytes net{};
  2241. int prefix_bits = 0;
  2242. };
  2243. struct NormalizedTarget {
  2244. std::string hostname; // lowercase; brackets and trailing dot removed
  2245. bool is_ipv4 = false;
  2246. bool is_ipv6 = false;
  2247. IPBytes ip{};
  2248. };
  2249. } // namespace detail
  2250. class ClientImpl {
  2251. public:
  2252. explicit ClientImpl(const std::string &host);
  2253. explicit ClientImpl(const std::string &host, int port);
  2254. explicit ClientImpl(const std::string &host, int port,
  2255. const std::string &client_cert_path,
  2256. const std::string &client_key_path);
  2257. virtual ~ClientImpl();
  2258. virtual bool is_valid() const;
  2259. struct StreamHandle {
  2260. std::unique_ptr<Response> response;
  2261. Error error = Error::Success;
  2262. StreamHandle() = default;
  2263. StreamHandle(const StreamHandle &) = delete;
  2264. StreamHandle &operator=(const StreamHandle &) = delete;
  2265. StreamHandle(StreamHandle &&) = default;
  2266. StreamHandle &operator=(StreamHandle &&) = default;
  2267. ~StreamHandle() = default;
  2268. bool is_valid() const {
  2269. return response != nullptr && error == Error::Success;
  2270. }
  2271. ssize_t read(char *buf, size_t len);
  2272. void parse_trailers_if_needed();
  2273. Error get_read_error() const { return body_reader_.last_error; }
  2274. bool has_read_error() const { return body_reader_.has_error(); }
  2275. bool trailers_parsed_ = false;
  2276. private:
  2277. friend class ClientImpl;
  2278. ssize_t read_with_decompression(char *buf, size_t len);
  2279. std::unique_ptr<ClientConnection> connection_;
  2280. std::unique_ptr<Stream> socket_stream_;
  2281. Stream *stream_ = nullptr;
  2282. detail::BodyReader body_reader_;
  2283. std::unique_ptr<detail::decompressor> decompressor_;
  2284. std::string decompress_buffer_;
  2285. size_t decompress_offset_ = 0;
  2286. size_t decompressed_bytes_read_ = 0;
  2287. };
  2288. // clang-format off
  2289. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2290. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2291. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2292. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2293. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2294. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2295. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2296. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2297. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2298. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2299. Result Head(const std::string &path);
  2300. Result Head(const std::string &path, const Headers &headers);
  2301. Result Post(const std::string &path);
  2302. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2304. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2305. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2306. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2307. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2308. Result Post(const std::string &path, const Params &params);
  2309. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2310. Result Post(const std::string &path, const Headers &headers);
  2311. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2312. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2313. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2314. 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);
  2315. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2317. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2318. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2319. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2320. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2321. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2322. Result Put(const std::string &path);
  2323. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2325. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2326. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2327. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2329. Result Put(const std::string &path, const Params &params);
  2330. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2331. Result Put(const std::string &path, const Headers &headers);
  2332. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2333. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2334. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2335. 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);
  2336. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2338. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2339. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2340. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2341. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2342. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2343. Result Patch(const std::string &path);
  2344. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2346. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2347. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2348. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2349. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2350. Result Patch(const std::string &path, const Params &params);
  2351. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2352. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2353. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2354. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2355. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2356. 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);
  2357. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2358. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2359. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2360. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2361. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2362. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2363. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2364. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2365. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2366. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2367. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2368. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2369. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2370. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2371. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2372. Result Options(const std::string &path);
  2373. Result Options(const std::string &path, const Headers &headers);
  2374. // clang-format on
  2375. // Streaming API: Open a stream for reading response body incrementally
  2376. // Socket ownership is transferred to StreamHandle for true streaming
  2377. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2378. StreamHandle open_stream(const std::string &method, const std::string &path,
  2379. const Params &params = {},
  2380. const Headers &headers = {},
  2381. const std::string &body = {},
  2382. const std::string &content_type = {});
  2383. bool send(Request &req, Response &res, Error &error);
  2384. Result send(const Request &req);
  2385. void stop();
  2386. std::string host() const;
  2387. int port() const;
  2388. size_t is_socket_open() const;
  2389. socket_t socket() const;
  2390. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2391. void set_default_headers(Headers headers);
  2392. void
  2393. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2394. void set_address_family(int family);
  2395. void set_tcp_nodelay(bool on);
  2396. void set_ipv6_v6only(bool on);
  2397. void set_socket_options(SocketOptions socket_options);
  2398. void set_connection_timeout(time_t sec, time_t usec = 0);
  2399. template <class Rep, class Period>
  2400. void
  2401. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2402. void set_read_timeout(time_t sec, time_t usec = 0);
  2403. template <class Rep, class Period>
  2404. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2405. void set_write_timeout(time_t sec, time_t usec = 0);
  2406. template <class Rep, class Period>
  2407. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2408. void set_max_timeout(time_t msec);
  2409. template <class Rep, class Period>
  2410. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2411. void set_basic_auth(const std::string &username, const std::string &password);
  2412. void set_bearer_token_auth(const std::string &token);
  2413. void set_keep_alive(bool on);
  2414. void set_follow_location(bool on);
  2415. void set_path_encode(bool on);
  2416. void set_compress(bool on);
  2417. void set_decompress(bool on);
  2418. void set_payload_max_length(size_t length);
  2419. void set_interface(const std::string &intf);
  2420. void set_proxy(const std::string &host, int port);
  2421. void set_proxy_basic_auth(const std::string &username,
  2422. const std::string &password);
  2423. void set_proxy_bearer_token_auth(const std::string &token);
  2424. void set_no_proxy(const std::vector<std::string> &patterns);
  2425. void set_logger(Logger logger);
  2426. void set_error_logger(ErrorLogger error_logger);
  2427. protected:
  2428. struct Socket {
  2429. socket_t sock = INVALID_SOCKET;
  2430. // For Mbed TLS compatibility: start_time for request timeout tracking
  2431. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2432. bool is_open() const { return sock != INVALID_SOCKET; }
  2433. #ifdef CPPHTTPLIB_SSL_ENABLED
  2434. tls::session_t ssl = nullptr;
  2435. #endif
  2436. };
  2437. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2438. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2439. virtual bool setup_proxy_connection(
  2440. Socket &socket,
  2441. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2442. Response &res, bool &success, Error &error);
  2443. bool is_proxy_enabled_for_host(const std::string &host) const;
  2444. // All of:
  2445. // shutdown_ssl
  2446. // shutdown_socket
  2447. // close_socket
  2448. // disconnect
  2449. // should ONLY be called when socket_mutex_ is locked, and only when
  2450. // no other thread is using the socket.
  2451. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2452. void shutdown_socket(Socket &socket) const;
  2453. void close_socket(Socket &socket);
  2454. void disconnect(bool gracefully);
  2455. bool process_request(Stream &strm, Request &req, Response &res,
  2456. bool close_connection, Error &error);
  2457. bool write_content_with_provider(Stream &strm, const Request &req,
  2458. Error &error) const;
  2459. void output_log(const Request &req, const Response &res) const;
  2460. void output_error_log(const Error &err, const Request *req) const;
  2461. // Socket endpoint information
  2462. const std::string host_;
  2463. const int port_;
  2464. // Current open socket
  2465. Socket socket_;
  2466. mutable std::mutex socket_mutex_;
  2467. std::recursive_mutex request_mutex_;
  2468. // These are all protected under socket_mutex
  2469. size_t socket_requests_in_flight_ = 0;
  2470. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2471. bool socket_should_be_closed_when_request_is_done_ = false;
  2472. // Hostname to connection target map. The value is an IP literal or another
  2473. // hostname; only the connection target changes, never the identity.
  2474. std::map<std::string, std::string> addr_map_;
  2475. // Default headers
  2476. Headers default_headers_;
  2477. // Header writer
  2478. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2479. detail::write_headers;
  2480. // Settings
  2481. std::string client_cert_path_;
  2482. std::string client_key_path_;
  2483. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2484. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2485. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2486. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2487. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2488. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2489. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2490. std::string basic_auth_username_;
  2491. std::string basic_auth_password_;
  2492. std::string bearer_token_auth_token_;
  2493. bool keep_alive_ = false;
  2494. bool follow_location_ = false;
  2495. bool path_encode_ = true;
  2496. int address_family_ = AF_UNSPEC;
  2497. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2498. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2499. SocketOptions socket_options_ = nullptr;
  2500. bool compress_ = false;
  2501. bool decompress_ = true;
  2502. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2503. bool has_payload_max_length_ = false;
  2504. std::string interface_;
  2505. std::string proxy_host_;
  2506. int proxy_port_ = -1;
  2507. std::string proxy_basic_auth_username_;
  2508. std::string proxy_basic_auth_password_;
  2509. std::string proxy_bearer_token_auth_token_;
  2510. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2511. mutable detail::NormalizedTarget host_normalized_;
  2512. mutable bool host_normalized_valid_ = false;
  2513. mutable std::mutex logger_mutex_;
  2514. Logger logger_;
  2515. ErrorLogger error_logger_;
  2516. private:
  2517. bool send_(Request &req, Response &res, Error &error);
  2518. Result send_(Request &&req);
  2519. socket_t create_client_socket(Error &error) const;
  2520. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2521. bool skip_100_continue = true) const;
  2522. bool write_request(Stream &strm, Request &req, bool close_connection,
  2523. Error &error, bool skip_body, bool &rejected_locally);
  2524. bool write_request_body(Stream &strm, Request &req, Error &error);
  2525. void prepare_default_headers(Request &r, bool for_stream,
  2526. const std::string &ct);
  2527. bool redirect(Request &req, Response &res, Error &error);
  2528. bool create_redirect_client(const std::string &scheme,
  2529. const std::string &host, int port, Request &req,
  2530. Response &res, const std::string &path,
  2531. const std::string &location, Error &error);
  2532. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2533. bool handle_request(Stream &strm, Request &req, Response &res,
  2534. bool close_connection, Error &error);
  2535. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2536. Request &req, const char *body, size_t content_length,
  2537. ContentProvider content_provider,
  2538. ContentProviderWithoutLength content_provider_without_length,
  2539. const std::string &content_type, ContentReceiver content_receiver,
  2540. Error &error);
  2541. Result send_with_content_provider_and_receiver(
  2542. const std::string &method, const std::string &path,
  2543. const Headers &headers, const char *body, size_t content_length,
  2544. ContentProvider content_provider,
  2545. ContentProviderWithoutLength content_provider_without_length,
  2546. const std::string &content_type, ContentReceiver content_receiver,
  2547. UploadProgress progress);
  2548. ContentProviderWithoutLength get_multipart_content_provider(
  2549. const std::string &boundary, const UploadFormDataItems &items,
  2550. const FormDataProviderItems &provider_items) const;
  2551. virtual bool
  2552. process_socket(const Socket &socket,
  2553. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2554. std::function<bool(Stream &strm)> callback);
  2555. virtual bool is_ssl() const;
  2556. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2557. #ifdef CPPHTTPLIB_SSL_ENABLED
  2558. public:
  2559. void set_digest_auth(const std::string &username,
  2560. const std::string &password);
  2561. void set_proxy_digest_auth(const std::string &username,
  2562. const std::string &password);
  2563. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2564. const std::string &ca_cert_dir_path = std::string());
  2565. void enable_server_certificate_verification(bool enabled);
  2566. void enable_server_hostname_verification(bool enabled);
  2567. void enable_system_ca(bool enabled);
  2568. protected:
  2569. std::string digest_auth_username_;
  2570. std::string digest_auth_password_;
  2571. std::string proxy_digest_auth_username_;
  2572. std::string proxy_digest_auth_password_;
  2573. std::string ca_cert_file_path_;
  2574. std::string ca_cert_dir_path_;
  2575. bool server_certificate_verification_ = true;
  2576. bool server_hostname_verification_ = true;
  2577. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2578. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2579. int last_ssl_error_ = 0;
  2580. uint64_t last_backend_error_ = 0;
  2581. #endif
  2582. };
  2583. namespace detail {
  2584. // Stands in for a client that Client could not make from its arguments, so a
  2585. // request fails rather than going through a null pointer.
  2586. class InvalidClientImpl final : public ClientImpl {
  2587. public:
  2588. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2589. bool is_valid() const override { return false; }
  2590. private:
  2591. bool create_and_connect_socket(Socket &, Error &error) override {
  2592. error = Error::Connection;
  2593. return false;
  2594. }
  2595. };
  2596. } // namespace detail
  2597. class Client {
  2598. public:
  2599. // Universal interface
  2600. explicit Client(const std::string &scheme_host_port);
  2601. explicit Client(const std::string &scheme_host_port,
  2602. const std::string &client_cert_path,
  2603. const std::string &client_key_path);
  2604. // HTTP only interface
  2605. explicit Client(const std::string &host, int port);
  2606. explicit Client(const std::string &host, int port,
  2607. const std::string &client_cert_path,
  2608. const std::string &client_key_path);
  2609. Client(Client &&) = default;
  2610. Client &operator=(Client &&) = default;
  2611. ~Client();
  2612. bool is_valid() const;
  2613. // clang-format off
  2614. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2615. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2616. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2617. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2618. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2619. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2620. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2621. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2622. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2623. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2624. Result Head(const std::string &path);
  2625. Result Head(const std::string &path, const Headers &headers);
  2626. Result Post(const std::string &path);
  2627. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2629. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2630. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2631. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2632. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2633. Result Post(const std::string &path, const Params &params);
  2634. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2635. Result Post(const std::string &path, const Headers &headers);
  2636. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2637. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2638. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2639. 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);
  2640. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2642. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2643. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2644. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2645. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2646. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2647. Result Put(const std::string &path);
  2648. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2650. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2651. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2652. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2653. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2654. Result Put(const std::string &path, const Params &params);
  2655. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2656. Result Put(const std::string &path, const Headers &headers);
  2657. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2658. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2659. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2660. 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);
  2661. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2663. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2664. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2665. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2666. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2667. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2668. Result Patch(const std::string &path);
  2669. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2671. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2672. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2673. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2674. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2675. Result Patch(const std::string &path, const Params &params);
  2676. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2677. Result Patch(const std::string &path, const Headers &headers);
  2678. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2679. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2680. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2681. 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);
  2682. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2684. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2685. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2686. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2687. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2688. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2689. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2690. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2691. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2692. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2693. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2694. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2695. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2696. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2697. Result Options(const std::string &path);
  2698. Result Options(const std::string &path, const Headers &headers);
  2699. // clang-format on
  2700. // Streaming API: Open a stream for reading response body incrementally
  2701. // Socket ownership is transferred to StreamHandle for true streaming
  2702. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2703. ClientImpl::StreamHandle open_stream(const std::string &method,
  2704. const std::string &path,
  2705. const Params &params = {},
  2706. const Headers &headers = {},
  2707. const std::string &body = {},
  2708. const std::string &content_type = {});
  2709. bool send(Request &req, Response &res, Error &error);
  2710. Result send(const Request &req);
  2711. void stop();
  2712. std::string host() const;
  2713. int port() const;
  2714. size_t is_socket_open() const;
  2715. socket_t socket() const;
  2716. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2717. void set_default_headers(Headers headers);
  2718. void
  2719. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2720. void set_address_family(int family);
  2721. void set_tcp_nodelay(bool on);
  2722. void set_socket_options(SocketOptions socket_options);
  2723. void set_connection_timeout(time_t sec, time_t usec = 0);
  2724. template <class Rep, class Period>
  2725. void
  2726. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2727. void set_read_timeout(time_t sec, time_t usec = 0);
  2728. template <class Rep, class Period>
  2729. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2730. void set_write_timeout(time_t sec, time_t usec = 0);
  2731. template <class Rep, class Period>
  2732. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2733. void set_max_timeout(time_t msec);
  2734. template <class Rep, class Period>
  2735. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2736. void set_basic_auth(const std::string &username, const std::string &password);
  2737. void set_bearer_token_auth(const std::string &token);
  2738. void set_keep_alive(bool on);
  2739. void set_follow_location(bool on);
  2740. void set_path_encode(bool on);
  2741. void set_compress(bool on);
  2742. void set_decompress(bool on);
  2743. void set_payload_max_length(size_t length);
  2744. void set_interface(const std::string &intf);
  2745. void set_proxy(const std::string &host, int port);
  2746. void set_proxy_basic_auth(const std::string &username,
  2747. const std::string &password);
  2748. void set_proxy_bearer_token_auth(const std::string &token);
  2749. void set_no_proxy(const std::vector<std::string> &patterns);
  2750. void set_logger(Logger logger);
  2751. void set_error_logger(ErrorLogger error_logger);
  2752. private:
  2753. std::unique_ptr<ClientImpl> cli_;
  2754. #ifdef CPPHTTPLIB_SSL_ENABLED
  2755. public:
  2756. void set_digest_auth(const std::string &username,
  2757. const std::string &password);
  2758. void set_proxy_digest_auth(const std::string &username,
  2759. const std::string &password);
  2760. void enable_server_certificate_verification(bool enabled);
  2761. void enable_server_hostname_verification(bool enabled);
  2762. void enable_system_ca(bool enabled);
  2763. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2764. const std::string &ca_cert_dir_path = std::string());
  2765. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2766. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2767. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2768. void set_session_verifier(
  2769. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2770. tls::ctx_t tls_context() const;
  2771. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2772. void enable_windows_certificate_verification(bool enabled);
  2773. #endif
  2774. private:
  2775. bool is_ssl_ = false;
  2776. #endif
  2777. };
  2778. #ifdef CPPHTTPLIB_SSL_ENABLED
  2779. class SSLServer : public Server {
  2780. public:
  2781. SSLServer(const char *cert_path, const char *private_key_path,
  2782. const char *client_ca_cert_file_path = nullptr,
  2783. const char *client_ca_cert_dir_path = nullptr,
  2784. const char *private_key_password = nullptr);
  2785. struct PemMemory {
  2786. const char *cert_pem;
  2787. size_t cert_pem_len;
  2788. const char *key_pem;
  2789. size_t key_pem_len;
  2790. const char *client_ca_pem;
  2791. size_t client_ca_pem_len;
  2792. const char *private_key_password;
  2793. };
  2794. explicit SSLServer(const PemMemory &pem);
  2795. // The callback receives the ctx_t handle which can be cast to the
  2796. // appropriate backend type (SSL_CTX* for OpenSSL,
  2797. // tls::impl::MbedTlsContext* for Mbed TLS)
  2798. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2799. ~SSLServer() override;
  2800. bool is_valid() const override;
  2801. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2802. const char *client_ca_pem = nullptr,
  2803. const char *password = nullptr);
  2804. tls::ctx_t tls_context() const { return ctx_; }
  2805. int ssl_last_error() const { return last_ssl_error_; }
  2806. private:
  2807. bool process_and_close_socket(socket_t sock) override;
  2808. tls::ctx_t ctx_ = nullptr;
  2809. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2810. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2811. // bounds, and new ones wait while it is pending so that they cannot keep it
  2812. // waiting.
  2813. std::mutex ctx_mutex_;
  2814. std::condition_variable ctx_cv_;
  2815. size_t handshakes_in_progress_ = 0;
  2816. size_t updates_pending_ = 0;
  2817. int last_ssl_error_ = 0;
  2818. };
  2819. class SSLClient final : public ClientImpl {
  2820. public:
  2821. explicit SSLClient(const std::string &host);
  2822. explicit SSLClient(const std::string &host, int port);
  2823. explicit SSLClient(const std::string &host, int port,
  2824. const std::string &client_cert_path,
  2825. const std::string &client_key_path,
  2826. const std::string &private_key_password = std::string());
  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 *private_key_password;
  2833. };
  2834. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2835. ~SSLClient() override;
  2836. bool is_valid() const override;
  2837. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2838. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2839. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2840. // Post-handshake session verifier (backend-independent)
  2841. void set_session_verifier(
  2842. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2843. tls::ctx_t tls_context() const { return ctx_; }
  2844. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2845. void enable_windows_certificate_verification(bool enabled);
  2846. #endif
  2847. private:
  2848. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2849. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2850. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2851. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2852. bool
  2853. process_socket(const Socket &socket,
  2854. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2855. std::function<bool(Stream &strm)> callback) override;
  2856. bool is_ssl() const override;
  2857. bool setup_proxy_connection(
  2858. Socket &socket,
  2859. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2860. Response &res, bool &success, Error &error) override;
  2861. bool connect_with_proxy(
  2862. Socket &sock,
  2863. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2864. Response &res, bool &success, Error &error);
  2865. bool initialize_ssl(Socket &socket, Error &error);
  2866. void init_ctx();
  2867. void reset_ctx_on_error();
  2868. bool load_certs();
  2869. tls::ctx_t ctx_ = nullptr;
  2870. std::mutex ctx_mutex_;
  2871. std::once_flag initialize_cert_;
  2872. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2873. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2874. // Used to keep custom CA configuration exclusive with system CA loading.
  2875. bool ca_cert_store_set_ = false;
  2876. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2877. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2878. // set_server_certificate_verifier() installed there.
  2879. tls::VerifyCallback server_certificate_verifier_;
  2880. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2881. bool enable_windows_cert_verification_ = true;
  2882. #endif
  2883. friend class ClientImpl;
  2884. };
  2885. #endif // CPPHTTPLIB_SSL_ENABLED
  2886. namespace detail {
  2887. template <typename T, typename U>
  2888. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2889. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2890. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2891. duration - std::chrono::seconds(sec))
  2892. .count();
  2893. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2894. }
  2895. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2896. return N - 1;
  2897. }
  2898. inline bool is_numeric(const std::string &str) {
  2899. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2900. }
  2901. // std::ranges::next(first, n, last) for C++11
  2902. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2903. for (; n > 0 && first != last; --n) {
  2904. ++first;
  2905. }
  2906. return first;
  2907. }
  2908. inline size_t get_header_value_u64(const Headers &headers,
  2909. const std::string &key, size_t def,
  2910. size_t id, bool &is_invalid_value) {
  2911. is_invalid_value = false;
  2912. auto rng = headers.equal_range(key);
  2913. auto it = bounded_next(rng.first, id, rng.second);
  2914. if (it != rng.second) {
  2915. if (is_numeric(it->second)) {
  2916. // Parse at size_t width so an out-of-range Content-Length is reported
  2917. // rather than silently saturated/truncated (a value above 2^32 would
  2918. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2919. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2920. size_t val = 0;
  2921. const auto &s = it->second;
  2922. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2923. if (r.ec == std::errc::result_out_of_range) {
  2924. is_invalid_value = true;
  2925. return (std::numeric_limits<size_t>::max)();
  2926. }
  2927. return val;
  2928. } else {
  2929. is_invalid_value = true;
  2930. }
  2931. }
  2932. return def;
  2933. }
  2934. inline size_t get_header_value_u64(const Headers &headers,
  2935. const std::string &key, size_t def,
  2936. size_t id) {
  2937. auto dummy = false;
  2938. return get_header_value_u64(headers, key, def, id, dummy);
  2939. }
  2940. } // namespace detail
  2941. template <class Rep, class Period>
  2942. inline Server &
  2943. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2944. detail::duration_to_sec_and_usec(
  2945. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2946. return *this;
  2947. }
  2948. template <class Rep, class Period>
  2949. inline Server &
  2950. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2951. detail::duration_to_sec_and_usec(
  2952. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2953. return *this;
  2954. }
  2955. template <class Rep, class Period>
  2956. inline Server &
  2957. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2958. detail::duration_to_sec_and_usec(
  2959. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2960. return *this;
  2961. }
  2962. template <class Rep, class Period>
  2963. inline void ClientImpl::set_connection_timeout(
  2964. const std::chrono::duration<Rep, Period> &duration) {
  2965. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2966. set_connection_timeout(sec, usec);
  2967. });
  2968. }
  2969. template <class Rep, class Period>
  2970. inline void ClientImpl::set_read_timeout(
  2971. const std::chrono::duration<Rep, Period> &duration) {
  2972. detail::duration_to_sec_and_usec(
  2973. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2974. }
  2975. template <class Rep, class Period>
  2976. inline void ClientImpl::set_write_timeout(
  2977. const std::chrono::duration<Rep, Period> &duration) {
  2978. detail::duration_to_sec_and_usec(
  2979. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2980. }
  2981. template <class Rep, class Period>
  2982. inline void ClientImpl::set_max_timeout(
  2983. const std::chrono::duration<Rep, Period> &duration) {
  2984. auto msec =
  2985. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2986. set_max_timeout(msec);
  2987. }
  2988. template <class Rep, class Period>
  2989. inline void Client::set_connection_timeout(
  2990. const std::chrono::duration<Rep, Period> &duration) {
  2991. cli_->set_connection_timeout(duration);
  2992. }
  2993. template <class Rep, class Period>
  2994. inline void
  2995. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2996. cli_->set_read_timeout(duration);
  2997. }
  2998. template <class Rep, class Period>
  2999. inline void
  3000. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3001. cli_->set_write_timeout(duration);
  3002. }
  3003. inline void Client::set_max_timeout(time_t msec) {
  3004. cli_->set_max_timeout(msec);
  3005. }
  3006. template <class Rep, class Period>
  3007. inline void
  3008. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3009. cli_->set_max_timeout(duration);
  3010. }
  3011. /*
  3012. * Forward declarations and types that will be part of the .h file if split into
  3013. * .h + .cc.
  3014. */
  3015. std::string hosted_at(const std::string &hostname);
  3016. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3017. // JavaScript-style URL encoding/decoding functions
  3018. std::string encode_uri_component(const std::string &value);
  3019. std::string encode_uri(const std::string &value);
  3020. std::string decode_uri_component(const std::string &value);
  3021. std::string decode_uri(const std::string &value);
  3022. // RFC 3986 compliant URL component encoding/decoding functions
  3023. std::string encode_path_component(const std::string &component);
  3024. std::string decode_path_component(const std::string &component);
  3025. std::string encode_query_component(const std::string &component,
  3026. bool space_as_plus = true);
  3027. std::string decode_query_component(const std::string &component,
  3028. bool plus_as_space = true);
  3029. std::string sanitize_filename(const std::string &filename);
  3030. std::string append_query_params(const std::string &path, const Params &params);
  3031. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3032. std::pair<std::string, std::string>
  3033. make_basic_authentication_header(const std::string &username,
  3034. const std::string &password,
  3035. bool is_proxy = false);
  3036. namespace detail {
  3037. #if defined(_WIN32)
  3038. inline std::wstring u8string_to_wstring(const char *s) {
  3039. if (!s) { return std::wstring(); }
  3040. auto len = static_cast<int>(strlen(s));
  3041. if (!len) { return std::wstring(); }
  3042. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3043. if (!wlen) { return std::wstring(); }
  3044. std::wstring ws;
  3045. ws.resize(wlen);
  3046. wlen = ::MultiByteToWideChar(
  3047. CP_UTF8, 0, s, len,
  3048. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3049. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3050. return ws;
  3051. }
  3052. #endif
  3053. struct FileStat {
  3054. FileStat(const std::string &path);
  3055. bool is_file() const;
  3056. bool is_dir() const;
  3057. time_t mtime() const;
  3058. size_t size() const;
  3059. private:
  3060. #if defined(_WIN32)
  3061. struct _stat st_;
  3062. #else
  3063. struct stat st_;
  3064. #endif
  3065. int ret_ = -1;
  3066. };
  3067. std::string make_host_and_port_string(const std::string &host, int port,
  3068. bool is_ssl);
  3069. template <typename T>
  3070. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3071. Error &error);
  3072. std::string trim_copy(const std::string &s);
  3073. void divide(
  3074. const char *data, std::size_t size, char d,
  3075. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3076. fn);
  3077. void divide(
  3078. const std::string &str, char d,
  3079. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3080. fn);
  3081. void split(const char *b, const char *e, char d,
  3082. std::function<void(const char *, const char *)> fn);
  3083. void split(const char *b, const char *e, char d, size_t m,
  3084. std::function<void(const char *, const char *)> fn);
  3085. bool split_find(const char *b, const char *e, char d,
  3086. std::function<bool(const char *, const char *)> fn);
  3087. bool has_header_token(const Headers &headers, const std::string &key,
  3088. const std::string &token);
  3089. std::string websocket_accept_key(const std::string &client_key);
  3090. bool is_websocket_upgrade(const Request &req);
  3091. bool process_client_socket(
  3092. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3093. time_t write_timeout_sec, time_t write_timeout_usec,
  3094. time_t max_timeout_msec,
  3095. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3096. std::function<bool(Stream &)> callback);
  3097. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3098. int port, int address_family, bool tcp_nodelay,
  3099. bool ipv6_v6only, SocketOptions socket_options,
  3100. time_t connection_timeout_sec,
  3101. time_t connection_timeout_usec,
  3102. time_t read_timeout_sec, time_t read_timeout_usec,
  3103. time_t write_timeout_sec,
  3104. time_t write_timeout_usec,
  3105. const std::string &intf, Error &error);
  3106. const char *get_header_value(const Headers &headers, const std::string &key,
  3107. const char *def, size_t id);
  3108. std::string get_combined_header_value(const Headers &headers,
  3109. const std::string &key);
  3110. std::string params_to_query_str(const Params &params);
  3111. void parse_query_text(const char *data, std::size_t size, Params &params);
  3112. void parse_query_text(const std::string &s, Params &params);
  3113. bool parse_multipart_boundary(const std::string &content_type,
  3114. std::string &boundary);
  3115. bool parse_range_header(const std::string &s, Ranges &ranges);
  3116. bool parse_accept_header(const std::string &s,
  3117. std::vector<std::string> &content_types);
  3118. void parse_disposition_params(const std::string &s, Params &params);
  3119. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3120. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3121. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3122. EncodingType encoding_type(const Request &req, const Response &res,
  3123. const std::string &content_type);
  3124. EncodingType encoding_type(const Request &req, const Response &res);
  3125. class BufferStream final : public Stream {
  3126. public:
  3127. BufferStream() = default;
  3128. ~BufferStream() override = default;
  3129. bool is_readable() const override;
  3130. bool wait_readable() const override;
  3131. bool wait_writable() const override;
  3132. ssize_t read(char *ptr, size_t size) override;
  3133. ssize_t write(const char *ptr, size_t size) override;
  3134. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3135. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3136. socket_t socket() const override;
  3137. time_t duration() const override;
  3138. const std::string &get_buffer() const;
  3139. private:
  3140. std::string buffer;
  3141. size_t position = 0;
  3142. };
  3143. class compressor {
  3144. public:
  3145. virtual ~compressor() = default;
  3146. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3147. virtual bool compress(const char *data, size_t data_length, bool last,
  3148. Callback callback) = 0;
  3149. };
  3150. class decompressor {
  3151. public:
  3152. virtual ~decompressor() = default;
  3153. virtual bool is_valid() const = 0;
  3154. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3155. virtual bool decompress(const char *data, size_t data_length,
  3156. Callback callback) = 0;
  3157. };
  3158. class nocompressor final : public compressor {
  3159. public:
  3160. ~nocompressor() override = default;
  3161. bool compress(const char *data, size_t data_length, bool /*last*/,
  3162. Callback callback) override;
  3163. };
  3164. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3165. class gzip_compressor final : public compressor {
  3166. public:
  3167. gzip_compressor();
  3168. ~gzip_compressor() override;
  3169. bool compress(const char *data, size_t data_length, bool last,
  3170. Callback callback) override;
  3171. private:
  3172. bool is_valid_ = false;
  3173. z_stream strm_;
  3174. };
  3175. class gzip_decompressor final : public decompressor {
  3176. public:
  3177. gzip_decompressor();
  3178. ~gzip_decompressor() override;
  3179. bool is_valid() const override;
  3180. bool decompress(const char *data, size_t data_length,
  3181. Callback callback) override;
  3182. private:
  3183. bool is_valid_ = false;
  3184. z_stream strm_;
  3185. };
  3186. #endif
  3187. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3188. class brotli_compressor final : public compressor {
  3189. public:
  3190. brotli_compressor();
  3191. ~brotli_compressor();
  3192. bool compress(const char *data, size_t data_length, bool last,
  3193. Callback callback) override;
  3194. private:
  3195. BrotliEncoderState *state_ = nullptr;
  3196. };
  3197. class brotli_decompressor final : public decompressor {
  3198. public:
  3199. brotli_decompressor();
  3200. ~brotli_decompressor();
  3201. bool is_valid() const override;
  3202. bool decompress(const char *data, size_t data_length,
  3203. Callback callback) override;
  3204. private:
  3205. BrotliDecoderResult decoder_r;
  3206. BrotliDecoderState *decoder_s = nullptr;
  3207. };
  3208. #endif
  3209. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3210. class zstd_compressor : public compressor {
  3211. public:
  3212. zstd_compressor();
  3213. ~zstd_compressor();
  3214. bool compress(const char *data, size_t data_length, bool last,
  3215. Callback callback) override;
  3216. private:
  3217. ZSTD_CCtx *ctx_ = nullptr;
  3218. };
  3219. class zstd_decompressor : public decompressor {
  3220. public:
  3221. zstd_decompressor();
  3222. ~zstd_decompressor();
  3223. bool is_valid() const override;
  3224. bool decompress(const char *data, size_t data_length,
  3225. Callback callback) override;
  3226. private:
  3227. ZSTD_DCtx *ctx_ = nullptr;
  3228. };
  3229. #endif
  3230. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3231. // to store data. The call can set memory on stack for performance.
  3232. class stream_line_reader {
  3233. public:
  3234. stream_line_reader(Stream &strm, char *fixed_buffer,
  3235. size_t fixed_buffer_size);
  3236. const char *ptr() const;
  3237. size_t size() const;
  3238. bool end_with_crlf() const;
  3239. bool getline();
  3240. private:
  3241. void append(char c);
  3242. void append(const char *data, size_t size);
  3243. Stream &strm_;
  3244. char *fixed_buffer_;
  3245. const size_t fixed_buffer_size_;
  3246. size_t fixed_buffer_used_size_ = 0;
  3247. std::string growable_buffer_;
  3248. };
  3249. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3250. const Headers &src_headers);
  3251. struct ChunkedDecoder {
  3252. Stream &strm;
  3253. size_t chunk_remaining = 0;
  3254. bool finished = false;
  3255. char line_buf[64];
  3256. size_t last_chunk_total = 0;
  3257. size_t last_chunk_offset = 0;
  3258. explicit ChunkedDecoder(Stream &s);
  3259. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3260. size_t &out_chunk_total);
  3261. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3262. };
  3263. class mmap {
  3264. public:
  3265. mmap(const char *path);
  3266. ~mmap();
  3267. bool open(const char *path);
  3268. void close();
  3269. bool is_open() const;
  3270. size_t size() const;
  3271. const char *data() const;
  3272. private:
  3273. #if defined(_WIN32)
  3274. HANDLE hFile_ = NULL;
  3275. HANDLE hMapping_ = NULL;
  3276. #else
  3277. int fd_ = -1;
  3278. #endif
  3279. size_t size_ = 0;
  3280. void *addr_ = nullptr;
  3281. bool is_open_empty_file = false;
  3282. };
  3283. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3284. namespace fields {
  3285. bool is_token_char(char c);
  3286. bool is_token(const std::string &s);
  3287. bool is_field_name(const std::string &s);
  3288. bool is_vchar(char c);
  3289. bool is_obs_text(char c);
  3290. bool is_field_vchar(char c);
  3291. bool is_field_content(const std::string &s);
  3292. bool is_field_value(const std::string &s);
  3293. bool is_field_valid(const std::string &name, const std::string &value);
  3294. bool is_request_target(const std::string &s);
  3295. bool is_host(const std::string &s);
  3296. } // namespace fields
  3297. } // namespace detail
  3298. /*
  3299. * TLS Abstraction Layer Declarations
  3300. */
  3301. #ifdef CPPHTTPLIB_SSL_ENABLED
  3302. // TLS abstraction layer - backend-specific type declarations
  3303. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3304. namespace tls {
  3305. namespace impl {
  3306. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3307. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3308. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3309. struct MbedTlsContext {
  3310. mbedtls_ssl_config conf;
  3311. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3312. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3313. mbedtls_entropy_context entropy;
  3314. mbedtls_ctr_drbg_context ctr_drbg;
  3315. #endif
  3316. mbedtls_x509_crt ca_chain;
  3317. mbedtls_x509_crt own_cert;
  3318. mbedtls_pk_context own_key;
  3319. bool is_server = false;
  3320. bool verify_client = false;
  3321. VerifyCallback verify_callback;
  3322. MbedTlsContext();
  3323. ~MbedTlsContext();
  3324. MbedTlsContext(const MbedTlsContext &) = delete;
  3325. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3326. };
  3327. } // namespace impl
  3328. } // namespace tls
  3329. #endif
  3330. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3331. namespace tls {
  3332. namespace impl {
  3333. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3334. // This struct is accessible via tls::impl for use in SSL context
  3335. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3336. struct WolfSSLContext {
  3337. WOLFSSL_CTX *ctx = nullptr;
  3338. bool is_server = false;
  3339. bool verify_client = false;
  3340. VerifyCallback verify_callback;
  3341. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3342. WolfSSLContext();
  3343. ~WolfSSLContext();
  3344. WolfSSLContext(const WolfSSLContext &) = delete;
  3345. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3346. };
  3347. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3348. struct WolfSSLCAStore {
  3349. std::string pem_data;
  3350. };
  3351. } // namespace impl
  3352. } // namespace tls
  3353. #endif
  3354. #endif // CPPHTTPLIB_SSL_ENABLED
  3355. namespace stream {
  3356. class Result {
  3357. public:
  3358. Result();
  3359. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3360. Result(Result &&other) noexcept;
  3361. Result &operator=(Result &&other) noexcept;
  3362. Result(const Result &) = delete;
  3363. Result &operator=(const Result &) = delete;
  3364. // Response info
  3365. bool is_valid() const;
  3366. explicit operator bool() const;
  3367. int status() const;
  3368. const Headers &headers() const;
  3369. std::string get_header_value(const std::string &key,
  3370. const char *def = "") const;
  3371. bool has_header(const std::string &key) const;
  3372. Error error() const;
  3373. Error read_error() const;
  3374. bool has_read_error() const;
  3375. // Stream reading
  3376. bool next();
  3377. const char *data() const;
  3378. size_t size() const;
  3379. std::string read_all();
  3380. private:
  3381. ClientImpl::StreamHandle handle_;
  3382. std::string buffer_;
  3383. size_t current_size_ = 0;
  3384. size_t chunk_size_;
  3385. bool finished_ = false;
  3386. };
  3387. // GET
  3388. template <typename ClientType>
  3389. inline Result Get(ClientType &cli, const std::string &path,
  3390. size_t chunk_size = 8192) {
  3391. return Result{cli.open_stream("GET", path), chunk_size};
  3392. }
  3393. template <typename ClientType>
  3394. inline Result Get(ClientType &cli, const std::string &path,
  3395. const Headers &headers, size_t chunk_size = 8192) {
  3396. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3397. }
  3398. template <typename ClientType>
  3399. inline Result Get(ClientType &cli, const std::string &path,
  3400. const Params &params, size_t chunk_size = 8192) {
  3401. return Result{cli.open_stream("GET", path, params), chunk_size};
  3402. }
  3403. template <typename ClientType>
  3404. inline Result Get(ClientType &cli, const std::string &path,
  3405. const Params &params, const Headers &headers,
  3406. size_t chunk_size = 8192) {
  3407. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3408. }
  3409. // POST
  3410. template <typename ClientType>
  3411. inline Result Post(ClientType &cli, const std::string &path,
  3412. const std::string &body, const std::string &content_type,
  3413. size_t chunk_size = 8192) {
  3414. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3415. chunk_size};
  3416. }
  3417. template <typename ClientType>
  3418. inline Result Post(ClientType &cli, const std::string &path,
  3419. const Headers &headers, const std::string &body,
  3420. const std::string &content_type, size_t chunk_size = 8192) {
  3421. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3422. chunk_size};
  3423. }
  3424. template <typename ClientType>
  3425. inline Result Post(ClientType &cli, const std::string &path,
  3426. const Params &params, const std::string &body,
  3427. const std::string &content_type, size_t chunk_size = 8192) {
  3428. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3429. chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Post(ClientType &cli, const std::string &path,
  3433. const Params &params, const Headers &headers,
  3434. const std::string &body, const std::string &content_type,
  3435. size_t chunk_size = 8192) {
  3436. return Result{
  3437. cli.open_stream("POST", path, params, headers, body, content_type),
  3438. chunk_size};
  3439. }
  3440. // PUT
  3441. template <typename ClientType>
  3442. inline Result Put(ClientType &cli, const std::string &path,
  3443. const std::string &body, const std::string &content_type,
  3444. size_t chunk_size = 8192) {
  3445. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3446. chunk_size};
  3447. }
  3448. template <typename ClientType>
  3449. inline Result Put(ClientType &cli, const std::string &path,
  3450. const Headers &headers, const std::string &body,
  3451. const std::string &content_type, size_t chunk_size = 8192) {
  3452. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3453. chunk_size};
  3454. }
  3455. template <typename ClientType>
  3456. inline Result Put(ClientType &cli, const std::string &path,
  3457. const Params &params, const std::string &body,
  3458. const std::string &content_type, size_t chunk_size = 8192) {
  3459. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3460. chunk_size};
  3461. }
  3462. template <typename ClientType>
  3463. inline Result Put(ClientType &cli, const std::string &path,
  3464. const Params &params, const Headers &headers,
  3465. const std::string &body, const std::string &content_type,
  3466. size_t chunk_size = 8192) {
  3467. return Result{
  3468. cli.open_stream("PUT", path, params, headers, body, content_type),
  3469. chunk_size};
  3470. }
  3471. // PATCH
  3472. template <typename ClientType>
  3473. inline Result Patch(ClientType &cli, const std::string &path,
  3474. const std::string &body, const std::string &content_type,
  3475. size_t chunk_size = 8192) {
  3476. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3477. chunk_size};
  3478. }
  3479. template <typename ClientType>
  3480. inline Result Patch(ClientType &cli, const std::string &path,
  3481. const Headers &headers, const std::string &body,
  3482. const std::string &content_type, size_t chunk_size = 8192) {
  3483. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3484. chunk_size};
  3485. }
  3486. template <typename ClientType>
  3487. inline Result Patch(ClientType &cli, const std::string &path,
  3488. const Params &params, const std::string &body,
  3489. const std::string &content_type, size_t chunk_size = 8192) {
  3490. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3491. chunk_size};
  3492. }
  3493. template <typename ClientType>
  3494. inline Result Patch(ClientType &cli, const std::string &path,
  3495. const Params &params, const Headers &headers,
  3496. const std::string &body, const std::string &content_type,
  3497. size_t chunk_size = 8192) {
  3498. return Result{
  3499. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3500. chunk_size};
  3501. }
  3502. // DELETE
  3503. template <typename ClientType>
  3504. inline Result Delete(ClientType &cli, const std::string &path,
  3505. size_t chunk_size = 8192) {
  3506. return Result{cli.open_stream("DELETE", path), chunk_size};
  3507. }
  3508. template <typename ClientType>
  3509. inline Result Delete(ClientType &cli, const std::string &path,
  3510. const Headers &headers, size_t chunk_size = 8192) {
  3511. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3512. }
  3513. template <typename ClientType>
  3514. inline Result Delete(ClientType &cli, const std::string &path,
  3515. const std::string &body, const std::string &content_type,
  3516. size_t chunk_size = 8192) {
  3517. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3518. chunk_size};
  3519. }
  3520. template <typename ClientType>
  3521. inline Result Delete(ClientType &cli, const std::string &path,
  3522. const Headers &headers, const std::string &body,
  3523. const std::string &content_type,
  3524. size_t chunk_size = 8192) {
  3525. return Result{
  3526. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3527. chunk_size};
  3528. }
  3529. template <typename ClientType>
  3530. inline Result Delete(ClientType &cli, const std::string &path,
  3531. const Params &params, size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3533. }
  3534. template <typename ClientType>
  3535. inline Result Delete(ClientType &cli, const std::string &path,
  3536. const Params &params, const Headers &headers,
  3537. size_t chunk_size = 8192) {
  3538. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3539. }
  3540. template <typename ClientType>
  3541. inline Result Delete(ClientType &cli, const std::string &path,
  3542. const Params &params, const std::string &body,
  3543. const std::string &content_type,
  3544. size_t chunk_size = 8192) {
  3545. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3546. chunk_size};
  3547. }
  3548. template <typename ClientType>
  3549. inline Result Delete(ClientType &cli, const std::string &path,
  3550. const Params &params, const Headers &headers,
  3551. const std::string &body, const std::string &content_type,
  3552. size_t chunk_size = 8192) {
  3553. return Result{
  3554. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3555. chunk_size};
  3556. }
  3557. // HEAD
  3558. template <typename ClientType>
  3559. inline Result Head(ClientType &cli, const std::string &path,
  3560. size_t chunk_size = 8192) {
  3561. return Result{cli.open_stream("HEAD", path), chunk_size};
  3562. }
  3563. template <typename ClientType>
  3564. inline Result Head(ClientType &cli, const std::string &path,
  3565. const Headers &headers, size_t chunk_size = 8192) {
  3566. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3567. }
  3568. template <typename ClientType>
  3569. inline Result Head(ClientType &cli, const std::string &path,
  3570. const Params &params, size_t chunk_size = 8192) {
  3571. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3572. }
  3573. template <typename ClientType>
  3574. inline Result Head(ClientType &cli, const std::string &path,
  3575. const Params &params, const Headers &headers,
  3576. size_t chunk_size = 8192) {
  3577. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3578. }
  3579. // OPTIONS
  3580. template <typename ClientType>
  3581. inline Result Options(ClientType &cli, const std::string &path,
  3582. size_t chunk_size = 8192) {
  3583. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3584. }
  3585. template <typename ClientType>
  3586. inline Result Options(ClientType &cli, const std::string &path,
  3587. const Headers &headers, size_t chunk_size = 8192) {
  3588. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3589. }
  3590. template <typename ClientType>
  3591. inline Result Options(ClientType &cli, const std::string &path,
  3592. const Params &params, size_t chunk_size = 8192) {
  3593. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3594. }
  3595. template <typename ClientType>
  3596. inline Result Options(ClientType &cli, const std::string &path,
  3597. const Params &params, const Headers &headers,
  3598. size_t chunk_size = 8192) {
  3599. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3600. }
  3601. } // namespace stream
  3602. namespace sse {
  3603. struct SSEMessage {
  3604. std::string event; // Event type (default: "message")
  3605. std::string data; // Event payload
  3606. std::string id; // Event ID for Last-Event-ID header
  3607. SSEMessage();
  3608. void clear();
  3609. };
  3610. class SSEClient {
  3611. public:
  3612. using MessageHandler = std::function<void(const SSEMessage &)>;
  3613. using ErrorHandler = std::function<void(Error)>;
  3614. using OpenHandler = std::function<void()>;
  3615. SSEClient(Client &client, const std::string &path);
  3616. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3617. ~SSEClient();
  3618. SSEClient(const SSEClient &) = delete;
  3619. SSEClient &operator=(const SSEClient &) = delete;
  3620. // Event handlers
  3621. SSEClient &on_message(MessageHandler handler);
  3622. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3623. SSEClient &on_open(OpenHandler handler);
  3624. SSEClient &on_error(ErrorHandler handler);
  3625. SSEClient &set_reconnect_interval(int ms);
  3626. SSEClient &set_max_reconnect_attempts(int n);
  3627. // Update headers (thread-safe)
  3628. SSEClient &set_headers(const Headers &headers);
  3629. // State accessors
  3630. bool is_connected() const;
  3631. const std::string &last_event_id() const;
  3632. // Blocking start - runs event loop with auto-reconnect
  3633. void start();
  3634. // Non-blocking start - runs in background thread
  3635. void start_async();
  3636. // Stop the client (thread-safe)
  3637. void stop();
  3638. private:
  3639. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3640. bool &has_data, bool &has_id);
  3641. void run_event_loop();
  3642. void dispatch_event(const SSEMessage &msg);
  3643. bool should_reconnect(int count) const;
  3644. void wait_for_reconnect();
  3645. // Client and path
  3646. Client &client_;
  3647. std::string path_;
  3648. Headers headers_;
  3649. mutable std::mutex headers_mutex_;
  3650. // Callbacks
  3651. MessageHandler on_message_;
  3652. std::map<std::string, MessageHandler> event_handlers_;
  3653. OpenHandler on_open_;
  3654. ErrorHandler on_error_;
  3655. // Configuration
  3656. int reconnect_interval_ms_ = 3000;
  3657. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3658. // State
  3659. std::atomic<bool> running_{false};
  3660. std::atomic<bool> connected_{false};
  3661. std::string last_event_id_;
  3662. // Async support
  3663. std::thread async_thread_;
  3664. };
  3665. } // namespace sse
  3666. namespace ws {
  3667. class WebSocketClient;
  3668. enum class Opcode : uint8_t {
  3669. Continuation = 0x0,
  3670. Text = 0x1,
  3671. Binary = 0x2,
  3672. Close = 0x8,
  3673. Ping = 0x9,
  3674. Pong = 0xA,
  3675. };
  3676. enum class CloseStatus : uint16_t {
  3677. Normal = 1000,
  3678. GoingAway = 1001,
  3679. ProtocolError = 1002,
  3680. UnsupportedData = 1003,
  3681. NoStatus = 1005,
  3682. Abnormal = 1006,
  3683. InvalidPayload = 1007,
  3684. PolicyViolation = 1008,
  3685. MessageTooBig = 1009,
  3686. MandatoryExtension = 1010,
  3687. InternalError = 1011,
  3688. };
  3689. // Timeout is returned only when a read timeout was set and it elapsed before
  3690. // any byte of a frame arrived: nothing was consumed and the connection is
  3691. // still open, so the caller can send on it and read again. `msg` is left
  3692. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3693. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3694. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3695. // upgrade handshake fully succeeded. On failure error() identifies the
  3696. // failing layer; status()/headers() expose the server's upgrade response
  3697. // when one was received (status() is -1 otherwise).
  3698. class Result {
  3699. public:
  3700. Result() = default;
  3701. Result(Error err, int status, Headers &&headers)
  3702. : err_(err), status_(status), headers_(std::move(headers)) {}
  3703. explicit operator bool() const { return err_ == Error::Success; }
  3704. Error error() const { return err_; }
  3705. // Upgrade response info
  3706. int status() const { return status_; }
  3707. const Headers &headers() const { return headers_; }
  3708. std::string get_header_value(const std::string &key,
  3709. const char *def = "") const {
  3710. return detail::get_header_value(headers_, key, def, 0);
  3711. }
  3712. bool has_header(const std::string &key) const {
  3713. return headers_.find(key) != headers_.end();
  3714. }
  3715. #ifdef CPPHTTPLIB_SSL_ENABLED
  3716. Result(Error err, int status, Headers &&headers, int ssl_error,
  3717. uint64_t ssl_backend_error)
  3718. : err_(err), status_(status), headers_(std::move(headers)),
  3719. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3720. int ssl_error() const { return ssl_error_; }
  3721. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3722. #endif
  3723. private:
  3724. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3725. int status_ = -1;
  3726. Headers headers_;
  3727. #ifdef CPPHTTPLIB_SSL_ENABLED
  3728. int ssl_error_ = 0;
  3729. uint64_t ssl_backend_error_ = 0;
  3730. #endif
  3731. };
  3732. class WebSocket {
  3733. public:
  3734. WebSocket(const WebSocket &) = delete;
  3735. WebSocket &operator=(const WebSocket &) = delete;
  3736. ~WebSocket();
  3737. ReadResult read(std::string &msg);
  3738. bool send(const std::string &data);
  3739. bool send(const char *data, size_t len);
  3740. void close(CloseStatus status = CloseStatus::Normal,
  3741. const std::string &reason = "");
  3742. const Request &request() const;
  3743. bool is_open() const;
  3744. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3745. // A server handler owns its connection's timeout this way; a client sets it
  3746. // through WebSocketClient. Safe to call while another thread is in read().
  3747. //
  3748. // Only a timeout set here is reported as Timeout. The compile-time default
  3749. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3750. // than a request for control, so when it elapses read() returns Fail and
  3751. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3752. void set_read_timeout(time_t sec, time_t usec = 0);
  3753. template <class Rep, class Period>
  3754. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3755. private:
  3756. friend class httplib::Server;
  3757. friend class httplib::ws::WebSocketClient;
  3758. WebSocket(
  3759. Stream &strm, const Request &req, bool is_server,
  3760. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3761. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3762. : strm_(strm), req_(req), is_server_(is_server),
  3763. ping_interval_sec_(ping_interval_sec),
  3764. max_missed_pongs_(max_missed_pongs) {
  3765. start_heartbeat();
  3766. }
  3767. WebSocket(
  3768. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3769. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3770. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3771. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3772. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3773. max_missed_pongs_(max_missed_pongs) {
  3774. start_heartbeat();
  3775. }
  3776. void start_heartbeat();
  3777. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3778. Stream &strm_;
  3779. std::unique_ptr<Stream> owned_strm_;
  3780. Request req_;
  3781. bool is_server_;
  3782. time_t ping_interval_sec_;
  3783. int max_missed_pongs_;
  3784. int unacked_pings_ = 0;
  3785. std::atomic<bool> closed_{false};
  3786. // Set once the caller has bounded read() through set_read_timeout(). Until
  3787. // then the timeout in effect is the compile-time default, and elapsing it
  3788. // is a failure that closes the connection, not a Timeout.
  3789. std::atomic<bool> read_timeout_set_{false};
  3790. std::mutex write_mutex_;
  3791. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3792. // may do so: read_websocket_frame() reads a payload until it has the whole
  3793. // declared length, so a second parser stealing bytes silently corrupts the
  3794. // message the first one is assembling.
  3795. std::mutex read_mutex_;
  3796. std::thread ping_thread_;
  3797. std::mutex ping_mutex_;
  3798. std::condition_variable ping_cv_;
  3799. };
  3800. class WebSocketClient {
  3801. public:
  3802. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3803. const Headers &headers = {});
  3804. ~WebSocketClient();
  3805. WebSocketClient(const WebSocketClient &) = delete;
  3806. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3807. bool is_valid() const;
  3808. Result connect();
  3809. ReadResult read(std::string &msg);
  3810. bool send(const std::string &data);
  3811. bool send(const char *data, size_t len);
  3812. void close(CloseStatus status = CloseStatus::Normal,
  3813. const std::string &reason = "");
  3814. bool is_open() const;
  3815. const std::string &subprotocol() const;
  3816. void set_read_timeout(time_t sec, time_t usec = 0);
  3817. template <class Rep, class Period>
  3818. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3819. void set_write_timeout(time_t sec, time_t usec = 0);
  3820. template <class Rep, class Period>
  3821. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3822. void set_websocket_ping_interval(time_t sec);
  3823. void set_websocket_max_missed_pongs(int count);
  3824. void set_tcp_nodelay(bool on);
  3825. void set_address_family(int family);
  3826. void set_ipv6_v6only(bool on);
  3827. void set_socket_options(SocketOptions socket_options);
  3828. void set_connection_timeout(time_t sec, time_t usec = 0);
  3829. template <class Rep, class Period>
  3830. void
  3831. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3832. void set_interface(const std::string &intf);
  3833. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3834. #ifdef CPPHTTPLIB_SSL_ENABLED
  3835. struct PemMemory {
  3836. const char *cert_pem;
  3837. size_t cert_pem_len;
  3838. const char *key_pem;
  3839. size_t key_pem_len;
  3840. const char *private_key_password;
  3841. };
  3842. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3843. const PemMemory &pem, const Headers &headers = {});
  3844. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3845. const std::string &ca_cert_dir_path = std::string());
  3846. void set_ca_cert_store(tls::ca_store_t store);
  3847. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3848. void enable_server_certificate_verification(bool enabled);
  3849. void enable_server_hostname_verification(bool enabled);
  3850. void enable_system_ca(bool enabled);
  3851. #endif
  3852. private:
  3853. void shutdown_and_close();
  3854. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3855. int &ssl_error, uint64_t &ssl_backend_error);
  3856. void prepare_default_headers(Request &req);
  3857. std::string host_;
  3858. int port_;
  3859. std::string path_;
  3860. Headers headers_;
  3861. std::string subprotocol_;
  3862. bool is_valid_ = false;
  3863. socket_t sock_ = INVALID_SOCKET;
  3864. std::unique_ptr<WebSocket> ws_;
  3865. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3866. time_t read_timeout_usec_ = 0;
  3867. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3868. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3869. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3870. time_t websocket_ping_interval_sec_ =
  3871. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3872. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3873. int address_family_ = AF_UNSPEC;
  3874. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3875. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3876. SocketOptions socket_options_ = nullptr;
  3877. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3878. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3879. std::string interface_;
  3880. // Hostname to connection target map. The value is an IP literal or another
  3881. // hostname; only the connection target changes, never the identity.
  3882. std::map<std::string, std::string> addr_map_;
  3883. #ifdef CPPHTTPLIB_SSL_ENABLED
  3884. bool is_ssl_ = false;
  3885. tls::ctx_t tls_ctx_ = nullptr;
  3886. tls::session_t tls_session_ = nullptr;
  3887. std::string ca_cert_file_path_;
  3888. std::string ca_cert_dir_path_;
  3889. bool custom_ca_loaded_ = false;
  3890. bool certs_loaded_ = false;
  3891. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3892. bool server_certificate_verification_ = true;
  3893. bool server_hostname_verification_ = true;
  3894. #endif
  3895. };
  3896. template <class Rep, class Period>
  3897. inline void WebSocket::set_read_timeout(
  3898. const std::chrono::duration<Rep, Period> &duration) {
  3899. detail::duration_to_sec_and_usec(
  3900. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3901. }
  3902. template <class Rep, class Period>
  3903. inline void WebSocketClient::set_read_timeout(
  3904. const std::chrono::duration<Rep, Period> &duration) {
  3905. detail::duration_to_sec_and_usec(
  3906. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3907. }
  3908. template <class Rep, class Period>
  3909. inline void WebSocketClient::set_write_timeout(
  3910. const std::chrono::duration<Rep, Period> &duration) {
  3911. detail::duration_to_sec_and_usec(
  3912. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3913. }
  3914. template <class Rep, class Period>
  3915. inline void WebSocketClient::set_connection_timeout(
  3916. const std::chrono::duration<Rep, Period> &duration) {
  3917. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3918. set_connection_timeout(sec, usec);
  3919. });
  3920. }
  3921. namespace impl {
  3922. bool is_valid_utf8(const std::string &s);
  3923. // Three states, because a failure that consumed bytes and one that consumed
  3924. // none are not the same thing: the first has left the stream in the middle of
  3925. // a frame and the connection cannot be reused, the second can just be retried.
  3926. enum class FrameRead { Ok, Fail, Timeout };
  3927. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3928. std::string &payload, bool &fin,
  3929. bool expect_masked, size_t max_len);
  3930. } // namespace impl
  3931. } // namespace ws
  3932. // ----------------------------------------------------------------------------
  3933. /*
  3934. * Implementation that will be part of the .cc file if split into .h + .cc.
  3935. */
  3936. namespace stream {
  3937. // stream::Result implementations
  3938. inline Result::Result() : chunk_size_(8192) {}
  3939. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3940. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3941. inline Result::Result(Result &&other) noexcept
  3942. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3943. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3944. finished_(other.finished_) {
  3945. other.current_size_ = 0;
  3946. other.finished_ = true;
  3947. }
  3948. inline Result &Result::operator=(Result &&other) noexcept {
  3949. if (this != &other) {
  3950. handle_ = std::move(other.handle_);
  3951. buffer_ = std::move(other.buffer_);
  3952. current_size_ = other.current_size_;
  3953. chunk_size_ = other.chunk_size_;
  3954. finished_ = other.finished_;
  3955. other.current_size_ = 0;
  3956. other.finished_ = true;
  3957. }
  3958. return *this;
  3959. }
  3960. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3961. inline Result::operator bool() const { return is_valid(); }
  3962. inline int Result::status() const {
  3963. return handle_.response ? handle_.response->status : -1;
  3964. }
  3965. inline const Headers &Result::headers() const {
  3966. static const Headers empty_headers;
  3967. return handle_.response ? handle_.response->headers : empty_headers;
  3968. }
  3969. inline std::string Result::get_header_value(const std::string &key,
  3970. const char *def) const {
  3971. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3972. }
  3973. inline bool Result::has_header(const std::string &key) const {
  3974. return handle_.response ? handle_.response->has_header(key) : false;
  3975. }
  3976. inline Error Result::error() const { return handle_.error; }
  3977. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3978. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3979. inline bool Result::next() {
  3980. if (!handle_.is_valid() || finished_) { return false; }
  3981. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3982. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3983. if (n > 0) {
  3984. current_size_ = static_cast<size_t>(n);
  3985. return true;
  3986. }
  3987. current_size_ = 0;
  3988. finished_ = true;
  3989. return false;
  3990. }
  3991. inline const char *Result::data() const { return buffer_.data(); }
  3992. inline size_t Result::size() const { return current_size_; }
  3993. inline std::string Result::read_all() {
  3994. std::string result;
  3995. while (next()) {
  3996. result.append(data(), size());
  3997. }
  3998. return result;
  3999. }
  4000. } // namespace stream
  4001. namespace sse {
  4002. // SSEMessage implementations
  4003. inline SSEMessage::SSEMessage() : event("message") {}
  4004. inline void SSEMessage::clear() {
  4005. event = "message";
  4006. data.clear();
  4007. id.clear();
  4008. }
  4009. // SSEClient implementations
  4010. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4011. : client_(client), path_(path) {}
  4012. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4013. const Headers &headers)
  4014. : client_(client), path_(path), headers_(headers) {}
  4015. inline SSEClient::~SSEClient() { stop(); }
  4016. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4017. on_message_ = std::move(handler);
  4018. return *this;
  4019. }
  4020. inline SSEClient &SSEClient::on_event(const std::string &type,
  4021. MessageHandler handler) {
  4022. event_handlers_[type] = std::move(handler);
  4023. return *this;
  4024. }
  4025. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4026. on_open_ = std::move(handler);
  4027. return *this;
  4028. }
  4029. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4030. on_error_ = std::move(handler);
  4031. return *this;
  4032. }
  4033. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4034. reconnect_interval_ms_ = ms;
  4035. return *this;
  4036. }
  4037. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4038. max_reconnect_attempts_ = n;
  4039. return *this;
  4040. }
  4041. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4042. std::lock_guard<std::mutex> lock(headers_mutex_);
  4043. headers_ = headers;
  4044. return *this;
  4045. }
  4046. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4047. inline const std::string &SSEClient::last_event_id() const {
  4048. return last_event_id_;
  4049. }
  4050. inline void SSEClient::start() {
  4051. running_.store(true);
  4052. run_event_loop();
  4053. }
  4054. inline void SSEClient::start_async() {
  4055. running_.store(true);
  4056. async_thread_ = std::thread([this]() { run_event_loop(); });
  4057. }
  4058. inline void SSEClient::stop() {
  4059. running_.store(false);
  4060. client_.stop(); // Cancel any pending operations
  4061. if (async_thread_.joinable()) { async_thread_.join(); }
  4062. }
  4063. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4064. int &retry_ms, bool &has_data,
  4065. bool &has_id) {
  4066. // Blank line signals end of event
  4067. if (line.empty()) { return true; }
  4068. // Lines starting with ':' are comments (ignored)
  4069. if (line[0] == ':') { return false; }
  4070. // Find the colon separator
  4071. auto colon_pos = line.find(':');
  4072. auto field = line.substr(0, colon_pos);
  4073. std::string value;
  4074. // Value starts after colon, skip optional single space
  4075. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4076. auto value_start = colon_pos + 1;
  4077. if (line[value_start] == ' ') { value_start++; }
  4078. value = line.substr(value_start);
  4079. }
  4080. // Handle known fields
  4081. if (field == "event") {
  4082. msg.event = value;
  4083. } else if (field == "data") {
  4084. // Multiple data lines are concatenated with newlines
  4085. if (has_data) { msg.data += "\n"; }
  4086. msg.data += value;
  4087. has_data = true;
  4088. } else if (field == "id") {
  4089. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4090. // valid (clears the last event ID)
  4091. if (detail::fields::is_field_value(value)) {
  4092. msg.id = value;
  4093. has_id = true;
  4094. }
  4095. } else if (field == "retry") {
  4096. // Parse retry interval in milliseconds
  4097. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4098. if (detail::is_numeric(value)) {
  4099. int v = 0;
  4100. auto res =
  4101. detail::from_chars(value.data(), value.data() + value.size(), v);
  4102. if (res.ec == std::errc{}) { retry_ms = v; }
  4103. }
  4104. }
  4105. // Unknown fields are ignored per SSE spec
  4106. return false;
  4107. }
  4108. inline void SSEClient::run_event_loop() {
  4109. auto reconnect_count = 0;
  4110. while (running_.load()) {
  4111. // Build headers, including Last-Event-ID if we have one
  4112. Headers request_headers;
  4113. {
  4114. std::lock_guard<std::mutex> lock(headers_mutex_);
  4115. request_headers = headers_;
  4116. }
  4117. if (!last_event_id_.empty()) {
  4118. request_headers.emplace("Last-Event-ID", last_event_id_);
  4119. }
  4120. // Open streaming connection
  4121. auto result = stream::Get(client_, path_, request_headers);
  4122. // Connection error handling
  4123. if (!result) {
  4124. connected_.store(false);
  4125. if (on_error_) { on_error_(result.error()); }
  4126. if (!should_reconnect(reconnect_count)) { break; }
  4127. wait_for_reconnect();
  4128. reconnect_count++;
  4129. continue;
  4130. }
  4131. if (result.status() != StatusCode::OK_200) {
  4132. connected_.store(false);
  4133. if (on_error_) { on_error_(Error::Connection); }
  4134. // For certain errors, don't reconnect.
  4135. // Note: 401 is intentionally absent so that handlers can refresh
  4136. // credentials via set_headers() and let the client reconnect.
  4137. if (result.status() == StatusCode::NoContent_204 ||
  4138. result.status() == StatusCode::NotFound_404 ||
  4139. result.status() == StatusCode::Forbidden_403) {
  4140. break;
  4141. }
  4142. if (!should_reconnect(reconnect_count)) { break; }
  4143. wait_for_reconnect();
  4144. reconnect_count++;
  4145. continue;
  4146. }
  4147. // Connection successful
  4148. connected_.store(true);
  4149. reconnect_count = 0;
  4150. if (on_open_) { on_open_(); }
  4151. // Event receiving loop
  4152. std::string buffer;
  4153. SSEMessage current_msg;
  4154. auto has_data = false;
  4155. auto has_id = false;
  4156. auto first_line = true;
  4157. auto after_cr = false;
  4158. while (running_.load() && result.next()) {
  4159. // What is left in the buffer has no line ending
  4160. auto search_pos = buffer.size();
  4161. buffer.append(result.data(), result.size());
  4162. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4163. // per the SSE spec
  4164. size_t line_start = 0;
  4165. size_t eol_pos;
  4166. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4167. std::string::npos) {
  4168. auto line = buffer.substr(line_start, eol_pos - line_start);
  4169. line_start = eol_pos + 1;
  4170. search_pos = line_start;
  4171. // The \n of a \r\n may arrive in a later chunk than its \r
  4172. auto is_lf_of_crlf =
  4173. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4174. after_cr = buffer[eol_pos] == '\r';
  4175. if (is_lf_of_crlf) { continue; }
  4176. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4177. if (first_line) {
  4178. first_line = false;
  4179. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4180. }
  4181. // Parse the line and check if event is complete
  4182. auto event_complete = parse_sse_line(
  4183. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4184. if (event_complete) {
  4185. // Update last_event_id for reconnection, even for an event that
  4186. // has no data. An empty id clears it.
  4187. if (has_id) { last_event_id_ = current_msg.id; }
  4188. // An event without a data field is not dispatched
  4189. if (has_data) { dispatch_event(current_msg); }
  4190. // Reset the message for the next event either way
  4191. current_msg.clear();
  4192. has_data = false;
  4193. has_id = false;
  4194. }
  4195. }
  4196. // Keep unprocessed data in buffer
  4197. buffer.erase(0, line_start);
  4198. // Neither an event nor a line still waiting for its end may grow
  4199. // without bound. 0 means no limit.
  4200. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4201. buffer.size() + current_msg.data.size() >
  4202. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4203. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4204. break;
  4205. }
  4206. }
  4207. // Connection ended
  4208. connected_.store(false);
  4209. if (!running_.load()) { break; }
  4210. // Check for read errors
  4211. if (result.has_read_error()) {
  4212. if (on_error_) { on_error_(result.read_error()); }
  4213. }
  4214. if (!should_reconnect(reconnect_count)) { break; }
  4215. wait_for_reconnect();
  4216. reconnect_count++;
  4217. }
  4218. connected_.store(false);
  4219. }
  4220. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4221. // Check for specific event type handler first
  4222. auto it = event_handlers_.find(msg.event);
  4223. if (it != event_handlers_.end()) {
  4224. it->second(msg);
  4225. return;
  4226. }
  4227. // Fall back to generic message handler
  4228. if (on_message_) { on_message_(msg); }
  4229. }
  4230. inline bool SSEClient::should_reconnect(int count) const {
  4231. if (!running_.load()) { return false; }
  4232. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4233. return count < max_reconnect_attempts_;
  4234. }
  4235. inline void SSEClient::wait_for_reconnect() {
  4236. // Use small increments to check running_ flag frequently.
  4237. // Always wait at least one increment, so that a zero interval (e.g.
  4238. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4239. const auto step_ms = 100;
  4240. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4241. auto waited = 0;
  4242. while (running_.load() && waited < interval_ms) {
  4243. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4244. waited += step_ms;
  4245. }
  4246. }
  4247. } // namespace sse
  4248. #ifdef CPPHTTPLIB_SSL_ENABLED
  4249. /*
  4250. * TLS abstraction layer - internal function declarations
  4251. * These are implementation details and not part of the public API.
  4252. */
  4253. namespace tls {
  4254. // Client context
  4255. ctx_t create_client_context();
  4256. void free_context(ctx_t ctx);
  4257. bool set_min_version(ctx_t ctx, Version version);
  4258. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4259. bool load_ca_file(ctx_t ctx, const char *file_path);
  4260. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4261. bool load_system_certs(ctx_t ctx);
  4262. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4263. const char *password);
  4264. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4265. const char *key_path, const char *password);
  4266. // Server context
  4267. ctx_t create_server_context();
  4268. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4269. const char *password);
  4270. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4271. const char *key_path, const char *password);
  4272. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4273. void set_verify_client(ctx_t ctx, bool require);
  4274. // Session management
  4275. session_t create_session(ctx_t ctx, socket_t sock);
  4276. void free_session(session_t session);
  4277. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4278. // Handshake (non-blocking capable)
  4279. TlsError connect(session_t session);
  4280. TlsError accept(session_t session);
  4281. // Handshake with timeout (blocking until timeout)
  4282. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4283. time_t timeout_usec, TlsError *err);
  4284. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4285. time_t timeout_usec, TlsError *err);
  4286. // I/O (non-blocking capable)
  4287. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4288. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4289. int pending(const_session_t session);
  4290. void shutdown(session_t session, bool graceful);
  4291. // Connection state
  4292. bool is_peer_closed(session_t session, socket_t sock);
  4293. // Certificate verification
  4294. cert_t get_peer_cert(const_session_t session);
  4295. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4296. // do not use them after free_session(), as with get_peer_cert().
  4297. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4298. void free_cert(cert_t cert);
  4299. bool verify_hostname(cert_t cert, const char *hostname);
  4300. uint64_t hostname_mismatch_code();
  4301. long get_verify_result(const_session_t session);
  4302. // Certificate introspection
  4303. std::string get_cert_subject_cn(cert_t cert);
  4304. std::string get_cert_issuer_name(cert_t cert);
  4305. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4306. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4307. std::string get_cert_serial(cert_t cert);
  4308. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4309. const char *get_sni(const_session_t session);
  4310. // CA store management
  4311. ca_store_t create_ca_store(const char *pem, size_t len);
  4312. void free_ca_store(ca_store_t store);
  4313. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4314. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4315. std::vector<std::string> get_ca_names(ctx_t ctx);
  4316. // Dynamic certificate update (for servers)
  4317. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4318. const char *password);
  4319. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4320. // Certificate verification callback
  4321. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4322. long get_verify_error(const_session_t session);
  4323. std::string verify_error_string(long error_code);
  4324. // TlsError information
  4325. uint64_t peek_error();
  4326. uint64_t get_error();
  4327. std::string error_string(uint64_t code);
  4328. } // namespace tls
  4329. #endif // CPPHTTPLIB_SSL_ENABLED
  4330. /*
  4331. * Group 1: detail namespace - Non-SSL utilities
  4332. */
  4333. namespace detail {
  4334. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4335. const void *optval, socklen_t optlen) {
  4336. return setsockopt(sock, level, optname,
  4337. #ifdef _WIN32
  4338. reinterpret_cast<const char *>(optval),
  4339. #else
  4340. optval,
  4341. #endif
  4342. optlen) == 0;
  4343. }
  4344. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4345. time_t sec, time_t usec) {
  4346. #ifdef _WIN32
  4347. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4348. #else
  4349. timeval timeout;
  4350. timeout.tv_sec = static_cast<long>(sec);
  4351. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4352. #endif
  4353. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4354. }
  4355. inline bool is_hex(char c, int &v) {
  4356. if (is_ascii_digit(c)) {
  4357. v = c - '0';
  4358. return true;
  4359. } else if ('A' <= c && c <= 'F') {
  4360. v = c - 'A' + 10;
  4361. return true;
  4362. } else if ('a' <= c && c <= 'f') {
  4363. v = c - 'a' + 10;
  4364. return true;
  4365. }
  4366. return false;
  4367. }
  4368. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4369. int &val) {
  4370. if (i >= s.size()) { return false; }
  4371. val = 0;
  4372. for (; cnt; i++, cnt--) {
  4373. if (!s[i]) { return false; }
  4374. auto v = 0;
  4375. if (is_hex(s[i], v)) {
  4376. val = val * 16 + v;
  4377. } else {
  4378. return false;
  4379. }
  4380. }
  4381. return true;
  4382. }
  4383. inline std::string from_i_to_hex(size_t n) {
  4384. static const auto charset = "0123456789abcdef";
  4385. std::string ret;
  4386. do {
  4387. ret = charset[n & 15] + ret;
  4388. n >>= 4;
  4389. } while (n > 0);
  4390. return ret;
  4391. }
  4392. inline std::string compute_etag(const FileStat &fs,
  4393. const std::string &suffix = std::string()) {
  4394. if (!fs.is_file()) { return std::string(); }
  4395. // If mtime cannot be determined (negative value indicates an error
  4396. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4397. // value like 0 could collide with a real file that legitimately has
  4398. // mtime == 0 (epoch) and lead to misleading validators.
  4399. auto mtime_raw = fs.mtime();
  4400. if (mtime_raw < 0) { return std::string(); }
  4401. auto mtime = static_cast<size_t>(mtime_raw);
  4402. auto size = fs.size();
  4403. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4404. from_i_to_hex(size) + suffix + "\"";
  4405. }
  4406. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4407. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4408. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4409. inline std::string file_mtime_to_http_date(time_t mtime) {
  4410. if (mtime < 0) { return std::string(); }
  4411. struct tm tm_buf;
  4412. #ifdef _WIN32
  4413. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4414. #else
  4415. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4416. #endif
  4417. char buf[64];
  4418. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4419. return std::string();
  4420. }
  4421. return std::string(buf);
  4422. }
  4423. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4424. inline time_t parse_http_date(const std::string &date_str) {
  4425. struct tm tm_buf;
  4426. // Create a classic locale object once for all parsing attempts
  4427. const std::locale classic_locale = std::locale::classic();
  4428. // Try to parse using std::get_time (C++11, cross-platform)
  4429. auto try_parse = [&](const char *fmt) -> bool {
  4430. std::istringstream ss(date_str);
  4431. ss.imbue(classic_locale);
  4432. memset(&tm_buf, 0, sizeof(tm_buf));
  4433. ss >> std::get_time(&tm_buf, fmt);
  4434. return !ss.fail();
  4435. };
  4436. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4437. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4438. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4439. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4440. // asctime format: "Sun Nov 6 08:49:37 1994"
  4441. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4442. return static_cast<time_t>(-1);
  4443. }
  4444. }
  4445. }
  4446. #ifdef _WIN32
  4447. return _mkgmtime(&tm_buf);
  4448. #elif defined _AIX
  4449. return mktime(&tm_buf);
  4450. #else
  4451. return timegm(&tm_buf);
  4452. #endif
  4453. }
  4454. inline bool is_weak_etag(const std::string &s) {
  4455. // Check if the string is a weak ETag (starts with 'W/"')
  4456. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4457. }
  4458. inline bool is_strong_etag(const std::string &s) {
  4459. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4460. // chars)
  4461. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4462. }
  4463. inline size_t to_utf8(int code, char *buff) {
  4464. if (code < 0x0080) {
  4465. buff[0] = static_cast<char>(code & 0x7F);
  4466. return 1;
  4467. } else if (code < 0x0800) {
  4468. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4469. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4470. return 2;
  4471. } else if (code < 0xD800) {
  4472. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4473. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4474. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4475. return 3;
  4476. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4477. return 0;
  4478. } else if (code < 0x10000) {
  4479. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4480. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4481. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4482. return 3;
  4483. } else if (code < 0x110000) {
  4484. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4485. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4486. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4487. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4488. return 4;
  4489. }
  4490. // NOTREACHED
  4491. return 0;
  4492. }
  4493. } // namespace detail
  4494. namespace ws {
  4495. namespace impl {
  4496. inline bool is_valid_utf8(const std::string &s) {
  4497. size_t i = 0;
  4498. auto n = s.size();
  4499. while (i < n) {
  4500. auto c = static_cast<unsigned char>(s[i]);
  4501. size_t len;
  4502. uint32_t cp;
  4503. if (c < 0x80) {
  4504. i++;
  4505. continue;
  4506. } else if ((c & 0xE0) == 0xC0) {
  4507. len = 2;
  4508. cp = c & 0x1F;
  4509. } else if ((c & 0xF0) == 0xE0) {
  4510. len = 3;
  4511. cp = c & 0x0F;
  4512. } else if ((c & 0xF8) == 0xF0) {
  4513. len = 4;
  4514. cp = c & 0x07;
  4515. } else {
  4516. return false;
  4517. }
  4518. if (i + len > n) { return false; }
  4519. for (size_t j = 1; j < len; j++) {
  4520. auto b = static_cast<unsigned char>(s[i + j]);
  4521. if ((b & 0xC0) != 0x80) { return false; }
  4522. cp = (cp << 6) | (b & 0x3F);
  4523. }
  4524. // Overlong encoding check
  4525. if (len == 2 && cp < 0x80) { return false; }
  4526. if (len == 3 && cp < 0x800) { return false; }
  4527. if (len == 4 && cp < 0x10000) { return false; }
  4528. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4529. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4530. if (cp > 0x10FFFF) { return false; }
  4531. i += len;
  4532. }
  4533. return true;
  4534. }
  4535. } // namespace impl
  4536. } // namespace ws
  4537. namespace detail {
  4538. // NOTE: This code came up with the following stackoverflow post:
  4539. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4540. inline std::string base64_encode(const std::string &in) {
  4541. static const auto lookup =
  4542. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4543. std::string out;
  4544. out.reserve(in.size());
  4545. // Unsigned: the accumulator is never masked, so with a signed int the
  4546. // `val << 8` below overflows once enough bytes are folded in (undefined
  4547. // behaviour before C++20). Only the low bits are ever emitted, so the
  4548. // wrap-around of an unsigned accumulator does not affect the output.
  4549. uint32_t val = 0;
  4550. auto valb = -6;
  4551. for (auto c : in) {
  4552. val = (val << 8) + static_cast<uint8_t>(c);
  4553. valb += 8;
  4554. while (valb >= 0) {
  4555. out.push_back(lookup[(val >> valb) & 0x3F]);
  4556. valb -= 6;
  4557. }
  4558. }
  4559. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4560. while (out.size() % 4) {
  4561. out.push_back('=');
  4562. }
  4563. return out;
  4564. }
  4565. inline std::string sha1(const std::string &input) {
  4566. // RFC 3174 SHA-1 implementation
  4567. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4568. return (x << n) | (x >> (32 - n));
  4569. };
  4570. uint32_t h0 = 0x67452301;
  4571. uint32_t h1 = 0xEFCDAB89;
  4572. uint32_t h2 = 0x98BADCFE;
  4573. uint32_t h3 = 0x10325476;
  4574. uint32_t h4 = 0xC3D2E1F0;
  4575. // Pre-processing: adding padding bits
  4576. std::string msg = input;
  4577. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4578. msg.push_back(static_cast<char>(0x80u));
  4579. while (msg.size() % 64 != 56) {
  4580. msg.push_back(0);
  4581. }
  4582. // Append original length in bits as 64-bit big-endian
  4583. for (int i = 56; i >= 0; i -= 8) {
  4584. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4585. }
  4586. // Process each 512-bit chunk
  4587. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4588. uint32_t w[80];
  4589. for (size_t i = 0; i < 16; i++) {
  4590. w[i] =
  4591. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4592. << 24) |
  4593. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4594. << 16) |
  4595. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4596. << 8) |
  4597. (static_cast<uint32_t>(
  4598. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4599. }
  4600. for (int i = 16; i < 80; i++) {
  4601. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4602. }
  4603. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4604. for (int i = 0; i < 80; i++) {
  4605. uint32_t f, k;
  4606. if (i < 20) {
  4607. f = (b & c) | ((~b) & d);
  4608. k = 0x5A827999;
  4609. } else if (i < 40) {
  4610. f = b ^ c ^ d;
  4611. k = 0x6ED9EBA1;
  4612. } else if (i < 60) {
  4613. f = (b & c) | (b & d) | (c & d);
  4614. k = 0x8F1BBCDC;
  4615. } else {
  4616. f = b ^ c ^ d;
  4617. k = 0xCA62C1D6;
  4618. }
  4619. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4620. e = d;
  4621. d = c;
  4622. c = left_rotate(b, 30);
  4623. b = a;
  4624. a = temp;
  4625. }
  4626. h0 += a;
  4627. h1 += b;
  4628. h2 += c;
  4629. h3 += d;
  4630. h4 += e;
  4631. }
  4632. // Produce the final hash as a 20-byte binary string
  4633. std::string hash(20, '\0');
  4634. for (size_t i = 0; i < 4; i++) {
  4635. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4636. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4637. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4638. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4639. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4640. }
  4641. return hash;
  4642. }
  4643. inline std::string websocket_accept_key(const std::string &client_key) {
  4644. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4645. return base64_encode(sha1(client_key + magic));
  4646. }
  4647. inline bool is_websocket_upgrade(const Request &req) {
  4648. if (req.method != "GET") { return false; }
  4649. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4650. // list of protocols and asks recipients to match each name
  4651. // case-insensitively, so look for the token rather than compare the whole
  4652. // field value.
  4653. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4654. // Check Connection: Upgrade
  4655. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4656. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4657. // RFC 6455 Section 4.2.1
  4658. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4659. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4660. return false;
  4661. }
  4662. static const std::string b64chars =
  4663. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4664. for (size_t i = 0; i < 22; i++) {
  4665. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4666. }
  4667. // Check Sec-WebSocket-Version: 13
  4668. auto version = req.get_header_value("Sec-WebSocket-Version");
  4669. if (version != "13") { return false; }
  4670. return true;
  4671. }
  4672. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4673. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4674. thread_local std::random_device rd;
  4675. size_t filled = 0;
  4676. while (filled < n) {
  4677. auto v = rd();
  4678. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4679. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4680. }
  4681. }
  4682. }
  4683. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4684. const char *data, size_t len, bool fin,
  4685. bool mask) {
  4686. // First byte: FIN + opcode
  4687. uint8_t header[2];
  4688. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4689. (static_cast<uint8_t>(opcode) & 0x0F));
  4690. // Second byte: MASK + payload length
  4691. if (len < 126) {
  4692. header[1] = static_cast<uint8_t>(len);
  4693. if (mask) { header[1] |= 0x80; }
  4694. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4695. } else if (len <= 0xFFFF) {
  4696. header[1] = 126;
  4697. if (mask) { header[1] |= 0x80; }
  4698. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4699. uint8_t ext[2];
  4700. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4701. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4702. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4703. } else {
  4704. header[1] = 127;
  4705. if (mask) { header[1] |= 0x80; }
  4706. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4707. uint8_t ext[8];
  4708. for (int i = 7; i >= 0; i--) {
  4709. ext[7 - i] =
  4710. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4711. }
  4712. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4713. }
  4714. if (mask) {
  4715. // Generate random mask key
  4716. uint8_t mask_key[4];
  4717. fill_random_bytes(mask_key, sizeof(mask_key));
  4718. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4719. // Write masked payload in chunks
  4720. const size_t chunk_size = 4096;
  4721. std::vector<char> buf((std::min)(len, chunk_size));
  4722. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4723. size_t n = (std::min)(chunk_size, len - offset);
  4724. for (size_t i = 0; i < n; i++) {
  4725. buf[i] =
  4726. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4727. }
  4728. if (strm.write(buf.data(), n) < 0) { return false; }
  4729. }
  4730. } else {
  4731. if (len > 0) {
  4732. if (strm.write(data, len) < 0) { return false; }
  4733. }
  4734. }
  4735. return true;
  4736. }
  4737. } // namespace detail
  4738. namespace ws {
  4739. namespace impl {
  4740. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4741. // hands back whatever its buffer already holds -- so every multi-byte field has
  4742. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4743. // header straddles the read buffer's boundary.
  4744. //
  4745. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4746. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4747. // there is a failure like any other. (When read() fails it always records why,
  4748. // so the error belongs to this call and not to an earlier one.)
  4749. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4750. auto p = static_cast<char *>(buf);
  4751. size_t total = 0;
  4752. while (total < size) {
  4753. auto n = strm.read(p + total, size - total);
  4754. if (n <= 0) {
  4755. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4756. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4757. }
  4758. total += static_cast<size_t>(n);
  4759. }
  4760. return FrameRead::Ok;
  4761. }
  4762. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4763. std::string &payload, bool &fin,
  4764. bool expect_masked, size_t max_len) {
  4765. // Read first 2 bytes. This is the only read that may report a timeout: it
  4766. // sits on a frame boundary, where nothing has been consumed yet.
  4767. uint8_t header[2];
  4768. FrameRead first = read_exact(strm, header, 2);
  4769. if (first != FrameRead::Ok) { return first; }
  4770. fin = (header[0] & 0x80) != 0;
  4771. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4772. if (header[0] & 0x70) { return FrameRead::Fail; }
  4773. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4774. bool masked = (header[1] & 0x80) != 0;
  4775. uint64_t payload_len = header[1] & 0x7F;
  4776. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4777. // MUST have a payload length of 125 bytes or less
  4778. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4779. if (is_control) {
  4780. if (!fin) { return FrameRead::Fail; }
  4781. if (payload_len > 125) { return FrameRead::Fail; }
  4782. }
  4783. if (masked != expect_masked) { return FrameRead::Fail; }
  4784. // Extended payload length
  4785. if (payload_len == 126) {
  4786. uint8_t ext[2];
  4787. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4788. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4789. } else if (payload_len == 127) {
  4790. uint8_t ext[8];
  4791. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4792. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4793. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4794. payload_len = 0;
  4795. for (int i = 0; i < 8; i++) {
  4796. payload_len = (payload_len << 8) | ext[i];
  4797. }
  4798. }
  4799. // A max_len of 0 means no limit, as payload_max_length does.
  4800. if ((max_len > 0 && payload_len > max_len) ||
  4801. payload_len > (std::numeric_limits<size_t>::max)()) {
  4802. return FrameRead::Fail;
  4803. }
  4804. // Read mask key if present
  4805. uint8_t mask_key[4] = {0};
  4806. if (masked) {
  4807. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4808. return FrameRead::Fail;
  4809. }
  4810. }
  4811. // Grow the payload only as it arrives, since a header alone can announce
  4812. // max_len bytes that never come.
  4813. payload.clear();
  4814. auto len = static_cast<size_t>(payload_len);
  4815. while (payload.size() < len) {
  4816. auto offset = payload.size();
  4817. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4818. payload.resize(offset + n);
  4819. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4820. return FrameRead::Fail;
  4821. }
  4822. }
  4823. // Unmask if needed
  4824. if (masked) {
  4825. for (size_t i = 0; i < payload.size(); i++) {
  4826. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4827. }
  4828. }
  4829. return FrameRead::Ok;
  4830. }
  4831. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4832. // be sent followed by a UTF-8 reason.
  4833. inline bool is_valid_close_payload(const std::string &payload) {
  4834. if (payload.empty()) { return true; }
  4835. if (payload.size() < 2) { return false; }
  4836. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4837. static_cast<uint8_t>(payload[1]);
  4838. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4839. (1007 <= code && code <= 1014) ||
  4840. (3000 <= code && code <= 4999);
  4841. return may_be_sent && is_valid_utf8(payload.substr(2));
  4842. }
  4843. } // namespace impl
  4844. } // namespace ws
  4845. namespace detail {
  4846. inline bool is_valid_path(const std::string &path) {
  4847. size_t level = 0;
  4848. size_t i = 0;
  4849. // Skip slash
  4850. while (i < path.size() && path[i] == '/') {
  4851. i++;
  4852. }
  4853. while (i < path.size()) {
  4854. // Read component
  4855. auto beg = i;
  4856. while (i < path.size() && path[i] != '/') {
  4857. if (path[i] == '\0') {
  4858. return false;
  4859. } else if (path[i] == '\\') {
  4860. return false;
  4861. }
  4862. i++;
  4863. }
  4864. auto len = i - beg;
  4865. assert(len > 0);
  4866. if (!path.compare(beg, len, ".")) {
  4867. ;
  4868. } else if (!path.compare(beg, len, "..")) {
  4869. if (level == 0) { return false; }
  4870. level--;
  4871. } else {
  4872. level++;
  4873. }
  4874. // Skip slash
  4875. while (i < path.size() && path[i] == '/') {
  4876. i++;
  4877. }
  4878. }
  4879. return true;
  4880. }
  4881. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4882. #if defined(_WIN32)
  4883. char buf[_MAX_PATH];
  4884. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4885. resolved = buf;
  4886. #elif defined(PATH_MAX)
  4887. char buf[PATH_MAX];
  4888. if (realpath(path, buf) == nullptr) { return false; }
  4889. resolved = buf;
  4890. #else
  4891. auto buf = realpath(path, nullptr);
  4892. auto guard = scope_exit([&]() { std::free(buf); });
  4893. if (buf == nullptr) { return false; }
  4894. resolved = buf;
  4895. #endif
  4896. return true;
  4897. }
  4898. inline bool is_path_within_base(const std::string &resolved_path,
  4899. const std::string &resolved_base) {
  4900. #if defined(_WIN32)
  4901. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4902. resolved_base.size()) == 0;
  4903. #else
  4904. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4905. resolved_base.size()) == 0;
  4906. #endif
  4907. }
  4908. inline FileStat::FileStat(const std::string &path) {
  4909. #if defined(_WIN32)
  4910. auto wpath = u8string_to_wstring(path.c_str());
  4911. ret_ = _wstat(wpath.c_str(), &st_);
  4912. #else
  4913. ret_ = stat(path.c_str(), &st_);
  4914. #endif
  4915. }
  4916. inline bool FileStat::is_file() const {
  4917. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4918. }
  4919. inline bool FileStat::is_dir() const {
  4920. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4921. }
  4922. inline time_t FileStat::mtime() const {
  4923. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4924. : static_cast<time_t>(-1);
  4925. }
  4926. inline size_t FileStat::size() const {
  4927. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4928. }
  4929. inline std::string encode_path(const std::string &s) {
  4930. std::string result;
  4931. result.reserve(s.size());
  4932. for (size_t i = 0; s[i]; i++) {
  4933. switch (s[i]) {
  4934. case ' ': result += "%20"; break;
  4935. case '+': result += "%2B"; break;
  4936. case '\'': result += "%27"; break;
  4937. case ',': result += "%2C"; break;
  4938. // case ':': result += "%3A"; break; // ok? probably...
  4939. case ';': result += "%3B"; break;
  4940. default:
  4941. auto c = static_cast<uint8_t>(s[i]);
  4942. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4943. // in a request-target as-is.
  4944. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4945. result += '%';
  4946. char hex[4];
  4947. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4948. assert(len == 2);
  4949. result.append(hex, static_cast<size_t>(len));
  4950. } else {
  4951. result += s[i];
  4952. }
  4953. break;
  4954. }
  4955. }
  4956. return result;
  4957. }
  4958. inline std::string file_extension(const std::string &path) {
  4959. auto i = path.size();
  4960. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4961. i--;
  4962. }
  4963. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4964. return std::string();
  4965. }
  4966. return path.substr(i);
  4967. }
  4968. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4969. template <typename T>
  4970. inline bool parse_header(const char *beg, const char *end, T fn);
  4971. template <typename T>
  4972. inline bool parse_header(const char *beg, const char *end, T fn) {
  4973. // Skip trailing spaces and tabs.
  4974. while (beg < end && is_space_or_tab(end[-1])) {
  4975. end--;
  4976. }
  4977. auto p = beg;
  4978. while (p < end && *p != ':') {
  4979. p++;
  4980. }
  4981. auto name = std::string(beg, p);
  4982. if (!detail::fields::is_field_name(name)) { return false; }
  4983. if (p == end) { return false; }
  4984. auto key_end = p;
  4985. if (*p++ != ':') { return false; }
  4986. while (p < end && is_space_or_tab(*p)) {
  4987. p++;
  4988. }
  4989. if (p <= end) {
  4990. auto key_len = key_end - beg;
  4991. if (!key_len) { return false; }
  4992. auto key = std::string(beg, key_end);
  4993. auto val = std::string(p, end);
  4994. if (!detail::fields::is_field_value(val)) { return false; }
  4995. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4996. // percent-decoded by the recipient. Applications that need to interpret a
  4997. // value as a URI component should call httplib::decode_uri_component()
  4998. // (or decode_path_component()) explicitly.
  4999. fn(key, val);
  5000. return true;
  5001. }
  5002. return false;
  5003. }
  5004. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5005. const Headers &src_headers) {
  5006. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5007. // transfer coding is complete when a chunk with a chunk-size of zero is
  5008. // received, possibly followed by a trailer section, and finally terminated by
  5009. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5010. //
  5011. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5012. // doesn't care for the existence of the final CRLF. In other words, it seems
  5013. // to be ok whether the final CRLF exists or not in the chunked data.
  5014. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5015. //
  5016. // According to the reference code in RFC 9112, cpp-httplib now allows
  5017. // chunked transfer coding data without the final CRLF.
  5018. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5019. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5020. "transfer-encoding",
  5021. "content-length",
  5022. "host",
  5023. "authorization",
  5024. "www-authenticate",
  5025. "proxy-authenticate",
  5026. "proxy-authorization",
  5027. "cookie",
  5028. "set-cookie",
  5029. "cache-control",
  5030. "expect",
  5031. "max-forwards",
  5032. "pragma",
  5033. "range",
  5034. "te",
  5035. "age",
  5036. "expires",
  5037. "date",
  5038. "location",
  5039. "retry-after",
  5040. "vary",
  5041. "warning",
  5042. "content-encoding",
  5043. "content-type",
  5044. "content-range",
  5045. "trailer"};
  5046. case_ignore::unordered_set<std::string> declared_trailers;
  5047. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5048. if (!trailer_header.empty()) {
  5049. // split() trims each token and skips empty ones, so the name arrives ready
  5050. // to look up.
  5051. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5052. ',', [&](const char *b, const char *e) {
  5053. // A legitimate message declares only a handful of trailers. Cap the
  5054. // set so a peer cannot grow it without bound: an oversized set only
  5055. // arises from an attempt to force many colliding names into
  5056. // quadratic lookups (case_ignore::hash is unkeyed).
  5057. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5058. return;
  5059. }
  5060. std::string key(b, e);
  5061. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5062. declared_trailers.insert(key);
  5063. }
  5064. });
  5065. }
  5066. size_t trailer_header_count = 0;
  5067. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5068. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5069. // Count every received trailer field, not only the declared ones stored in
  5070. // dest, so undeclared fields cannot keep this loop running past the limit.
  5071. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5072. constexpr auto line_terminator_len = 2;
  5073. auto line_beg = line_reader.ptr();
  5074. auto line_end =
  5075. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5076. if (!parse_header(line_beg, line_end,
  5077. [&](const std::string &key, const std::string &val) {
  5078. if (declared_trailers.find(key) !=
  5079. declared_trailers.end()) {
  5080. dest.emplace(key, val);
  5081. }
  5082. })) {
  5083. return false;
  5084. }
  5085. trailer_header_count++;
  5086. if (!line_reader.getline()) { return false; }
  5087. }
  5088. return true;
  5089. }
  5090. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5091. size_t right) {
  5092. while (b + left < e && is_space_or_tab(b[left])) {
  5093. left++;
  5094. }
  5095. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5096. right--;
  5097. }
  5098. return std::make_pair(left, right);
  5099. }
  5100. inline std::string trim_copy(const std::string &s) {
  5101. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5102. return s.substr(r.first, r.second - r.first);
  5103. }
  5104. inline std::string trim_double_quotes_copy(const std::string &s) {
  5105. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5106. return s.substr(1, s.size() - 2);
  5107. }
  5108. return s;
  5109. }
  5110. inline void
  5111. divide(const char *data, std::size_t size, char d,
  5112. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5113. fn) {
  5114. const auto it = std::find(data, data + size, d);
  5115. const auto found = static_cast<std::size_t>(it != data + size);
  5116. const auto lhs_data = data;
  5117. const auto lhs_size = static_cast<std::size_t>(it - data);
  5118. const auto rhs_data = it + found;
  5119. const auto rhs_size = size - lhs_size - found;
  5120. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5121. }
  5122. inline void
  5123. divide(const std::string &str, char d,
  5124. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5125. fn) {
  5126. divide(str.data(), str.size(), d, std::move(fn));
  5127. }
  5128. inline void split(const char *b, const char *e, char d,
  5129. std::function<void(const char *, const char *)> fn) {
  5130. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5131. }
  5132. inline void split(const char *b, const char *e, char d, size_t m,
  5133. std::function<void(const char *, const char *)> fn) {
  5134. size_t i = 0;
  5135. size_t beg = 0;
  5136. size_t count = 1;
  5137. while (e ? (b + i < e) : (b[i] != '\0')) {
  5138. if (b[i] == d && count < m) {
  5139. auto r = trim(b, e, beg, i);
  5140. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5141. beg = i + 1;
  5142. count++;
  5143. }
  5144. i++;
  5145. }
  5146. if (i) {
  5147. auto r = trim(b, e, beg, i);
  5148. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5149. }
  5150. }
  5151. // Same contract as split(), except that a delimiter inside a quoted-string is
  5152. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5153. // quoted-string, and ';' and '=' are legal characters inside one.
  5154. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5155. std::function<void(const char *, const char *)> fn) {
  5156. size_t i = 0;
  5157. size_t beg = 0;
  5158. size_t count = 1;
  5159. auto in_quotes = false;
  5160. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5161. while (has(i)) {
  5162. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5163. // A quoted-pair, whose second character does not end the string.
  5164. i++;
  5165. } else if (b[i] == '"') {
  5166. in_quotes = !in_quotes;
  5167. } else if (b[i] == d && !in_quotes && count < m) {
  5168. auto r = trim(b, e, beg, i);
  5169. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5170. beg = i + 1;
  5171. count++;
  5172. }
  5173. i++;
  5174. }
  5175. if (i) {
  5176. auto r = trim(b, e, beg, i);
  5177. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5178. }
  5179. }
  5180. inline void split_unquoted(const char *b, const char *e, char d,
  5181. std::function<void(const char *, const char *)> fn) {
  5182. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5183. std::move(fn));
  5184. }
  5185. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5186. // key a token, so the first '=' is the separator even when the value is a
  5187. // quoted-string carrying more of them.
  5188. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5189. std::string &val) {
  5190. divide(
  5191. b, static_cast<std::size_t>(e - b), '=',
  5192. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5193. const auto kr = trim(kb, kb + klen, 0, klen);
  5194. key.assign(kb + kr.first, kb + kr.second);
  5195. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5196. val.assign(vb + vr.first, vb + vr.second);
  5197. });
  5198. }
  5199. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5200. std::function<bool(const char *, const char *)> fn) {
  5201. size_t i = 0;
  5202. size_t beg = 0;
  5203. size_t count = 1;
  5204. while (e ? (b + i < e) : (b[i] != '\0')) {
  5205. if (b[i] == d && count < m) {
  5206. auto r = trim(b, e, beg, i);
  5207. if (r.first < r.second) {
  5208. auto found = fn(&b[r.first], &b[r.second]);
  5209. if (found) { return true; }
  5210. }
  5211. beg = i + 1;
  5212. count++;
  5213. }
  5214. i++;
  5215. }
  5216. if (i) {
  5217. auto r = trim(b, e, beg, i);
  5218. if (r.first < r.second) {
  5219. auto found = fn(&b[r.first], &b[r.second]);
  5220. if (found) { return true; }
  5221. }
  5222. }
  5223. return false;
  5224. }
  5225. inline bool split_find(const char *b, const char *e, char d,
  5226. std::function<bool(const char *, const char *)> fn) {
  5227. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5228. std::move(fn));
  5229. }
  5230. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5231. size_t fixed_buffer_size)
  5232. : strm_(strm), fixed_buffer_(fixed_buffer),
  5233. fixed_buffer_size_(fixed_buffer_size) {}
  5234. inline const char *stream_line_reader::ptr() const {
  5235. if (growable_buffer_.empty()) {
  5236. return fixed_buffer_;
  5237. } else {
  5238. return growable_buffer_.data();
  5239. }
  5240. }
  5241. inline size_t stream_line_reader::size() const {
  5242. if (growable_buffer_.empty()) {
  5243. return fixed_buffer_used_size_;
  5244. } else {
  5245. return growable_buffer_.size();
  5246. }
  5247. }
  5248. inline bool stream_line_reader::end_with_crlf() const {
  5249. auto end = ptr() + size();
  5250. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5251. }
  5252. inline bool stream_line_reader::getline() {
  5253. fixed_buffer_used_size_ = 0;
  5254. growable_buffer_.clear();
  5255. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5256. char prev_byte = 0;
  5257. #endif
  5258. for (size_t i = 0;; i++) {
  5259. // Fast path: whatever the stream has already buffered can be scanned for
  5260. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5261. // call, a bounds check and a one-byte copy per character of the request.
  5262. size_t buffered_size = 0;
  5263. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5264. auto take = buffered_size;
  5265. auto terminated = false;
  5266. for (size_t at = 0; at < buffered_size;) {
  5267. auto nl = static_cast<const char *>(
  5268. memchr(buffered + at, '\n', buffered_size - at));
  5269. if (!nl) { break; }
  5270. auto pos = static_cast<size_t>(nl - buffered);
  5271. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5272. take = pos + 1;
  5273. terminated = true;
  5274. break;
  5275. #else
  5276. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5277. // be the last byte of an earlier chunk, hence prev_byte.
  5278. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5279. take = pos + 1;
  5280. terminated = true;
  5281. break;
  5282. }
  5283. at = pos + 1;
  5284. #endif
  5285. }
  5286. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5287. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5288. prev_byte = buffered[take - 1];
  5289. #endif
  5290. append(buffered, take);
  5291. strm_.consume_buffered(take);
  5292. i += take;
  5293. if (terminated) { return true; }
  5294. continue;
  5295. }
  5296. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5297. // Treat exceptionally long lines as an error to
  5298. // prevent infinite loops/memory exhaustion
  5299. return false;
  5300. }
  5301. char byte;
  5302. auto n = strm_.read(&byte, 1);
  5303. if (n < 0) {
  5304. return false;
  5305. } else if (n == 0) {
  5306. if (i == 0) {
  5307. return false;
  5308. } else {
  5309. break;
  5310. }
  5311. }
  5312. append(byte);
  5313. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5314. if (byte == '\n') { break; }
  5315. #else
  5316. if (prev_byte == '\r' && byte == '\n') { break; }
  5317. prev_byte = byte;
  5318. #endif
  5319. }
  5320. return true;
  5321. }
  5322. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5323. inline void stream_line_reader::append(const char *data, size_t size) {
  5324. // Once the line has outgrown the fixed buffer everything must keep going to
  5325. // the growable one, even if a later chunk would have fit. Without the
  5326. // emptiness check a short append after a long one would land in the fixed
  5327. // buffer, which ptr() and size() no longer look at, and be lost.
  5328. if (growable_buffer_.empty() &&
  5329. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5330. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5331. fixed_buffer_used_size_ += size;
  5332. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5333. } else {
  5334. // Unlike the per-character overload, this can be the very first append of
  5335. // the line, so the fixed buffer may hold nothing and carry no terminator
  5336. // yet. assign() takes an explicit length and does not need one.
  5337. if (growable_buffer_.empty()) {
  5338. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5339. }
  5340. growable_buffer_.append(data, size);
  5341. }
  5342. }
  5343. inline mmap::mmap(const char *path) { open(path); }
  5344. inline mmap::~mmap() { close(); }
  5345. inline bool mmap::open(const char *path) {
  5346. close();
  5347. #if defined(_WIN32)
  5348. auto wpath = u8string_to_wstring(path);
  5349. if (wpath.empty()) { return false; }
  5350. hFile_ =
  5351. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5352. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5353. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5354. LARGE_INTEGER size{};
  5355. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5356. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5357. // See:
  5358. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5359. if (static_cast<ULONGLONG>(size.QuadPart) >
  5360. (std::numeric_limits<decltype(size_)>::max)()) {
  5361. // `size_t` might be 32-bits, on 32-bits Windows.
  5362. return false;
  5363. }
  5364. size_ = static_cast<size_t>(size.QuadPart);
  5365. hMapping_ =
  5366. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5367. // Special treatment for an empty file...
  5368. if (hMapping_ == NULL && size_ == 0) {
  5369. close();
  5370. is_open_empty_file = true;
  5371. return true;
  5372. }
  5373. if (hMapping_ == NULL) {
  5374. close();
  5375. return false;
  5376. }
  5377. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5378. if (addr_ == nullptr) {
  5379. close();
  5380. return false;
  5381. }
  5382. #else
  5383. fd_ = ::open(path, O_RDONLY);
  5384. if (fd_ == -1) { return false; }
  5385. struct stat sb;
  5386. if (fstat(fd_, &sb) == -1) {
  5387. close();
  5388. return false;
  5389. }
  5390. size_ = static_cast<size_t>(sb.st_size);
  5391. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5392. // Special treatment for an empty file...
  5393. if (addr_ == MAP_FAILED && size_ == 0) {
  5394. close();
  5395. is_open_empty_file = true;
  5396. return false;
  5397. }
  5398. if (addr_ == MAP_FAILED) {
  5399. // Clear the sentinel before `close()`, since `is_open()` only checks
  5400. // `addr_` against nullptr and `munmap()` must not be called with it.
  5401. addr_ = nullptr;
  5402. close();
  5403. return false;
  5404. }
  5405. #endif
  5406. return true;
  5407. }
  5408. inline bool mmap::is_open() const {
  5409. return is_open_empty_file ? true : addr_ != nullptr;
  5410. }
  5411. inline size_t mmap::size() const { return size_; }
  5412. inline const char *mmap::data() const {
  5413. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5414. }
  5415. inline void mmap::close() {
  5416. #if defined(_WIN32)
  5417. if (addr_) {
  5418. ::UnmapViewOfFile(addr_);
  5419. addr_ = nullptr;
  5420. }
  5421. if (hMapping_) {
  5422. ::CloseHandle(hMapping_);
  5423. hMapping_ = NULL;
  5424. }
  5425. if (hFile_ != INVALID_HANDLE_VALUE) {
  5426. ::CloseHandle(hFile_);
  5427. hFile_ = INVALID_HANDLE_VALUE;
  5428. }
  5429. is_open_empty_file = false;
  5430. #else
  5431. if (addr_ != nullptr) {
  5432. munmap(addr_, size_);
  5433. addr_ = nullptr;
  5434. }
  5435. if (fd_ != -1) {
  5436. ::close(fd_);
  5437. fd_ = -1;
  5438. }
  5439. #endif
  5440. size_ = 0;
  5441. }
  5442. inline int close_socket(socket_t sock) noexcept {
  5443. #ifdef _WIN32
  5444. return closesocket(sock);
  5445. #else
  5446. return close(sock);
  5447. #endif
  5448. }
  5449. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5450. ssize_t res = 0;
  5451. while (true) {
  5452. res = fn();
  5453. if (res < 0 && errno == EINTR) {
  5454. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5455. continue;
  5456. }
  5457. break;
  5458. }
  5459. return res;
  5460. }
  5461. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5462. return handle_EINTR([&]() {
  5463. return recv(sock,
  5464. #ifdef _WIN32
  5465. static_cast<char *>(ptr), static_cast<int>(size),
  5466. #else
  5467. ptr, size,
  5468. #endif
  5469. flags);
  5470. });
  5471. }
  5472. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5473. int flags) {
  5474. return handle_EINTR([&]() {
  5475. return send(sock,
  5476. #ifdef _WIN32
  5477. static_cast<const char *>(ptr), static_cast<int>(size),
  5478. #else
  5479. ptr, size,
  5480. #endif
  5481. flags);
  5482. });
  5483. }
  5484. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5485. #ifdef _WIN32
  5486. return ::WSAPoll(fds, nfds, timeout);
  5487. #else
  5488. return ::poll(fds, nfds, timeout);
  5489. #endif
  5490. }
  5491. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5492. time_t usec) {
  5493. struct pollfd pfd;
  5494. pfd.fd = sock;
  5495. pfd.events = events;
  5496. pfd.revents = 0;
  5497. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5498. // "return immediately", which callers here rely on to probe a socket.
  5499. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5500. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5501. }
  5502. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5503. return select_impl(sock, POLLIN, sec, usec);
  5504. }
  5505. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5506. return select_impl(sock, POLLOUT, sec, usec);
  5507. }
  5508. // The point sec and usec from now, for select_until(). A negative sec never
  5509. // comes, as a negative timeout waits forever in select_impl().
  5510. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5511. time_t usec) {
  5512. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5513. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5514. std::chrono::microseconds(usec);
  5515. }
  5516. // Waits only for the time left until deadline, so that all the waits of one
  5517. // TLS handshake come out of a single timeout.
  5518. inline ssize_t select_until(socket_t sock, short events,
  5519. std::chrono::steady_clock::time_point deadline) {
  5520. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5521. return select_impl(sock, events, -1, 0);
  5522. }
  5523. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5524. deadline - std::chrono::steady_clock::now())
  5525. .count();
  5526. if (left <= 0) { return 0; }
  5527. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5528. static_cast<time_t>(left % 1000000));
  5529. }
  5530. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5531. time_t usec) {
  5532. struct pollfd pfd_read;
  5533. pfd_read.fd = sock;
  5534. pfd_read.events = POLLIN | POLLOUT;
  5535. pfd_read.revents = 0;
  5536. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5537. auto poll_res =
  5538. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5539. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5540. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5541. auto error = 0;
  5542. socklen_t len = sizeof(error);
  5543. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5544. reinterpret_cast<char *>(&error), &len);
  5545. auto successful = res >= 0 && !error;
  5546. return successful ? Error::Success : Error::Connection;
  5547. }
  5548. return Error::Connection;
  5549. }
  5550. inline bool is_socket_alive(socket_t sock) {
  5551. const auto val = detail::select_read(sock, 0, 0);
  5552. if (val == 0) {
  5553. return true;
  5554. } else if (val < 0 && errno == EBADF) {
  5555. return false;
  5556. }
  5557. char buf[1];
  5558. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5559. }
  5560. class SocketStream final : public Stream {
  5561. public:
  5562. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5563. time_t write_timeout_sec, time_t write_timeout_usec,
  5564. time_t max_timeout_msec = 0,
  5565. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5566. (std::chrono::steady_clock::time_point::min)());
  5567. ~SocketStream() override;
  5568. bool is_readable() const override;
  5569. bool wait_readable() const override;
  5570. bool wait_writable() const override;
  5571. bool is_peer_alive() const override;
  5572. ssize_t read(char *ptr, size_t size) override;
  5573. ssize_t write(const char *ptr, size_t size) override;
  5574. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5575. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5576. socket_t socket() const override;
  5577. time_t duration() const override;
  5578. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5579. const char *buffered_data(size_t &size) const override;
  5580. void consume_buffered(size_t size) override;
  5581. // The caller has just seen this socket become readable. Lets the next read
  5582. // skip its own readiness wait, which would otherwise ask the kernel a
  5583. // question that was answered a moment ago. Consumed by that read.
  5584. void set_readable_hint() { readable_hint_ = true; }
  5585. private:
  5586. bool ensure_readable();
  5587. socket_t sock_;
  5588. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5589. // thread while a read is in flight -- that is the point of it, for a caller
  5590. // holding one connection and wanting control back to send on it.
  5591. std::atomic<time_t> read_timeout_sec_;
  5592. std::atomic<time_t> read_timeout_usec_;
  5593. time_t write_timeout_sec_;
  5594. time_t write_timeout_usec_;
  5595. time_t max_timeout_msec_;
  5596. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5597. std::vector<char> read_buff_;
  5598. size_t read_buff_off_ = 0;
  5599. size_t read_buff_content_size_ = 0;
  5600. bool readable_hint_ = false;
  5601. static const size_t read_buff_size_ = 1024l * 4;
  5602. };
  5603. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5604. time_t keep_alive_timeout_sec) {
  5605. using namespace std::chrono;
  5606. const auto interval_usec =
  5607. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5608. // Avoid expensive `steady_clock::now()` call for the first time
  5609. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5610. const auto start = steady_clock::now() - microseconds{interval_usec};
  5611. const auto timeout = seconds{keep_alive_timeout_sec};
  5612. while (true) {
  5613. if (svr_sock == INVALID_SOCKET) {
  5614. break; // Server socket is closed
  5615. }
  5616. auto val = select_read(sock, 0, interval_usec);
  5617. if (val < 0) {
  5618. break; // Ssocket error
  5619. } else if (val == 0) {
  5620. if (steady_clock::now() - start > timeout) {
  5621. break; // Timeout
  5622. }
  5623. } else {
  5624. return true; // Ready for read
  5625. }
  5626. }
  5627. return false;
  5628. }
  5629. // `has_buffered_request` reports whether the connection's stream already holds
  5630. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5631. // 9.3.2), so reading one request can pull the start of the next one into the
  5632. // stream's buffer; that request must be served without waiting for the socket
  5633. // to become readable again, since its bytes are no longer on the socket.
  5634. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5635. template <typename P, typename T>
  5636. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5637. socket_t sock,
  5638. size_t keep_alive_max_count,
  5639. time_t keep_alive_timeout_sec,
  5640. P has_buffered_request, T callback) {
  5641. assert(keep_alive_max_count > 0);
  5642. auto ret = false;
  5643. auto count = keep_alive_max_count;
  5644. while (count > 0) {
  5645. auto socket_readable = false;
  5646. if (!has_buffered_request()) {
  5647. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5648. socket_readable = true;
  5649. }
  5650. auto close_connection = count == 1;
  5651. auto connection_closed = false;
  5652. ret = callback(socket_readable, close_connection, connection_closed);
  5653. if (!ret || connection_closed) { break; }
  5654. count--;
  5655. }
  5656. return ret;
  5657. }
  5658. template <typename T>
  5659. inline bool
  5660. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5661. size_t keep_alive_max_count,
  5662. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5663. time_t read_timeout_usec, time_t write_timeout_sec,
  5664. time_t write_timeout_usec, T callback) {
  5665. // One stream per connection: its read buffer can already hold the start of
  5666. // the next, pipelined request.
  5667. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5668. write_timeout_sec, write_timeout_usec);
  5669. return process_server_socket_core(
  5670. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5671. [&]() { return strm.is_readable(); },
  5672. [&](bool socket_readable, bool close_connection,
  5673. bool &connection_closed) {
  5674. if (socket_readable) { strm.set_readable_hint(); }
  5675. return callback(strm, close_connection, connection_closed);
  5676. });
  5677. }
  5678. inline bool process_client_socket(
  5679. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5680. time_t write_timeout_sec, time_t write_timeout_usec,
  5681. time_t max_timeout_msec,
  5682. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5683. std::function<bool(Stream &)> callback) {
  5684. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5685. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5686. start_time);
  5687. return callback(strm);
  5688. }
  5689. inline int shutdown_socket(socket_t sock) noexcept {
  5690. #ifdef _WIN32
  5691. return shutdown(sock, SD_BOTH);
  5692. #else
  5693. return shutdown(sock, SHUT_RDWR);
  5694. #endif
  5695. }
  5696. // Half-closes the write side and drains any in-flight/queued bytes before
  5697. // the final shutdown+close. Closing with unread data in the receive queue
  5698. // (or bytes arriving after the receive side is closed) makes the stack send
  5699. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5700. // response as a failed read even though it was fully written.
  5701. inline void drain_and_close_socket(socket_t sock) noexcept {
  5702. #ifdef _WIN32
  5703. shutdown(sock, SD_SEND);
  5704. #else
  5705. shutdown(sock, SHUT_WR);
  5706. #endif
  5707. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5708. size_t total = 0;
  5709. const auto deadline = std::chrono::steady_clock::now() +
  5710. std::chrono::milliseconds(100); // bound #1
  5711. while (total < size_t(1024u * 1024u)) { // bound #2
  5712. const auto remaining =
  5713. std::chrono::duration_cast<std::chrono::microseconds>(
  5714. deadline - std::chrono::steady_clock::now())
  5715. .count();
  5716. if (remaining <= 0) { break; }
  5717. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5718. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5719. if (n <= 0) { break; }
  5720. total += static_cast<size_t>(n);
  5721. }
  5722. shutdown_socket(sock);
  5723. close_socket(sock);
  5724. }
  5725. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5726. if (s.size() > 1 && s[0] == '\0') {
  5727. auto ret = s;
  5728. ret[0] = '@';
  5729. return ret;
  5730. }
  5731. return s;
  5732. }
  5733. inline std::string
  5734. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5735. if (s.size() > 1 && s[0] == '@') {
  5736. auto ret = s;
  5737. ret[0] = '\0';
  5738. return ret;
  5739. }
  5740. return s;
  5741. }
  5742. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5743. const struct addrinfo *hints,
  5744. struct addrinfo **res, time_t timeout_sec) {
  5745. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5746. if (timeout_sec <= 0) {
  5747. // No timeout specified, use standard getaddrinfo
  5748. return getaddrinfo(node, service, hints, res);
  5749. }
  5750. #ifdef _WIN32
  5751. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5752. OVERLAPPED overlapped = {};
  5753. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5754. if (!event) { return EAI_FAIL; }
  5755. overlapped.hEvent = event;
  5756. PADDRINFOEXW result_addrinfo = nullptr;
  5757. HANDLE cancel_handle = nullptr;
  5758. ADDRINFOEXW hints_ex = {};
  5759. if (hints) {
  5760. hints_ex.ai_flags = hints->ai_flags;
  5761. hints_ex.ai_family = hints->ai_family;
  5762. hints_ex.ai_socktype = hints->ai_socktype;
  5763. hints_ex.ai_protocol = hints->ai_protocol;
  5764. }
  5765. auto wnode = u8string_to_wstring(node);
  5766. auto wservice = u8string_to_wstring(service);
  5767. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5768. hints ? &hints_ex : nullptr, &result_addrinfo,
  5769. nullptr, &overlapped, nullptr, &cancel_handle);
  5770. if (ret == WSA_IO_PENDING) {
  5771. auto wait_result =
  5772. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5773. if (wait_result == WAIT_TIMEOUT) {
  5774. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5775. ::CloseHandle(event);
  5776. return EAI_AGAIN;
  5777. }
  5778. DWORD bytes_returned;
  5779. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5780. &bytes_returned, FALSE)) {
  5781. ::CloseHandle(event);
  5782. return ::WSAGetLastError();
  5783. }
  5784. }
  5785. ::CloseHandle(event);
  5786. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5787. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5788. return 0;
  5789. }
  5790. return ret;
  5791. #elif TARGET_OS_MAC && defined(__clang__)
  5792. if (!node) { return EAI_NONAME; }
  5793. // macOS implementation using CFHost API for asynchronous DNS resolution
  5794. CFStringRef hostname_ref = CFStringCreateWithCString(
  5795. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5796. if (!hostname_ref) { return EAI_MEMORY; }
  5797. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5798. CFRelease(hostname_ref);
  5799. if (!host_ref) { return EAI_MEMORY; }
  5800. // Set up context for callback
  5801. struct CFHostContext {
  5802. bool completed = false;
  5803. bool success = false;
  5804. CFArrayRef addresses = nullptr;
  5805. std::mutex mutex;
  5806. std::condition_variable cv;
  5807. } context;
  5808. CFHostClientContext client_context;
  5809. memset(&client_context, 0, sizeof(client_context));
  5810. client_context.info = &context;
  5811. // Set callback
  5812. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5813. const CFStreamError *error, void *info) {
  5814. auto ctx = static_cast<CFHostContext *>(info);
  5815. std::lock_guard<std::mutex> lock(ctx->mutex);
  5816. if (error && error->error != 0) {
  5817. ctx->success = false;
  5818. } else {
  5819. Boolean hasBeenResolved;
  5820. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5821. if (ctx->addresses && hasBeenResolved) {
  5822. CFRetain(ctx->addresses);
  5823. ctx->success = true;
  5824. } else {
  5825. ctx->success = false;
  5826. }
  5827. }
  5828. ctx->completed = true;
  5829. ctx->cv.notify_one();
  5830. };
  5831. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5832. CFRelease(host_ref);
  5833. return EAI_SYSTEM;
  5834. }
  5835. // Schedule on run loop
  5836. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5837. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5838. // Start resolution
  5839. CFStreamError stream_error;
  5840. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5841. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5842. CFRelease(host_ref);
  5843. return EAI_FAIL;
  5844. }
  5845. // Wait for completion with timeout
  5846. auto timeout_time =
  5847. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5848. bool timed_out = false;
  5849. {
  5850. std::unique_lock<std::mutex> lock(context.mutex);
  5851. while (!context.completed) {
  5852. auto now = std::chrono::steady_clock::now();
  5853. if (now >= timeout_time) {
  5854. timed_out = true;
  5855. break;
  5856. }
  5857. // Run the runloop for a short time
  5858. lock.unlock();
  5859. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5860. lock.lock();
  5861. }
  5862. }
  5863. // Clean up
  5864. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5865. CFHostSetClient(host_ref, nullptr, nullptr);
  5866. if (timed_out || !context.completed) {
  5867. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5868. CFRelease(host_ref);
  5869. return EAI_AGAIN;
  5870. }
  5871. if (!context.success || !context.addresses) {
  5872. CFRelease(host_ref);
  5873. return EAI_NODATA;
  5874. }
  5875. // Convert CFArray to addrinfo
  5876. CFIndex count = CFArrayGetCount(context.addresses);
  5877. if (count == 0) {
  5878. CFRelease(context.addresses);
  5879. CFRelease(host_ref);
  5880. return EAI_NODATA;
  5881. }
  5882. struct addrinfo *result_addrinfo = nullptr;
  5883. struct addrinfo **current = &result_addrinfo;
  5884. for (CFIndex i = 0; i < count; i++) {
  5885. CFDataRef addr_data =
  5886. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5887. if (!addr_data) continue;
  5888. const struct sockaddr *sockaddr_ptr =
  5889. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5890. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5891. // Allocate addrinfo structure
  5892. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5893. if (!*current) {
  5894. freeaddrinfo(result_addrinfo);
  5895. CFRelease(context.addresses);
  5896. CFRelease(host_ref);
  5897. return EAI_MEMORY;
  5898. }
  5899. memset(*current, 0, sizeof(struct addrinfo));
  5900. // Set up addrinfo fields
  5901. (*current)->ai_family = sockaddr_ptr->sa_family;
  5902. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5903. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5904. (*current)->ai_addrlen = sockaddr_len;
  5905. // Copy sockaddr
  5906. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5907. if (!(*current)->ai_addr) {
  5908. freeaddrinfo(result_addrinfo);
  5909. CFRelease(context.addresses);
  5910. CFRelease(host_ref);
  5911. return EAI_MEMORY;
  5912. }
  5913. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5914. // Set port if service is specified
  5915. if (service && *service) {
  5916. int port = 0;
  5917. if (parse_port(service, strlen(service), port)) {
  5918. if (sockaddr_ptr->sa_family == AF_INET) {
  5919. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5920. ->sin_port = htons(static_cast<uint16_t>(port));
  5921. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5922. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5923. ->sin6_port = htons(static_cast<uint16_t>(port));
  5924. }
  5925. }
  5926. }
  5927. current = &((*current)->ai_next);
  5928. }
  5929. CFRelease(context.addresses);
  5930. CFRelease(host_ref);
  5931. *res = result_addrinfo;
  5932. return 0;
  5933. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5934. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5935. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5936. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5937. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5938. // the resolver worker still references the stack-local gaicb. The cancel
  5939. // path therefore waits (gai_suspend with no timeout) for the worker to
  5940. // actually finish before letting the stack frame go. The trade-off is that
  5941. // a wedged DNS server can hold this thread for the system resolver timeout
  5942. // (~30s by default) past the caller's connection timeout.
  5943. struct gaicb request{};
  5944. struct gaicb *requests[1] = {&request};
  5945. struct sigevent sevp{};
  5946. struct timespec timeout{timeout_sec, 0};
  5947. request.ar_name = node;
  5948. request.ar_service = service;
  5949. request.ar_request = hints;
  5950. sevp.sigev_notify = SIGEV_NONE;
  5951. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5952. if (rc != 0) { return rc; }
  5953. auto cleanup = scope_exit([&] {
  5954. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5955. });
  5956. int wait_result = gai_suspend(requests, 1, &timeout);
  5957. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5958. int gai_result = gai_error(&request);
  5959. if (gai_result == 0) {
  5960. *res = request.ar_result;
  5961. request.ar_result = nullptr;
  5962. return 0;
  5963. }
  5964. return gai_result;
  5965. }
  5966. gai_cancel(&request);
  5967. while (gai_error(&request) == EAI_INPROGRESS) {
  5968. gai_suspend(requests, 1, nullptr);
  5969. }
  5970. return wait_result;
  5971. #else
  5972. // Fallback implementation using thread-based timeout for other Unix systems.
  5973. struct GetAddrInfoState {
  5974. ~GetAddrInfoState() {
  5975. if (info) { freeaddrinfo(info); }
  5976. }
  5977. std::mutex mutex;
  5978. std::condition_variable result_cv;
  5979. bool completed = false;
  5980. int result = EAI_SYSTEM;
  5981. std::string node;
  5982. std::string service;
  5983. struct addrinfo hints;
  5984. struct addrinfo *info = nullptr;
  5985. };
  5986. // Allocate on the heap, so the resolver thread can keep using the data.
  5987. auto state = std::make_shared<GetAddrInfoState>();
  5988. if (node) { state->node = node; }
  5989. state->service = service;
  5990. state->hints = *hints;
  5991. std::thread resolve_thread([state]() {
  5992. auto thread_result =
  5993. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5994. &state->info);
  5995. std::lock_guard<std::mutex> lock(state->mutex);
  5996. state->result = thread_result;
  5997. state->completed = true;
  5998. state->result_cv.notify_one();
  5999. });
  6000. // Wait for completion or timeout
  6001. std::unique_lock<std::mutex> lock(state->mutex);
  6002. auto finished =
  6003. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6004. [&] { return state->completed; });
  6005. if (finished) {
  6006. // Operation completed within timeout
  6007. resolve_thread.join();
  6008. *res = state->info;
  6009. state->info = nullptr; // Pass ownership to caller
  6010. return state->result;
  6011. } else {
  6012. // Timeout occurred
  6013. resolve_thread.detach(); // Let the thread finish in background
  6014. return EAI_AGAIN; // Return timeout error
  6015. }
  6016. #endif
  6017. #else
  6018. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6019. return getaddrinfo(node, service, hints, res);
  6020. #endif
  6021. }
  6022. template <typename BindOrConnect>
  6023. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6024. int address_family, int socket_flags, bool tcp_nodelay,
  6025. bool ipv6_v6only, SocketOptions socket_options,
  6026. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6027. // Get address info
  6028. const char *node = nullptr;
  6029. struct addrinfo hints;
  6030. struct addrinfo *result;
  6031. memset(&hints, 0, sizeof(struct addrinfo));
  6032. hints.ai_socktype = SOCK_STREAM;
  6033. hints.ai_protocol = IPPROTO_IP;
  6034. if (!ip.empty()) {
  6035. node = ip.c_str();
  6036. // Ask getaddrinfo to convert IP in c-string to address
  6037. hints.ai_family = AF_UNSPEC;
  6038. hints.ai_flags = AI_NUMERICHOST;
  6039. } else {
  6040. if (!host.empty()) { node = host.c_str(); }
  6041. hints.ai_family = address_family;
  6042. hints.ai_flags = socket_flags;
  6043. }
  6044. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6045. if (hints.ai_family == AF_UNIX) {
  6046. const auto addrlen = host.length();
  6047. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6048. #ifdef SOCK_CLOEXEC
  6049. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6050. hints.ai_protocol);
  6051. #else
  6052. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6053. #endif
  6054. if (sock != INVALID_SOCKET) {
  6055. sockaddr_un addr{};
  6056. addr.sun_family = AF_UNIX;
  6057. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6058. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6059. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6060. hints.ai_addrlen = static_cast<socklen_t>(
  6061. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6062. #ifndef SOCK_CLOEXEC
  6063. #ifndef _WIN32
  6064. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6065. #endif
  6066. #endif
  6067. if (socket_options) { socket_options(sock); }
  6068. #ifdef _WIN32
  6069. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6070. // remove the option.
  6071. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6072. #endif
  6073. bool dummy;
  6074. if (!bind_or_connect(sock, hints, dummy)) {
  6075. close_socket(sock);
  6076. sock = INVALID_SOCKET;
  6077. }
  6078. }
  6079. return sock;
  6080. }
  6081. #endif
  6082. auto service = std::to_string(port);
  6083. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6084. timeout_sec)) {
  6085. #if defined __linux__ && !defined __ANDROID__
  6086. res_init();
  6087. #endif
  6088. return INVALID_SOCKET;
  6089. }
  6090. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6091. for (auto rp = result; rp; rp = rp->ai_next) {
  6092. // Create a socket
  6093. #ifdef _WIN32
  6094. auto sock =
  6095. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6096. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6097. /**
  6098. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6099. * and above the socket creation fails on older Windows Systems.
  6100. *
  6101. * Let's try to create a socket the old way in this case.
  6102. *
  6103. * Reference:
  6104. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6105. *
  6106. * WSA_FLAG_NO_HANDLE_INHERIT:
  6107. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6108. * SP1, and later
  6109. *
  6110. */
  6111. if (sock == INVALID_SOCKET) {
  6112. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6113. }
  6114. #else
  6115. #ifdef SOCK_CLOEXEC
  6116. auto sock =
  6117. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6118. #else
  6119. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6120. #endif
  6121. #endif
  6122. if (sock == INVALID_SOCKET) { continue; }
  6123. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6124. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6125. close_socket(sock);
  6126. continue;
  6127. }
  6128. #endif
  6129. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6130. if (rp->ai_family == AF_INET6) {
  6131. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6132. }
  6133. if (socket_options) { socket_options(sock); }
  6134. // bind or connect
  6135. auto quit = false;
  6136. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6137. close_socket(sock);
  6138. if (quit) { break; }
  6139. }
  6140. return INVALID_SOCKET;
  6141. }
  6142. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6143. #ifdef _WIN32
  6144. auto flags = nonblocking ? 1UL : 0UL;
  6145. ioctlsocket(sock, FIONBIO, &flags);
  6146. #else
  6147. auto flags = fcntl(sock, F_GETFL, 0);
  6148. fcntl(sock, F_SETFL,
  6149. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6150. #endif
  6151. }
  6152. inline bool is_connection_error() {
  6153. #ifdef _WIN32
  6154. return WSAGetLastError() != WSAEWOULDBLOCK;
  6155. #else
  6156. return errno != EINPROGRESS;
  6157. #endif
  6158. }
  6159. // accept() failed because the process or the network stack is temporarily out
  6160. // of resources. The listening socket is still usable, so back off briefly and
  6161. // try again.
  6162. inline bool is_accept_resource_error() {
  6163. #ifdef _WIN32
  6164. auto err = WSAGetLastError();
  6165. return err == WSAEMFILE || err == WSAENOBUFS;
  6166. #else
  6167. auto err = errno;
  6168. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6169. #endif
  6170. }
  6171. // accept() failed for a reason that says nothing about the listening socket:
  6172. // the pending connection went away before it could be accepted, or the call
  6173. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6174. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6175. // connection that way.
  6176. inline bool is_accept_transient_error() {
  6177. #ifdef _WIN32
  6178. auto err = WSAGetLastError();
  6179. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6180. err == WSAECONNABORTED;
  6181. #else
  6182. auto err = errno;
  6183. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6184. err == ECONNABORTED;
  6185. #endif
  6186. }
  6187. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6188. struct addrinfo hints;
  6189. struct addrinfo *result;
  6190. memset(&hints, 0, sizeof(struct addrinfo));
  6191. hints.ai_family = AF_UNSPEC;
  6192. hints.ai_socktype = SOCK_STREAM;
  6193. hints.ai_protocol = 0;
  6194. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6195. return false;
  6196. }
  6197. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6198. auto ret = false;
  6199. for (auto rp = result; rp; rp = rp->ai_next) {
  6200. const auto &ai = *rp;
  6201. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6202. ret = true;
  6203. break;
  6204. }
  6205. }
  6206. return ret;
  6207. }
  6208. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6209. #define USE_IF2IP
  6210. #endif
  6211. #ifdef USE_IF2IP
  6212. inline std::string if2ip(int address_family, const std::string &ifn) {
  6213. struct ifaddrs *ifap;
  6214. getifaddrs(&ifap);
  6215. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6216. std::string addr_candidate;
  6217. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6218. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6219. (AF_UNSPEC == address_family ||
  6220. ifa->ifa_addr->sa_family == address_family)) {
  6221. if (ifa->ifa_addr->sa_family == AF_INET) {
  6222. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6223. char buf[INET_ADDRSTRLEN];
  6224. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6225. return std::string(buf, INET_ADDRSTRLEN);
  6226. }
  6227. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6228. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6229. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6230. char buf[INET6_ADDRSTRLEN] = {};
  6231. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6232. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6233. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6234. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6235. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6236. } else {
  6237. return std::string(buf, INET6_ADDRSTRLEN);
  6238. }
  6239. }
  6240. }
  6241. }
  6242. }
  6243. }
  6244. return addr_candidate;
  6245. }
  6246. #endif
  6247. inline socket_t create_client_socket(
  6248. const std::string &host, const std::string &ip, int port,
  6249. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6250. SocketOptions socket_options, time_t connection_timeout_sec,
  6251. time_t connection_timeout_usec, time_t read_timeout_sec,
  6252. time_t read_timeout_usec, time_t write_timeout_sec,
  6253. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6254. auto sock = create_socket(
  6255. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6256. std::move(socket_options),
  6257. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6258. if (!intf.empty()) {
  6259. #ifdef USE_IF2IP
  6260. auto ip_from_if = if2ip(address_family, intf);
  6261. if (ip_from_if.empty()) { ip_from_if = intf; }
  6262. if (!bind_ip_address(sock2, ip_from_if)) {
  6263. error = Error::BindIPAddress;
  6264. return false;
  6265. }
  6266. #endif
  6267. }
  6268. set_nonblocking(sock2, true);
  6269. auto ret =
  6270. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6271. if (ret < 0) {
  6272. if (is_connection_error()) {
  6273. error = Error::Connection;
  6274. return false;
  6275. }
  6276. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6277. connection_timeout_usec);
  6278. if (error != Error::Success) {
  6279. if (error == Error::ConnectionTimeout) { quit = true; }
  6280. return false;
  6281. }
  6282. }
  6283. set_nonblocking(sock2, false);
  6284. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6285. read_timeout_usec);
  6286. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6287. write_timeout_usec);
  6288. error = Error::Success;
  6289. return true;
  6290. },
  6291. connection_timeout_sec); // Pass DNS timeout
  6292. if (sock != INVALID_SOCKET) {
  6293. error = Error::Success;
  6294. } else {
  6295. if (error == Error::Success) { error = Error::Connection; }
  6296. }
  6297. return sock;
  6298. }
  6299. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6300. socklen_t addr_len, std::string &ip, int &port) {
  6301. if (addr.ss_family == AF_INET) {
  6302. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6303. } else if (addr.ss_family == AF_INET6) {
  6304. port =
  6305. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6306. } else {
  6307. return false;
  6308. }
  6309. std::array<char, NI_MAXHOST> ipstr{};
  6310. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6311. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6312. 0, NI_NUMERICHOST)) {
  6313. return false;
  6314. }
  6315. ip = ipstr.data();
  6316. return true;
  6317. }
  6318. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6319. struct sockaddr_storage addr;
  6320. socklen_t addr_len = sizeof(addr);
  6321. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6322. &addr_len)) {
  6323. get_ip_and_port(addr, addr_len, ip, port);
  6324. }
  6325. }
  6326. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6327. struct sockaddr_storage addr;
  6328. socklen_t addr_len = sizeof(addr);
  6329. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6330. &addr_len)) {
  6331. #ifndef _WIN32
  6332. if (addr.ss_family == AF_UNIX) {
  6333. #if defined(__linux__)
  6334. struct ucred ucred;
  6335. socklen_t len = sizeof(ucred);
  6336. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6337. port = ucred.pid;
  6338. }
  6339. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6340. pid_t pid;
  6341. socklen_t len = sizeof(pid);
  6342. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6343. port = pid;
  6344. }
  6345. #endif
  6346. return;
  6347. }
  6348. #endif
  6349. get_ip_and_port(addr, addr_len, ip, port);
  6350. }
  6351. }
  6352. inline std::string
  6353. find_content_type(const std::string &path,
  6354. const std::map<std::string, std::string> &user_data,
  6355. const std::string &default_content_type) {
  6356. auto ext = file_extension(path);
  6357. auto it = user_data.find(ext);
  6358. if (it != user_data.end()) { return it->second; }
  6359. static const struct {
  6360. const char *ext;
  6361. const char *type;
  6362. } types[] = {
  6363. {"css", "text/css"},
  6364. {"csv", "text/csv"},
  6365. {"htm", "text/html"},
  6366. {"html", "text/html"},
  6367. {"js", "text/javascript"},
  6368. {"mjs", "text/javascript"},
  6369. {"txt", "text/plain"},
  6370. {"vtt", "text/vtt"},
  6371. {"apng", "image/apng"},
  6372. {"avif", "image/avif"},
  6373. {"bmp", "image/bmp"},
  6374. {"gif", "image/gif"},
  6375. {"png", "image/png"},
  6376. {"svg", "image/svg+xml"},
  6377. {"webp", "image/webp"},
  6378. {"ico", "image/x-icon"},
  6379. {"tif", "image/tiff"},
  6380. {"tiff", "image/tiff"},
  6381. {"jpg", "image/jpeg"},
  6382. {"jpeg", "image/jpeg"},
  6383. {"mp4", "video/mp4"},
  6384. {"mpeg", "video/mpeg"},
  6385. {"webm", "video/webm"},
  6386. {"mp3", "audio/mp3"},
  6387. {"mpga", "audio/mpeg"},
  6388. {"weba", "audio/webm"},
  6389. {"wav", "audio/wave"},
  6390. {"otf", "font/otf"},
  6391. {"ttf", "font/ttf"},
  6392. {"woff", "font/woff"},
  6393. {"woff2", "font/woff2"},
  6394. {"7z", "application/x-7z-compressed"},
  6395. {"atom", "application/atom+xml"},
  6396. {"pdf", "application/pdf"},
  6397. {"json", "application/json"},
  6398. {"rss", "application/rss+xml"},
  6399. {"tar", "application/x-tar"},
  6400. {"xht", "application/xhtml+xml"},
  6401. {"xhtml", "application/xhtml+xml"},
  6402. {"xslt", "application/xslt+xml"},
  6403. {"xml", "application/xml"},
  6404. {"gz", "application/gzip"},
  6405. {"zip", "application/zip"},
  6406. {"wasm", "application/wasm"},
  6407. };
  6408. for (const auto &t : types) {
  6409. if (ext == t.ext) { return t.type; }
  6410. }
  6411. return default_content_type;
  6412. }
  6413. inline std::string
  6414. extract_media_type(const std::string &content_type,
  6415. std::map<std::string, std::string> *params = nullptr) {
  6416. // Extract type/subtype from Content-Type value (RFC 2045)
  6417. // e.g. "application/json; charset=utf-8" -> "application/json"
  6418. auto media_type = content_type;
  6419. auto semicolon_pos = media_type.find(';');
  6420. if (semicolon_pos != std::string::npos) {
  6421. auto param_str = media_type.substr(semicolon_pos + 1);
  6422. media_type = media_type.substr(0, semicolon_pos);
  6423. if (params) {
  6424. // Parse parameters: key=value pairs separated by ';'
  6425. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6426. [&](const char *b, const char *e) {
  6427. std::string key;
  6428. std::string val;
  6429. divide_param_pair(b, e, key, val);
  6430. if (!key.empty()) {
  6431. params->emplace(trim_copy(key),
  6432. trim_double_quotes_copy(val));
  6433. }
  6434. });
  6435. }
  6436. }
  6437. // Trim whitespace from media type
  6438. return trim_copy(media_type);
  6439. }
  6440. inline bool can_compress_content_type(const std::string &content_type) {
  6441. auto mime_type = extract_media_type(content_type);
  6442. static const char *const compressible[] = {
  6443. "image/svg+xml",
  6444. "application/javascript",
  6445. "application/x-javascript",
  6446. "application/json",
  6447. "application/ld+json",
  6448. "application/xml",
  6449. "application/xhtml+xml",
  6450. "application/rss+xml",
  6451. "application/atom+xml",
  6452. "application/xslt+xml",
  6453. "application/protobuf",
  6454. };
  6455. for (auto type : compressible) {
  6456. if (mime_type == type) { return true; }
  6457. }
  6458. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6459. }
  6460. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6461. double &quality) {
  6462. quality = 1.0;
  6463. token.clear();
  6464. // Split on first ';': left = token name, right = parameters
  6465. const char *params_b = nullptr;
  6466. std::size_t params_len = 0;
  6467. divide(
  6468. b, static_cast<std::size_t>(e - b), ';',
  6469. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6470. auto r = trim(lb, lb + llen, 0, llen);
  6471. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6472. params_b = rb;
  6473. params_len = rlen;
  6474. });
  6475. if (token.empty()) { return false; }
  6476. if (params_len == 0) { return true; }
  6477. // Scan parameters for q= (stops on first match)
  6478. bool invalid = false;
  6479. split_find(params_b, params_b + params_len, ';',
  6480. (std::numeric_limits<size_t>::max)(),
  6481. [&](const char *pb, const char *pe) -> bool {
  6482. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6483. auto len = static_cast<size_t>(pe - pb);
  6484. if (len < 2) { return false; }
  6485. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6486. return false;
  6487. }
  6488. // Trim the value portion
  6489. auto r = trim(pb, pe, 2, len);
  6490. if (r.first >= r.second) {
  6491. invalid = true;
  6492. return true;
  6493. }
  6494. double v = 0.0;
  6495. auto res = from_chars(pb + r.first, pb + r.second, v);
  6496. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6497. v < 0.0 || v > 1.0) {
  6498. invalid = true;
  6499. return true;
  6500. }
  6501. quality = v;
  6502. return true;
  6503. });
  6504. return !invalid;
  6505. }
  6506. inline EncodingType encoding_type(const Request &req,
  6507. const std::string &content_type) {
  6508. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6509. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6510. if (s.empty()) { return EncodingType::None; }
  6511. // Single-pass: iterate tokens and track the best supported encoding.
  6512. // Server preference breaks ties (br > gzip > zstd).
  6513. EncodingType best = EncodingType::None;
  6514. double best_q = 0.0; // q=0 means "not acceptable"
  6515. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6516. auto priority = [](EncodingType t) -> int {
  6517. switch (t) {
  6518. case EncodingType::Brotli: return 0;
  6519. case EncodingType::Gzip: return 1;
  6520. case EncodingType::Zstd: return 2;
  6521. default: return 3;
  6522. }
  6523. };
  6524. std::string name;
  6525. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6526. double quality = 1.0;
  6527. if (!parse_quality(b, e, name, quality)) { return; }
  6528. if (quality <= 0.0) { return; }
  6529. EncodingType type = EncodingType::None;
  6530. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6531. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6532. #endif
  6533. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6534. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6535. type = EncodingType::Gzip;
  6536. }
  6537. #endif
  6538. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6539. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6540. type = EncodingType::Zstd;
  6541. }
  6542. #endif
  6543. if (type == EncodingType::None) { return; }
  6544. // Higher q-value wins; for equal q, server preference breaks ties
  6545. if (quality > best_q ||
  6546. (quality == best_q && priority(type) < priority(best))) {
  6547. best_q = quality;
  6548. best = type;
  6549. }
  6550. });
  6551. return best;
  6552. }
  6553. // `content_type` is taken separately because a file-backed response has not
  6554. // been given one yet when its coding has to be decided.
  6555. inline EncodingType encoding_type(const Request &req, const Response &res,
  6556. const std::string &content_type) {
  6557. // The response already names a content coding of its own: a handler serving
  6558. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6559. // point whose headers name the coding its files are stored in. Applying one
  6560. // on top of that would double-encode the body and append a second
  6561. // `Content-Encoding` field line.
  6562. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6563. return encoding_type(req, content_type);
  6564. }
  6565. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6566. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6567. }
  6568. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6569. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6570. if (type == EncodingType::Gzip) {
  6571. return detail::make_unique<gzip_compressor>();
  6572. }
  6573. #endif
  6574. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6575. if (type == EncodingType::Brotli) {
  6576. return detail::make_unique<brotli_compressor>();
  6577. }
  6578. #endif
  6579. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6580. if (type == EncodingType::Zstd) {
  6581. return detail::make_unique<zstd_compressor>();
  6582. }
  6583. #endif
  6584. (void)type;
  6585. return nullptr;
  6586. }
  6587. inline const char *encoding_name(EncodingType type) {
  6588. switch (type) {
  6589. case EncodingType::Gzip: return "gzip";
  6590. case EncodingType::Brotli: return "br";
  6591. case EncodingType::Zstd: return "zstd";
  6592. default: return "";
  6593. }
  6594. }
  6595. inline bool nocompressor::compress(const char *data, size_t data_length,
  6596. bool /*last*/, Callback callback) {
  6597. if (!data_length) { return true; }
  6598. return callback(data, data_length);
  6599. }
  6600. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6601. inline gzip_compressor::gzip_compressor() {
  6602. std::memset(&strm_, 0, sizeof(strm_));
  6603. strm_.zalloc = Z_NULL;
  6604. strm_.zfree = Z_NULL;
  6605. strm_.opaque = Z_NULL;
  6606. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6607. Z_DEFAULT_STRATEGY) == Z_OK;
  6608. }
  6609. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6610. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6611. bool last, Callback callback) {
  6612. assert(is_valid_);
  6613. do {
  6614. constexpr size_t max_avail_in =
  6615. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6616. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6617. (std::min)(data_length, max_avail_in));
  6618. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6619. data_length -= strm_.avail_in;
  6620. data += strm_.avail_in;
  6621. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6622. auto ret = Z_OK;
  6623. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6624. do {
  6625. strm_.avail_out = static_cast<uInt>(buff.size());
  6626. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6627. ret = deflate(&strm_, flush);
  6628. if (ret == Z_STREAM_ERROR) { return false; }
  6629. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6630. return false;
  6631. }
  6632. } while (strm_.avail_out == 0);
  6633. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6634. (flush == Z_NO_FLUSH && ret == Z_OK));
  6635. assert(strm_.avail_in == 0);
  6636. } while (data_length > 0);
  6637. return true;
  6638. }
  6639. inline gzip_decompressor::gzip_decompressor() {
  6640. std::memset(&strm_, 0, sizeof(strm_));
  6641. strm_.zalloc = Z_NULL;
  6642. strm_.zfree = Z_NULL;
  6643. strm_.opaque = Z_NULL;
  6644. // 15 is the value of wbits, which should be at the maximum possible value
  6645. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6646. // that the stream type should be automatically detected either gzip or
  6647. // deflate.
  6648. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6649. }
  6650. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6651. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6652. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6653. Callback callback) {
  6654. assert(is_valid_);
  6655. auto ret = Z_OK;
  6656. do {
  6657. constexpr size_t max_avail_in =
  6658. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6659. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6660. (std::min)(data_length, max_avail_in));
  6661. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6662. data_length -= strm_.avail_in;
  6663. data += strm_.avail_in;
  6664. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6665. while (strm_.avail_in > 0 && ret == Z_OK) {
  6666. strm_.avail_out = static_cast<uInt>(buff.size());
  6667. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6668. ret = inflate(&strm_, Z_NO_FLUSH);
  6669. assert(ret != Z_STREAM_ERROR);
  6670. switch (ret) {
  6671. case Z_NEED_DICT:
  6672. case Z_DATA_ERROR:
  6673. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6674. }
  6675. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6676. return false;
  6677. }
  6678. }
  6679. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6680. } while (data_length > 0);
  6681. return true;
  6682. }
  6683. #endif
  6684. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6685. inline brotli_compressor::brotli_compressor() {
  6686. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6687. }
  6688. inline brotli_compressor::~brotli_compressor() {
  6689. BrotliEncoderDestroyInstance(state_);
  6690. }
  6691. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6692. bool last, Callback callback) {
  6693. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6694. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6695. auto available_in = data_length;
  6696. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6697. for (;;) {
  6698. if (last) {
  6699. if (BrotliEncoderIsFinished(state_)) { break; }
  6700. } else {
  6701. if (!available_in) { break; }
  6702. }
  6703. auto available_out = buff.size();
  6704. auto next_out = buff.data();
  6705. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6706. &available_out, &next_out, nullptr)) {
  6707. return false;
  6708. }
  6709. auto output_bytes = buff.size() - available_out;
  6710. if (output_bytes) {
  6711. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6712. }
  6713. }
  6714. return true;
  6715. }
  6716. inline brotli_decompressor::brotli_decompressor() {
  6717. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6718. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6719. : BROTLI_DECODER_RESULT_ERROR;
  6720. }
  6721. inline brotli_decompressor::~brotli_decompressor() {
  6722. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6723. }
  6724. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6725. inline bool brotli_decompressor::decompress(const char *data,
  6726. size_t data_length,
  6727. Callback callback) {
  6728. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6729. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6730. return 0;
  6731. }
  6732. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6733. size_t avail_in = data_length;
  6734. size_t total_out;
  6735. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6736. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6737. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6738. char *next_out = buff.data();
  6739. size_t avail_out = buff.size();
  6740. decoder_r = BrotliDecoderDecompressStream(
  6741. decoder_s, &avail_in, &next_in, &avail_out,
  6742. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6743. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6744. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6745. }
  6746. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6747. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6748. }
  6749. #endif
  6750. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6751. inline zstd_compressor::zstd_compressor() {
  6752. ctx_ = ZSTD_createCCtx();
  6753. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6754. }
  6755. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6756. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6757. bool last, Callback callback) {
  6758. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6759. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6760. ZSTD_inBuffer input = {data, data_length, 0};
  6761. bool finished;
  6762. do {
  6763. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6764. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6765. if (ZSTD_isError(remaining)) { return false; }
  6766. if (!callback(buff.data(), output.pos)) { return false; }
  6767. finished = last ? (remaining == 0) : (input.pos == input.size);
  6768. } while (!finished);
  6769. return true;
  6770. }
  6771. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6772. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6773. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6774. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6775. Callback callback) {
  6776. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6777. ZSTD_inBuffer input = {data, data_length, 0};
  6778. while (input.pos < input.size) {
  6779. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6780. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6781. if (ZSTD_isError(remaining)) { return false; }
  6782. if (!callback(buff.data(), output.pos)) { return false; }
  6783. }
  6784. return true;
  6785. }
  6786. #endif
  6787. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6788. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6789. // unknown coding, and its payload would be handed back still compressed.
  6790. inline bool is_zlib_encoding(const std::string &encoding) {
  6791. return case_ignore::equal(encoding, "gzip") ||
  6792. case_ignore::equal(encoding, "deflate");
  6793. }
  6794. inline bool is_brotli_encoding(const std::string &encoding) {
  6795. return case_ignore::equal(encoding, "br");
  6796. }
  6797. inline bool is_zstd_encoding(const std::string &encoding) {
  6798. return case_ignore::equal(encoding, "zstd");
  6799. }
  6800. // Returns true if the content coding is one cpp-httplib is able to decompress
  6801. // when the corresponding support is compiled in.
  6802. inline bool is_known_content_encoding(const std::string &encoding) {
  6803. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6804. is_zstd_encoding(encoding);
  6805. }
  6806. inline std::unique_ptr<decompressor>
  6807. create_decompressor(const std::string &encoding) {
  6808. std::unique_ptr<decompressor> decompressor;
  6809. if (is_zlib_encoding(encoding)) {
  6810. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6811. decompressor = detail::make_unique<gzip_decompressor>();
  6812. #endif
  6813. } else if (is_brotli_encoding(encoding)) {
  6814. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6815. decompressor = detail::make_unique<brotli_decompressor>();
  6816. #endif
  6817. } else if (is_zstd_encoding(encoding)) {
  6818. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6819. decompressor = detail::make_unique<zstd_decompressor>();
  6820. #endif
  6821. }
  6822. return decompressor;
  6823. }
  6824. // Returns the best available compressor and its Content-Encoding name.
  6825. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6826. inline std::pair<std::unique_ptr<compressor>, const char *>
  6827. create_compressor() {
  6828. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6829. return {detail::make_unique<brotli_compressor>(), "br"};
  6830. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6831. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6832. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6833. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6834. #else
  6835. return {nullptr, nullptr};
  6836. #endif
  6837. }
  6838. // s == lit, comparing the lengths first, which operator== may not do.
  6839. template <size_t N>
  6840. inline bool equals_literal(const std::string &s, const char (&lit)[N]) {
  6841. return s.size() == N - 1 && !s.compare(0, N - 1, lit);
  6842. }
  6843. inline bool is_prohibited_header_name(const std::string &name) {
  6844. // Every header lookup by name runs this.
  6845. return equals_literal(name, "REMOTE_ADDR") ||
  6846. equals_literal(name, "REMOTE_PORT") ||
  6847. equals_literal(name, "LOCAL_ADDR") ||
  6848. equals_literal(name, "LOCAL_PORT");
  6849. }
  6850. inline bool has_header(const Headers &headers, const std::string &key) {
  6851. if (is_prohibited_header_name(key)) { return false; }
  6852. return headers.find(key) != headers.end();
  6853. }
  6854. inline const char *get_header_value(const Headers &headers,
  6855. const std::string &key, const char *def,
  6856. size_t id) {
  6857. if (is_prohibited_header_name(key)) {
  6858. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6859. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6860. throw std::invalid_argument(msg);
  6861. #else
  6862. return "";
  6863. #endif
  6864. }
  6865. auto rng = headers.equal_range(key);
  6866. auto it = bounded_next(rng.first, id, rng.second);
  6867. if (it != rng.second) { return it->second.c_str(); }
  6868. return def;
  6869. }
  6870. inline size_t get_header_value_count(const Headers &headers,
  6871. const std::string &key) {
  6872. return headers.count(key);
  6873. }
  6874. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6875. // list may be sent as several field lines, and the combined field value is
  6876. // those values joined by commas in the order they were received. Callers that
  6877. // parse such a list must work on the combined value; reading only the first
  6878. // occurrence silently drops whatever the later field lines carry.
  6879. inline std::string get_combined_header_value(const Headers &headers,
  6880. const std::string &key) {
  6881. std::string combined;
  6882. auto rng = headers.equal_range(key);
  6883. for (auto it = rng.first; it != rng.second; ++it) {
  6884. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6885. // elements, so an empty field line must not contribute a bare comma to the
  6886. // combined value.
  6887. if (it->second.empty()) { continue; }
  6888. if (!combined.empty()) { combined += ", "; }
  6889. combined += it->second;
  6890. }
  6891. return combined;
  6892. }
  6893. inline bool has_header_token(const Headers &headers, const std::string &key,
  6894. const std::string &token) {
  6895. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6896. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6897. // several lines. Match complete tokens rather than searching the raw value,
  6898. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6899. auto rng = headers.equal_range(key);
  6900. for (auto it = rng.first; it != rng.second; ++it) {
  6901. const auto &value = it->second;
  6902. if (split_find(value.data(), value.data() + value.size(), ',',
  6903. [&](const char *b, const char *e) {
  6904. return case_ignore::equal(std::string(b, e), token);
  6905. })) {
  6906. return true;
  6907. }
  6908. }
  6909. return false;
  6910. }
  6911. template <typename Map>
  6912. inline typename Map::mapped_type
  6913. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6914. auto rng = m.equal_range(key);
  6915. auto it = bounded_next(rng.first, id, rng.second);
  6916. if (it != rng.second) { return it->second; }
  6917. return typename Map::mapped_type();
  6918. }
  6919. inline void set_header(Headers &headers, const std::string &key,
  6920. const std::string &val) {
  6921. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6922. }
  6923. inline bool read_headers(Stream &strm, Headers &headers) {
  6924. const auto bufsiz = 2048;
  6925. char buf[bufsiz];
  6926. stream_line_reader line_reader(strm, buf, bufsiz);
  6927. size_t header_count = 0;
  6928. for (;;) {
  6929. if (!line_reader.getline()) { return false; }
  6930. // Check if the line ends with CRLF.
  6931. auto line_terminator_len = 2;
  6932. if (line_reader.end_with_crlf()) {
  6933. // Blank line indicates end of headers.
  6934. if (line_reader.size() == 2) { break; }
  6935. } else {
  6936. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6937. // Blank line indicates end of headers.
  6938. if (line_reader.size() == 1) { break; }
  6939. line_terminator_len = 1;
  6940. #else
  6941. continue; // Skip invalid line.
  6942. #endif
  6943. }
  6944. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6945. // Check header count limit
  6946. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6947. // Exclude line terminator
  6948. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6949. if (!parse_header(line_reader.ptr(), end,
  6950. [&](const std::string &key, const std::string &val) {
  6951. headers.emplace(key, val);
  6952. })) {
  6953. return false;
  6954. }
  6955. header_count++;
  6956. }
  6957. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6958. // headers that have different values to prevent request smuggling.
  6959. auto cl_range = headers.equal_range("Content-Length");
  6960. if (cl_range.first != cl_range.second) {
  6961. const auto &first_val = cl_range.first->second;
  6962. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6963. if (it->second != first_val) { return false; }
  6964. }
  6965. }
  6966. return true;
  6967. }
  6968. // Parsed by hand: std::regex_match recurses once per character of the reason
  6969. // phrase, which a server can make as long as a whole line.
  6970. inline bool parse_status_line(const char *line, std::string &version,
  6971. int &status, std::string &reason) {
  6972. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  6973. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  6974. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  6975. !is_ascii_digit(line[11])) {
  6976. return false;
  6977. }
  6978. auto p = line + 12;
  6979. auto reason_begin = p;
  6980. if (*p == ' ') {
  6981. reason_begin = ++p;
  6982. p += std::strcspn(p, "\r\n");
  6983. }
  6984. auto reason_end = p;
  6985. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6986. if (*p == '\r') { p++; }
  6987. #else
  6988. if (*p++ != '\r') { return false; }
  6989. #endif
  6990. if (*p++ != '\n' || *p != '\0') { return false; }
  6991. version.assign(line, 8);
  6992. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  6993. reason.assign(reason_begin, reason_end);
  6994. return true;
  6995. }
  6996. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6997. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6998. struct WebSocketUpgradeResponse {
  6999. Error error = Error::Success;
  7000. int status = -1;
  7001. Headers headers;
  7002. std::string selected_subprotocol;
  7003. };
  7004. inline bool
  7005. read_websocket_upgrade_response(Stream &strm,
  7006. const std::string &expected_accept,
  7007. const std::string &offered_subprotocols,
  7008. WebSocketUpgradeResponse &upgrade) {
  7009. // Read status line
  7010. const auto bufsiz = 2048;
  7011. char buf[bufsiz];
  7012. stream_line_reader line_reader(strm, buf, bufsiz);
  7013. if (!line_reader.getline()) {
  7014. upgrade.error = Error::Read;
  7015. return false;
  7016. }
  7017. std::string version;
  7018. std::string reason;
  7019. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  7020. upgrade.error = Error::WebSocketHandshake;
  7021. return false;
  7022. }
  7023. // Read the headers even for a rejection so the caller can see why the
  7024. // server refused the upgrade. A non-101 response may carry a body; it is
  7025. // deliberately left unread since the caller closes the socket right away.
  7026. if (!read_headers(strm, upgrade.headers)) {
  7027. upgrade.error = Error::Read;
  7028. return false;
  7029. }
  7030. const auto &headers = upgrade.headers;
  7031. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7032. upgrade.error = Error::WebSocketHandshake;
  7033. return false;
  7034. }
  7035. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7036. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7037. upgrade.error = Error::WebSocketHandshake;
  7038. return false;
  7039. }
  7040. // Verify Connection: Upgrade
  7041. if (!has_header_token(headers, "Connection", "upgrade")) {
  7042. upgrade.error = Error::WebSocketHandshake;
  7043. return false;
  7044. }
  7045. // Verify Sec-WebSocket-Accept header value
  7046. auto it = headers.find("Sec-WebSocket-Accept");
  7047. if (it == headers.end() || it->second != expected_accept) {
  7048. upgrade.error = Error::WebSocketHandshake;
  7049. return false;
  7050. }
  7051. // Extract negotiated subprotocol
  7052. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7053. if (proto_it != headers.end()) {
  7054. upgrade.selected_subprotocol = proto_it->second;
  7055. }
  7056. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7057. if (!upgrade.selected_subprotocol.empty()) {
  7058. auto was_offered = false;
  7059. split(offered_subprotocols.data(),
  7060. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7061. [&](const char *b, const char *e) {
  7062. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7063. was_offered = true;
  7064. }
  7065. });
  7066. if (!was_offered) {
  7067. upgrade.error = Error::WebSocketHandshake;
  7068. return false;
  7069. }
  7070. }
  7071. return true;
  7072. }
  7073. enum class ReadContentResult {
  7074. Success, // Successfully read the content
  7075. PayloadTooLarge, // The content exceeds the specified payload limit
  7076. Error // An error occurred while reading the content
  7077. };
  7078. inline ReadContentResult read_content_with_length(
  7079. Stream &strm, size_t len, DownloadProgress progress,
  7080. ContentReceiverWithProgress out,
  7081. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7082. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7083. detail::BodyReader br;
  7084. br.stream = &strm;
  7085. br.has_content_length = true;
  7086. br.content_length = len;
  7087. br.payload_max_length = payload_max_length;
  7088. br.chunked = false;
  7089. br.bytes_read = 0;
  7090. br.last_error = Error::Success;
  7091. size_t r = 0;
  7092. while (r < len) {
  7093. auto read_len = static_cast<size_t>(len - r);
  7094. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7095. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7096. if (n <= 0) {
  7097. // Check if it was a payload size error
  7098. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7099. return ReadContentResult::PayloadTooLarge;
  7100. }
  7101. return ReadContentResult::Error;
  7102. }
  7103. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7104. return ReadContentResult::Error;
  7105. }
  7106. r += static_cast<size_t>(n);
  7107. if (progress) {
  7108. if (!progress(r, len)) { return ReadContentResult::Error; }
  7109. }
  7110. }
  7111. return ReadContentResult::Success;
  7112. }
  7113. inline ReadContentResult
  7114. read_content_without_length(Stream &strm, size_t payload_max_length,
  7115. ContentReceiverWithProgress out) {
  7116. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7117. size_t r = 0;
  7118. for (;;) {
  7119. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7120. if (n == 0) { return ReadContentResult::Success; }
  7121. if (n < 0) { return ReadContentResult::Error; }
  7122. // Check if adding this data would exceed the payload limit
  7123. if (payload_max_length > 0 &&
  7124. (r > payload_max_length ||
  7125. payload_max_length - r < static_cast<size_t>(n))) {
  7126. return ReadContentResult::PayloadTooLarge;
  7127. }
  7128. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7129. return ReadContentResult::Error;
  7130. }
  7131. r += static_cast<size_t>(n);
  7132. }
  7133. return ReadContentResult::Success;
  7134. }
  7135. template <typename T>
  7136. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7137. size_t payload_max_length,
  7138. ContentReceiverWithProgress out) {
  7139. detail::ChunkedDecoder dec(strm);
  7140. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7141. size_t total_len = 0;
  7142. for (;;) {
  7143. size_t chunk_offset = 0;
  7144. size_t chunk_total = 0;
  7145. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7146. if (n < 0) { return ReadContentResult::Error; }
  7147. if (n == 0) {
  7148. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7149. return ReadContentResult::Error;
  7150. }
  7151. return ReadContentResult::Success;
  7152. }
  7153. if (payload_max_length > 0 &&
  7154. (total_len > payload_max_length ||
  7155. payload_max_length - total_len < static_cast<size_t>(n))) {
  7156. return ReadContentResult::PayloadTooLarge;
  7157. }
  7158. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7159. return ReadContentResult::Error;
  7160. }
  7161. total_len += static_cast<size_t>(n);
  7162. }
  7163. }
  7164. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7165. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7166. // is the final transfer coding. A single field value may list several
  7167. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7168. // several Transfer-Encoding lines, which combine into one comma-separated
  7169. // list in the order the lines were received. Headers preserves that order,
  7170. // so the final coding is the last token of the last line. Match it
  7171. // case-insensitively rather than comparing the whole value against
  7172. // "chunked".
  7173. //
  7174. // Security: reading a chunked message as unframed leaves its body in the
  7175. // socket, where a keep-alive connection parses it as a smuggled request.
  7176. // Server::process_request() answers 400 and closes when the final coding is
  7177. // not chunked, so a request whose framing cannot be determined never
  7178. // reaches the "no body" path.
  7179. auto rng = headers.equal_range("Transfer-Encoding");
  7180. if (rng.first == rng.second) { return false; }
  7181. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7182. // combined list ending in nothing rather than inheriting the line before it.
  7183. std::string last_coding;
  7184. for (auto it = rng.first; it != rng.second; ++it) {
  7185. const auto &value = it->second;
  7186. last_coding.clear();
  7187. split(value.data(), value.data() + value.size(), ',',
  7188. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7189. }
  7190. return case_ignore::equal(last_coding, "chunked");
  7191. }
  7192. inline bool has_conflicting_content_length(const Headers &headers) {
  7193. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7194. // Content-Length is framed ambiguously. The body readers here delimit it by
  7195. // the transfer coding and drop Content-Length, while an intermediary may do
  7196. // the reverse, so the two disagree on where the body ends and a reused
  7197. // connection is desynchronised (request/response smuggling). Content-Length:
  7198. // 0 is tolerated for compatibility with existing peers.
  7199. return has_header(headers, "Transfer-Encoding") &&
  7200. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7201. }
  7202. template <typename T, typename U>
  7203. bool prepare_content_receiver(T &x, int &status,
  7204. ContentReceiverWithProgress receiver,
  7205. bool decompress, size_t payload_max_length,
  7206. bool &exceed_payload_max_length, U callback) {
  7207. if (decompress) {
  7208. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7209. std::unique_ptr<decompressor> decompressor;
  7210. if (!encoding.empty()) {
  7211. // A coding we know about but were not built with is an error. An
  7212. // unrecognized coding (including "identity") is left alone and the
  7213. // payload is passed through as-is, since some servers misuse the header,
  7214. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7215. decompressor = detail::create_decompressor(encoding);
  7216. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7217. status = StatusCode::UnsupportedMediaType_415;
  7218. return false;
  7219. }
  7220. }
  7221. if (decompressor) {
  7222. if (decompressor->is_valid()) {
  7223. size_t decompressed_size = 0;
  7224. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7225. size_t off, size_t len) {
  7226. return decompressor->decompress(
  7227. buf, n, [&](const char *buf2, size_t n2) {
  7228. // Guard against zip-bomb: check
  7229. // decompressed size against limit.
  7230. if (payload_max_length > 0 &&
  7231. (decompressed_size >= payload_max_length ||
  7232. n2 > payload_max_length - decompressed_size)) {
  7233. exceed_payload_max_length = true;
  7234. return false;
  7235. }
  7236. decompressed_size += n2;
  7237. return receiver(buf2, n2, off, len);
  7238. });
  7239. };
  7240. return callback(std::move(out));
  7241. } else {
  7242. status = StatusCode::InternalServerError_500;
  7243. return false;
  7244. }
  7245. }
  7246. }
  7247. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7248. size_t len) {
  7249. return receiver(buf, n, off, len);
  7250. };
  7251. return callback(std::move(out));
  7252. }
  7253. template <typename T>
  7254. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7255. DownloadProgress progress,
  7256. ContentReceiverWithProgress receiver, bool decompress) {
  7257. bool exceed_payload_max_length = false;
  7258. return prepare_content_receiver(
  7259. x, status, std::move(receiver), decompress, payload_max_length,
  7260. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7261. auto ret = true;
  7262. // Note: exceed_payload_max_length may also be set by the decompressor
  7263. // wrapper in prepare_content_receiver when the decompressed payload
  7264. // size exceeds the limit.
  7265. if (is_chunked_transfer_encoding(x.headers)) {
  7266. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7267. if (result == ReadContentResult::Success) {
  7268. ret = true;
  7269. } else if (result == ReadContentResult::PayloadTooLarge) {
  7270. exceed_payload_max_length = true;
  7271. ret = false;
  7272. } else {
  7273. ret = false;
  7274. }
  7275. } else if (!has_header(x.headers, "Content-Length")) {
  7276. auto result =
  7277. read_content_without_length(strm, payload_max_length, out);
  7278. if (result == ReadContentResult::Success) {
  7279. ret = true;
  7280. } else if (result == ReadContentResult::PayloadTooLarge) {
  7281. exceed_payload_max_length = true;
  7282. ret = false;
  7283. } else {
  7284. ret = false;
  7285. }
  7286. } else {
  7287. auto is_invalid_value = false;
  7288. auto len = get_header_value_u64(x.headers, "Content-Length",
  7289. (std::numeric_limits<size_t>::max)(),
  7290. 0, is_invalid_value);
  7291. if (is_invalid_value) {
  7292. ret = false;
  7293. } else if (len > 0) {
  7294. auto result = read_content_with_length(
  7295. strm, len, std::move(progress), out, payload_max_length);
  7296. ret = (result == ReadContentResult::Success);
  7297. if (result == ReadContentResult::PayloadTooLarge) {
  7298. exceed_payload_max_length = true;
  7299. }
  7300. }
  7301. }
  7302. if (!ret) {
  7303. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7304. : StatusCode::BadRequest_400;
  7305. }
  7306. return ret;
  7307. });
  7308. }
  7309. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7310. const std::string &path) {
  7311. // Neither the method nor the request target may carry CR/LF, SP or other
  7312. // control octets; otherwise a value smuggled into either splits the request
  7313. // line and injects headers or a whole request.
  7314. if (!fields::is_token(method)) { return -1; }
  7315. if (!fields::is_request_target(path)) { return -1; }
  7316. std::string s = method;
  7317. s += ' ';
  7318. s += path;
  7319. s += " HTTP/1.1\r\n";
  7320. return strm.write(s.data(), s.size());
  7321. }
  7322. inline ssize_t write_response_line(Stream &strm, int status) {
  7323. std::string s = "HTTP/1.1 ";
  7324. s += std::to_string(status);
  7325. s += ' ';
  7326. s += httplib::status_message(status);
  7327. s += "\r\n";
  7328. return strm.write(s.data(), s.size());
  7329. }
  7330. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7331. ssize_t write_len = 0;
  7332. for (const auto &x : headers) {
  7333. // Skip fields with invalid names or values to prevent response splitting
  7334. // via CR/LF injection, matching set_header(). The client validates request
  7335. // headers up front in check_and_write_headers, but the server passes
  7336. // res.headers straight to this writer, and res.headers is a public field
  7337. // an application can populate directly with request-derived values.
  7338. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7339. std::string s;
  7340. s = x.first;
  7341. s += ": ";
  7342. s += x.second;
  7343. s += "\r\n";
  7344. auto len = strm.write(s.data(), s.size());
  7345. if (len < 0) { return len; }
  7346. write_len += len;
  7347. }
  7348. auto len = strm.write("\r\n");
  7349. if (len < 0) { return len; }
  7350. write_len += len;
  7351. return write_len;
  7352. }
  7353. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7354. size_t offset = 0;
  7355. while (offset < l) {
  7356. auto length = strm.write(d + offset, l - offset);
  7357. if (length < 0) { return false; }
  7358. offset += static_cast<size_t>(length);
  7359. }
  7360. return true;
  7361. }
  7362. template <typename T>
  7363. inline bool write_content_with_progress(Stream &strm,
  7364. const ContentProvider &content_provider,
  7365. size_t offset, size_t length,
  7366. T is_shutting_down,
  7367. const UploadProgress &upload_progress,
  7368. Error &error) {
  7369. size_t end_offset = offset + length;
  7370. size_t start_offset = offset;
  7371. auto ok = true;
  7372. auto finished = false;
  7373. DataSink data_sink;
  7374. data_sink.write = [&](const char *d, size_t l) -> bool {
  7375. if (ok) {
  7376. if (write_data(strm, d, l)) {
  7377. offset += l;
  7378. if (upload_progress && length > 0) {
  7379. size_t current_written = offset - start_offset;
  7380. if (!upload_progress(current_written, length)) {
  7381. ok = false;
  7382. return false;
  7383. }
  7384. }
  7385. } else {
  7386. ok = false;
  7387. }
  7388. }
  7389. return ok;
  7390. };
  7391. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7392. // The body is framed by `length`, so a provider that reports itself done
  7393. // early has truncated it. Record that and let the short-body check below
  7394. // fail the write, rather than calling the provider again forever.
  7395. data_sink.done = [&]() { finished = true; };
  7396. while (offset < end_offset && !finished && !is_shutting_down()) {
  7397. auto last_offset = offset;
  7398. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7399. error = Error::Write;
  7400. return false;
  7401. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7402. error = Error::Canceled;
  7403. return false;
  7404. } else if (!ok) {
  7405. error = Error::Write;
  7406. return false;
  7407. }
  7408. // A provider that reports success without writing anything and without
  7409. // reporting itself done gets handed the same offset and length again on
  7410. // the next pass, so it would spin here for as long as the peer stays
  7411. // connected. Treat making no progress as a short body, like done() early.
  7412. if (!finished && offset == last_offset) {
  7413. error = Error::Write;
  7414. return false;
  7415. }
  7416. }
  7417. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7418. error = Error::Write;
  7419. return false;
  7420. }
  7421. error = Error::Success;
  7422. return true;
  7423. }
  7424. template <typename T>
  7425. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7426. size_t offset, size_t length, T is_shutting_down,
  7427. Error &error) {
  7428. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7429. is_shutting_down, nullptr, error);
  7430. }
  7431. template <typename T>
  7432. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7433. size_t offset, size_t length,
  7434. const T &is_shutting_down) {
  7435. auto error = Error::Success;
  7436. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7437. error);
  7438. }
  7439. template <typename T>
  7440. inline bool
  7441. write_content_without_length(Stream &strm,
  7442. const ContentProvider &content_provider,
  7443. const T &is_shutting_down) {
  7444. size_t offset = 0;
  7445. auto data_available = true;
  7446. auto ok = true;
  7447. DataSink data_sink;
  7448. data_sink.write = [&](const char *d, size_t l) -> bool {
  7449. if (ok) {
  7450. offset += l;
  7451. if (!write_data(strm, d, l)) { ok = false; }
  7452. }
  7453. return ok;
  7454. };
  7455. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7456. data_sink.done = [&](void) { data_available = false; };
  7457. while (data_available && !is_shutting_down()) {
  7458. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7459. return false;
  7460. } else if (!content_provider(offset, 0, data_sink)) {
  7461. return false;
  7462. } else if (!ok) {
  7463. return false;
  7464. }
  7465. }
  7466. return !data_available; // true only if done() was called, false if shutting
  7467. // down
  7468. }
  7469. // Runs a known-length content provider to completion and compresses what it
  7470. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7471. // by an mmap hands the compressor a pointer straight into the mapping.
  7472. inline bool compress_content_provider(const ContentProvider &content_provider,
  7473. size_t length, compressor &cmp,
  7474. std::string &out) {
  7475. size_t offset = 0;
  7476. auto ok = true;
  7477. auto finished = false;
  7478. DataSink data_sink;
  7479. auto append = [&](const char *data, size_t data_len) {
  7480. out.append(data, data_len);
  7481. return true;
  7482. };
  7483. data_sink.write = [&](const char *d, size_t l) -> bool {
  7484. if (!ok) { return false; }
  7485. offset += l;
  7486. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7487. return ok;
  7488. };
  7489. // The body is framed by `length`, so a provider that reports itself done
  7490. // early has truncated it; the short-body check below turns that into a
  7491. // failure rather than calling the provider again forever.
  7492. data_sink.done = [&]() { finished = true; };
  7493. while (offset < length && !finished) {
  7494. auto prev_offset = offset;
  7495. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7496. return false;
  7497. }
  7498. // No Stream to block on here, so a provider that keeps returning true
  7499. // without writing would spin. Treat a pass that made no progress as a
  7500. // failure.
  7501. if (offset == prev_offset) { return false; }
  7502. }
  7503. if (offset != length) { return false; }
  7504. return cmp.compress(nullptr, 0, true, append);
  7505. }
  7506. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7507. // and the file flag, so recording them has to come after; keeping all of it
  7508. // here means a third file-serving path cannot get that order wrong.
  7509. inline void set_file_content_provider(Response &res,
  7510. const std::shared_ptr<mmap> &m,
  7511. const std::string &content_type,
  7512. EncodingType encoding) {
  7513. res.set_content_provider(
  7514. m->size(), content_type,
  7515. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7516. // Never read past the mapping.
  7517. if (offset >= m->size()) { return false; }
  7518. sink.write(m->data() + offset, (std::min)(length, m->size() - offset));
  7519. return true;
  7520. });
  7521. res.is_file_content_provider_ = true;
  7522. res.content_coding_ = encoding;
  7523. }
  7524. template <typename T, typename U>
  7525. inline bool
  7526. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7527. const T &is_shutting_down, U &compressor, Error &error) {
  7528. size_t offset = 0;
  7529. auto data_available = true;
  7530. auto ok = true;
  7531. DataSink data_sink;
  7532. data_sink.write = [&](const char *d, size_t l) -> bool {
  7533. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7534. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7535. // zero-length chunk is the terminator, so it must not be emitted here.
  7536. if (ok && l > 0) {
  7537. offset += l;
  7538. std::string payload;
  7539. if (compressor.compress(d, l, false,
  7540. [&](const char *data, size_t data_len) {
  7541. payload.append(data, data_len);
  7542. return true;
  7543. })) {
  7544. if (!payload.empty()) {
  7545. // Emit chunked response header and footer for each chunk
  7546. auto chunk =
  7547. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7548. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7549. }
  7550. } else {
  7551. ok = false;
  7552. }
  7553. }
  7554. return ok;
  7555. };
  7556. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7557. auto done_with_trailer = [&](const Headers *trailer) {
  7558. if (!ok) { return; }
  7559. data_available = false;
  7560. std::string payload;
  7561. if (!compressor.compress(nullptr, 0, true,
  7562. [&](const char *data, size_t data_len) {
  7563. payload.append(data, data_len);
  7564. return true;
  7565. })) {
  7566. ok = false;
  7567. return;
  7568. }
  7569. if (!payload.empty()) {
  7570. // Emit chunked response header and footer for each chunk
  7571. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7572. if (!write_data(strm, chunk.data(), chunk.size())) {
  7573. ok = false;
  7574. return;
  7575. }
  7576. }
  7577. constexpr const char done_marker[] = "0\r\n";
  7578. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7579. // Trailer
  7580. if (trailer) {
  7581. for (const auto &kv : *trailer) {
  7582. // Skip fields with invalid names or values to prevent response
  7583. // splitting via CR/LF injection, matching set_header().
  7584. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7585. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7586. if (!write_data(strm, field_line.data(), field_line.size())) {
  7587. ok = false;
  7588. }
  7589. }
  7590. }
  7591. constexpr const char crlf[] = "\r\n";
  7592. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7593. };
  7594. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7595. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7596. done_with_trailer(&trailer);
  7597. };
  7598. while (data_available && !is_shutting_down()) {
  7599. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7600. error = Error::Write;
  7601. return false;
  7602. } else if (!content_provider(offset, 0, data_sink)) {
  7603. error = Error::Canceled;
  7604. return false;
  7605. } else if (!ok) {
  7606. error = Error::Write;
  7607. return false;
  7608. }
  7609. }
  7610. if (data_available) { // exited due to is_shutting_down(), not done()
  7611. error = Error::Write;
  7612. return false;
  7613. }
  7614. error = Error::Success;
  7615. return true;
  7616. }
  7617. template <typename T, typename U>
  7618. inline bool write_content_chunked(Stream &strm,
  7619. const ContentProvider &content_provider,
  7620. const T &is_shutting_down, U &compressor) {
  7621. auto error = Error::Success;
  7622. return write_content_chunked(strm, content_provider, is_shutting_down,
  7623. compressor, error);
  7624. }
  7625. template <typename T>
  7626. inline bool redirect(T &cli, Request &req, Response &res,
  7627. const std::string &path, const std::string &location,
  7628. Error &error) {
  7629. Request new_req = req;
  7630. new_req.path = path;
  7631. new_req.redirect_count_ -= 1;
  7632. if (res.status == StatusCode::SeeOther_303 &&
  7633. (req.method != "GET" && req.method != "HEAD")) {
  7634. new_req.method = "GET";
  7635. new_req.body.clear();
  7636. new_req.headers.clear();
  7637. new_req.content_length_ = 0;
  7638. new_req.content_provider_ = nullptr;
  7639. new_req.is_chunked_content_provider_ = false;
  7640. }
  7641. Response new_res;
  7642. auto ret = cli.send(new_req, new_res, error);
  7643. if (ret) {
  7644. req = std::move(new_req);
  7645. res = std::move(new_res);
  7646. if (res.location.empty()) { res.location = location; }
  7647. }
  7648. return ret;
  7649. }
  7650. inline std::string params_to_query_str(const Params &params) {
  7651. std::string query;
  7652. for (auto it = params.begin(); it != params.end(); ++it) {
  7653. if (it != params.begin()) { query += '&'; }
  7654. query += encode_query_component(it->first);
  7655. query += '=';
  7656. query += encode_query_component(it->second);
  7657. }
  7658. return query;
  7659. }
  7660. // Splits one "key=value" span of a query string at its first '='. A span with
  7661. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7662. // "?flag" keeps its name.
  7663. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7664. std::string &val) {
  7665. divide(b, static_cast<std::size_t>(e - b), '=',
  7666. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7667. std::size_t rhs_size) {
  7668. key.assign(lhs_data, lhs_size);
  7669. val.assign(rhs_data, rhs_size);
  7670. });
  7671. }
  7672. inline void parse_query_text(const char *data, std::size_t size,
  7673. Params &params) {
  7674. std::set<std::string> cache;
  7675. split(data, data + size, '&', [&](const char *b, const char *e) {
  7676. std::string kv(b, e);
  7677. if (cache.find(kv) != cache.end()) { return; }
  7678. cache.insert(std::move(kv));
  7679. std::string key;
  7680. std::string val;
  7681. divide_query_pair(b, e, key, val);
  7682. if (!key.empty()) {
  7683. params.emplace(decode_query_component(key), decode_query_component(val));
  7684. }
  7685. });
  7686. }
  7687. inline void parse_query_text(const std::string &s, Params &params) {
  7688. parse_query_text(s.data(), s.size(), params);
  7689. }
  7690. // Normalize a query string by decoding and re-encoding each key/value pair
  7691. // while preserving the original parameter order. This avoids double-encoding
  7692. // and ensures consistent encoding. It works on the raw string rather than
  7693. // parsing into Params and re-serializing, because that round trip cannot
  7694. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7695. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7696. // duplicated pairs.
  7697. inline std::string normalize_query_string(const std::string &query) {
  7698. std::string result;
  7699. split(query.data(), query.data() + query.size(), '&',
  7700. [&](const char *b, const char *e) {
  7701. std::string key;
  7702. std::string val;
  7703. divide_query_pair(b, e, key, val);
  7704. if (!key.empty()) {
  7705. auto dec_key = decode_query_component(key);
  7706. auto dec_val = decode_query_component(val);
  7707. if (!result.empty()) { result += '&'; }
  7708. result += encode_query_component(dec_key);
  7709. if (!val.empty() || std::find(b, e, '=') != e) {
  7710. result += '=';
  7711. result += encode_query_component(dec_val);
  7712. }
  7713. }
  7714. });
  7715. return result;
  7716. }
  7717. // Build the request target that goes on the wire from a caller-supplied path.
  7718. // Shared by the buffered send path and the streaming API so that both put the
  7719. // same bytes in the request line for the same input.
  7720. inline std::string encode_request_target(const std::string &uri,
  7721. bool path_encode) {
  7722. // The fragment stays with the client (RFC 9110 §7.1).
  7723. auto target = uri.substr(0, uri.find('#'));
  7724. // `substr(0, npos)` yields the whole string, which is what the no-query
  7725. // case needs.
  7726. auto query_pos = target.find('?');
  7727. auto path_part = target.substr(0, query_pos);
  7728. std::string query_part;
  7729. if (query_pos != std::string::npos) {
  7730. query_part = target.substr(query_pos + 1);
  7731. }
  7732. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7733. if (!query_part.empty()) {
  7734. // When path encoding is disabled the caller has supplied an already-encoded
  7735. // target and expects the exact bytes to be sent on the wire, so skip
  7736. // normalization for the query too. Normalizing would decode-then-re-encode
  7737. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7738. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7739. if (path_encode) {
  7740. auto normalized = normalize_query_string(query_part);
  7741. if (!normalized.empty()) {
  7742. result += '?';
  7743. result += normalized;
  7744. }
  7745. } else {
  7746. result += '?';
  7747. result += query_part;
  7748. }
  7749. }
  7750. return result;
  7751. }
  7752. inline bool parse_multipart_boundary(const std::string &content_type,
  7753. std::string &boundary) {
  7754. std::map<std::string, std::string> params;
  7755. extract_media_type(content_type, &params);
  7756. auto it = params.find("boundary");
  7757. if (it == params.end()) { return false; }
  7758. boundary = it->second;
  7759. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7760. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7761. // bytes costs a nearly full comparison at nearly every position: the
  7762. // boundary's length multiplies the worst-case cost of scanning a body.
  7763. return !boundary.empty() && boundary.size() <= 70;
  7764. }
  7765. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  7766. // here, as browsers send any other backslash, such as one in a Windows path,
  7767. // as it is.
  7768. inline std::string unquote_disposition_param(const std::string &s) {
  7769. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  7770. std::string out;
  7771. for (size_t i = 1; i + 1 < s.size(); i++) {
  7772. if (s[i] == '\\' && i + 2 < s.size() &&
  7773. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  7774. i++;
  7775. }
  7776. out += s[i];
  7777. }
  7778. return out;
  7779. }
  7780. inline void parse_disposition_params(const std::string &s, Params &params) {
  7781. std::set<std::string> cache;
  7782. split_unquoted(s.data(), s.data() + s.size(), ';',
  7783. [&](const char *b, const char *e) {
  7784. std::string kv(b, e);
  7785. if (cache.find(kv) != cache.end()) { return; }
  7786. cache.insert(kv);
  7787. std::string key;
  7788. std::string val;
  7789. divide_param_pair(b, e, key, val);
  7790. if (!key.empty()) {
  7791. params.emplace(trim_double_quotes_copy(key),
  7792. unquote_disposition_param(val));
  7793. }
  7794. });
  7795. }
  7796. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7797. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7798. #else
  7799. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7800. #endif
  7801. auto is_valid = [](const std::string &str) {
  7802. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7803. };
  7804. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7805. const auto pos = static_cast<size_t>(6);
  7806. const auto len = static_cast<size_t>(s.size() - 6);
  7807. auto all_valid_ranges = true;
  7808. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7809. if (!all_valid_ranges) { return; }
  7810. const auto it = std::find(b, e, '-');
  7811. if (it == e) {
  7812. all_valid_ranges = false;
  7813. return;
  7814. }
  7815. const auto lhs = std::string(b, it);
  7816. const auto rhs = std::string(it + 1, e);
  7817. if (!is_valid(lhs) || !is_valid(rhs)) {
  7818. all_valid_ranges = false;
  7819. return;
  7820. }
  7821. ssize_t first = -1;
  7822. if (!lhs.empty()) {
  7823. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7824. // would turn the range into a suffix range.
  7825. auto res =
  7826. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7827. if (res.ec != std::errc{}) {
  7828. all_valid_ranges = false;
  7829. return;
  7830. }
  7831. }
  7832. ssize_t last = -1;
  7833. if (!rhs.empty()) {
  7834. // An overflowing last-byte-pos is past any content length, so keeping
  7835. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7836. ssize_t v;
  7837. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7838. if (res.ec == std::errc{}) { last = v; }
  7839. }
  7840. if ((first == -1 && last == -1) ||
  7841. (first != -1 && last != -1 && first > last)) {
  7842. all_valid_ranges = false;
  7843. return;
  7844. }
  7845. ranges.emplace_back(first, last);
  7846. });
  7847. return all_valid_ranges && !ranges.empty();
  7848. }
  7849. return false;
  7850. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7851. }
  7852. #else
  7853. } catch (...) { return false; }
  7854. #endif
  7855. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7856. inline std::string remove_quoted_strings(const std::string &s) {
  7857. std::string out;
  7858. auto in_quotes = false;
  7859. for (size_t i = 0; i < s.size(); i++) {
  7860. if (s[i] == '"') {
  7861. in_quotes = !in_quotes;
  7862. } else if (!in_quotes) {
  7863. out += s[i];
  7864. } else if (s[i] == '\\') {
  7865. i++;
  7866. }
  7867. }
  7868. return out;
  7869. }
  7870. inline bool parse_accept_header(const std::string &s,
  7871. std::vector<std::string> &content_types) {
  7872. // Parameter values are not used here, so a quoted-string is dropped rather
  7873. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7874. if (s.find('"') != std::string::npos) {
  7875. return parse_accept_header(remove_quoted_strings(s), content_types);
  7876. }
  7877. content_types.clear();
  7878. // Empty string is considered valid (no preference)
  7879. if (s.empty()) { return true; }
  7880. struct AcceptEntry {
  7881. std::string media_type;
  7882. double quality;
  7883. int order;
  7884. };
  7885. std::vector<AcceptEntry> entries;
  7886. int order = 0;
  7887. bool has_invalid_entry = false;
  7888. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7889. // has to parse and ignore empty list elements, so a leading, trailing or
  7890. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7891. // split() skips them, and the header length limit bounds how many a sender
  7892. // can send, so ignoring all of them cannot be used as a denial-of-service
  7893. // vector.
  7894. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7895. std::string entry(b, e);
  7896. entry = trim_copy(entry);
  7897. AcceptEntry accept_entry;
  7898. accept_entry.order = order++;
  7899. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7900. accept_entry.media_type, accept_entry.quality)) {
  7901. has_invalid_entry = true;
  7902. return;
  7903. }
  7904. // Remove additional parameters from media type
  7905. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7906. // Basic validation of media type format
  7907. if (accept_entry.media_type.empty()) {
  7908. has_invalid_entry = true;
  7909. return;
  7910. }
  7911. // Check for basic media type format (should contain '/' or be '*')
  7912. if (accept_entry.media_type != "*" &&
  7913. accept_entry.media_type.find('/') == std::string::npos) {
  7914. has_invalid_entry = true;
  7915. return;
  7916. }
  7917. entries.push_back(std::move(accept_entry));
  7918. });
  7919. // Return false if any invalid entry was found
  7920. if (has_invalid_entry) { return false; }
  7921. // Sort by quality (descending), then by original order (ascending)
  7922. std::sort(entries.begin(), entries.end(),
  7923. [](const AcceptEntry &a, const AcceptEntry &b) {
  7924. if (a.quality != b.quality) {
  7925. return a.quality > b.quality; // Higher quality first
  7926. }
  7927. return a.order < b.order; // Earlier order first for same quality
  7928. });
  7929. // Extract sorted media types
  7930. content_types.reserve(entries.size());
  7931. for (auto &entry : entries) {
  7932. content_types.push_back(std::move(entry.media_type));
  7933. }
  7934. return true;
  7935. }
  7936. class FormDataParser {
  7937. public:
  7938. FormDataParser() = default;
  7939. void set_boundary(std::string &&boundary) {
  7940. boundary_ = std::move(boundary);
  7941. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7942. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7943. }
  7944. bool is_valid() const { return is_valid_; }
  7945. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7946. const ContentReceiver &content_callback) {
  7947. // Once the close delimiter has been seen the rest of the body is epilogue
  7948. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7949. // spread across reads is not copied in only to be erased right away.
  7950. if (state_ == 5) { return true; }
  7951. buf_append(buf, n);
  7952. while (buf_size() > 0) {
  7953. switch (state_) {
  7954. case 0: { // Initial boundary
  7955. auto pos = buf_find(dash_boundary_crlf_);
  7956. if (pos == buf_size()) {
  7957. // Not found yet: keep only a possible partial boundary at the tail so
  7958. // that a body which never contains the boundary cannot grow the
  7959. // buffer (and get rescanned from the start) without bound.
  7960. auto keep = dash_boundary_crlf_.size() - 1;
  7961. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7962. return true;
  7963. }
  7964. buf_erase(pos + dash_boundary_crlf_.size());
  7965. state_ = 1;
  7966. break;
  7967. }
  7968. case 1: { // New entry
  7969. clear_file_info();
  7970. header_searched_ = 0;
  7971. state_ = 2;
  7972. break;
  7973. }
  7974. case 2: { // Headers
  7975. // Resume where the last call stopped looking, so that a line arriving
  7976. // a few bytes at a time is not searched from its start each time.
  7977. auto pos = buf_find(crlf_, header_searched_);
  7978. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7979. while (pos < buf_size()) {
  7980. // Empty line
  7981. if (pos == 0) {
  7982. if (!header_callback(file_)) {
  7983. is_valid_ = false;
  7984. return false;
  7985. }
  7986. buf_erase(crlf_.size());
  7987. state_ = 3;
  7988. break;
  7989. }
  7990. // Check header count limit
  7991. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7992. is_valid_ = false;
  7993. return false;
  7994. }
  7995. header_count_++;
  7996. const auto header = buf_head(pos);
  7997. if (!parse_header(header.data(), header.data() + header.size(),
  7998. [&](const std::string &, const std::string &) {})) {
  7999. is_valid_ = false;
  8000. return false;
  8001. }
  8002. // Parse and emplace space trimmed headers into a map
  8003. if (!parse_header(
  8004. header.data(), header.data() + header.size(),
  8005. [&](const std::string &key, const std::string &val) {
  8006. file_.headers.emplace(key, val);
  8007. })) {
  8008. is_valid_ = false;
  8009. return false;
  8010. }
  8011. constexpr const char header_content_type[] = "Content-Type:";
  8012. if (start_with_case_ignore(header, header_content_type)) {
  8013. file_.content_type =
  8014. trim_copy(header.substr(str_len(header_content_type)));
  8015. } else {
  8016. std::string disposition_params;
  8017. if (parse_content_disposition(header, disposition_params)) {
  8018. Params params;
  8019. parse_disposition_params(disposition_params, params);
  8020. auto it = params.find("name");
  8021. if (it != params.end()) {
  8022. file_.name = it->second;
  8023. } else {
  8024. is_valid_ = false;
  8025. return false;
  8026. }
  8027. it = params.find("filename");
  8028. if (it != params.end()) { file_.filename = it->second; }
  8029. it = params.find("filename*");
  8030. if (it != params.end()) {
  8031. // RFC 5987: only UTF-8 encoding is allowed
  8032. const auto &val = it->second;
  8033. constexpr const char utf8_prefix[] = "UTF-8''";
  8034. constexpr size_t prefix_len = str_len(utf8_prefix);
  8035. if (val.size() > prefix_len &&
  8036. start_with_case_ignore(val, utf8_prefix)) {
  8037. file_.filename = decode_path_component(
  8038. val.substr(prefix_len)); // override...
  8039. } else {
  8040. is_valid_ = false;
  8041. return false;
  8042. }
  8043. }
  8044. }
  8045. }
  8046. buf_erase(pos + crlf_.size());
  8047. pos = buf_find(crlf_);
  8048. }
  8049. if (state_ != 3) {
  8050. // The CR of the CRLF may be the last byte so far.
  8051. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8052. return true;
  8053. }
  8054. break;
  8055. }
  8056. case 3: { // Body
  8057. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8058. auto pos = buf_find(crlf_dash_boundary_);
  8059. if (pos < buf_size()) {
  8060. if (!content_callback(buf_data(), pos)) {
  8061. is_valid_ = false;
  8062. return false;
  8063. }
  8064. buf_erase(pos + crlf_dash_boundary_.size());
  8065. state_ = 4;
  8066. } else {
  8067. auto len = buf_size() - crlf_dash_boundary_.size();
  8068. if (len > 0) {
  8069. if (!content_callback(buf_data(), len)) {
  8070. is_valid_ = false;
  8071. return false;
  8072. }
  8073. buf_erase(len);
  8074. }
  8075. return true;
  8076. }
  8077. break;
  8078. }
  8079. case 4: { // Boundary
  8080. if (crlf_.size() > buf_size()) { return true; }
  8081. if (buf_start_with(crlf_)) {
  8082. buf_erase(crlf_.size());
  8083. state_ = 1;
  8084. } else if (buf_start_with(dash_)) {
  8085. buf_erase(dash_.size());
  8086. is_valid_ = true;
  8087. state_ = 5;
  8088. } else {
  8089. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8090. // accepted after a boundary; RFC 2046 allows transport-padding in
  8091. // between, but this parser has never supported it. Either way the
  8092. // body is already destined to be rejected, so fail now instead of
  8093. // buffering the rest of it. Both are two bytes, so the check above
  8094. // already guarantees enough buffered data to decide.
  8095. is_valid_ = false;
  8096. return false;
  8097. }
  8098. break;
  8099. }
  8100. case 5: { // Epilogue
  8101. buf_erase(buf_size());
  8102. break;
  8103. }
  8104. }
  8105. }
  8106. return true;
  8107. }
  8108. private:
  8109. void clear_file_info() {
  8110. file_.name.clear();
  8111. file_.filename.clear();
  8112. file_.content_type.clear();
  8113. file_.headers.clear();
  8114. header_count_ = 0;
  8115. }
  8116. bool start_with_case_ignore(const std::string &a, const char *b,
  8117. size_t offset = 0) const {
  8118. const auto b_len = strlen(b);
  8119. if (a.size() < offset + b_len) { return false; }
  8120. for (size_t i = 0; i < b_len; i++) {
  8121. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8122. return false;
  8123. }
  8124. }
  8125. return true;
  8126. }
  8127. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8128. // Returns true if header matches, with the params portion in `params_out`.
  8129. bool parse_content_disposition(const std::string &header,
  8130. std::string &params_out) const {
  8131. constexpr const char prefix[] = "Content-Disposition:";
  8132. constexpr size_t prefix_len = str_len(prefix);
  8133. if (!start_with_case_ignore(header, prefix)) { return false; }
  8134. // Skip whitespace after "Content-Disposition:"
  8135. auto pos = prefix_len;
  8136. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8137. pos++;
  8138. }
  8139. // Match "form-data;" (case-insensitive)
  8140. constexpr const char form_data[] = "form-data;";
  8141. constexpr size_t form_data_len = str_len(form_data);
  8142. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8143. pos += form_data_len;
  8144. // Skip whitespace after "form-data;"
  8145. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8146. pos++;
  8147. }
  8148. params_out = header.substr(pos);
  8149. return true;
  8150. }
  8151. const std::string dash_ = "--";
  8152. const std::string crlf_ = "\r\n";
  8153. std::string boundary_;
  8154. std::string dash_boundary_crlf_;
  8155. std::string crlf_dash_boundary_;
  8156. size_t state_ = 0;
  8157. bool is_valid_ = false;
  8158. FormData file_;
  8159. size_t header_count_ = 0;
  8160. size_t header_searched_ = 0;
  8161. // Buffer
  8162. bool start_with(const std::string &a, size_t spos, size_t epos,
  8163. const std::string &b) const {
  8164. if (epos - spos < b.size()) { return false; }
  8165. for (size_t i = 0; i < b.size(); i++) {
  8166. if (a[i + spos] != b[i]) { return false; }
  8167. }
  8168. return true;
  8169. }
  8170. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8171. const char *buf_data() const { return &buf_[buf_spos_]; }
  8172. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8173. bool buf_start_with(const std::string &s) const {
  8174. return start_with(buf_, buf_spos_, buf_epos_, s);
  8175. }
  8176. size_t buf_find(const std::string &s, size_t from = 0) const {
  8177. auto c = s.front();
  8178. size_t off = buf_spos_ + from;
  8179. while (off < buf_epos_) {
  8180. auto pos = off;
  8181. while (true) {
  8182. if (pos == buf_epos_) { return buf_size(); }
  8183. if (buf_[pos] == c) { break; }
  8184. pos++;
  8185. }
  8186. auto remaining_size = buf_epos_ - pos;
  8187. if (s.size() > remaining_size) { return buf_size(); }
  8188. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8189. off = pos + 1;
  8190. }
  8191. return buf_size();
  8192. }
  8193. void buf_append(const char *data, size_t n) {
  8194. auto remaining_size = buf_size();
  8195. if (remaining_size > 0 && buf_spos_ > 0) {
  8196. for (size_t i = 0; i < remaining_size; i++) {
  8197. buf_[i] = buf_[buf_spos_ + i];
  8198. }
  8199. }
  8200. buf_spos_ = 0;
  8201. buf_epos_ = remaining_size;
  8202. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8203. for (size_t i = 0; i < n; i++) {
  8204. buf_[buf_epos_ + i] = data[i];
  8205. }
  8206. buf_epos_ += n;
  8207. }
  8208. void buf_erase(size_t size) { buf_spos_ += size; }
  8209. std::string buf_;
  8210. size_t buf_spos_ = 0;
  8211. size_t buf_epos_ = 0;
  8212. };
  8213. inline std::string random_string(size_t length) {
  8214. constexpr const char data[] =
  8215. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8216. std::string result(length, '\0');
  8217. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8218. for (auto &c : result) {
  8219. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8220. }
  8221. return result;
  8222. }
  8223. inline std::string make_multipart_data_boundary() {
  8224. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8225. }
  8226. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8227. auto valid = true;
  8228. for (size_t i = 0; i < boundary.size(); i++) {
  8229. auto c = boundary[i];
  8230. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8231. valid = false;
  8232. break;
  8233. }
  8234. }
  8235. return valid;
  8236. }
  8237. // Escape a multipart field name/filename following the WHATWG HTML standard
  8238. // ("escape a multipart form-data name"), which is what browsers send:
  8239. // '"' -> %22, CR -> %0D, LF -> %0A
  8240. // With escape_quote = false, only CR and LF are escaped; this is for header
  8241. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8242. inline std::string escape_multipart_field(const std::string &s,
  8243. bool escape_quote = true) {
  8244. std::string result;
  8245. result.reserve(s.size());
  8246. for (auto c : s) {
  8247. switch (c) {
  8248. case '"':
  8249. if (escape_quote) {
  8250. result += "%22";
  8251. } else {
  8252. result += c;
  8253. }
  8254. break;
  8255. case '\r': result += "%0D"; break;
  8256. case '\n': result += "%0A"; break;
  8257. default: result += c; break;
  8258. }
  8259. }
  8260. return result;
  8261. }
  8262. template <typename T>
  8263. inline std::string
  8264. serialize_multipart_formdata_item_begin(const T &item,
  8265. const std::string &boundary) {
  8266. std::string body = "--" + boundary + "\r\n";
  8267. body += "Content-Disposition: form-data; name=\"" +
  8268. escape_multipart_field(item.name) + "\"";
  8269. if (!item.filename.empty()) {
  8270. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8271. }
  8272. body += "\r\n";
  8273. if (!item.content_type.empty()) {
  8274. body +=
  8275. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8276. "\r\n";
  8277. }
  8278. body += "\r\n";
  8279. return body;
  8280. }
  8281. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8282. inline std::string
  8283. serialize_multipart_formdata_finish(const std::string &boundary) {
  8284. return "--" + boundary + "--\r\n";
  8285. }
  8286. inline std::string
  8287. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8288. return "multipart/form-data; boundary=" + boundary;
  8289. }
  8290. inline std::string
  8291. serialize_multipart_formdata(const UploadFormDataItems &items,
  8292. const std::string &boundary, bool finish = true) {
  8293. std::string body;
  8294. for (const auto &item : items) {
  8295. body += serialize_multipart_formdata_item_begin(item, boundary);
  8296. body += item.content + serialize_multipart_formdata_item_end();
  8297. }
  8298. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8299. return body;
  8300. }
  8301. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8302. const std::string &boundary) {
  8303. size_t total = 0;
  8304. for (const auto &item : items) {
  8305. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8306. total += item.content.size();
  8307. total += serialize_multipart_formdata_item_end().size();
  8308. }
  8309. total += serialize_multipart_formdata_finish(boundary).size();
  8310. return total;
  8311. }
  8312. struct MultipartSegment {
  8313. const char *data;
  8314. size_t size;
  8315. };
  8316. // NOTE: items must outlive the returned ContentProvider
  8317. // (safe for synchronous use inside Post/Put/Patch)
  8318. inline ContentProvider
  8319. make_multipart_content_provider(const UploadFormDataItems &items,
  8320. const std::string &boundary) {
  8321. // Own the per-item header strings and the finish string
  8322. std::vector<std::string> owned;
  8323. owned.reserve(items.size() + 1);
  8324. for (const auto &item : items)
  8325. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8326. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8327. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8328. std::vector<MultipartSegment> segs;
  8329. segs.reserve(items.size() * 3 + 1);
  8330. static const char crlf[] = "\r\n";
  8331. for (size_t i = 0; i < items.size(); i++) {
  8332. segs.push_back({owned[i].data(), owned[i].size()});
  8333. segs.push_back({items[i].content.data(), items[i].content.size()});
  8334. segs.push_back({crlf, 2});
  8335. }
  8336. segs.push_back({owned.back().data(), owned.back().size()});
  8337. struct MultipartState {
  8338. std::vector<std::string> owned;
  8339. std::vector<MultipartSegment> segs;
  8340. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8341. };
  8342. auto state = std::make_shared<MultipartState>();
  8343. state->owned = std::move(owned);
  8344. // `segs` holds raw pointers into owned strings; std::string move preserves
  8345. // the data pointer, so these pointers remain valid after the move above.
  8346. state->segs = std::move(segs);
  8347. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8348. // Buffer multiple small segments into fewer, larger writes to avoid
  8349. // excessive TCP packets when there are many form data items (#2410)
  8350. auto &buf = state->buf;
  8351. auto buf_size = buf.size();
  8352. size_t buf_len = 0;
  8353. size_t remaining = length;
  8354. // Find the first segment containing 'offset'
  8355. size_t pos = 0;
  8356. size_t seg_idx = 0;
  8357. for (; seg_idx < state->segs.size(); seg_idx++) {
  8358. const auto &seg = state->segs[seg_idx];
  8359. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8360. pos += seg.size;
  8361. }
  8362. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8363. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8364. const auto &seg = state->segs[seg_idx];
  8365. size_t available = seg.size - seg_offset;
  8366. size_t to_copy = (std::min)(available, remaining);
  8367. const char *src = seg.data + seg_offset;
  8368. seg_offset = 0; // only the first segment has a non-zero offset
  8369. while (to_copy > 0) {
  8370. size_t space = buf_size - buf_len;
  8371. size_t chunk = (std::min)(to_copy, space);
  8372. std::memcpy(buf.data() + buf_len, src, chunk);
  8373. buf_len += chunk;
  8374. src += chunk;
  8375. to_copy -= chunk;
  8376. remaining -= chunk;
  8377. if (buf_len == buf_size) {
  8378. if (!sink.write(buf.data(), buf_len)) { return false; }
  8379. buf_len = 0;
  8380. }
  8381. }
  8382. }
  8383. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8384. return true;
  8385. };
  8386. }
  8387. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8388. if (ranges.size() <= 1) return;
  8389. // Sort ranges by start position
  8390. std::sort(ranges.begin(), ranges.end(),
  8391. [](const Range &a, const Range &b) { return a.first < b.first; });
  8392. Ranges coalesced;
  8393. coalesced.reserve(ranges.size());
  8394. for (auto &r : ranges) {
  8395. auto first_pos = r.first;
  8396. auto last_pos = r.second;
  8397. // Handle special cases like in range_error
  8398. if (first_pos == -1 && last_pos == -1) {
  8399. first_pos = 0;
  8400. last_pos = static_cast<ssize_t>(content_length);
  8401. }
  8402. if (first_pos == -1) {
  8403. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8404. last_pos = static_cast<ssize_t>(content_length) - 1;
  8405. }
  8406. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8407. last_pos = static_cast<ssize_t>(content_length) - 1;
  8408. }
  8409. // Skip invalid ranges
  8410. if (!(0 <= first_pos && first_pos <= last_pos &&
  8411. last_pos < static_cast<ssize_t>(content_length))) {
  8412. continue;
  8413. }
  8414. // Coalesce with previous range if overlapping or adjacent (but not
  8415. // identical)
  8416. if (!coalesced.empty()) {
  8417. auto &prev = coalesced.back();
  8418. // Check if current range overlaps or is adjacent to previous range
  8419. // but don't coalesce identical ranges (allow duplicates)
  8420. if (first_pos <= prev.second + 1 &&
  8421. !(first_pos == prev.first && last_pos == prev.second)) {
  8422. // Extend the previous range
  8423. prev.second = (std::max)(prev.second, last_pos);
  8424. continue;
  8425. }
  8426. }
  8427. // Add new range
  8428. coalesced.emplace_back(first_pos, last_pos);
  8429. }
  8430. ranges = std::move(coalesced);
  8431. }
  8432. inline bool range_error(Request &req, Response &res) {
  8433. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8434. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8435. req.ranges.clear();
  8436. if (res.status == StatusCode::PartialContent_206) {
  8437. res.status = StatusCode::OK_200;
  8438. }
  8439. return false;
  8440. }
  8441. ssize_t content_len = static_cast<ssize_t>(
  8442. res.content_length_ ? res.content_length_ : res.body.size());
  8443. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8444. size_t overwrapping_count = 0;
  8445. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8446. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8447. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8448. // Too many ranges
  8449. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8450. for (auto &r : req.ranges) {
  8451. auto &first_pos = r.first;
  8452. auto &last_pos = r.second;
  8453. if (first_pos == -1 && last_pos == -1) {
  8454. first_pos = 0;
  8455. last_pos = content_len;
  8456. }
  8457. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8458. // selects the entire representation.
  8459. if (first_pos == -1) {
  8460. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8461. last_pos = content_len - 1;
  8462. }
  8463. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8464. // A client can limit the number of bytes requested without knowing the
  8465. // size of the selected representation. If the last-pos value is absent,
  8466. // or if the value is greater than or equal to the current length of the
  8467. // representation data, the byte range is interpreted as the remainder of
  8468. // the representation (i.e., the server replaces the value of last-pos
  8469. // with a value that is one less than the current length of the selected
  8470. // representation).
  8471. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8472. if (last_pos == -1 || last_pos >= content_len) {
  8473. last_pos = content_len - 1;
  8474. }
  8475. // Range must be within content length
  8476. if (!(0 <= first_pos && first_pos <= last_pos &&
  8477. last_pos <= content_len - 1)) {
  8478. return true;
  8479. }
  8480. // Request must not have more than two overlapping ranges
  8481. for (const auto &processed_range : processed_ranges) {
  8482. if (!(last_pos < processed_range.first ||
  8483. first_pos > processed_range.second)) {
  8484. overwrapping_count++;
  8485. if (overwrapping_count > 2) { return true; }
  8486. break; // Only count once per range
  8487. }
  8488. }
  8489. processed_ranges.emplace_back(first_pos, last_pos);
  8490. }
  8491. // After validation, coalesce overlapping ranges as per RFC 9110
  8492. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8493. }
  8494. return false;
  8495. }
  8496. inline std::pair<size_t, size_t>
  8497. get_range_offset_and_length(Range r, size_t content_length) {
  8498. assert(r.first != -1 && r.second != -1);
  8499. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8500. assert(r.first <= r.second &&
  8501. r.second < static_cast<ssize_t>(content_length));
  8502. (void)(content_length);
  8503. return std::make_pair(static_cast<size_t>(r.first),
  8504. static_cast<size_t>(r.second - r.first) + 1);
  8505. }
  8506. inline std::string make_content_range_header_field(
  8507. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8508. auto st = offset_and_length.first;
  8509. auto ed = st + offset_and_length.second - 1;
  8510. std::string field = "bytes ";
  8511. field += std::to_string(st);
  8512. field += '-';
  8513. field += std::to_string(ed);
  8514. field += '/';
  8515. field += std::to_string(content_length);
  8516. return field;
  8517. }
  8518. template <typename SToken, typename CToken, typename Content>
  8519. bool process_multipart_ranges_data(const Request &req,
  8520. const std::string &boundary,
  8521. const std::string &content_type,
  8522. size_t content_length, SToken stoken,
  8523. CToken ctoken, Content content) {
  8524. for (size_t i = 0; i < req.ranges.size(); i++) {
  8525. ctoken("--");
  8526. stoken(boundary);
  8527. ctoken("\r\n");
  8528. if (!content_type.empty()) {
  8529. ctoken("Content-Type: ");
  8530. stoken(content_type);
  8531. ctoken("\r\n");
  8532. }
  8533. auto offset_and_length =
  8534. get_range_offset_and_length(req.ranges[i], content_length);
  8535. ctoken("Content-Range: ");
  8536. stoken(make_content_range_header_field(offset_and_length, content_length));
  8537. ctoken("\r\n");
  8538. ctoken("\r\n");
  8539. if (!content(offset_and_length.first, offset_and_length.second)) {
  8540. return false;
  8541. }
  8542. ctoken("\r\n");
  8543. }
  8544. ctoken("--");
  8545. stoken(boundary);
  8546. ctoken("--");
  8547. return true;
  8548. }
  8549. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8550. const std::string &boundary,
  8551. const std::string &content_type,
  8552. size_t content_length,
  8553. std::string &data) {
  8554. process_multipart_ranges_data(
  8555. req, boundary, content_type, content_length,
  8556. [&](const std::string &token) { data += token; },
  8557. [&](const std::string &token) { data += token; },
  8558. [&](size_t offset, size_t length) {
  8559. assert(offset + length <= content_length);
  8560. data += res.body.substr(offset, length);
  8561. return true;
  8562. });
  8563. }
  8564. inline size_t get_multipart_ranges_data_length(const Request &req,
  8565. const std::string &boundary,
  8566. const std::string &content_type,
  8567. size_t content_length) {
  8568. size_t data_length = 0;
  8569. process_multipart_ranges_data(
  8570. req, boundary, content_type, content_length,
  8571. [&](const std::string &token) { data_length += token.size(); },
  8572. [&](const std::string &token) { data_length += token.size(); },
  8573. [&](size_t /*offset*/, size_t length) {
  8574. data_length += length;
  8575. return true;
  8576. });
  8577. return data_length;
  8578. }
  8579. template <typename T>
  8580. inline bool
  8581. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8582. const std::string &boundary,
  8583. const std::string &content_type,
  8584. size_t content_length, const T &is_shutting_down) {
  8585. return process_multipart_ranges_data(
  8586. req, boundary, content_type, content_length,
  8587. [&](const std::string &token) { strm.write(token); },
  8588. [&](const std::string &token) { strm.write(token); },
  8589. [&](size_t offset, size_t length) {
  8590. return write_content(strm, res.content_provider_, offset, length,
  8591. is_shutting_down);
  8592. });
  8593. }
  8594. inline bool has_framed_body(const Request &req) {
  8595. return is_chunked_transfer_encoding(req.headers) ||
  8596. req.get_header_value_u64("Content-Length") > 0;
  8597. }
  8598. inline bool is_connection_persistent(const Request &req) {
  8599. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8600. if (req.version == "HTTP/1.0" &&
  8601. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8602. return false;
  8603. }
  8604. return true;
  8605. }
  8606. inline bool expect_content(const Request &req) {
  8607. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8608. req.method == "DELETE") {
  8609. return true;
  8610. }
  8611. return has_framed_body(req);
  8612. }
  8613. #ifdef _WIN32
  8614. class WSInit {
  8615. public:
  8616. WSInit() {
  8617. WSADATA wsaData;
  8618. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8619. }
  8620. ~WSInit() {
  8621. if (is_valid_) WSACleanup();
  8622. }
  8623. bool is_valid_ = false;
  8624. };
  8625. static WSInit wsinit_;
  8626. #endif
  8627. // RFC 9110 Section 11.6.1 defines a challenge list as
  8628. // WWW-Authenticate = #challenge
  8629. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8630. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8631. // so a server may offer several schemes, each with its own comma-separated
  8632. // auth-param list, in either order and either as separate field lines or
  8633. // packed into one. Splitting on every comma would break apart a challenge's
  8634. // own param list; splitting only on the first space would miss a Digest
  8635. // challenge that isn't first. Split on commas that aren't inside a
  8636. // quoted-string instead, then track which scheme each resulting segment
  8637. // belongs to: a segment whose text before "=" contains whitespace (or that
  8638. // has no "=" at all) starts a new challenge named by its leading token.
  8639. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8640. std::vector<std::string> segments;
  8641. size_t start = 0;
  8642. auto in_quotes = false;
  8643. for (size_t i = 0; i < s.size(); i++) {
  8644. auto c = s[i];
  8645. if (in_quotes) {
  8646. if (c == '\\' && i + 1 < s.size()) {
  8647. i++;
  8648. } else if (c == '"') {
  8649. in_quotes = false;
  8650. }
  8651. } else if (c == '"') {
  8652. in_quotes = true;
  8653. } else if (c == ',') {
  8654. segments.push_back(s.substr(start, i - start));
  8655. start = i + 1;
  8656. }
  8657. }
  8658. segments.push_back(s.substr(start));
  8659. return segments;
  8660. }
  8661. inline std::string unescape_quoted_pairs(const std::string &s) {
  8662. std::string out;
  8663. out.reserve(s.size());
  8664. for (size_t i = 0; i < s.size(); i++) {
  8665. if (s[i] == '\\' && i + 1 < s.size()) {
  8666. out += s[++i];
  8667. } else {
  8668. out += s[i];
  8669. }
  8670. }
  8671. return out;
  8672. }
  8673. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8674. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8675. // quoted-pair, so the recipient recovers the original value.
  8676. inline std::string escape_quoted_pairs(const std::string &s) {
  8677. std::string out;
  8678. out.reserve(s.size());
  8679. for (auto c : s) {
  8680. if (c == '\\' || c == '"') { out += '\\'; }
  8681. out += c;
  8682. }
  8683. return out;
  8684. }
  8685. inline bool parse_www_authenticate(const Response &res,
  8686. std::map<std::string, std::string> &auth,
  8687. bool is_proxy) {
  8688. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8689. auto combined = get_combined_header_value(res.headers, auth_key);
  8690. if (combined.empty()) { return false; }
  8691. auto found_digest = false;
  8692. auto in_digest_challenge = false;
  8693. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8694. auto segment = trim_copy(raw_segment);
  8695. if (segment.empty()) { continue; }
  8696. auto eq_pos = segment.find('=');
  8697. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8698. // for the first segment of a challenge, "<scheme> <key>") must be
  8699. // trimmed before its boundaries are inspected.
  8700. auto key_part = trim_copy(
  8701. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8702. auto space_pos = key_part.find_last_of(" \t");
  8703. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8704. // "<scheme>[ <key>]" starts a new challenge.
  8705. auto scheme_end =
  8706. space_pos == std::string::npos ? key_part.size() : space_pos;
  8707. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8708. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8709. // from one challenge is never paired with another's algorithm.
  8710. in_digest_challenge =
  8711. !found_digest &&
  8712. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8713. if (in_digest_challenge) { found_digest = true; }
  8714. if (space_pos == std::string::npos) {
  8715. // Bare scheme (or a token68), no auth-param on this segment.
  8716. continue;
  8717. }
  8718. key_part = key_part.substr(space_pos + 1);
  8719. }
  8720. if (!in_digest_challenge) { continue; }
  8721. auto val = trim_copy(segment.substr(eq_pos + 1));
  8722. auto unquoted = trim_double_quotes_copy(val);
  8723. if (unquoted.size() != val.size()) {
  8724. unquoted = unescape_quoted_pairs(unquoted);
  8725. }
  8726. auth[std::move(key_part)] = std::move(unquoted);
  8727. }
  8728. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8729. // make_digest_authentication_header() dereferences both unconditionally, so
  8730. // a challenge missing either can't produce a usable Authorization header.
  8731. // Treat it the same as no Digest challenge at all.
  8732. return found_digest && auth.find("realm") != auth.end() &&
  8733. auth.find("nonce") != auth.end();
  8734. }
  8735. class ContentProviderAdapter {
  8736. public:
  8737. explicit ContentProviderAdapter(
  8738. ContentProviderWithoutLength &&content_provider)
  8739. : content_provider_(std::move(content_provider)) {}
  8740. bool operator()(size_t offset, size_t, DataSink &sink) {
  8741. return content_provider_(offset, sink);
  8742. }
  8743. private:
  8744. ContentProviderWithoutLength content_provider_;
  8745. };
  8746. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8747. namespace fields {
  8748. inline bool is_token_char(char c) {
  8749. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8750. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8751. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8752. }
  8753. inline bool is_token(const std::string &s) {
  8754. if (s.empty()) { return false; }
  8755. for (auto c : s) {
  8756. if (!is_token_char(c)) { return false; }
  8757. }
  8758. return true;
  8759. }
  8760. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8761. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8762. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8763. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8764. inline bool is_field_content(const std::string &s) {
  8765. if (s.empty()) { return true; }
  8766. if (s.size() == 1) {
  8767. return is_field_vchar(s[0]);
  8768. } else if (s.size() == 2) {
  8769. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8770. } else {
  8771. size_t i = 0;
  8772. if (!is_field_vchar(s[i])) { return false; }
  8773. i++;
  8774. while (i < s.size() - 1) {
  8775. auto c = s[i++];
  8776. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8777. } else {
  8778. return false;
  8779. }
  8780. }
  8781. return is_field_vchar(s[i]);
  8782. }
  8783. }
  8784. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8785. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8786. return is_field_name(name) && is_field_value(value);
  8787. }
  8788. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8789. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8790. inline bool is_request_target(const std::string &s) {
  8791. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8792. }
  8793. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8794. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8795. inline bool is_host(const std::string &s) {
  8796. return std::all_of(s.begin(), s.end(), [](char c) {
  8797. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8798. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8799. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8800. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8801. });
  8802. }
  8803. } // namespace fields
  8804. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8805. WebSocketUpgradeResponse &upgrade) {
  8806. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8807. std::string key_bytes(16, '\0');
  8808. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8809. key_bytes.size());
  8810. auto client_key = base64_encode(key_bytes);
  8811. req.headers.erase("Upgrade");
  8812. req.headers.erase("Connection");
  8813. req.headers.erase("Sec-WebSocket-Key");
  8814. req.headers.erase("Sec-WebSocket-Version");
  8815. req.headers.emplace("Upgrade", "websocket");
  8816. req.headers.emplace("Connection", "Upgrade");
  8817. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8818. req.headers.emplace("Sec-WebSocket-Version", "13");
  8819. // Build the request in memory first, like ClientImpl::write_request does.
  8820. // Writing straight to the socket would leak a request line onto the wire
  8821. // before check_and_write_headers gets a chance to reject an invalid header,
  8822. // and would emit one small write per header.
  8823. BufferStream bstrm;
  8824. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8825. upgrade.error = Error::Write;
  8826. return false;
  8827. }
  8828. auto error = Error::Success;
  8829. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8830. upgrade.error = error;
  8831. return false;
  8832. }
  8833. const auto &data = bstrm.get_buffer();
  8834. if (!write_data(strm, data.data(), data.size())) {
  8835. upgrade.error = Error::Write;
  8836. return false;
  8837. }
  8838. // Verify 101 response and Sec-WebSocket-Accept header
  8839. auto expected_accept = websocket_accept_key(client_key);
  8840. auto offered_subprotocols =
  8841. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8842. return read_websocket_upgrade_response(strm, expected_accept,
  8843. offered_subprotocols, upgrade);
  8844. }
  8845. inline bool is_ip_address(const std::string &host) {
  8846. struct in_addr addr4;
  8847. struct in6_addr addr6;
  8848. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8849. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8850. }
  8851. // Resolve where a client should connect for `host`, honoring a user-supplied
  8852. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8853. // supplying the Host header and SNI; only the connection target changes.
  8854. //
  8855. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8856. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8857. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8858. // absent or empty mapping leaves `host` as the connection target; without the
  8859. // empty check the value would reach getaddrinfo as a null node and silently
  8860. // resolve to loopback.
  8861. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8862. const std::string &host, std::string &connect_host,
  8863. std::string &ip) {
  8864. connect_host = host;
  8865. ip.clear();
  8866. auto it = addr_map.find(host);
  8867. if (it == addr_map.end() || it->second.empty()) { return; }
  8868. if (is_ip_address(it->second)) {
  8869. ip = it->second;
  8870. } else {
  8871. connect_host = it->second;
  8872. }
  8873. }
  8874. } // namespace detail
  8875. /*
  8876. * Group 2: detail namespace - SSL common utilities
  8877. */
  8878. #ifdef CPPHTTPLIB_SSL_ENABLED
  8879. namespace detail {
  8880. class SSLSocketStream final : public Stream {
  8881. public:
  8882. SSLSocketStream(
  8883. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8884. time_t read_timeout_usec, time_t write_timeout_sec,
  8885. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8886. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8887. (std::chrono::steady_clock::time_point::min)());
  8888. ~SSLSocketStream() override;
  8889. bool is_readable() const override;
  8890. bool wait_readable() const override;
  8891. bool wait_writable() const override;
  8892. bool is_peer_alive() const override;
  8893. ssize_t read(char *ptr, size_t size) override;
  8894. ssize_t write(const char *ptr, size_t size) override;
  8895. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8896. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8897. socket_t socket() const override;
  8898. time_t duration() const override;
  8899. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8900. // See SocketStream::set_readable_hint().
  8901. void set_readable_hint() { readable_hint_ = true; }
  8902. private:
  8903. bool ensure_readable();
  8904. socket_t sock_;
  8905. tls::session_t session_;
  8906. time_t read_timeout_sec_;
  8907. time_t read_timeout_usec_;
  8908. time_t write_timeout_sec_;
  8909. time_t write_timeout_usec_;
  8910. time_t max_timeout_msec_;
  8911. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8912. bool readable_hint_ = false;
  8913. };
  8914. // A TLS stream for WebSocket connections, where the receive path and the
  8915. // send path (application send() plus the heartbeat ping thread) run on
  8916. // different threads. A single TLS session must never be entered
  8917. // concurrently, so every call into the session is serialized by one mutex.
  8918. //
  8919. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8920. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8921. // call under the lock, then waits for readiness with select() outside the
  8922. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8923. // blocked waiting for data never stalls a concurrent sender.
  8924. //
  8925. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8926. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8927. class WebSocketSSLStream final : public Stream {
  8928. public:
  8929. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8930. time_t read_timeout_sec, time_t read_timeout_usec,
  8931. time_t write_timeout_sec, time_t write_timeout_usec);
  8932. ~WebSocketSSLStream() override;
  8933. bool is_readable() const override;
  8934. bool wait_readable() const override;
  8935. bool wait_writable() const override;
  8936. ssize_t read(char *ptr, size_t size) override;
  8937. ssize_t write(const char *ptr, size_t size) override;
  8938. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8939. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8940. socket_t socket() const override;
  8941. time_t duration() const override;
  8942. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8943. private:
  8944. mutable std::mutex session_mutex_;
  8945. socket_t sock_;
  8946. tls::session_t session_;
  8947. // WebSocket::close() shortens the read timeout from the closing thread
  8948. // while the receive thread is inside wait_readable(), so these two are read
  8949. // and written concurrently. The write timeouts are never mutated.
  8950. std::atomic<time_t> read_timeout_sec_;
  8951. std::atomic<time_t> read_timeout_usec_;
  8952. time_t write_timeout_sec_;
  8953. time_t write_timeout_usec_;
  8954. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8955. };
  8956. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8957. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8958. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8959. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8960. unsigned int hash_length = 0;
  8961. unsigned char hash[EVP_MAX_MD_SIZE];
  8962. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8963. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8964. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8965. std::stringstream ss;
  8966. for (auto i = 0u; i < hash_length; ++i) {
  8967. ss << std::hex << std::setw(2) << std::setfill('0')
  8968. << static_cast<unsigned int>(hash[i]);
  8969. }
  8970. return ss.str();
  8971. }
  8972. inline std::string MD5(const std::string &s) {
  8973. return message_digest(s, EVP_md5());
  8974. }
  8975. inline std::string SHA_256(const std::string &s) {
  8976. return message_digest(s, EVP_sha256());
  8977. }
  8978. inline std::string SHA_512(const std::string &s) {
  8979. return message_digest(s, EVP_sha512());
  8980. }
  8981. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8982. namespace {
  8983. template <size_t N>
  8984. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8985. std::stringstream ss;
  8986. for (size_t i = 0; i < N; ++i) {
  8987. ss << std::hex << std::setw(2) << std::setfill('0')
  8988. << static_cast<unsigned int>(hash[i]);
  8989. }
  8990. return ss.str();
  8991. }
  8992. } // namespace
  8993. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8994. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8995. // initialized once. PSA state is process-global; do not free it.
  8996. inline bool ensure_mbedtls_psa_crypto() {
  8997. static std::once_flag once;
  8998. static bool ok = false;
  8999. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9000. return ok;
  9001. }
  9002. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9003. unsigned char *out, size_t out_size) {
  9004. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9005. size_t olen = 0;
  9006. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9007. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9008. olen == out_size;
  9009. }
  9010. #endif
  9011. inline std::string MD5(const std::string &s) {
  9012. unsigned char hash[16];
  9013. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9014. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9015. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9016. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9017. hash);
  9018. #else
  9019. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9020. hash);
  9021. #endif
  9022. return hash_to_hex(hash);
  9023. }
  9024. inline std::string SHA_256(const std::string &s) {
  9025. unsigned char hash[32];
  9026. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9027. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9028. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9029. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9030. hash, 0);
  9031. #else
  9032. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9033. s.size(), hash, 0);
  9034. #endif
  9035. return hash_to_hex(hash);
  9036. }
  9037. inline std::string SHA_512(const std::string &s) {
  9038. unsigned char hash[64];
  9039. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9040. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9041. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9042. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9043. hash, 0);
  9044. #else
  9045. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9046. s.size(), hash, 0);
  9047. #endif
  9048. return hash_to_hex(hash);
  9049. }
  9050. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9051. namespace {
  9052. template <size_t N>
  9053. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9054. std::stringstream ss;
  9055. for (size_t i = 0; i < N; ++i) {
  9056. ss << std::hex << std::setw(2) << std::setfill('0')
  9057. << static_cast<unsigned int>(hash[i]);
  9058. }
  9059. return ss.str();
  9060. }
  9061. } // namespace
  9062. inline std::string MD5(const std::string &s) {
  9063. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9064. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9065. static_cast<word32>(s.size()), hash);
  9066. return hash_to_hex(hash);
  9067. }
  9068. inline std::string SHA_256(const std::string &s) {
  9069. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9070. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9071. static_cast<word32>(s.size()), hash);
  9072. return hash_to_hex(hash);
  9073. }
  9074. inline std::string SHA_512(const std::string &s) {
  9075. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9076. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9077. static_cast<word32>(s.size()), hash);
  9078. return hash_to_hex(hash);
  9079. }
  9080. #endif
  9081. template <typename T>
  9082. inline bool process_server_socket_ssl(
  9083. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9084. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9085. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9086. time_t write_timeout_usec, T callback) {
  9087. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9088. // of a pipelined request, which keep_alive() cannot see on the socket.
  9089. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9090. write_timeout_sec, write_timeout_usec);
  9091. return process_server_socket_core(
  9092. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9093. [&]() { return strm.is_readable(); },
  9094. [&](bool socket_readable, bool close_connection,
  9095. bool &connection_closed) {
  9096. if (socket_readable) { strm.set_readable_hint(); }
  9097. return callback(strm, close_connection, connection_closed);
  9098. });
  9099. }
  9100. template <typename T>
  9101. inline bool process_client_socket_ssl(
  9102. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9103. time_t read_timeout_usec, time_t write_timeout_sec,
  9104. time_t write_timeout_usec, time_t max_timeout_msec,
  9105. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9106. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9107. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9108. start_time);
  9109. return callback(strm);
  9110. }
  9111. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9112. const Request &req, const std::map<std::string, std::string> &auth,
  9113. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9114. const std::string &password, bool is_proxy = false) {
  9115. std::string nc;
  9116. {
  9117. std::stringstream ss;
  9118. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9119. nc = ss.str();
  9120. }
  9121. std::string qop;
  9122. if (auth.find("qop") != auth.end()) {
  9123. qop = auth.at("qop");
  9124. if (qop.find("auth-int") != std::string::npos) {
  9125. qop = "auth-int";
  9126. } else if (qop.find("auth") != std::string::npos) {
  9127. qop = "auth";
  9128. } else {
  9129. qop.clear();
  9130. }
  9131. }
  9132. std::string algo = "MD5";
  9133. if (auth.find("algorithm") != auth.end()) {
  9134. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9135. // not a token would otherwise be emitted verbatim and could carry commas
  9136. // or quotes that inject further auth-params into the header below.
  9137. const auto &a = auth.at("algorithm");
  9138. if (fields::is_token(a)) { algo = a; }
  9139. }
  9140. std::string response;
  9141. {
  9142. auto H = algo == "SHA-256" ? detail::SHA_256
  9143. : algo == "SHA-512" ? detail::SHA_512
  9144. : detail::MD5;
  9145. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9146. auto A2 = req.method + ":" + req.path;
  9147. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9148. if (qop.empty()) {
  9149. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9150. } else {
  9151. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9152. ":" + qop + ":" + H(A2));
  9153. }
  9154. }
  9155. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9156. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9157. // close the string early. realm, nonce and opaque come straight from the
  9158. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9159. // without this a crafted challenge injects extra auth-params into the header.
  9160. auto field =
  9161. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9162. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9163. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9164. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9165. "\", algorithm=" + algo +
  9166. (qop.empty() ? ", response=\""
  9167. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9168. "\", response=\"") +
  9169. response + "\"" +
  9170. (opaque.empty()
  9171. ? ""
  9172. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9173. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9174. return std::make_pair(key, field);
  9175. }
  9176. inline bool match_hostname(const std::string &pattern,
  9177. const std::string &hostname) {
  9178. // Exact match (case-insensitive)
  9179. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  9180. // Split both pattern and hostname into components by '.'
  9181. std::vector<std::string> pattern_components;
  9182. if (!pattern.empty()) {
  9183. split(pattern.data(), pattern.data() + pattern.size(), '.',
  9184. [&](const char *b, const char *e) {
  9185. pattern_components.emplace_back(b, e);
  9186. });
  9187. }
  9188. std::vector<std::string> host_components;
  9189. if (!hostname.empty()) {
  9190. split(hostname.data(), hostname.data() + hostname.size(), '.',
  9191. [&](const char *b, const char *e) {
  9192. host_components.emplace_back(b, e);
  9193. });
  9194. }
  9195. // Component count must match
  9196. if (host_components.size() != pattern_components.size()) { return false; }
  9197. // Compare each component with wildcard support
  9198. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9199. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9200. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9201. auto itr = pattern_components.begin();
  9202. for (const auto &h : host_components) {
  9203. auto &p = *itr;
  9204. auto is_leftmost = itr == pattern_components.begin();
  9205. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9206. bool partial_match = false;
  9207. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9208. const auto prefix_length = p.size() - 1;
  9209. if (prefix_length == 0) {
  9210. partial_match = true;
  9211. } else if (h.size() >= prefix_length) {
  9212. partial_match =
  9213. std::equal(p.begin(),
  9214. p.begin() + static_cast<std::string::difference_type>(
  9215. prefix_length),
  9216. h.begin(), [](const char ca, const char cb) {
  9217. return detail::case_ignore::to_lower(ca) ==
  9218. detail::case_ignore::to_lower(cb);
  9219. });
  9220. }
  9221. }
  9222. if (!partial_match) { return false; }
  9223. }
  9224. ++itr;
  9225. }
  9226. return true;
  9227. }
  9228. #ifdef _WIN32
  9229. // Verify certificate using Windows CertGetCertificateChain API.
  9230. // This provides real-time certificate validation with Windows Update
  9231. // integration, independent of the TLS backend.
  9232. inline bool verify_cert_with_windows_schannel(
  9233. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9234. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9235. if (der_cert.empty()) { return false; }
  9236. out_error = 0;
  9237. // Create Windows certificate context from DER data
  9238. auto cert_context = CertCreateCertificateContext(
  9239. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9240. static_cast<DWORD>(der_cert.size()));
  9241. if (!cert_context) {
  9242. out_error = GetLastError();
  9243. return false;
  9244. }
  9245. auto cert_guard =
  9246. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9247. // Give CryptoAPI the certificates the server sent. Without them it follows
  9248. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9249. std::vector<tls::cert_t> peer_certs;
  9250. tls::get_peer_certs(session, peer_certs);
  9251. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9252. auto store_guard = scope_exit([&] {
  9253. for (auto cert : peer_certs) {
  9254. tls::free_cert(cert);
  9255. }
  9256. if (store) { CertCloseStore(store, 0); }
  9257. });
  9258. for (auto cert : peer_certs) {
  9259. std::vector<unsigned char> der;
  9260. if (store && tls::get_cert_der(cert, der)) {
  9261. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9262. static_cast<DWORD>(der.size()),
  9263. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9264. }
  9265. }
  9266. // Setup chain parameters
  9267. CERT_CHAIN_PARA chain_para = {};
  9268. chain_para.cbSize = sizeof(chain_para);
  9269. // Require the server authentication usage along the chain, which also
  9270. // rejects roots that Windows trusts only for other purposes.
  9271. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9272. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9273. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9274. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9275. // Build certificate chain with revocation checking
  9276. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9277. auto chain_result = CertGetCertificateChain(
  9278. nullptr, cert_context, nullptr, store, &chain_para,
  9279. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9280. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9281. nullptr, &chain_context);
  9282. if (!chain_result || !chain_context) {
  9283. out_error = GetLastError();
  9284. return false;
  9285. }
  9286. auto chain_guard =
  9287. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9288. // Verify SSL policy
  9289. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9290. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9291. #ifdef AUTHTYPE_SERVER
  9292. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9293. #endif
  9294. std::wstring whost;
  9295. if (verify_hostname) {
  9296. whost = u8string_to_wstring(hostname.c_str());
  9297. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9298. }
  9299. CERT_CHAIN_POLICY_PARA policy_para = {};
  9300. policy_para.cbSize = sizeof(policy_para);
  9301. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9302. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9303. #else
  9304. policy_para.dwFlags = 0;
  9305. #endif
  9306. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9307. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9308. policy_status.cbSize = sizeof(policy_status);
  9309. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9310. &policy_para, &policy_status)) {
  9311. out_error = GetLastError();
  9312. return false;
  9313. }
  9314. if (policy_status.dwError != 0) {
  9315. out_error = policy_status.dwError;
  9316. return false;
  9317. }
  9318. return true;
  9319. }
  9320. #endif // _WIN32
  9321. // Loads CA file/dir configuration and applies the system CA policy to a
  9322. // client TLS context. PEM data and native stores are applied to the context
  9323. // directly at set time; has_custom_store reflects them for the Auto policy
  9324. // decision.
  9325. inline bool load_client_ca_config(tls::ctx_t ctx,
  9326. const std::string &ca_cert_file_path,
  9327. const std::string &ca_cert_dir_path,
  9328. bool has_custom_store, SystemCAMode mode,
  9329. uint64_t &backend_error) {
  9330. auto ret = true;
  9331. if (!ca_cert_file_path.empty()) {
  9332. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9333. backend_error = tls::get_error();
  9334. ret = false;
  9335. }
  9336. } else if (!ca_cert_dir_path.empty()) {
  9337. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9338. backend_error = tls::get_error();
  9339. ret = false;
  9340. }
  9341. }
  9342. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9343. !ca_cert_dir_path.empty() || has_custom_store;
  9344. if (mode == SystemCAMode::Enabled ||
  9345. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9346. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9347. }
  9348. return ret;
  9349. }
  9350. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9351. std::vector<tls::cert_t> certs;
  9352. tls::get_ca_certs(ctx, certs);
  9353. std::string pem;
  9354. for (auto cert : certs) {
  9355. std::vector<unsigned char> der;
  9356. if (tls::get_cert_der(cert, der)) {
  9357. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9358. pem += "-----BEGIN CERTIFICATE-----\n";
  9359. for (size_t i = 0; i < b64.size(); i += 64) {
  9360. pem += b64.substr(i, 64) + "\n";
  9361. }
  9362. pem += "-----END CERTIFICATE-----\n";
  9363. }
  9364. tls::free_cert(cert);
  9365. }
  9366. return pem;
  9367. }
  9368. // The parts of session setup that only SSLClient needs, plus the handful
  9369. // WebSocketClient also exposes; everything else takes the defaults, which is
  9370. // what keeps the two clients on one implementation.
  9371. struct ClientTlsSessionOptions {
  9372. // Both SSLClient and WebSocketClient expose this independently of
  9373. // certificate verification.
  9374. bool server_hostname_verification = true;
  9375. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9376. // When non-null, guards session creation against concurrent use of the
  9377. // context. A WebSocketClient is not safe to use from several threads to
  9378. // begin with, so it passes nothing.
  9379. std::mutex *ctx_mutex = nullptr;
  9380. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9381. // The caller decides whether Schannel has anything to say about this
  9382. // connection; see SSLClient::initialize_ssl().
  9383. bool windows_cert_verification = false;
  9384. // A server certificate verifier works on the backend's chain verification,
  9385. // so the backend keeps deciding and Schannel only adds its own check.
  9386. bool server_certificate_verifier_set = false;
  9387. #endif
  9388. };
  9389. // Filled in on failure for callers that report error details.
  9390. struct ClientTlsSessionError {
  9391. Error error = Error::Success;
  9392. int ssl_error = 0;
  9393. uint64_t backend_error = 0;
  9394. };
  9395. // Establishes a client TLS session on an already connected socket. On failure
  9396. // the session is left for the caller to free: SSLClient frees it right away,
  9397. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9398. inline bool setup_client_tls_session(
  9399. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9400. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9401. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9402. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9403. using namespace tls;
  9404. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9405. if (out_error) {
  9406. out_error->error = error;
  9407. out_error->ssl_error = ssl_error;
  9408. out_error->backend_error = backend_error;
  9409. }
  9410. return false;
  9411. };
  9412. if (!ctx) {
  9413. session = nullptr;
  9414. return fail(Error::SSLConnection, 0, 0);
  9415. }
  9416. // With Windows verification on and no server certificate verifier set,
  9417. // Schannel is the only chain verifier. The backend's trust store is a
  9418. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9419. // demand, so the backend's verdict is not used.
  9420. auto windows_verifies_chain = false;
  9421. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9422. windows_verifies_chain = options.windows_cert_verification &&
  9423. !options.server_certificate_verifier_set;
  9424. #endif
  9425. {
  9426. std::unique_lock<std::mutex> guard;
  9427. if (options.ctx_mutex) {
  9428. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9429. }
  9430. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9431. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9432. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9433. // all verification post-handshake. Unless Schannel verifies the chain
  9434. // instead, chain verification happens during the handshake even for IP
  9435. // hosts; the certificate identity is verified post-handshake via
  9436. // verify_hostname().
  9437. set_verify_client(ctx, server_certificate_verification &&
  9438. !windows_verifies_chain);
  9439. #endif
  9440. session = create_session(ctx, sock);
  9441. }
  9442. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9443. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9444. // their identity is checked post-handshake below instead. On Mbed TLS and
  9445. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9446. // options.server_hostname_verification is threaded through here.
  9447. if (!is_ip_address(host)) {
  9448. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9449. return fail(Error::SSLConnection, 0, get_error());
  9450. }
  9451. }
  9452. TlsError tls_err;
  9453. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9454. &tls_err)) {
  9455. auto error = Error::SSLConnection;
  9456. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9457. error = Error::SSLServerVerification;
  9458. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9459. error = Error::SSLServerHostnameVerification;
  9460. }
  9461. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9462. }
  9463. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9464. if (options.session_verifier) {
  9465. verification_status = options.session_verifier(session);
  9466. }
  9467. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9468. return fail(Error::SSLServerVerification, 0, get_error());
  9469. }
  9470. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9471. server_certificate_verification) {
  9472. if (!windows_verifies_chain) {
  9473. auto verify_result = get_verify_result(session);
  9474. if (verify_result != 0) {
  9475. return fail(Error::SSLServerVerification, 0,
  9476. static_cast<uint64_t>(verify_result));
  9477. }
  9478. }
  9479. auto server_cert = get_peer_cert(session);
  9480. if (!server_cert) {
  9481. return fail(Error::SSLServerVerification, 0, get_error());
  9482. }
  9483. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9484. // Identity check against the peer certificate, post-handshake for all
  9485. // backends. For IP hosts this is the only identity verification, since no
  9486. // hostname is bound during the handshake.
  9487. if (options.server_hostname_verification) {
  9488. if (!verify_hostname(server_cert, host.c_str())) {
  9489. return fail(Error::SSLServerHostnameVerification, 0,
  9490. hostname_mismatch_code());
  9491. }
  9492. }
  9493. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9494. // Windows Schannel verification, which lets Windows fetch missing roots
  9495. // and intermediates on demand. It must not be skipped: unless a server
  9496. // certificate verifier is set, it is the only chain check.
  9497. if (options.windows_cert_verification) {
  9498. std::vector<unsigned char> der;
  9499. uint64_t wincrypt_error = 0;
  9500. if (!get_cert_der(server_cert, der) ||
  9501. !verify_cert_with_windows_schannel(
  9502. der, host, options.server_hostname_verification, wincrypt_error,
  9503. session)) {
  9504. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9505. }
  9506. }
  9507. #endif
  9508. }
  9509. return true;
  9510. }
  9511. } // namespace detail
  9512. #endif // CPPHTTPLIB_SSL_ENABLED
  9513. /*
  9514. * Group 3: httplib namespace - Non-SSL public API implementations
  9515. */
  9516. inline void default_socket_options(socket_t sock) {
  9517. set_socket_opt(sock, SOL_SOCKET,
  9518. #ifdef SO_REUSEPORT
  9519. SO_REUSEPORT,
  9520. #else
  9521. SO_REUSEADDR,
  9522. #endif
  9523. 1);
  9524. }
  9525. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9526. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9527. sizeof(optval));
  9528. }
  9529. inline std::string get_bearer_token_auth(const Request &req) {
  9530. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9531. // than the prefix carries no token.
  9532. constexpr const char bearer_prefix[] = "Bearer ";
  9533. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9534. auto value = req.get_header_value("Authorization");
  9535. if (value.size() >= bearer_prefix_len &&
  9536. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9537. bearer_prefix)) {
  9538. return value.substr(bearer_prefix_len);
  9539. }
  9540. return "";
  9541. }
  9542. inline const char *status_message(int status) {
  9543. switch (status) {
  9544. case StatusCode::Continue_100: return "Continue";
  9545. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9546. case StatusCode::Processing_102: return "Processing";
  9547. case StatusCode::EarlyHints_103: return "Early Hints";
  9548. case StatusCode::OK_200: return "OK";
  9549. case StatusCode::Created_201: return "Created";
  9550. case StatusCode::Accepted_202: return "Accepted";
  9551. case StatusCode::NonAuthoritativeInformation_203:
  9552. return "Non-Authoritative Information";
  9553. case StatusCode::NoContent_204: return "No Content";
  9554. case StatusCode::ResetContent_205: return "Reset Content";
  9555. case StatusCode::PartialContent_206: return "Partial Content";
  9556. case StatusCode::MultiStatus_207: return "Multi-Status";
  9557. case StatusCode::AlreadyReported_208: return "Already Reported";
  9558. case StatusCode::IMUsed_226: return "IM Used";
  9559. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9560. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9561. case StatusCode::Found_302: return "Found";
  9562. case StatusCode::SeeOther_303: return "See Other";
  9563. case StatusCode::NotModified_304: return "Not Modified";
  9564. case StatusCode::UseProxy_305: return "Use Proxy";
  9565. case StatusCode::unused_306: return "unused";
  9566. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9567. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9568. case StatusCode::BadRequest_400: return "Bad Request";
  9569. case StatusCode::Unauthorized_401: return "Unauthorized";
  9570. case StatusCode::PaymentRequired_402: return "Payment Required";
  9571. case StatusCode::Forbidden_403: return "Forbidden";
  9572. case StatusCode::NotFound_404: return "Not Found";
  9573. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9574. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9575. case StatusCode::ProxyAuthenticationRequired_407:
  9576. return "Proxy Authentication Required";
  9577. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9578. case StatusCode::Conflict_409: return "Conflict";
  9579. case StatusCode::Gone_410: return "Gone";
  9580. case StatusCode::LengthRequired_411: return "Length Required";
  9581. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9582. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9583. case StatusCode::UriTooLong_414: return "URI Too Long";
  9584. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9585. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9586. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9587. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9588. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9589. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9590. case StatusCode::Locked_423: return "Locked";
  9591. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9592. case StatusCode::TooEarly_425: return "Too Early";
  9593. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9594. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9595. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9596. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9597. return "Request Header Fields Too Large";
  9598. case StatusCode::UnavailableForLegalReasons_451:
  9599. return "Unavailable For Legal Reasons";
  9600. case StatusCode::NotImplemented_501: return "Not Implemented";
  9601. case StatusCode::BadGateway_502: return "Bad Gateway";
  9602. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9603. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9604. case StatusCode::HttpVersionNotSupported_505:
  9605. return "HTTP Version Not Supported";
  9606. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9607. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9608. case StatusCode::LoopDetected_508: return "Loop Detected";
  9609. case StatusCode::NotExtended_510: return "Not Extended";
  9610. case StatusCode::NetworkAuthenticationRequired_511:
  9611. return "Network Authentication Required";
  9612. default:
  9613. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9614. }
  9615. }
  9616. inline std::string to_string(const Error error) {
  9617. switch (error) {
  9618. case Error::Success: return "Success (no error)";
  9619. case Error::Unknown: return "Unknown";
  9620. case Error::Connection: return "Could not establish connection";
  9621. case Error::BindIPAddress: return "Failed to bind IP address";
  9622. case Error::Read: return "Failed to read connection";
  9623. case Error::Write: return "Failed to write connection";
  9624. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9625. case Error::Canceled: return "Connection handling canceled";
  9626. case Error::SSLConnection: return "SSL connection failed";
  9627. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9628. case Error::SSLServerVerification: return "SSL server verification failed";
  9629. case Error::SSLServerHostnameVerification:
  9630. return "SSL server hostname verification failed";
  9631. case Error::UnsupportedMultipartBoundaryChars:
  9632. return "Unsupported HTTP multipart boundary characters";
  9633. case Error::Compression: return "Compression failed";
  9634. case Error::ConnectionTimeout: return "Connection timed out";
  9635. case Error::ProxyConnection: return "Proxy connection failed";
  9636. case Error::ConnectionClosed: return "Connection closed by server";
  9637. case Error::Timeout: return "Read timeout";
  9638. case Error::ResourceExhaustion: return "Resource exhaustion";
  9639. case Error::TooManyFormDataFiles: return "Too many form data files";
  9640. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9641. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9642. case Error::ExceedMaxSocketDescriptorCount:
  9643. return "Exceeded maximum socket descriptor count";
  9644. case Error::InvalidRequestLine: return "Invalid request line";
  9645. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9646. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9647. case Error::InvalidHeaders: return "Invalid headers";
  9648. case Error::MultipartParsing: return "Multipart parsing failed";
  9649. case Error::OpenFile: return "Failed to open file";
  9650. case Error::Listen: return "Failed to listen on socket";
  9651. case Error::GetSockName: return "Failed to get socket name";
  9652. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9653. case Error::HTTPParsing: return "HTTP parsing failed";
  9654. case Error::InvalidRangeHeader: return "Invalid Range header";
  9655. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9656. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9657. case Error::UserCallbackException: return "User callback threw an exception";
  9658. default: break;
  9659. }
  9660. return "Invalid";
  9661. }
  9662. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9663. os << to_string(obj);
  9664. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9665. return os;
  9666. }
  9667. inline std::string hosted_at(const std::string &hostname) {
  9668. std::vector<std::string> addrs;
  9669. hosted_at(hostname, addrs);
  9670. if (addrs.empty()) { return std::string(); }
  9671. return addrs[0];
  9672. }
  9673. inline void hosted_at(const std::string &hostname,
  9674. std::vector<std::string> &addrs) {
  9675. struct addrinfo hints;
  9676. struct addrinfo *result;
  9677. memset(&hints, 0, sizeof(struct addrinfo));
  9678. hints.ai_family = AF_UNSPEC;
  9679. hints.ai_socktype = SOCK_STREAM;
  9680. hints.ai_protocol = 0;
  9681. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9682. &result, 0)) {
  9683. #if defined __linux__ && !defined __ANDROID__
  9684. res_init();
  9685. #endif
  9686. return;
  9687. }
  9688. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9689. for (auto rp = result; rp; rp = rp->ai_next) {
  9690. const auto &addr =
  9691. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9692. std::string ip;
  9693. auto dummy = -1;
  9694. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9695. dummy)) {
  9696. addrs.emplace_back(std::move(ip));
  9697. }
  9698. }
  9699. }
  9700. inline std::string encode_uri_component(const std::string &value) {
  9701. std::ostringstream escaped;
  9702. escaped.fill('0');
  9703. escaped << std::hex;
  9704. for (auto c : value) {
  9705. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9706. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9707. escaped << c;
  9708. } else {
  9709. escaped << std::uppercase;
  9710. escaped << '%' << std::setw(2)
  9711. << static_cast<int>(static_cast<unsigned char>(c));
  9712. escaped << std::nouppercase;
  9713. }
  9714. }
  9715. return escaped.str();
  9716. }
  9717. inline std::string encode_uri(const std::string &value) {
  9718. std::ostringstream escaped;
  9719. escaped.fill('0');
  9720. escaped << std::hex;
  9721. for (auto c : value) {
  9722. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9723. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9724. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9725. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9726. escaped << c;
  9727. } else {
  9728. escaped << std::uppercase;
  9729. escaped << '%' << std::setw(2)
  9730. << static_cast<int>(static_cast<unsigned char>(c));
  9731. escaped << std::nouppercase;
  9732. }
  9733. }
  9734. return escaped.str();
  9735. }
  9736. inline std::string decode_uri_component(const std::string &value) {
  9737. std::string result;
  9738. for (size_t i = 0; i < value.size(); i++) {
  9739. if (value[i] == '%' && i + 2 < value.size()) {
  9740. auto val = 0;
  9741. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9742. result += static_cast<char>(val);
  9743. i += 2;
  9744. } else {
  9745. result += value[i];
  9746. }
  9747. } else {
  9748. result += value[i];
  9749. }
  9750. }
  9751. return result;
  9752. }
  9753. inline std::string decode_uri(const std::string &value) {
  9754. std::string result;
  9755. for (size_t i = 0; i < value.size(); i++) {
  9756. if (value[i] == '%' && i + 2 < value.size()) {
  9757. auto val = 0;
  9758. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9759. auto c = static_cast<char>(val);
  9760. // Keep escapes of the reserved characters that encode_uri leaves
  9761. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9762. // delimiter is not promoted into a real one (as with JS decodeURI).
  9763. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9764. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9765. c == '#') {
  9766. result += value[i];
  9767. result += value[i + 1];
  9768. result += value[i + 2];
  9769. } else {
  9770. result += c;
  9771. }
  9772. i += 2;
  9773. } else {
  9774. result += value[i];
  9775. }
  9776. } else {
  9777. result += value[i];
  9778. }
  9779. }
  9780. return result;
  9781. }
  9782. inline std::string encode_path_component(const std::string &component) {
  9783. std::string result;
  9784. result.reserve(component.size() * 3);
  9785. for (size_t i = 0; i < component.size(); i++) {
  9786. auto c = static_cast<unsigned char>(component[i]);
  9787. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9788. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9789. c == '_' || c == '~') {
  9790. result += static_cast<char>(c);
  9791. }
  9792. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9793. // "," / ";" / "="
  9794. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9795. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9796. c == '=') {
  9797. result += static_cast<char>(c);
  9798. }
  9799. // Colon is allowed in path segments except first segment
  9800. else if (c == ':') {
  9801. result += static_cast<char>(c);
  9802. }
  9803. // @ is allowed in path
  9804. else if (c == '@') {
  9805. result += static_cast<char>(c);
  9806. } else {
  9807. result += '%';
  9808. char hex[3];
  9809. snprintf(hex, sizeof(hex), "%02X", c);
  9810. result.append(hex, 2);
  9811. }
  9812. }
  9813. return result;
  9814. }
  9815. inline std::string decode_path_component(const std::string &component) {
  9816. std::string result;
  9817. result.reserve(component.size());
  9818. for (size_t i = 0; i < component.size(); i++) {
  9819. if (component[i] == '%' && i + 1 < component.size()) {
  9820. if (component[i + 1] == 'u') {
  9821. // Unicode %uXXXX encoding
  9822. auto val = 0;
  9823. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9824. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9825. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9826. char buff[4];
  9827. size_t len = detail::to_utf8(val, buff);
  9828. if (len > 0) {
  9829. result.append(buff, len);
  9830. i += 5; // 'u0000'
  9831. } else {
  9832. // A surrogate is no character. Dropping it would join what is on
  9833. // either side of it, so the escape is kept as it is.
  9834. result += component[i];
  9835. }
  9836. } else {
  9837. result += component[i];
  9838. }
  9839. } else {
  9840. // Standard %XX encoding
  9841. auto val = 0;
  9842. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9843. // 2 digits hex codes
  9844. result += static_cast<char>(val);
  9845. i += 2; // 'XX'
  9846. } else {
  9847. result += component[i];
  9848. }
  9849. }
  9850. } else {
  9851. result += component[i];
  9852. }
  9853. }
  9854. return result;
  9855. }
  9856. inline std::string encode_query_component(const std::string &component,
  9857. bool space_as_plus) {
  9858. std::string result;
  9859. result.reserve(component.size() * 3);
  9860. for (size_t i = 0; i < component.size(); i++) {
  9861. auto c = static_cast<unsigned char>(component[i]);
  9862. // Unreserved characters per RFC 3986
  9863. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9864. c == '_' || c == '~') {
  9865. result += static_cast<char>(c);
  9866. }
  9867. // Space handling
  9868. else if (c == ' ') {
  9869. if (space_as_plus) {
  9870. result += '+';
  9871. } else {
  9872. result += "%20";
  9873. }
  9874. }
  9875. // Plus sign handling
  9876. else if (c == '+') {
  9877. if (space_as_plus) {
  9878. result += "%2B";
  9879. } else {
  9880. result += static_cast<char>(c);
  9881. }
  9882. }
  9883. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9884. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9885. c == '*' || c == ',' || c == ';') {
  9886. result += static_cast<char>(c);
  9887. }
  9888. // Colon and @ are allowed in query
  9889. else if (c == ':' || c == '@') {
  9890. result += static_cast<char>(c);
  9891. }
  9892. // Forward slash is allowed in query values
  9893. else if (c == '/') {
  9894. result += static_cast<char>(c);
  9895. }
  9896. // Question mark is allowed in query values (after first ?)
  9897. else if (c == '?') {
  9898. result += static_cast<char>(c);
  9899. } else {
  9900. result += '%';
  9901. char hex[3];
  9902. snprintf(hex, sizeof(hex), "%02X", c);
  9903. result.append(hex, 2);
  9904. }
  9905. }
  9906. return result;
  9907. }
  9908. inline std::string decode_query_component(const std::string &component,
  9909. bool plus_as_space) {
  9910. std::string result;
  9911. result.reserve(component.size());
  9912. for (size_t i = 0; i < component.size(); i++) {
  9913. if (component[i] == '%' && i + 2 < component.size()) {
  9914. auto val = 0;
  9915. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9916. result += static_cast<char>(val);
  9917. i += 2;
  9918. } else {
  9919. result += component[i];
  9920. }
  9921. } else if (component[i] == '+' && plus_as_space) {
  9922. result += ' '; // + becomes space in form-urlencoded
  9923. } else {
  9924. result += component[i];
  9925. }
  9926. }
  9927. return result;
  9928. }
  9929. inline std::string sanitize_filename(const std::string &filename) {
  9930. // Extract basename: find the last path separator (/ or \)
  9931. auto pos = filename.find_last_of("/\\");
  9932. auto result =
  9933. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9934. // Strip null bytes
  9935. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9936. // Trim whitespace
  9937. {
  9938. auto start = result.find_first_not_of(" \t");
  9939. auto end = result.find_last_not_of(" \t");
  9940. result = (start == std::string::npos)
  9941. ? ""
  9942. : result.substr(start, end - start + 1);
  9943. }
  9944. // Reject . and ..
  9945. if (result == "." || result == "..") { return ""; }
  9946. return result;
  9947. }
  9948. inline std::string append_query_params(const std::string &path,
  9949. const Params &params) {
  9950. std::string path_with_query = path;
  9951. path_with_query += path.find('?') == std::string::npos ? '?' : '&';
  9952. path_with_query += detail::params_to_query_str(params);
  9953. return path_with_query;
  9954. }
  9955. // Header utilities
  9956. inline std::pair<std::string, std::string>
  9957. make_range_header(const Ranges &ranges) {
  9958. std::string field = "bytes=";
  9959. auto i = 0;
  9960. for (const auto &r : ranges) {
  9961. if (i != 0) { field += ", "; }
  9962. if (r.first != -1) { field += std::to_string(r.first); }
  9963. field += '-';
  9964. if (r.second != -1) { field += std::to_string(r.second); }
  9965. i++;
  9966. }
  9967. return std::make_pair("Range", std::move(field));
  9968. }
  9969. inline std::pair<std::string, std::string>
  9970. make_basic_authentication_header(const std::string &username,
  9971. const std::string &password, bool is_proxy) {
  9972. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9973. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9974. return std::make_pair(key, std::move(field));
  9975. }
  9976. inline std::pair<std::string, std::string>
  9977. make_bearer_token_authentication_header(const std::string &token,
  9978. bool is_proxy = false) {
  9979. auto field = "Bearer " + token;
  9980. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9981. return std::make_pair(key, std::move(field));
  9982. }
  9983. // Request implementation
  9984. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9985. size_t id) const {
  9986. return detail::get_header_value_u64(headers, key, def, id);
  9987. }
  9988. inline bool Request::has_header(const std::string &key) const {
  9989. return detail::has_header(headers, key);
  9990. }
  9991. inline std::string Request::get_header_value(const std::string &key,
  9992. const char *def, size_t id) const {
  9993. return detail::get_header_value(headers, key, def, id);
  9994. }
  9995. inline size_t Request::get_header_value_count(const std::string &key) const {
  9996. return detail::get_header_value_count(headers, key);
  9997. }
  9998. inline void Request::set_header(const std::string &key,
  9999. const std::string &val) {
  10000. detail::set_header(headers, key, val);
  10001. }
  10002. inline bool Request::has_trailer(const std::string &key) const {
  10003. return trailers.find(key) != trailers.end();
  10004. }
  10005. inline std::string Request::get_trailer_value(const std::string &key,
  10006. size_t id) const {
  10007. return detail::get_multimap_value(trailers, key, id);
  10008. }
  10009. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10010. return trailers.count(key);
  10011. }
  10012. inline bool Request::has_param(const std::string &key) const {
  10013. return params.find(key) != params.end();
  10014. }
  10015. inline std::string Request::get_param_value(const std::string &key,
  10016. size_t id) const {
  10017. return detail::get_multimap_value(params, key, id);
  10018. }
  10019. inline std::vector<std::string>
  10020. Request::get_param_values(const std::string &key) const {
  10021. auto rng = params.equal_range(key);
  10022. std::vector<std::string> values;
  10023. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10024. for (auto it = rng.first; it != rng.second; ++it) {
  10025. values.push_back(it->second);
  10026. }
  10027. return values;
  10028. }
  10029. inline size_t Request::get_param_value_count(const std::string &key) const {
  10030. return params.count(key);
  10031. }
  10032. inline bool Request::is_multipart_form_data() const {
  10033. const auto &content_type = get_header_value("Content-Type");
  10034. return detail::extract_media_type(content_type) == "multipart/form-data";
  10035. }
  10036. // Multipart FormData implementation
  10037. inline std::string MultipartFormData::get_field(const std::string &key,
  10038. size_t id) const {
  10039. auto rng = fields.equal_range(key);
  10040. auto it = detail::bounded_next(rng.first, id, rng.second);
  10041. if (it != rng.second) { return it->second.content; }
  10042. return std::string();
  10043. }
  10044. inline std::vector<std::string>
  10045. MultipartFormData::get_fields(const std::string &key) const {
  10046. std::vector<std::string> values;
  10047. auto rng = fields.equal_range(key);
  10048. for (auto it = rng.first; it != rng.second; it++) {
  10049. values.push_back(it->second.content);
  10050. }
  10051. return values;
  10052. }
  10053. inline bool MultipartFormData::has_field(const std::string &key) const {
  10054. return fields.find(key) != fields.end();
  10055. }
  10056. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10057. return fields.count(key);
  10058. }
  10059. inline FormData MultipartFormData::get_file(const std::string &key,
  10060. size_t id) const {
  10061. return detail::get_multimap_value(files, key, id);
  10062. }
  10063. inline std::vector<FormData>
  10064. MultipartFormData::get_files(const std::string &key) const {
  10065. std::vector<FormData> values;
  10066. auto rng = files.equal_range(key);
  10067. for (auto it = rng.first; it != rng.second; it++) {
  10068. values.push_back(it->second);
  10069. }
  10070. return values;
  10071. }
  10072. inline bool MultipartFormData::has_file(const std::string &key) const {
  10073. return files.find(key) != files.end();
  10074. }
  10075. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10076. return files.count(key);
  10077. }
  10078. // Multipart FormData writer implementation
  10079. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10080. return detail::is_multipart_boundary_chars_valid(boundary);
  10081. }
  10082. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10083. : boundary_(detail::make_multipart_data_boundary()) {}
  10084. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10085. : boundary_(std::move(boundary)) {}
  10086. inline const std::string &MultipartFormDataWriter::boundary() const {
  10087. return boundary_;
  10088. }
  10089. inline std::string MultipartFormDataWriter::content_type() const {
  10090. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10091. }
  10092. inline std::string
  10093. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10094. return detail::serialize_multipart_formdata(items, boundary_);
  10095. }
  10096. inline size_t MultipartFormDataWriter::content_length(
  10097. const UploadFormDataItems &items) const {
  10098. return detail::get_multipart_content_length(items, boundary_);
  10099. }
  10100. inline std::string
  10101. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10102. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10103. }
  10104. inline std::string MultipartFormDataWriter::item_end() {
  10105. return detail::serialize_multipart_formdata_item_end();
  10106. }
  10107. inline std::string MultipartFormDataWriter::finish() const {
  10108. return detail::serialize_multipart_formdata_finish(boundary_);
  10109. }
  10110. // Response implementation
  10111. namespace detail {
  10112. // A response has one content source: `body`, a content provider, or a file.
  10113. // Each content setter calls this so that the one called last wins.
  10114. inline void clear_content_provider(Response &res) {
  10115. auto releaser = std::move(res.content_provider_resource_releaser_);
  10116. auto success = res.content_provider_success_;
  10117. res.content_length_ = 0;
  10118. res.content_provider_ = nullptr;
  10119. res.content_provider_resource_releaser_ = nullptr;
  10120. res.is_chunked_content_provider_ = false;
  10121. res.is_file_content_provider_ = false;
  10122. res.content_provider_success_ = false;
  10123. res.content_coding_ = EncodingType::None;
  10124. res.file_content_path_.clear();
  10125. res.file_content_content_type_.clear();
  10126. if (releaser) { releaser(success); }
  10127. }
  10128. inline void clear_content(Response &res) {
  10129. res.body.clear();
  10130. clear_content_provider(res);
  10131. }
  10132. // `body` is public, so it can be assigned directly after a provider or a file
  10133. // was set. It came last, so it wins.
  10134. inline void prefer_assigned_body(Response &res) {
  10135. if (!res.body.empty() &&
  10136. (res.content_provider_ || !res.file_content_path_.empty())) {
  10137. clear_content_provider(res);
  10138. }
  10139. }
  10140. } // namespace detail
  10141. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10142. size_t id) const {
  10143. return detail::get_header_value_u64(headers, key, def, id);
  10144. }
  10145. inline bool Response::has_header(const std::string &key) const {
  10146. return headers.find(key) != headers.end();
  10147. }
  10148. inline std::string Response::get_header_value(const std::string &key,
  10149. const char *def,
  10150. size_t id) const {
  10151. return detail::get_header_value(headers, key, def, id);
  10152. }
  10153. inline size_t Response::get_header_value_count(const std::string &key) const {
  10154. return detail::get_header_value_count(headers, key);
  10155. }
  10156. inline void Response::set_header(const std::string &key,
  10157. const std::string &val) {
  10158. detail::set_header(headers, key, val);
  10159. }
  10160. inline bool Response::has_trailer(const std::string &key) const {
  10161. return trailers.find(key) != trailers.end();
  10162. }
  10163. inline std::string Response::get_trailer_value(const std::string &key,
  10164. size_t id) const {
  10165. return detail::get_multimap_value(trailers, key, id);
  10166. }
  10167. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10168. return trailers.count(key);
  10169. }
  10170. inline void Response::set_redirect(const std::string &url, int stat) {
  10171. if (detail::fields::is_field_value(url)) {
  10172. set_header("Location", url);
  10173. if (300 <= stat && stat < 400) {
  10174. this->status = stat;
  10175. } else {
  10176. this->status = StatusCode::Found_302;
  10177. }
  10178. }
  10179. }
  10180. inline void Response::set_content(const char *s, size_t n,
  10181. const std::string &content_type) {
  10182. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10183. detail::clear_content_provider(*this);
  10184. auto rng = headers.equal_range("Content-Type");
  10185. headers.erase(rng.first, rng.second);
  10186. set_header("Content-Type", content_type);
  10187. }
  10188. inline void Response::set_content(const std::string &s,
  10189. const std::string &content_type) {
  10190. set_content(s.data(), s.size(), content_type);
  10191. }
  10192. inline void Response::set_content(std::string &&s,
  10193. const std::string &content_type) {
  10194. body = std::move(s);
  10195. detail::clear_content_provider(*this);
  10196. auto rng = headers.equal_range("Content-Type");
  10197. headers.erase(rng.first, rng.second);
  10198. set_header("Content-Type", content_type);
  10199. }
  10200. inline void Response::set_content_provider(
  10201. size_t in_length, const std::string &content_type, ContentProvider provider,
  10202. ContentProviderResourceReleaser resource_releaser) {
  10203. detail::clear_content(*this);
  10204. set_header("Content-Type", content_type);
  10205. content_length_ = in_length;
  10206. if (in_length > 0) { content_provider_ = std::move(provider); }
  10207. content_provider_resource_releaser_ = std::move(resource_releaser);
  10208. }
  10209. inline void Response::set_content_provider(
  10210. const std::string &content_type, ContentProviderWithoutLength provider,
  10211. ContentProviderResourceReleaser resource_releaser) {
  10212. detail::clear_content(*this);
  10213. set_header("Content-Type", content_type);
  10214. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10215. content_provider_resource_releaser_ = std::move(resource_releaser);
  10216. }
  10217. inline void Response::set_chunked_content_provider(
  10218. const std::string &content_type, ContentProviderWithoutLength provider,
  10219. ContentProviderResourceReleaser resource_releaser) {
  10220. set_content_provider(content_type, std::move(provider),
  10221. std::move(resource_releaser));
  10222. is_chunked_content_provider_ = true;
  10223. }
  10224. inline void Response::set_file_content(const std::string &path,
  10225. const std::string &content_type) {
  10226. detail::clear_content(*this);
  10227. file_content_path_ = path;
  10228. file_content_content_type_ = content_type;
  10229. }
  10230. inline void Response::set_file_content(const std::string &path) {
  10231. set_file_content(path, std::string());
  10232. }
  10233. // Result implementation
  10234. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10235. size_t def,
  10236. size_t id) const {
  10237. return detail::get_header_value_u64(request_headers_, key, def, id);
  10238. }
  10239. inline bool Result::has_request_header(const std::string &key) const {
  10240. return request_headers_.find(key) != request_headers_.end();
  10241. }
  10242. inline std::string Result::get_request_header_value(const std::string &key,
  10243. const char *def,
  10244. size_t id) const {
  10245. return detail::get_header_value(request_headers_, key, def, id);
  10246. }
  10247. inline size_t
  10248. Result::get_request_header_value_count(const std::string &key) const {
  10249. return request_headers_.count(key);
  10250. }
  10251. // Stream implementation
  10252. inline ssize_t Stream::write(const char *ptr) {
  10253. return write(ptr, strlen(ptr));
  10254. }
  10255. inline ssize_t Stream::write(const std::string &s) {
  10256. return write(s.data(), s.size());
  10257. }
  10258. // BodyReader implementation
  10259. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10260. if (!stream) {
  10261. last_error = Error::Connection;
  10262. return -1;
  10263. }
  10264. if (eof) { return 0; }
  10265. if (!chunked) {
  10266. // Content-Length based reading
  10267. if (has_content_length && bytes_read >= content_length) {
  10268. eof = true;
  10269. return 0;
  10270. }
  10271. auto to_read = len;
  10272. if (has_content_length) {
  10273. auto remaining = content_length - bytes_read;
  10274. to_read = (std::min)(len, remaining);
  10275. }
  10276. auto n = stream->read(buf, to_read);
  10277. if (n < 0) {
  10278. last_error = stream->get_error();
  10279. if (last_error == Error::Success) { last_error = Error::Read; }
  10280. eof = true;
  10281. return n;
  10282. }
  10283. if (n == 0) {
  10284. // Unexpected EOF before content_length
  10285. last_error = stream->get_error();
  10286. if (last_error == Error::Success) { last_error = Error::Read; }
  10287. eof = true;
  10288. return 0;
  10289. }
  10290. bytes_read += static_cast<size_t>(n);
  10291. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10292. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10293. last_error = Error::ExceedMaxPayloadSize;
  10294. eof = true;
  10295. return -1;
  10296. }
  10297. return n;
  10298. }
  10299. // Chunked transfer encoding: delegate to shared decoder instance.
  10300. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10301. size_t chunk_offset = 0;
  10302. size_t chunk_total = 0;
  10303. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10304. if (n < 0) {
  10305. last_error = stream->get_error();
  10306. if (last_error == Error::Success) { last_error = Error::Read; }
  10307. eof = true;
  10308. return n;
  10309. }
  10310. if (n == 0) {
  10311. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10312. eof = true;
  10313. return 0;
  10314. }
  10315. bytes_read += static_cast<size_t>(n);
  10316. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10317. last_error = Error::ExceedMaxPayloadSize;
  10318. eof = true;
  10319. return -1;
  10320. }
  10321. return n;
  10322. }
  10323. // ThreadPool implementation
  10324. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10325. time_t idle_timeout_sec)
  10326. : base_thread_count_(n), max_queued_requests_(mqr),
  10327. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10328. shutdown_(false) {
  10329. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10330. if (max_n != 0 && max_n < n) {
  10331. std::string msg = "max_threads must be >= base_threads";
  10332. throw std::invalid_argument(msg);
  10333. }
  10334. #endif
  10335. max_thread_count_ = max_n == 0 ? n : max_n;
  10336. threads_.reserve(base_thread_count_);
  10337. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10338. try {
  10339. #endif
  10340. for (size_t i = 0; i < base_thread_count_; i++) {
  10341. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10342. }
  10343. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10344. } catch (...) {
  10345. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10346. // signal the workers we already spawned to exit and join them so the
  10347. // vector destructor does not see joinable threads (which would call
  10348. // std::terminate). Then rethrow so the caller learns of the failure.
  10349. {
  10350. std::unique_lock<std::mutex> lock(mutex_);
  10351. shutdown_ = true;
  10352. }
  10353. cond_.notify_all();
  10354. for (auto &t : threads_) {
  10355. if (t.joinable()) { t.join(); }
  10356. }
  10357. throw;
  10358. }
  10359. #endif
  10360. }
  10361. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10362. {
  10363. std::unique_lock<std::mutex> lock(mutex_);
  10364. if (shutdown_) { return false; }
  10365. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10366. return false;
  10367. }
  10368. jobs_.push_back(std::move(fn));
  10369. // Spawn a dynamic thread if no idle threads and under max
  10370. if (idle_thread_count_ == 0 &&
  10371. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10372. cleanup_finished_threads();
  10373. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10374. }
  10375. }
  10376. cond_.notify_one();
  10377. return true;
  10378. }
  10379. inline void ThreadPool::shutdown() {
  10380. {
  10381. std::unique_lock<std::mutex> lock(mutex_);
  10382. shutdown_ = true;
  10383. }
  10384. cond_.notify_all();
  10385. for (auto &t : threads_) {
  10386. if (t.joinable()) { t.join(); }
  10387. }
  10388. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10389. // with worker threads that call move_to_finished() concurrently.
  10390. std::list<std::thread> remaining_dynamic;
  10391. {
  10392. std::unique_lock<std::mutex> lock(mutex_);
  10393. remaining_dynamic = std::move(dynamic_threads_);
  10394. }
  10395. for (auto &t : remaining_dynamic) {
  10396. if (t.joinable()) { t.join(); }
  10397. }
  10398. std::unique_lock<std::mutex> lock(mutex_);
  10399. cleanup_finished_threads();
  10400. }
  10401. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10402. // Must be called with mutex_ held
  10403. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10404. if (it->get_id() == id) {
  10405. finished_threads_.push_back(std::move(*it));
  10406. dynamic_threads_.erase(it);
  10407. return;
  10408. }
  10409. }
  10410. }
  10411. inline void ThreadPool::cleanup_finished_threads() {
  10412. // Must be called with mutex_ held
  10413. for (auto &t : finished_threads_) {
  10414. if (t.joinable()) { t.join(); }
  10415. }
  10416. finished_threads_.clear();
  10417. }
  10418. inline void ThreadPool::worker(bool is_dynamic) {
  10419. for (;;) {
  10420. std::function<void()> fn;
  10421. {
  10422. std::unique_lock<std::mutex> lock(mutex_);
  10423. idle_thread_count_++;
  10424. if (is_dynamic) {
  10425. auto has_work =
  10426. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10427. [&] { return !jobs_.empty() || shutdown_; });
  10428. if (!has_work) {
  10429. // Timed out with no work - exit this dynamic thread
  10430. idle_thread_count_--;
  10431. move_to_finished(std::this_thread::get_id());
  10432. break;
  10433. }
  10434. } else {
  10435. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10436. }
  10437. idle_thread_count_--;
  10438. if (shutdown_ && jobs_.empty()) { break; }
  10439. fn = std::move(jobs_.front());
  10440. jobs_.pop_front();
  10441. }
  10442. assert(true == static_cast<bool>(fn));
  10443. fn();
  10444. }
  10445. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10446. !defined(LIBRESSL_VERSION_NUMBER)
  10447. OPENSSL_thread_stop();
  10448. #endif
  10449. }
  10450. /*
  10451. * Group 1 (continued): detail namespace - Stream implementations
  10452. */
  10453. namespace detail {
  10454. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10455. time_t timeout_sec, time_t timeout_usec,
  10456. time_t &actual_timeout_sec,
  10457. time_t &actual_timeout_usec) {
  10458. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10459. auto actual_timeout_msec =
  10460. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10461. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10462. actual_timeout_sec = actual_timeout_msec / 1000;
  10463. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10464. }
  10465. // Socket stream implementation
  10466. inline SocketStream::SocketStream(
  10467. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10468. time_t write_timeout_sec, time_t write_timeout_usec,
  10469. time_t max_timeout_msec,
  10470. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10471. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10472. read_timeout_usec_(read_timeout_usec),
  10473. write_timeout_sec_(write_timeout_sec),
  10474. write_timeout_usec_(write_timeout_usec),
  10475. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10476. read_buff_(read_buff_size_, 0) {}
  10477. inline SocketStream::~SocketStream() = default;
  10478. inline bool SocketStream::is_readable() const {
  10479. return read_buff_off_ < read_buff_content_size_;
  10480. }
  10481. inline bool SocketStream::wait_readable() const {
  10482. if (max_timeout_msec_ <= 0) {
  10483. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10484. }
  10485. time_t read_timeout_sec;
  10486. time_t read_timeout_usec;
  10487. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10488. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10489. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10490. }
  10491. inline bool SocketStream::wait_writable() const {
  10492. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10493. }
  10494. inline bool SocketStream::ensure_readable() {
  10495. if (readable_hint_) {
  10496. readable_hint_ = false;
  10497. return true;
  10498. }
  10499. return wait_readable();
  10500. }
  10501. inline const char *SocketStream::buffered_data(size_t &size) const {
  10502. size = read_buff_content_size_ - read_buff_off_;
  10503. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10504. }
  10505. inline void SocketStream::consume_buffered(size_t size) {
  10506. assert(size <= read_buff_content_size_ - read_buff_off_);
  10507. read_buff_off_ += size;
  10508. }
  10509. inline bool SocketStream::is_peer_alive() const {
  10510. return detail::is_socket_alive(sock_);
  10511. }
  10512. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10513. #ifdef _WIN32
  10514. size =
  10515. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10516. #else
  10517. size = (std::min)(size,
  10518. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10519. #endif
  10520. if (read_buff_off_ < read_buff_content_size_) {
  10521. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10522. if (size <= remaining_size) {
  10523. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10524. read_buff_off_ += size;
  10525. return static_cast<ssize_t>(size);
  10526. } else {
  10527. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10528. read_buff_off_ += remaining_size;
  10529. return static_cast<ssize_t>(remaining_size);
  10530. }
  10531. }
  10532. if (!ensure_readable()) {
  10533. error_ = Error::Timeout;
  10534. return -1;
  10535. }
  10536. read_buff_off_ = 0;
  10537. read_buff_content_size_ = 0;
  10538. if (size < read_buff_size_) {
  10539. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10540. CPPHTTPLIB_RECV_FLAGS);
  10541. if (n <= 0) {
  10542. if (n == 0) {
  10543. error_ = Error::ConnectionClosed;
  10544. } else {
  10545. error_ = Error::Read;
  10546. }
  10547. return n;
  10548. } else if (n <= static_cast<ssize_t>(size)) {
  10549. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10550. return n;
  10551. } else {
  10552. memcpy(ptr, read_buff_.data(), size);
  10553. read_buff_off_ = size;
  10554. read_buff_content_size_ = static_cast<size_t>(n);
  10555. return static_cast<ssize_t>(size);
  10556. }
  10557. } else {
  10558. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10559. if (n <= 0) {
  10560. if (n == 0) {
  10561. error_ = Error::ConnectionClosed;
  10562. } else {
  10563. error_ = Error::Read;
  10564. }
  10565. }
  10566. return n;
  10567. }
  10568. }
  10569. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10570. if (!wait_writable()) { return -1; }
  10571. #if defined(_WIN32) && !defined(_WIN64)
  10572. size =
  10573. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10574. #endif
  10575. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10576. }
  10577. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10578. int &port) const {
  10579. return detail::get_remote_ip_and_port(sock_, ip, port);
  10580. }
  10581. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10582. int &port) const {
  10583. return detail::get_local_ip_and_port(sock_, ip, port);
  10584. }
  10585. inline socket_t SocketStream::socket() const { return sock_; }
  10586. inline time_t SocketStream::duration() const {
  10587. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10588. std::chrono::steady_clock::now() - start_time_)
  10589. .count();
  10590. }
  10591. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10592. read_timeout_sec_ = sec;
  10593. read_timeout_usec_ = usec;
  10594. }
  10595. // Buffer stream implementation
  10596. inline bool BufferStream::is_readable() const { return true; }
  10597. inline bool BufferStream::wait_readable() const { return true; }
  10598. inline bool BufferStream::wait_writable() const { return true; }
  10599. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10600. #if defined(_MSC_VER) && _MSC_VER < 1910
  10601. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10602. #else
  10603. auto len_read = buffer.copy(ptr, size, position);
  10604. #endif
  10605. position += static_cast<size_t>(len_read);
  10606. return static_cast<ssize_t>(len_read);
  10607. }
  10608. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10609. buffer.append(ptr, size);
  10610. return static_cast<ssize_t>(size);
  10611. }
  10612. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10613. int & /*port*/) const {}
  10614. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10615. int & /*port*/) const {}
  10616. inline socket_t BufferStream::socket() const { return 0; }
  10617. inline time_t BufferStream::duration() const { return 0; }
  10618. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10619. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10620. : MatcherBase(pattern) {
  10621. constexpr const char marker[] = "/:";
  10622. // One past the last ending position of a path param substring
  10623. std::size_t last_param_end = 0;
  10624. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10625. // Needed to ensure that parameter names are unique during matcher
  10626. // construction
  10627. // If exceptions are disabled, only last duplicate path
  10628. // parameter will be set
  10629. std::unordered_set<std::string> param_name_set;
  10630. #endif
  10631. while (true) {
  10632. const auto marker_pos = pattern.find(
  10633. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10634. if (marker_pos == std::string::npos) { break; }
  10635. static_fragments_.push_back(
  10636. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10637. const auto param_name_start = marker_pos + str_len(marker);
  10638. auto sep_pos = pattern.find(separator, param_name_start);
  10639. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10640. auto param_name =
  10641. pattern.substr(param_name_start, sep_pos - param_name_start);
  10642. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10643. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10644. std::string msg = "Encountered path parameter '" + param_name +
  10645. "' multiple times in route pattern '" + pattern + "'.";
  10646. throw std::invalid_argument(msg);
  10647. }
  10648. #endif
  10649. param_names_.push_back(std::move(param_name));
  10650. last_param_end = sep_pos + 1;
  10651. }
  10652. if (last_param_end < pattern.length()) {
  10653. static_fragments_.push_back(pattern.substr(last_param_end));
  10654. }
  10655. }
  10656. inline bool PathParamsMatcher::match(Request &request) const {
  10657. request.matches = std::smatch();
  10658. request.path_params.clear();
  10659. // A pattern without parameters is just a literal path to compare against
  10660. if (param_names_.empty()) { return request.path == pattern(); }
  10661. request.path_params.reserve(param_names_.size());
  10662. // One past the position at which the path matched the pattern last time
  10663. std::size_t starting_pos = 0;
  10664. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10665. const auto &fragment = static_fragments_[i];
  10666. if (starting_pos + fragment.length() > request.path.length()) {
  10667. return false;
  10668. }
  10669. // Avoid unnecessary allocation by using strncmp instead of substr +
  10670. // comparison
  10671. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10672. fragment.length()) != 0) {
  10673. return false;
  10674. }
  10675. starting_pos += fragment.length();
  10676. // Should only happen when we have a static fragment after a param
  10677. // Example: '/users/:id/subscriptions'
  10678. // The 'subscriptions' fragment here does not have a corresponding param
  10679. if (i >= param_names_.size()) { continue; }
  10680. auto sep_pos = request.path.find(separator, starting_pos);
  10681. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10682. const auto &param_name = param_names_[i];
  10683. request.path_params.emplace(
  10684. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10685. // Mark everything up to '/' as matched
  10686. starting_pos = sep_pos + 1;
  10687. }
  10688. // Returns false if the path is longer than the pattern
  10689. return starting_pos >= request.path.length();
  10690. }
  10691. inline bool RegexMatcher::match(Request &request) const {
  10692. request.path_params.clear();
  10693. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10694. // a non-match rather than risking a stack overflow in std::regex_match.
  10695. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10696. return false;
  10697. }
  10698. return std::regex_match(request.path, request.matches, regex_);
  10699. }
  10700. // Enclose IPv6 address in brackets if needed
  10701. inline std::string prepare_host_string(const std::string &host) {
  10702. // Enclose IPv6 address in brackets (but not if already enclosed)
  10703. if (host.find(':') == std::string::npos ||
  10704. (!host.empty() && host[0] == '[')) {
  10705. // IPv4, hostname, or already bracketed IPv6
  10706. return host;
  10707. } else {
  10708. // IPv6 address without brackets
  10709. return "[" + host + "]";
  10710. }
  10711. }
  10712. inline std::string make_host_and_port_string(const std::string &host, int port,
  10713. bool is_ssl) {
  10714. auto result = prepare_host_string(host);
  10715. // Append port if not default
  10716. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10717. ; // do nothing
  10718. } else {
  10719. result += ":" + std::to_string(port);
  10720. }
  10721. return result;
  10722. }
  10723. // Create "host:port" string always including port number (for CONNECT method)
  10724. inline std::string
  10725. make_host_and_port_string_always_port(const std::string &host, int port) {
  10726. return prepare_host_string(host) + ":" + std::to_string(port);
  10727. }
  10728. // Value for the Host header a client sends when the caller supplied none.
  10729. // Only the value: callers decide where in their header list it goes.
  10730. inline std::string make_default_host_header_value(const std::string &host,
  10731. int port, bool is_ssl,
  10732. int address_family) {
  10733. if (address_family == AF_UNIX) { return "localhost"; }
  10734. return make_host_and_port_string(host, port, is_ssl);
  10735. }
  10736. inline void add_default_user_agent_header(Request &req) {
  10737. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10738. if (!req.has_header("User-Agent")) {
  10739. req.set_header("User-Agent",
  10740. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10741. }
  10742. #else
  10743. (void)req;
  10744. #endif
  10745. }
  10746. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10747. NormalizedTarget normalize_target(const std::string &host);
  10748. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10749. bool host_matches_no_proxy(const NormalizedTarget &target,
  10750. const std::vector<NoProxyEntry> &entries);
  10751. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10752. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10753. if (prefix_bits == 0) { return true; }
  10754. int full_bytes = prefix_bits / 8;
  10755. int rem_bits = prefix_bits % 8;
  10756. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10757. static_cast<size_t>(full_bytes)) != 0) {
  10758. return false;
  10759. }
  10760. if (rem_bits == 0) { return true; }
  10761. auto i = static_cast<size_t>(full_bytes);
  10762. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10763. return (ip[i] & mask) == (net[i] & mask);
  10764. }
  10765. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10766. if (token.empty()) { return false; }
  10767. if (token == "*") {
  10768. out.kind = NoProxyKind::Wildcard;
  10769. return true;
  10770. }
  10771. auto slash = token.find('/');
  10772. std::string addr_part =
  10773. (slash == std::string::npos) ? token : token.substr(0, slash);
  10774. std::string prefix_part =
  10775. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10776. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10777. // don't silently treat it as a /32 (or /128).
  10778. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10779. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10780. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10781. // when brackets are present.
  10782. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10783. addr_part.back() == ']';
  10784. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10785. if (!bracketed) {
  10786. struct in_addr v4;
  10787. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10788. int prefix = 32;
  10789. if (!prefix_part.empty() &&
  10790. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10791. prefix)) {
  10792. return false;
  10793. }
  10794. out.kind = NoProxyKind::IPv4Cidr;
  10795. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10796. out.prefix_bits = prefix;
  10797. return true;
  10798. }
  10799. }
  10800. struct in6_addr v6;
  10801. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10802. int prefix = 128;
  10803. if (!prefix_part.empty() &&
  10804. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10805. prefix)) {
  10806. return false;
  10807. }
  10808. out.kind = NoProxyKind::IPv6Cidr;
  10809. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10810. out.prefix_bits = prefix;
  10811. return true;
  10812. }
  10813. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10814. // the entry is malformed — don't fall through to the hostname branch.
  10815. if (bracketed) { return false; }
  10816. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10817. if (slash != std::string::npos) { return false; }
  10818. // Port-specific entries (host:port) are not supported.
  10819. if (token.find(':') != std::string::npos) { return false; }
  10820. std::string hostname = case_ignore::to_lower(token);
  10821. while (!hostname.empty() && hostname.front() == '.') {
  10822. hostname.erase(hostname.begin());
  10823. }
  10824. while (!hostname.empty() && hostname.back() == '.') {
  10825. hostname.pop_back();
  10826. }
  10827. if (hostname.empty()) { return false; }
  10828. out.kind = NoProxyKind::HostnameSuffix;
  10829. out.hostname_pattern = std::move(hostname);
  10830. return true;
  10831. }
  10832. inline NormalizedTarget normalize_target(const std::string &host) {
  10833. NormalizedTarget t;
  10834. std::string h = host;
  10835. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10836. h = h.substr(1, h.size() - 2);
  10837. }
  10838. // Strip a single trailing dot so "example.com." canonicalizes to
  10839. // "example.com".
  10840. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10841. t.hostname = case_ignore::to_lower(h);
  10842. if (!t.hostname.empty()) {
  10843. struct in_addr v4;
  10844. struct in6_addr v6;
  10845. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10846. t.is_ipv4 = true;
  10847. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10848. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10849. t.is_ipv6 = true;
  10850. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10851. }
  10852. }
  10853. return t;
  10854. }
  10855. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10856. const std::vector<NoProxyEntry> &entries) {
  10857. if (target.hostname.empty()) { return false; }
  10858. for (const auto &e : entries) {
  10859. switch (e.kind) {
  10860. case NoProxyKind::Wildcard: return true;
  10861. case NoProxyKind::IPv4Cidr:
  10862. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10863. return true;
  10864. }
  10865. break;
  10866. case NoProxyKind::IPv6Cidr:
  10867. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10868. return true;
  10869. }
  10870. break;
  10871. case NoProxyKind::HostnameSuffix:
  10872. if (target.is_ipv4 || target.is_ipv6) { break; }
  10873. if (target.hostname == e.hostname_pattern) { return true; }
  10874. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10875. // an entry of "example.com".
  10876. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10877. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10878. if (target.hostname[offset - 1] == '.' &&
  10879. target.hostname.compare(offset, e.hostname_pattern.size(),
  10880. e.hostname_pattern) == 0) {
  10881. return true;
  10882. }
  10883. }
  10884. break;
  10885. }
  10886. }
  10887. return false;
  10888. }
  10889. template <typename T>
  10890. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10891. T header_writer, Error &error) {
  10892. for (const auto &h : headers) {
  10893. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10894. error = Error::InvalidHeaders;
  10895. return false;
  10896. }
  10897. }
  10898. if (header_writer(strm, headers) <= 0) {
  10899. error = Error::Write;
  10900. return false;
  10901. }
  10902. return true;
  10903. }
  10904. } // namespace detail
  10905. /*
  10906. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10907. */
  10908. #ifdef CPPHTTPLIB_SSL_ENABLED
  10909. namespace detail {
  10910. // SSL socket stream implementation
  10911. inline SSLSocketStream::SSLSocketStream(
  10912. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10913. time_t read_timeout_usec, time_t write_timeout_sec,
  10914. time_t write_timeout_usec, time_t max_timeout_msec,
  10915. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10916. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10917. read_timeout_usec_(read_timeout_usec),
  10918. write_timeout_sec_(write_timeout_sec),
  10919. write_timeout_usec_(write_timeout_usec),
  10920. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10921. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10922. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10923. // Note: create_session() also clears this, but SSLClient currently
  10924. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10925. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10926. // SSL session was created.
  10927. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10928. #endif
  10929. }
  10930. inline SSLSocketStream::~SSLSocketStream() = default;
  10931. inline bool SSLSocketStream::is_readable() const {
  10932. return tls::pending(session_) > 0;
  10933. }
  10934. inline bool SSLSocketStream::wait_readable() const {
  10935. if (max_timeout_msec_ <= 0) {
  10936. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10937. }
  10938. time_t read_timeout_sec;
  10939. time_t read_timeout_usec;
  10940. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10941. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10942. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10943. }
  10944. inline bool SSLSocketStream::wait_writable() const {
  10945. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10946. !tls::is_peer_closed(session_, sock_);
  10947. }
  10948. inline bool SSLSocketStream::ensure_readable() {
  10949. if (readable_hint_) {
  10950. readable_hint_ = false;
  10951. return true;
  10952. }
  10953. return wait_readable();
  10954. }
  10955. inline bool SSLSocketStream::is_peer_alive() const {
  10956. return !tls::is_peer_closed(session_, sock_);
  10957. }
  10958. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10959. if (tls::pending(session_) > 0) {
  10960. tls::TlsError err;
  10961. auto ret = tls::read(session_, ptr, size, err);
  10962. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10963. error_ = Error::ConnectionClosed;
  10964. }
  10965. return ret;
  10966. } else if (ensure_readable()) {
  10967. tls::TlsError err;
  10968. auto ret = tls::read(session_, ptr, size, err);
  10969. if (ret < 0) {
  10970. auto n = 1000;
  10971. #ifdef _WIN32
  10972. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10973. (err.code == tls::ErrorCode::SyscallError &&
  10974. WSAGetLastError() == WSAETIMEDOUT))) {
  10975. #else
  10976. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10977. #endif
  10978. if (tls::pending(session_) > 0) {
  10979. return tls::read(session_, ptr, size, err);
  10980. } else if (wait_readable()) {
  10981. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10982. ret = tls::read(session_, ptr, size, err);
  10983. if (ret >= 0) { return ret; }
  10984. } else {
  10985. break;
  10986. }
  10987. }
  10988. assert(ret < 0);
  10989. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10990. error_ = Error::ConnectionClosed;
  10991. }
  10992. return ret;
  10993. } else {
  10994. error_ = Error::Timeout;
  10995. return -1;
  10996. }
  10997. }
  10998. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10999. if (wait_writable()) {
  11000. auto handle_size =
  11001. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11002. tls::TlsError err;
  11003. auto ret = tls::write(session_, ptr, handle_size, err);
  11004. if (ret < 0) {
  11005. auto n = 1000;
  11006. #ifdef _WIN32
  11007. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11008. (err.code == tls::ErrorCode::SyscallError &&
  11009. WSAGetLastError() == WSAETIMEDOUT))) {
  11010. #else
  11011. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11012. #endif
  11013. if (wait_writable()) {
  11014. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11015. ret = tls::write(session_, ptr, handle_size, err);
  11016. if (ret >= 0) { return ret; }
  11017. } else {
  11018. break;
  11019. }
  11020. }
  11021. assert(ret < 0);
  11022. }
  11023. return ret;
  11024. }
  11025. return -1;
  11026. }
  11027. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11028. int &port) const {
  11029. detail::get_remote_ip_and_port(sock_, ip, port);
  11030. }
  11031. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11032. int &port) const {
  11033. detail::get_local_ip_and_port(sock_, ip, port);
  11034. }
  11035. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11036. inline time_t SSLSocketStream::duration() const {
  11037. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11038. std::chrono::steady_clock::now() - start_time_)
  11039. .count();
  11040. }
  11041. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11042. read_timeout_sec_ = sec;
  11043. read_timeout_usec_ = usec;
  11044. }
  11045. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11046. tls::session_t session,
  11047. time_t read_timeout_sec,
  11048. time_t read_timeout_usec,
  11049. time_t write_timeout_sec,
  11050. time_t write_timeout_usec)
  11051. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11052. read_timeout_usec_(read_timeout_usec),
  11053. write_timeout_sec_(write_timeout_sec),
  11054. write_timeout_usec_(write_timeout_usec),
  11055. start_time_(std::chrono::steady_clock::now()) {
  11056. // The receive and send paths run on different threads, so each TLS call is
  11057. // driven in non-blocking mode and readiness is awaited with select()
  11058. // outside the session lock. Set the socket non-blocking once here; it is
  11059. // never flipped back, so no thread races on the flag.
  11060. detail::set_nonblocking(sock_, true);
  11061. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11062. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11063. #endif
  11064. }
  11065. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11066. inline bool WebSocketSSLStream::is_readable() const {
  11067. std::lock_guard<std::mutex> guard(session_mutex_);
  11068. return tls::pending(session_) > 0;
  11069. }
  11070. inline bool WebSocketSSLStream::wait_readable() const {
  11071. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11072. }
  11073. inline bool WebSocketSSLStream::wait_writable() const {
  11074. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11075. // that probe toggles the socket's blocking flag, which would race with the
  11076. // concurrent reader on a permanently non-blocking socket.
  11077. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11078. }
  11079. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11080. tls::TlsError err;
  11081. auto n = 1000;
  11082. while (--n >= 0) {
  11083. {
  11084. std::lock_guard<std::mutex> guard(session_mutex_);
  11085. auto ret = tls::read(session_, ptr, size, err);
  11086. if (ret > 0) { return ret; }
  11087. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11088. error_ = Error::ConnectionClosed;
  11089. return ret;
  11090. }
  11091. }
  11092. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11093. // direction: the send path shares this session, so output it left pending
  11094. // has to be flushed before more input can be decrypted. Anything else is
  11095. // a hard error.
  11096. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11097. #ifdef _WIN32
  11098. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11099. needs_readable =
  11100. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11101. WSAGetLastError() == WSAETIMEDOUT);
  11102. #endif
  11103. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11104. error_ = Error::Read;
  11105. return -1;
  11106. }
  11107. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11108. error_ = Error::Timeout;
  11109. return -1;
  11110. }
  11111. }
  11112. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11113. // to tell a timeout from a close would otherwise see whatever the previous
  11114. // failure left behind (error_ is never cleared on success).
  11115. error_ = Error::Read;
  11116. return -1;
  11117. }
  11118. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11119. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11120. tls::TlsError err;
  11121. auto n = 1000;
  11122. while (--n >= 0) {
  11123. {
  11124. std::lock_guard<std::mutex> guard(session_mutex_);
  11125. auto ret = tls::write(session_, ptr, handle_size, err);
  11126. if (ret >= 0) { return ret; }
  11127. }
  11128. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11129. // or a post-handshake message must be consumed before the record goes
  11130. // out. Anything else is a hard error.
  11131. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11132. #ifdef _WIN32
  11133. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11134. needs_writable =
  11135. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11136. WSAGetLastError() == WSAETIMEDOUT);
  11137. #endif
  11138. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11139. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11140. }
  11141. return -1;
  11142. }
  11143. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11144. int &port) const {
  11145. detail::get_remote_ip_and_port(sock_, ip, port);
  11146. }
  11147. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11148. int &port) const {
  11149. detail::get_local_ip_and_port(sock_, ip, port);
  11150. }
  11151. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11152. inline time_t WebSocketSSLStream::duration() const {
  11153. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11154. std::chrono::steady_clock::now() - start_time_)
  11155. .count();
  11156. }
  11157. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11158. read_timeout_sec_ = sec;
  11159. read_timeout_usec_ = usec;
  11160. }
  11161. } // namespace detail
  11162. #endif // CPPHTTPLIB_SSL_ENABLED
  11163. /*
  11164. * Group 4: Server implementation
  11165. */
  11166. // HTTP server implementation
  11167. inline Server::Server()
  11168. : new_task_queue([] {
  11169. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11170. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11171. }) {
  11172. #ifndef _WIN32
  11173. signal(SIGPIPE, SIG_IGN);
  11174. #endif
  11175. }
  11176. inline Server::~Server() = default;
  11177. inline std::unique_ptr<detail::MatcherBase>
  11178. Server::make_matcher(const std::string &pattern) {
  11179. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11180. // a path params pattern
  11181. if (pattern.find("/:") != std::string::npos) {
  11182. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11183. }
  11184. // A pattern with no regex metacharacter only has to be compared literally,
  11185. // which is what PathParamsMatcher already does when it captures no
  11186. // parameter, so std::regex is only worth building for the patterns that
  11187. // actually need it
  11188. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11189. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11190. }
  11191. return detail::make_unique<detail::RegexMatcher>(pattern);
  11192. }
  11193. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11194. return add_handler(get_handlers_, pattern, std::move(handler));
  11195. }
  11196. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11197. return add_handler(post_handlers_, pattern, std::move(handler));
  11198. }
  11199. inline Server &Server::Post(const std::string &pattern,
  11200. HandlerWithContentReader handler) {
  11201. return add_handler(post_handlers_for_content_reader_, pattern,
  11202. std::move(handler));
  11203. }
  11204. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11205. return add_handler(put_handlers_, pattern, std::move(handler));
  11206. }
  11207. inline Server &Server::Put(const std::string &pattern,
  11208. HandlerWithContentReader handler) {
  11209. return add_handler(put_handlers_for_content_reader_, pattern,
  11210. std::move(handler));
  11211. }
  11212. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11213. return add_handler(patch_handlers_, pattern, std::move(handler));
  11214. }
  11215. inline Server &Server::Patch(const std::string &pattern,
  11216. HandlerWithContentReader handler) {
  11217. return add_handler(patch_handlers_for_content_reader_, pattern,
  11218. std::move(handler));
  11219. }
  11220. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11221. return add_handler(delete_handlers_, pattern, std::move(handler));
  11222. }
  11223. inline Server &Server::Delete(const std::string &pattern,
  11224. HandlerWithContentReader handler) {
  11225. return add_handler(delete_handlers_for_content_reader_, pattern,
  11226. std::move(handler));
  11227. }
  11228. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11229. return add_handler(options_handlers_, pattern, std::move(handler));
  11230. }
  11231. inline const std::set<std::string> &Server::builtin_methods() {
  11232. thread_local const std::set<std::string> methods{
  11233. "GET", "HEAD", "POST", "PUT", "DELETE",
  11234. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11235. return methods;
  11236. }
  11237. inline Server::CustomHandlerEntry *
  11238. Server::custom_entry_for_registration(const std::string &method) {
  11239. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11240. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11241. // routing() before the custom tables are consulted, so a route registered
  11242. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11243. // there and would be reachable, but they carry protocol-level meaning
  11244. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11245. // library does not route.
  11246. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11247. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11248. has_invalid_registration_ = true;
  11249. return nullptr;
  11250. }
  11251. return &custom_handlers_[method];
  11252. }
  11253. inline Server &Server::CustomRoute(const std::string &method,
  11254. const std::string &pattern,
  11255. Handler handler) {
  11256. auto *entry = custom_entry_for_registration(method);
  11257. if (!entry) { return *this; }
  11258. return add_handler(entry->handlers, pattern, std::move(handler));
  11259. }
  11260. inline Server &Server::CustomRoute(const std::string &method,
  11261. const std::string &pattern,
  11262. HandlerWithContentReader handler) {
  11263. auto *entry = custom_entry_for_registration(method);
  11264. if (!entry) { return *this; }
  11265. return add_handler(entry->handlers_for_content_reader, pattern,
  11266. std::move(handler));
  11267. }
  11268. inline const Server::CustomHandlerEntry *
  11269. Server::find_custom_entry(const std::string &method) const {
  11270. // find() alone would be correct here. The empty() check is what keeps the
  11271. // per-request cost off servers that never call CustomRoute(), which is the
  11272. // overwhelmingly common case; keep it rather than walking into the tree.
  11273. if (custom_handlers_.empty()) { return nullptr; }
  11274. auto it = custom_handlers_.find(method);
  11275. return it == custom_handlers_.end() ? nullptr : &it->second;
  11276. }
  11277. inline Server &Server::WebSocket(const std::string &pattern,
  11278. WebSocketHandler handler) {
  11279. websocket_handlers_.push_back(
  11280. {make_matcher(pattern), std::move(handler), nullptr});
  11281. return *this;
  11282. }
  11283. inline Server &Server::WebSocket(const std::string &pattern,
  11284. WebSocketHandler handler,
  11285. SubProtocolSelector sub_protocol_selector) {
  11286. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11287. std::move(sub_protocol_selector)});
  11288. return *this;
  11289. }
  11290. inline bool Server::set_base_dir(const std::string &dir,
  11291. const std::string &mount_point) {
  11292. return set_mount_point(mount_point, dir);
  11293. }
  11294. inline bool Server::set_mount_point(const std::string &mount_point,
  11295. const std::string &dir, Headers headers) {
  11296. detail::FileStat stat(dir);
  11297. if (stat.is_dir()) {
  11298. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11299. if (!mnt.empty() && mnt[0] == '/') {
  11300. // Without the resolved directory, a file could not be checked to be
  11301. // inside it.
  11302. std::string resolved_base;
  11303. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11304. return false;
  11305. }
  11306. #if defined(_WIN32)
  11307. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11308. resolved_base += '\\';
  11309. }
  11310. #else
  11311. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11312. #endif
  11313. base_dirs_.push_back(
  11314. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11315. return true;
  11316. }
  11317. }
  11318. return false;
  11319. }
  11320. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11321. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11322. if (it->mount_point == mount_point) {
  11323. base_dirs_.erase(it);
  11324. return true;
  11325. }
  11326. }
  11327. return false;
  11328. }
  11329. inline Server &
  11330. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11331. const std::string &mime) {
  11332. file_extension_and_mimetype_map_[ext] = mime;
  11333. return *this;
  11334. }
  11335. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11336. default_file_mimetype_ = mime;
  11337. return *this;
  11338. }
  11339. inline Server &Server::set_file_request_handler(Handler handler) {
  11340. file_request_handler_ = std::move(handler);
  11341. return *this;
  11342. }
  11343. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11344. std::true_type) {
  11345. error_handler_ = std::move(handler);
  11346. return *this;
  11347. }
  11348. inline Server &Server::set_error_handler_core(Handler handler,
  11349. std::false_type) {
  11350. error_handler_ = [handler](const Request &req, Response &res) {
  11351. handler(req, res);
  11352. return HandlerResponse::Handled;
  11353. };
  11354. return *this;
  11355. }
  11356. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11357. exception_handler_ = std::move(handler);
  11358. return *this;
  11359. }
  11360. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11361. pre_routing_handler_ = std::move(handler);
  11362. return *this;
  11363. }
  11364. inline Server &Server::set_post_routing_handler(Handler handler) {
  11365. post_routing_handler_ = std::move(handler);
  11366. return *this;
  11367. }
  11368. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11369. pre_request_handler_ = std::move(handler);
  11370. return *this;
  11371. }
  11372. inline Server &Server::set_logger(Logger logger) {
  11373. logger_ = std::move(logger);
  11374. return *this;
  11375. }
  11376. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11377. error_logger_ = std::move(error_logger);
  11378. return *this;
  11379. }
  11380. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11381. pre_compression_logger_ = std::move(logger);
  11382. return *this;
  11383. }
  11384. inline Server &
  11385. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11386. expect_100_continue_handler_ = std::move(handler);
  11387. return *this;
  11388. }
  11389. inline Server &Server::set_start_handler(StartHandler handler) {
  11390. start_handler_ = std::move(handler);
  11391. return *this;
  11392. }
  11393. inline Server &Server::set_address_family(int family) {
  11394. address_family_ = family;
  11395. return *this;
  11396. }
  11397. inline Server &Server::set_tcp_nodelay(bool on) {
  11398. tcp_nodelay_ = on;
  11399. return *this;
  11400. }
  11401. inline Server &Server::set_ipv6_v6only(bool on) {
  11402. ipv6_v6only_ = on;
  11403. return *this;
  11404. }
  11405. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11406. socket_options_ = std::move(socket_options);
  11407. return *this;
  11408. }
  11409. inline Server &Server::set_default_headers(Headers headers) {
  11410. default_headers_ = std::move(headers);
  11411. return *this;
  11412. }
  11413. inline Server &Server::set_header_writer(
  11414. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11415. header_writer_ = writer;
  11416. return *this;
  11417. }
  11418. inline Server &
  11419. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11420. trusted_proxies_ = proxies;
  11421. return *this;
  11422. }
  11423. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11424. keep_alive_max_count_ = count;
  11425. return *this;
  11426. }
  11427. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11428. keep_alive_timeout_sec_ = sec;
  11429. return *this;
  11430. }
  11431. template <class Rep, class Period>
  11432. inline Server &Server::set_keep_alive_timeout(
  11433. const std::chrono::duration<Rep, Period> &duration) {
  11434. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11435. set_keep_alive_timeout(sec);
  11436. });
  11437. return *this;
  11438. }
  11439. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11440. read_timeout_sec_ = sec;
  11441. read_timeout_usec_ = usec;
  11442. return *this;
  11443. }
  11444. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11445. write_timeout_sec_ = sec;
  11446. write_timeout_usec_ = usec;
  11447. return *this;
  11448. }
  11449. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11450. idle_interval_sec_ = sec;
  11451. idle_interval_usec_ = usec;
  11452. return *this;
  11453. }
  11454. inline Server &Server::set_payload_max_length(size_t length) {
  11455. payload_max_length_ = length;
  11456. return *this;
  11457. }
  11458. inline Server &Server::set_static_file_compression(bool on) {
  11459. static_file_compression_ = on;
  11460. return *this;
  11461. }
  11462. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11463. static_file_compression_min_length_ = length;
  11464. return *this;
  11465. }
  11466. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11467. static_file_compression_max_length_ = length;
  11468. return *this;
  11469. }
  11470. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11471. websocket_max_missed_pongs_ = count;
  11472. return *this;
  11473. }
  11474. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11475. websocket_ping_interval_sec_ = sec;
  11476. return *this;
  11477. }
  11478. template <class Rep, class Period>
  11479. inline Server &Server::set_websocket_ping_interval(
  11480. const std::chrono::duration<Rep, Period> &duration) {
  11481. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11482. set_websocket_ping_interval(sec);
  11483. });
  11484. return *this;
  11485. }
  11486. inline bool Server::bind_to_port(const std::string &host, int port,
  11487. int socket_flags) {
  11488. auto ret = bind_internal(host, port, socket_flags);
  11489. if (ret == -1) { is_decommissioned = true; }
  11490. return ret >= 0;
  11491. }
  11492. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11493. auto ret = bind_internal(host, 0, socket_flags);
  11494. if (ret == -1) { is_decommissioned = true; }
  11495. return ret;
  11496. }
  11497. inline bool Server::listen_after_bind() { return listen_internal(); }
  11498. inline bool Server::listen(const std::string &host, int port,
  11499. int socket_flags) {
  11500. return bind_to_port(host, port, socket_flags) && listen_internal();
  11501. }
  11502. inline bool Server::is_running() const { return is_running_; }
  11503. inline void Server::wait_until_ready() const {
  11504. while (!is_running_ && !is_decommissioned) {
  11505. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11506. }
  11507. }
  11508. inline void Server::stop() noexcept {
  11509. // Release the listening socket whether or not the accept loop is running:
  11510. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11511. // exchange is what makes this safe to call concurrently with the accept loop.
  11512. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11513. if (sock != INVALID_SOCKET) {
  11514. detail::shutdown_socket(sock);
  11515. detail::close_socket(sock);
  11516. }
  11517. is_decommissioned = false;
  11518. }
  11519. inline void Server::decommission() { is_decommissioned = true; }
  11520. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11521. auto len = strlen(s);
  11522. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11523. len -= 2;
  11524. {
  11525. // RFC 9112 §3: exactly one SP between the method, the target and the
  11526. // version. Taking other whitespace as a separator too lets recipients
  11527. // that parse more strictly see a different request.
  11528. auto end = s + len;
  11529. auto sp1 = std::find(s, end, ' ');
  11530. auto sp2 = sp1 == end ? end : std::find(sp1 + 1, end, ' ');
  11531. if (sp2 == end || std::find(sp2 + 1, end, ' ') != end || sp1 == s ||
  11532. sp2 == sp1 + 1 || sp2 + 1 == end) {
  11533. return false;
  11534. }
  11535. req.method.assign(s, sp1);
  11536. req.target.assign(sp1 + 1, sp2);
  11537. req.version.assign(sp2 + 1, end);
  11538. }
  11539. // A method outside the built-in set is accepted only when a handler has been
  11540. // registered for it with CustomRoute().
  11541. const auto &methods = builtin_methods();
  11542. if (methods.find(req.method) == methods.end() &&
  11543. !find_custom_entry(req.method)) {
  11544. output_error_log(Error::InvalidHTTPMethod, &req);
  11545. return false;
  11546. }
  11547. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11548. output_error_log(Error::InvalidHTTPVersion, &req);
  11549. return false;
  11550. }
  11551. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11552. // would leave this server routing a different path than a cache or a
  11553. // filter in front of it sees.
  11554. if (!detail::fields::is_request_target(req.target) ||
  11555. req.target.find('#') != std::string::npos) {
  11556. return false;
  11557. }
  11558. {
  11559. detail::divide(req.target, '?',
  11560. [&](const char *lhs_data, std::size_t lhs_size,
  11561. const char *rhs_data, std::size_t rhs_size) {
  11562. req.path =
  11563. decode_path_component(std::string(lhs_data, lhs_size));
  11564. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11565. });
  11566. }
  11567. return true;
  11568. }
  11569. inline bool Server::write_response(Stream &strm, bool close_connection,
  11570. Request &req, Response &res) {
  11571. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11572. // incorrectly to the error content.
  11573. req.ranges.clear();
  11574. return write_response_core(strm, close_connection, req, res, false);
  11575. }
  11576. inline bool Server::write_response_with_content(Stream &strm,
  11577. bool close_connection,
  11578. const Request &req,
  11579. Response &res) {
  11580. return write_response_core(strm, close_connection, req, res, true);
  11581. }
  11582. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11583. const Request &req, Response &res,
  11584. bool need_apply_ranges) {
  11585. assert(res.status != -1);
  11586. if (400 <= res.status && error_handler_ &&
  11587. error_handler_(req, res) == HandlerResponse::Handled) {
  11588. need_apply_ranges = true;
  11589. }
  11590. detail::prefer_assigned_body(res);
  11591. std::string content_type;
  11592. std::string boundary;
  11593. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11594. // Prepare additional headers
  11595. if (close_connection ||
  11596. detail::has_header_token(req.headers, "Connection", "close") ||
  11597. 400 <= res.status || // Don't leave connections open after errors
  11598. // The client withholds the body until `100 Continue`, which was never
  11599. // sent, so whether and when the body follows is unknown.
  11600. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11601. // The body was left partway, e.g. by a content receiver that returned
  11602. // false, so the rest of it cannot be told from the next request.
  11603. (req.body_read_started_ && !req.body_consumed_)) {
  11604. res.set_header("Connection", "close");
  11605. } else {
  11606. std::string s = "timeout=";
  11607. s += std::to_string(keep_alive_timeout_sec_);
  11608. s += ", max=";
  11609. s += std::to_string(keep_alive_max_count_);
  11610. res.set_header("Keep-Alive", s);
  11611. }
  11612. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11613. !res.has_header("Content-Type")) {
  11614. res.set_header("Content-Type", "text/plain");
  11615. }
  11616. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11617. !res.has_header("Content-Length")) {
  11618. res.set_header("Content-Length", "0");
  11619. }
  11620. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11621. res.set_header("Accept-Ranges", "bytes");
  11622. }
  11623. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11624. // Response line and headers
  11625. detail::BufferStream bstrm;
  11626. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11627. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11628. // Combine a small body with the headers so the whole response leaves in a
  11629. // single write. A large body is written on its own instead: a copy of it
  11630. // costs more than the extra write saves.
  11631. auto send_body = req.method != "HEAD";
  11632. auto body_is_separate = false;
  11633. auto provider_done = false;
  11634. if (send_body && !res.body.empty() && !res.content_provider_) {
  11635. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11636. bstrm.write(res.body.data(), res.body.size());
  11637. } else {
  11638. body_is_separate = true;
  11639. }
  11640. } else if (send_body && res.content_provider_ &&
  11641. res.is_file_content_provider_ &&
  11642. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11643. // A small file is read into the same buffer. Other providers may produce
  11644. // their data over time, so they are never held back.
  11645. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11646. return false;
  11647. }
  11648. provider_done = true;
  11649. }
  11650. // Log before writing to avoid race condition with client-side code that
  11651. // accesses logger-captured data immediately after receiving the response.
  11652. output_log(req, res);
  11653. // Flush buffer
  11654. auto &data = bstrm.get_buffer();
  11655. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11656. if (body_is_separate) {
  11657. return detail::write_data(strm, res.body.data(), res.body.size());
  11658. }
  11659. // Streaming body
  11660. if (send_body && res.content_provider_) {
  11661. if (!provider_done &&
  11662. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11663. return false;
  11664. }
  11665. res.content_provider_success_ = true;
  11666. }
  11667. return true;
  11668. }
  11669. inline bool
  11670. Server::write_content_with_provider(Stream &strm, const Request &req,
  11671. Response &res, const std::string &boundary,
  11672. const std::string &content_type) {
  11673. auto is_shutting_down = [this]() {
  11674. return this->svr_sock_ == INVALID_SOCKET;
  11675. };
  11676. if (res.content_length_ > 0) {
  11677. // Only a 206 response is served as a partial representation, matching the
  11678. // condition `apply_ranges()` used to decide the Content-Length and the
  11679. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11680. // only for a 2xx status, slicing under any other status would write a body
  11681. // that disagrees with the header already sent, from an unchecked offset.
  11682. auto is_partial =
  11683. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11684. if (!is_partial) {
  11685. return detail::write_content(strm, res.content_provider_, 0,
  11686. res.content_length_, is_shutting_down);
  11687. } else if (req.ranges.size() == 1) {
  11688. auto offset_and_length = detail::get_range_offset_and_length(
  11689. req.ranges[0], res.content_length_);
  11690. return detail::write_content(strm, res.content_provider_,
  11691. offset_and_length.first,
  11692. offset_and_length.second, is_shutting_down);
  11693. } else {
  11694. return detail::write_multipart_ranges_data(
  11695. strm, req, res, boundary, content_type, res.content_length_,
  11696. is_shutting_down);
  11697. }
  11698. } else {
  11699. if (res.is_chunked_content_provider_) {
  11700. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11701. // re-negotiating here would disagree with them, e.g. once a handler's
  11702. // own Content-Encoding header suppresses the negotiation.
  11703. auto compressor = detail::make_compressor(res.content_coding_);
  11704. if (!compressor) {
  11705. compressor = detail::make_unique<detail::nocompressor>();
  11706. }
  11707. return detail::write_content_chunked(strm, res.content_provider_,
  11708. is_shutting_down, *compressor);
  11709. } else {
  11710. return detail::write_content_without_length(strm, res.content_provider_,
  11711. is_shutting_down);
  11712. }
  11713. }
  11714. }
  11715. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11716. FormFields::iterator cur_field;
  11717. FormFiles::iterator cur_file;
  11718. auto is_text_field = false;
  11719. size_t count = 0;
  11720. if (read_content_core(
  11721. strm, req, res,
  11722. // Regular
  11723. [&](const char *buf, size_t n) {
  11724. // Prevent arithmetic overflow when checking sizes.
  11725. // Avoid computing (req.body.size() + n) directly because
  11726. // adding two unsigned `size_t` values can wrap around and
  11727. // produce a small result instead of indicating overflow.
  11728. // Instead, check using subtraction: ensure `n` does not
  11729. // exceed the remaining capacity `max_size() - size()`.
  11730. if (req.body.size() >= req.body.max_size() ||
  11731. n > req.body.max_size() - req.body.size()) {
  11732. return false;
  11733. }
  11734. // Limit decompressed body size to payload_max_length_ to protect
  11735. // against "zip bomb" attacks where a small compressed payload
  11736. // decompresses to a massive size.
  11737. if (payload_max_length_ > 0 &&
  11738. (req.body.size() >= payload_max_length_ ||
  11739. n > payload_max_length_ - req.body.size())) {
  11740. return false;
  11741. }
  11742. req.body.append(buf, n);
  11743. return true;
  11744. },
  11745. // Multipart FormData
  11746. [&](const FormData &file) {
  11747. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11748. output_error_log(Error::TooManyFormDataFiles, &req);
  11749. return false;
  11750. }
  11751. if (file.filename.empty()) {
  11752. cur_field = req.form.fields.emplace(
  11753. file.name, FormField{file.name, file.content, file.headers});
  11754. is_text_field = true;
  11755. } else {
  11756. cur_file = req.form.files.emplace(file.name, file);
  11757. is_text_field = false;
  11758. }
  11759. return true;
  11760. },
  11761. [&](const char *buf, size_t n) {
  11762. if (is_text_field) {
  11763. auto &content = cur_field->second.content;
  11764. if (content.size() + n > content.max_size()) { return false; }
  11765. content.append(buf, n);
  11766. } else {
  11767. auto &content = cur_file->second.content;
  11768. if (content.size() + n > content.max_size()) { return false; }
  11769. content.append(buf, n);
  11770. }
  11771. return true;
  11772. })) {
  11773. const auto &content_type = req.get_header_value("Content-Type");
  11774. if (detail::extract_media_type(content_type) ==
  11775. "application/x-www-form-urlencoded") {
  11776. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11777. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11778. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11779. return false;
  11780. }
  11781. detail::parse_query_text(req.body, req.params);
  11782. }
  11783. return true;
  11784. }
  11785. return false;
  11786. }
  11787. inline bool Server::read_content_with_content_receiver(
  11788. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11789. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11790. return read_content_core(strm, req, res, std::move(receiver),
  11791. std::move(multipart_header),
  11792. std::move(multipart_receiver));
  11793. }
  11794. inline bool Server::read_content_core(
  11795. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11796. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11797. detail::FormDataParser multipart_form_data_parser;
  11798. ContentReceiverWithProgress out;
  11799. if (req.is_multipart_form_data()) {
  11800. const auto &content_type = req.get_header_value("Content-Type");
  11801. std::string boundary;
  11802. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11803. res.status = StatusCode::BadRequest_400;
  11804. output_error_log(Error::MultipartParsing, &req);
  11805. return false;
  11806. }
  11807. multipart_form_data_parser.set_boundary(std::move(boundary));
  11808. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11809. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11810. multipart_receiver);
  11811. };
  11812. } else {
  11813. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11814. size_t /*len*/) { return receiver(buf, n); };
  11815. }
  11816. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11817. // For non-SSL builds we still scan non-persistent connections for stray
  11818. // body bytes so the payload limit is enforced (413). On keep-alive,
  11819. // pending bytes may be the next request (issue #2450), so skip.
  11820. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11821. if (!req.has_header("Content-Length") &&
  11822. !detail::is_chunked_transfer_encoding(req.headers)) {
  11823. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11824. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11825. auto has_data = strm.is_readable();
  11826. if (!has_data) {
  11827. auto s = strm.socket();
  11828. if (s != INVALID_SOCKET) {
  11829. has_data = detail::select_read(s, 0, 0) > 0;
  11830. }
  11831. }
  11832. if (has_data) {
  11833. // Route through the same decompressing reader used by the
  11834. // length-framed and chunked paths below, so payload_max_length_ is
  11835. // enforced on the decompressed size here too instead of only on the
  11836. // compressed wire bytes.
  11837. return detail::read_content(strm, req, payload_max_length_, res.status,
  11838. nullptr, out, true);
  11839. }
  11840. }
  11841. return true;
  11842. }
  11843. #else
  11844. if (!req.has_header("Content-Length") &&
  11845. !detail::is_chunked_transfer_encoding(req.headers)) {
  11846. return true;
  11847. }
  11848. #endif
  11849. // A second read would start where the first one stopped, or in the next
  11850. // request.
  11851. if (req.body_read_started_) { return false; }
  11852. // The client is waiting for this before it sends the body.
  11853. if (req.expect_100_continue_pending_) {
  11854. req.expect_100_continue_pending_ = false;
  11855. detail::write_response_line(strm, StatusCode::Continue_100);
  11856. strm.write("\r\n");
  11857. }
  11858. // Set before reading, since a receiver may also stop by throwing.
  11859. req.body_read_started_ = true;
  11860. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11861. out, true)) {
  11862. return false;
  11863. }
  11864. req.body_consumed_ = true;
  11865. if (req.is_multipart_form_data()) {
  11866. if (!multipart_form_data_parser.is_valid()) {
  11867. res.status = StatusCode::BadRequest_400;
  11868. output_error_log(Error::MultipartParsing, &req);
  11869. return false;
  11870. }
  11871. }
  11872. return true;
  11873. }
  11874. inline bool Server::handle_file_request(Request &req, Response &res) {
  11875. for (const auto &entry : base_dirs_) {
  11876. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11877. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11878. // One that already ends in '/' (the root mount among them) carries its own
  11879. // boundary; set_mount_point() guarantees the mount point is not empty.
  11880. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11881. (entry.mount_point.back() == '/' ||
  11882. req.path.size() == entry.mount_point.size() ||
  11883. req.path[entry.mount_point.size()] == '/')) {
  11884. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11885. if (detail::is_valid_path(sub_path)) {
  11886. auto path = entry.base_dir + sub_path;
  11887. if (path.back() == '/') { path += "index.html"; }
  11888. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11889. // but symlinks/junctions can still escape the base directory. A path
  11890. // that cannot be resolved, which includes one that does not exist, is
  11891. // not served from here.
  11892. std::string resolved_path;
  11893. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  11894. continue;
  11895. }
  11896. if (!detail::is_path_within_base(resolved_path,
  11897. entry.resolved_base_dir)) {
  11898. res.status = StatusCode::Forbidden_403;
  11899. return true;
  11900. }
  11901. detail::FileStat stat(path);
  11902. if (stat.is_dir()) {
  11903. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  11904. // in the name from reading as a scheme.
  11905. auto name = req.path.substr(req.path.rfind('/') + 1);
  11906. res.set_redirect("./" + encode_path_component(name) + "/",
  11907. StatusCode::MovedPermanently_301);
  11908. return true;
  11909. }
  11910. if (stat.is_file()) {
  11911. for (const auto &kv : entry.headers) {
  11912. res.set_header(kv.first, kv.second);
  11913. }
  11914. auto content_type = detail::find_content_type(
  11915. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11916. auto encoding = detail::EncodingType::None;
  11917. if (static_file_compression_) {
  11918. encoding =
  11919. static_file_encoding(req, res, content_type, stat.size());
  11920. }
  11921. // The ETag names the representation actually sent, so a client that
  11922. // cached the compressed form revalidates against the compressed ETag
  11923. // and still gets a 304, while one that took identity keeps the plain
  11924. // ETag.
  11925. auto etag = detail::compute_etag(
  11926. stat, encoding == detail::EncodingType::None
  11927. ? std::string()
  11928. : std::string("-") + detail::encoding_name(encoding));
  11929. if (!etag.empty()) { res.set_header("ETag", etag); }
  11930. auto mtime = stat.mtime();
  11931. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11932. if (!last_modified.empty()) {
  11933. res.set_header("Last-Modified", last_modified);
  11934. }
  11935. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11936. check_if_range(req, etag, mtime);
  11937. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11938. if (!mm->is_open()) {
  11939. output_error_log(Error::OpenFile, &req);
  11940. return false;
  11941. }
  11942. detail::set_file_content_provider(res, mm, content_type, encoding);
  11943. if (req.method != "HEAD" && file_request_handler_) {
  11944. file_request_handler_(req, res);
  11945. }
  11946. return true;
  11947. } else {
  11948. output_error_log(Error::OpenFile, &req);
  11949. }
  11950. }
  11951. }
  11952. }
  11953. return false;
  11954. }
  11955. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11956. const std::string &etag,
  11957. time_t mtime) const {
  11958. // Handle conditional GET:
  11959. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11960. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11961. if (req.has_header("If-None-Match")) {
  11962. if (!etag.empty()) {
  11963. auto val =
  11964. detail::get_combined_header_value(req.headers, "If-None-Match");
  11965. // NOTE: We use exact string matching here. This works correctly
  11966. // because our server always generates weak ETags (W/"..."), and
  11967. // clients typically send back the same ETag they received.
  11968. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11969. // If-None-Match, where W/"x" and "x" would match, but this
  11970. // simplified implementation requires exact matches.
  11971. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11972. [&](const char *b, const char *e) {
  11973. auto seg_len = static_cast<size_t>(e - b);
  11974. return (seg_len == 1 && *b == '*') ||
  11975. (seg_len == etag.size() &&
  11976. std::equal(b, e, etag.begin()));
  11977. });
  11978. if (ret) {
  11979. res.status = StatusCode::NotModified_304;
  11980. return true;
  11981. }
  11982. }
  11983. } else if (req.has_header("If-Modified-Since")) {
  11984. auto val = req.get_header_value("If-Modified-Since");
  11985. auto t = detail::parse_http_date(val);
  11986. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11987. res.status = StatusCode::NotModified_304;
  11988. return true;
  11989. }
  11990. }
  11991. return false;
  11992. }
  11993. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11994. time_t mtime) const {
  11995. // Handle If-Range for partial content requests (RFC 9110
  11996. // Section 13.1.5). If-Range is only evaluated when Range header is
  11997. // present. If the validator matches, serve partial content; otherwise
  11998. // serve full content.
  11999. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12000. auto val = req.get_header_value("If-Range");
  12001. auto is_valid_range = [&]() {
  12002. if (detail::is_strong_etag(val)) {
  12003. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12004. // comparison.
  12005. return (!etag.empty() && val == etag);
  12006. } else if (detail::is_weak_etag(val)) {
  12007. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12008. return false;
  12009. } else {
  12010. // HTTP-date comparison
  12011. auto t = detail::parse_http_date(val);
  12012. return (t != static_cast<time_t>(-1) && mtime <= t);
  12013. }
  12014. };
  12015. if (!is_valid_range()) {
  12016. // Validator doesn't match: ignore Range and serve full content
  12017. req.ranges.clear();
  12018. return false;
  12019. }
  12020. }
  12021. return true;
  12022. }
  12023. inline socket_t
  12024. Server::create_server_socket(const std::string &host, int port,
  12025. int socket_flags,
  12026. SocketOptions socket_options) const {
  12027. return detail::create_socket(
  12028. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12029. ipv6_v6only_, std::move(socket_options),
  12030. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12031. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12032. output_error_log(Error::BindIPAddress, nullptr);
  12033. return false;
  12034. }
  12035. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12036. output_error_log(Error::Listen, nullptr);
  12037. return false;
  12038. }
  12039. return true;
  12040. });
  12041. }
  12042. inline int Server::bind_internal(const std::string &host, int port,
  12043. int socket_flags) {
  12044. if (is_decommissioned) { return -1; }
  12045. if (!is_valid()) { return -1; }
  12046. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12047. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12048. if (port == 0) {
  12049. struct sockaddr_storage addr;
  12050. socklen_t addr_len = sizeof(addr);
  12051. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12052. &addr_len) == -1) {
  12053. output_error_log(Error::GetSockName, nullptr);
  12054. return -1;
  12055. }
  12056. if (addr.ss_family == AF_INET) {
  12057. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12058. } else if (addr.ss_family == AF_INET6) {
  12059. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12060. } else {
  12061. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12062. return -1;
  12063. }
  12064. } else {
  12065. return port;
  12066. }
  12067. }
  12068. inline bool Server::listen_internal() {
  12069. // A stop() between bind and listen leaves nothing to accept on. Report
  12070. // failure instead of returning success without ever serving, and mark the
  12071. // server decommissioned the way any failed listen does so that a concurrent
  12072. // wait_until_ready() wakes up instead of spinning forever.
  12073. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12074. is_decommissioned = true;
  12075. return false;
  12076. }
  12077. auto ret = true;
  12078. is_running_ = true;
  12079. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12080. if (start_handler_) { start_handler_(); }
  12081. {
  12082. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12083. while (svr_sock_ != INVALID_SOCKET) {
  12084. #ifndef _WIN32
  12085. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12086. #endif
  12087. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12088. idle_interval_usec_);
  12089. if (val == 0) { // Timeout
  12090. task_queue->on_idle();
  12091. continue;
  12092. }
  12093. #ifndef _WIN32
  12094. }
  12095. #endif
  12096. #if defined _WIN32
  12097. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12098. // OVERLAPPED
  12099. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12100. #elif defined SOCK_CLOEXEC
  12101. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12102. #else
  12103. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12104. #endif
  12105. if (sock == INVALID_SOCKET) {
  12106. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12107. // touches the CRT errno, so the two have to be asked platform by
  12108. // platform rather than by testing errno here.
  12109. if (detail::is_accept_resource_error()) {
  12110. // The per-process descriptor limit or the network stack's buffer
  12111. // space has been reached. Try to accept new connections after a
  12112. // short sleep.
  12113. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12114. continue;
  12115. } else if (detail::is_accept_transient_error()) {
  12116. continue;
  12117. }
  12118. // Take the descriptor out of svr_sock_ before closing it: a later
  12119. // stop() would otherwise shutdown()/close() a value the OS may have
  12120. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12121. // gone. The exchange also settles the race with a concurrent stop(),
  12122. // since whichever side takes the descriptor closes it exactly once.
  12123. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12124. if (listen_sock != INVALID_SOCKET) {
  12125. detail::close_socket(listen_sock);
  12126. ret = false;
  12127. output_error_log(Error::Connection, nullptr);
  12128. } else {
  12129. ; // The server socket was closed by user.
  12130. }
  12131. break;
  12132. }
  12133. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12134. read_timeout_sec_, read_timeout_usec_);
  12135. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12136. write_timeout_sec_, write_timeout_usec_);
  12137. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12138. if (!task_queue->enqueue(
  12139. [this, sock]() { process_and_close_socket(sock); })) {
  12140. output_error_log(Error::ResourceExhaustion, nullptr);
  12141. detail::shutdown_socket(sock);
  12142. detail::close_socket(sock);
  12143. }
  12144. }
  12145. task_queue->shutdown();
  12146. }
  12147. is_decommissioned = !ret;
  12148. return ret;
  12149. }
  12150. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12151. if (pre_routing_handler_ &&
  12152. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12153. return true;
  12154. }
  12155. // File handler
  12156. if ((req.method == "GET" || req.method == "HEAD") &&
  12157. handle_file_request(req, res)) {
  12158. return true;
  12159. }
  12160. const auto *custom = find_custom_entry(req.method);
  12161. // The second clause mirrors what expect_content() does unconditionally for
  12162. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12163. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12164. // `allprop`) would skip its handler and fall through to 404.
  12165. if (detail::expect_content(req) ||
  12166. (custom && !custom->handlers_for_content_reader.empty())) {
  12167. // Content reader handler
  12168. {
  12169. // Track whether the ContentReader was aborted due to the decompressed
  12170. // payload exceeding `payload_max_length_`.
  12171. // The user handler runs after the lambda returns, so we must restore the
  12172. // 413 status if the handler overwrites it.
  12173. bool content_reader_payload_too_large = false;
  12174. ContentReader reader(
  12175. [&](ContentReceiver receiver) {
  12176. auto result = read_content_with_content_receiver(
  12177. strm, req, res, std::move(receiver), nullptr, nullptr);
  12178. if (!result) {
  12179. output_error_log(Error::Read, &req);
  12180. if (res.status == StatusCode::PayloadTooLarge_413) {
  12181. content_reader_payload_too_large = true;
  12182. }
  12183. }
  12184. return result;
  12185. },
  12186. [&](FormDataHeader header, ContentReceiver receiver) {
  12187. auto result = read_content_with_content_receiver(
  12188. strm, req, res, nullptr, std::move(header),
  12189. std::move(receiver));
  12190. if (!result) {
  12191. output_error_log(Error::Read, &req);
  12192. if (res.status == StatusCode::PayloadTooLarge_413) {
  12193. content_reader_payload_too_large = true;
  12194. }
  12195. }
  12196. return result;
  12197. });
  12198. bool dispatched = false;
  12199. if (req.method == "POST") {
  12200. dispatched = dispatch_request_for_content_reader(
  12201. req, res, std::move(reader), post_handlers_for_content_reader_);
  12202. } else if (req.method == "PUT") {
  12203. dispatched = dispatch_request_for_content_reader(
  12204. req, res, std::move(reader), put_handlers_for_content_reader_);
  12205. } else if (req.method == "PATCH") {
  12206. dispatched = dispatch_request_for_content_reader(
  12207. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12208. } else if (req.method == "DELETE") {
  12209. dispatched = dispatch_request_for_content_reader(
  12210. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12211. } else if (custom) {
  12212. dispatched = dispatch_request_for_content_reader(
  12213. req, res, std::move(reader), custom->handlers_for_content_reader);
  12214. }
  12215. if (dispatched) {
  12216. if (content_reader_payload_too_large) {
  12217. // Enforce the limit: override any status the handler may have set
  12218. // and return false so the error path sends a plain 413 response.
  12219. res.status = StatusCode::PayloadTooLarge_413;
  12220. detail::clear_content(res);
  12221. return false;
  12222. }
  12223. return true;
  12224. }
  12225. }
  12226. // NOTE: `req.body` is not read here. For a regular handler the body is
  12227. // read inside dispatch_request(), after the route has matched and the
  12228. // pre-request handler has approved the request, so that a rejected
  12229. // request (e.g. failed authentication) never forces us to buffer a
  12230. // potentially large body.
  12231. }
  12232. // Regular handler
  12233. if (req.method == "GET" || req.method == "HEAD") {
  12234. return dispatch_request(req, res, get_handlers_, strm);
  12235. } else if (req.method == "POST") {
  12236. return dispatch_request(req, res, post_handlers_, strm);
  12237. } else if (req.method == "PUT") {
  12238. return dispatch_request(req, res, put_handlers_, strm);
  12239. } else if (req.method == "DELETE") {
  12240. return dispatch_request(req, res, delete_handlers_, strm);
  12241. } else if (req.method == "OPTIONS") {
  12242. return dispatch_request(req, res, options_handlers_, strm);
  12243. } else if (req.method == "PATCH") {
  12244. return dispatch_request(req, res, patch_handlers_, strm);
  12245. } else if (custom) {
  12246. return dispatch_request(req, res, custom->handlers, strm);
  12247. }
  12248. res.status = StatusCode::BadRequest_400;
  12249. return false;
  12250. }
  12251. inline bool Server::dispatch_request(Request &req, Response &res,
  12252. const Handlers &handlers, Stream &strm) {
  12253. for (const auto &x : handlers) {
  12254. const auto &matcher = x.first;
  12255. const auto &handler = x.second;
  12256. if (matcher->match(req)) {
  12257. req.matched_route = matcher->pattern();
  12258. // Run the pre-request handler before reading the body so a rejected
  12259. // request (e.g. failed authentication) never forces us to buffer a
  12260. // potentially large body. `req.matched_route` is available here.
  12261. if (pre_request_handler_ &&
  12262. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12263. return true;
  12264. }
  12265. // The route matched and the request was approved; read the body now.
  12266. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12267. output_error_log(Error::Read, &req);
  12268. return false;
  12269. }
  12270. handler(req, res);
  12271. return true;
  12272. }
  12273. }
  12274. return false;
  12275. }
  12276. // Decides the content coding for a response served straight from a file. Both
  12277. // the ETag, which has to name the representation actually sent, and
  12278. // `apply_static_file_compression()` go through this, so the two cannot drift
  12279. // apart.
  12280. inline detail::EncodingType
  12281. Server::static_file_encoding(const Request &req, const Response &res,
  12282. const std::string &content_type,
  12283. size_t length) const {
  12284. if (!static_file_compression_) { return detail::EncodingType::None; }
  12285. // Nothing to compress, and an empty file already answers with
  12286. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12287. // turn an empty body into a 20-byte gzip stream.
  12288. if (length == 0) { return detail::EncodingType::None; }
  12289. // A file that already fits in a single packet gains nothing from being made
  12290. // smaller, since it still travels in that one segment, and a file of a few
  12291. // bytes comes out larger than it went in.
  12292. if (length < static_file_compression_min_length_) {
  12293. return detail::EncodingType::None;
  12294. }
  12295. // RFC 9110 applies Range to the representation after content coding, so a
  12296. // compressed 206 would mean compressing the whole file and then slicing it.
  12297. // Serve ranges from the identity representation instead.
  12298. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12299. if (static_file_compression_max_length_ > 0 &&
  12300. length > static_file_compression_max_length_) {
  12301. return detail::EncodingType::None;
  12302. }
  12303. return detail::encoding_type(req, res, content_type);
  12304. }
  12305. // Compresses a file-backed content provider into `res.body` and takes over the
  12306. // framing headers. Returns false when the response is left untouched.
  12307. inline bool Server::apply_static_file_compression(const Request &req,
  12308. Response &res) const {
  12309. auto type = res.content_coding_;
  12310. if (type == detail::EncodingType::None || !res.content_provider_) {
  12311. return false;
  12312. }
  12313. auto compressor = detail::make_compressor(type);
  12314. if (!compressor) { return false; }
  12315. output_pre_compression_log(req, res);
  12316. std::string compressed;
  12317. if (!detail::compress_content_provider(res.content_provider_,
  12318. res.content_length_, *compressor,
  12319. compressed)) {
  12320. return false;
  12321. }
  12322. res.body.swap(compressed);
  12323. // The provider was consumed in full, so its releaser hears about a success.
  12324. res.content_provider_success_ = true;
  12325. detail::clear_content_provider(res);
  12326. res.set_header("Content-Encoding", detail::encoding_name(type));
  12327. res.set_header("Vary", "Accept-Encoding");
  12328. res.set_header("Content-Length", std::to_string(res.body.size()));
  12329. return true;
  12330. }
  12331. inline void Server::apply_ranges(const Request &req, Response &res,
  12332. std::string &content_type,
  12333. std::string &boundary) const {
  12334. // A known-length content provider leaves `res.body` empty, so the compressor
  12335. // at the end of this function never runs for one (issue #2545). A file-backed
  12336. // provider is fully readable right here, so compress it and answer with an
  12337. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12338. // takes the same path as `set_content()` from here on. Range requests never
  12339. // get a content coding, so `Content-Range` still names identity bytes and
  12340. // none of the framing below applies.
  12341. if (apply_static_file_compression(req, res)) { return; }
  12342. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12343. auto it = res.headers.find("Content-Type");
  12344. if (it != res.headers.end()) {
  12345. content_type = it->second;
  12346. res.headers.erase(it);
  12347. }
  12348. boundary = detail::make_multipart_data_boundary();
  12349. res.set_header("Content-Type",
  12350. "multipart/byteranges; boundary=" + boundary);
  12351. }
  12352. auto type = detail::encoding_type(req, res);
  12353. if (res.body.empty()) {
  12354. if (res.content_length_ > 0) {
  12355. size_t length = 0;
  12356. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12357. length = res.content_length_;
  12358. } else if (req.ranges.size() == 1) {
  12359. auto offset_and_length = detail::get_range_offset_and_length(
  12360. req.ranges[0], res.content_length_);
  12361. length = offset_and_length.second;
  12362. auto content_range = detail::make_content_range_header_field(
  12363. offset_and_length, res.content_length_);
  12364. res.set_header("Content-Range", content_range);
  12365. } else {
  12366. length = detail::get_multipart_ranges_data_length(
  12367. req, boundary, content_type, res.content_length_);
  12368. }
  12369. res.set_header("Content-Length", std::to_string(length));
  12370. } else {
  12371. if (res.content_provider_) {
  12372. if (res.is_chunked_content_provider_) {
  12373. res.set_header("Transfer-Encoding", "chunked");
  12374. res.content_coding_ = type;
  12375. if (type != detail::EncodingType::None) {
  12376. res.set_header("Content-Encoding", detail::encoding_name(type));
  12377. res.set_header("Vary", "Accept-Encoding");
  12378. }
  12379. }
  12380. }
  12381. }
  12382. } else {
  12383. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12384. ;
  12385. } else if (req.ranges.size() == 1) {
  12386. auto offset_and_length =
  12387. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12388. auto offset = offset_and_length.first;
  12389. auto length = offset_and_length.second;
  12390. auto content_range = detail::make_content_range_header_field(
  12391. offset_and_length, res.body.size());
  12392. res.set_header("Content-Range", content_range);
  12393. assert(offset + length <= res.body.size());
  12394. res.body = res.body.substr(offset, length);
  12395. } else {
  12396. std::string data;
  12397. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12398. res.body.size(), data);
  12399. res.body.swap(data);
  12400. }
  12401. if (type != detail::EncodingType::None) {
  12402. output_pre_compression_log(req, res);
  12403. if (auto compressor = detail::make_compressor(type)) {
  12404. std::string compressed;
  12405. if (compressor->compress(res.body.data(), res.body.size(), true,
  12406. [&](const char *data, size_t data_len) {
  12407. compressed.append(data, data_len);
  12408. return true;
  12409. })) {
  12410. res.body.swap(compressed);
  12411. res.set_header("Content-Encoding", detail::encoding_name(type));
  12412. res.set_header("Vary", "Accept-Encoding");
  12413. }
  12414. }
  12415. }
  12416. res.content_length_ = res.body.size();
  12417. res.set_header("Content-Length", std::to_string(res.content_length_));
  12418. }
  12419. }
  12420. inline bool Server::dispatch_request_for_content_reader(
  12421. Request &req, Response &res, ContentReader content_reader,
  12422. const HandlersForContentReader &handlers) const {
  12423. for (const auto &x : handlers) {
  12424. const auto &matcher = x.first;
  12425. const auto &handler = x.second;
  12426. if (matcher->match(req)) {
  12427. req.matched_route = matcher->pattern();
  12428. if (!pre_request_handler_ ||
  12429. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12430. handler(req, res, content_reader);
  12431. }
  12432. return true;
  12433. }
  12434. }
  12435. return false;
  12436. }
  12437. inline std::string
  12438. get_client_ip(const std::string &x_forwarded_for,
  12439. const std::vector<std::string> &trusted_proxies) {
  12440. // X-Forwarded-For is a comma-separated list per RFC 7239
  12441. std::vector<std::string> ip_list;
  12442. detail::split(x_forwarded_for.data(),
  12443. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12444. [&](const char *b, const char *e) {
  12445. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12446. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12447. });
  12448. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12449. // no segments. Signal "no client IP derived" with an empty string so the
  12450. // caller can fall back to the connection-level remote address.
  12451. if (ip_list.empty()) { return std::string(); }
  12452. // Each hop appends the address it received the request from, so the rightmost
  12453. // entries are the ones written by our own infrastructure while the leftmost
  12454. // are whatever the original client chose to send. Walk from the right and
  12455. // skip trusted proxies; the first address that is not a trusted proxy is the
  12456. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12457. // from the left instead lets a client forge an arbitrary address by following
  12458. // it with a trusted proxy's address, which the left-to-right scan then
  12459. // returned as the client.
  12460. for (size_t i = ip_list.size(); i-- > 0;) {
  12461. const auto &ip = ip_list[i];
  12462. auto is_trusted_proxy =
  12463. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12464. [&](const std::string &proxy) { return ip == proxy; });
  12465. if (!is_trusted_proxy) { return ip; }
  12466. }
  12467. // Every hop was a trusted proxy; fall back to the first entry.
  12468. return ip_list.front();
  12469. }
  12470. inline bool
  12471. Server::process_request(Stream &strm, const std::string &remote_addr,
  12472. int remote_port, const std::string &local_addr,
  12473. int local_port, bool close_connection,
  12474. bool &connection_closed,
  12475. const std::function<void(Request &)> &setup_request,
  12476. bool *websocket_upgraded) {
  12477. std::array<char, 2048> buf{};
  12478. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12479. // Connection has been closed on client
  12480. if (!line_reader.getline()) { return false; }
  12481. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12482. // clients send an extra CRLF after a request body, which would otherwise be
  12483. // parsed as the next request on a persistent connection.
  12484. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12485. return false;
  12486. }
  12487. Request req;
  12488. req.start_time_ = std::chrono::steady_clock::now();
  12489. req.remote_addr = remote_addr;
  12490. req.remote_port = remote_port;
  12491. req.local_addr = local_addr;
  12492. req.local_port = local_port;
  12493. Response res;
  12494. res.version = "HTTP/1.1";
  12495. res.headers = default_headers_;
  12496. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12497. // close the connection after that response, whichever path wrote it (an
  12498. // error status, a handler, or a rejected request). Reading on would also
  12499. // parse whatever the client sent next on a connection it considers done.
  12500. auto honor_connection_close = detail::scope_exit([&] {
  12501. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12502. connection_closed = true;
  12503. }
  12504. });
  12505. // Request line and headers. A rejected message leaves the rest of it (and
  12506. // any body) unread, so the connection cannot be reused: the leftover bytes
  12507. // would be parsed as the next request.
  12508. if (!parse_request_line(line_reader.ptr(), req)) {
  12509. connection_closed = true;
  12510. res.status = StatusCode::BadRequest_400;
  12511. output_error_log(Error::InvalidRequestLine, &req);
  12512. return write_response(strm, close_connection, req, res);
  12513. }
  12514. // Request headers
  12515. if (!detail::read_headers(strm, req.headers)) {
  12516. connection_closed = true;
  12517. res.status = StatusCode::BadRequest_400;
  12518. output_error_log(Error::InvalidHeaders, &req);
  12519. return write_response(strm, close_connection, req, res);
  12520. }
  12521. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12522. // which would otherwise let an intermediary and this parser disagree on
  12523. // where the body ends and enable request smuggling. Three cases: a
  12524. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12525. // or empty), which would otherwise be read as "no body"; a non-zero
  12526. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12527. // tolerated for compatibility with existing clients); and a
  12528. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12529. // length undeterminable. None of them may fall through to the "no body"
  12530. // path, or the body bytes are parsed as the next request on a persistent
  12531. // connection.
  12532. auto is_invalid_content_length = false;
  12533. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12534. is_invalid_content_length);
  12535. if (is_invalid_content_length ||
  12536. detail::has_conflicting_content_length(req.headers) ||
  12537. (req.has_header("Transfer-Encoding") &&
  12538. !detail::is_chunked_transfer_encoding(req.headers))) {
  12539. connection_closed = true;
  12540. res.status = StatusCode::BadRequest_400;
  12541. return write_response(strm, close_connection, req, res);
  12542. }
  12543. // RFC 9112 §6.1: answer a request that also has a Content-Length, or an
  12544. // HTTP/1.0 one, by its Transfer-Encoding, but close the connection after.
  12545. if (req.has_header("Transfer-Encoding") &&
  12546. (req.has_header("Content-Length") || req.version == "HTTP/1.0")) {
  12547. connection_closed = true;
  12548. }
  12549. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12550. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12551. // the same authority.
  12552. if (req.get_header_value_count("Host") > 1 ||
  12553. !detail::fields::is_host(req.get_header_value("Host")) ||
  12554. (req.version == "HTTP/1.1" && !req.has_header("Host"))) {
  12555. connection_closed = true;
  12556. res.status = StatusCode::BadRequest_400;
  12557. output_error_log(Error::InvalidHeaders, &req);
  12558. return write_response(strm, close_connection, req, res);
  12559. }
  12560. // Check if the request URI doesn't exceed the limit
  12561. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12562. connection_closed = true;
  12563. res.status = StatusCode::UriTooLong_414;
  12564. output_error_log(Error::ExceedUriMaxLength, &req);
  12565. return write_response(strm, close_connection, req, res);
  12566. }
  12567. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12568. connection_closed = true;
  12569. }
  12570. if (req.version == "HTTP/1.0" &&
  12571. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12572. connection_closed = true;
  12573. }
  12574. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12575. // itself a trusted proxy. Otherwise any direct client could spoof
  12576. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12577. auto is_trusted_peer = std::any_of(
  12578. trusted_proxies_.begin(), trusted_proxies_.end(),
  12579. [&](const std::string &proxy) { return proxy == remote_addr; });
  12580. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12581. // Some proxies append the address they observed as a separate
  12582. // X-Forwarded-For field line instead of extending the one the client sent
  12583. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12584. // be scanned. Reading only the first occurrence would hand back the
  12585. // client-supplied, and therefore forgeable, value.
  12586. auto x_forwarded_for =
  12587. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12588. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12589. req.remote_addr = derived.empty() ? remote_addr : derived;
  12590. } else {
  12591. req.remote_addr = remote_addr;
  12592. }
  12593. req.remote_port = remote_port;
  12594. req.local_addr = local_addr;
  12595. req.local_port = local_port;
  12596. if (req.has_header("Accept")) {
  12597. auto accept_header =
  12598. detail::get_combined_header_value(req.headers, "Accept");
  12599. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12600. connection_closed = true;
  12601. res.status = StatusCode::BadRequest_400;
  12602. output_error_log(Error::HTTPParsing, &req);
  12603. return write_response(strm, close_connection, req, res);
  12604. }
  12605. }
  12606. if (req.has_header("Range")) {
  12607. const auto &range_header_value = req.get_header_value("Range");
  12608. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12609. connection_closed = true;
  12610. res.status = StatusCode::RangeNotSatisfiable_416;
  12611. output_error_log(Error::InvalidRangeHeader, &req);
  12612. return write_response(strm, close_connection, req, res);
  12613. }
  12614. }
  12615. if (setup_request) { setup_request(req); }
  12616. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12617. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12618. // must be ignored. An expectation we do not recognize is left alone; the
  12619. // 417 the section allows for one is a MAY, not a requirement.
  12620. //
  12621. // `100 Continue` itself is deferred until the body is actually read (see
  12622. // read_content_core), so a request rejected by a later handler never
  12623. // invites the client to send a body nobody will read.
  12624. if (req.version != "HTTP/1.0" &&
  12625. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12626. int status = StatusCode::Continue_100;
  12627. if (expect_100_continue_handler_) {
  12628. status = expect_100_continue_handler_(req, res);
  12629. }
  12630. if (status == StatusCode::Continue_100) {
  12631. req.expect_100_continue_pending_ = true;
  12632. } else {
  12633. if (res.status == -1) { res.status = status; }
  12634. connection_closed = true;
  12635. return write_response(strm, true, req, res);
  12636. }
  12637. }
  12638. // Setup `is_connection_closed` method
  12639. auto sock = strm.socket();
  12640. req.is_connection_closed = [sock]() {
  12641. return !detail::is_socket_alive(sock);
  12642. };
  12643. // WebSocket upgrade
  12644. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12645. // that authentication and other middleware can reject the request with an
  12646. // HTTP response (e.g., 401) before the protocol switches.
  12647. if (detail::is_websocket_upgrade(req)) {
  12648. if (pre_routing_handler_ &&
  12649. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12650. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12651. return write_response_with_content(strm, close_connection, req, res);
  12652. }
  12653. // Find matching WebSocket handler
  12654. for (const auto &entry : websocket_handlers_) {
  12655. if (entry.matcher->match(req)) {
  12656. req.matched_route = entry.matcher->pattern();
  12657. if (pre_request_handler_ &&
  12658. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12659. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12660. return write_response_with_content(strm, close_connection, req, res);
  12661. }
  12662. // Compute accept key
  12663. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12664. auto accept_key = detail::websocket_accept_key(client_key);
  12665. // Negotiate subprotocol
  12666. std::string selected_subprotocol;
  12667. if (entry.sub_protocol_selector) {
  12668. auto protocol_header = detail::get_combined_header_value(
  12669. req.headers, "Sec-WebSocket-Protocol");
  12670. if (!protocol_header.empty()) {
  12671. std::vector<std::string> protocols;
  12672. detail::split(protocol_header.data(),
  12673. protocol_header.data() + protocol_header.size(), ',',
  12674. [&](const char *b, const char *e) {
  12675. protocols.emplace_back(b, e);
  12676. });
  12677. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12678. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12679. if (std::find(protocols.begin(), protocols.end(),
  12680. selected_subprotocol) == protocols.end()) {
  12681. selected_subprotocol.clear();
  12682. }
  12683. }
  12684. }
  12685. // Send 101 Switching Protocols
  12686. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12687. "Upgrade: websocket\r\n"
  12688. "Connection: Upgrade\r\n"
  12689. "Sec-WebSocket-Accept: " +
  12690. accept_key + "\r\n";
  12691. if (!selected_subprotocol.empty()) {
  12692. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12693. return false;
  12694. }
  12695. handshake_response +=
  12696. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12697. }
  12698. handshake_response += "\r\n";
  12699. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12700. 0) {
  12701. return false;
  12702. }
  12703. connection_closed = true;
  12704. if (websocket_upgraded) { *websocket_upgraded = true; }
  12705. {
  12706. #ifdef CPPHTTPLIB_SSL_ENABLED
  12707. if (req.ssl) {
  12708. // wss: the heartbeat ping thread and the read path enter the same
  12709. // TLS session from different threads. Hand the WebSocket a stream
  12710. // that serializes every TLS call, so the shared SSLSocketStream on
  12711. // the plain HTTP/HTTPS paths stays untouched.
  12712. auto ws_strm =
  12713. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12714. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12715. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12716. write_timeout_sec_, write_timeout_usec_));
  12717. ws::WebSocket ws(std::move(ws_strm), req, true,
  12718. websocket_ping_interval_sec_,
  12719. websocket_max_missed_pongs_);
  12720. entry.handler(req, ws);
  12721. return true;
  12722. }
  12723. #endif
  12724. // Use WebSocket-specific read timeout instead of HTTP timeout
  12725. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12726. 0);
  12727. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12728. websocket_max_missed_pongs_);
  12729. entry.handler(req, ws);
  12730. }
  12731. return true;
  12732. }
  12733. }
  12734. // No matching handler - fall through to 404
  12735. }
  12736. // Routing
  12737. auto routed = false;
  12738. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12739. routed = routing(req, res, strm);
  12740. #else
  12741. try {
  12742. routed = routing(req, res, strm);
  12743. } catch (std::exception &) {
  12744. if (exception_handler_) {
  12745. auto ep = std::current_exception();
  12746. exception_handler_(req, res, ep);
  12747. routed = true;
  12748. } else {
  12749. res.status = StatusCode::InternalServerError_500;
  12750. }
  12751. } catch (...) {
  12752. if (exception_handler_) {
  12753. auto ep = std::current_exception();
  12754. exception_handler_(req, res, ep);
  12755. routed = true;
  12756. } else {
  12757. res.status = StatusCode::InternalServerError_500;
  12758. }
  12759. }
  12760. #endif
  12761. // The response says so when this connection closes after it.
  12762. auto close = close_connection || connection_closed;
  12763. auto ret = false;
  12764. if (routed) {
  12765. if (res.status == -1) {
  12766. res.status = req.ranges.empty() ? StatusCode::OK_200
  12767. : StatusCode::PartialContent_206;
  12768. }
  12769. // Before the Range checks below, so they see the body's own length.
  12770. detail::prefer_assigned_body(res);
  12771. // Serve file content by using a content provider
  12772. auto file_open_error = false;
  12773. if (!res.file_content_path_.empty()) {
  12774. const auto &path = res.file_content_path_;
  12775. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12776. if (!mm->is_open()) {
  12777. res.status = StatusCode::NotFound_404;
  12778. output_error_log(Error::OpenFile, &req);
  12779. file_open_error = true;
  12780. } else {
  12781. auto content_type = res.file_content_content_type_;
  12782. if (content_type.empty()) {
  12783. content_type = detail::find_content_type(
  12784. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12785. }
  12786. detail::set_file_content_provider(
  12787. res, mm, content_type,
  12788. static_file_encoding(req, res, content_type, mm->size()));
  12789. }
  12790. }
  12791. if (file_open_error) {
  12792. ret = write_response(strm, close, req, res);
  12793. } else if (detail::range_error(req, res)) {
  12794. detail::clear_content(res);
  12795. res.status = StatusCode::RangeNotSatisfiable_416;
  12796. ret = write_response(strm, close, req, res);
  12797. } else {
  12798. ret = write_response_with_content(strm, close, req, res);
  12799. }
  12800. } else {
  12801. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12802. ret = write_response(strm, close, req, res);
  12803. }
  12804. // Drain any unconsumed framed body to prevent request smuggling on
  12805. // keep-alive. Without framing there is no body to drain — reading would
  12806. // consume the next request (issue #2450). If the response has committed the
  12807. // connection to close, there is no next request to protect. A body read in
  12808. // part cannot be drained from where it stopped, so the connection closes.
  12809. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12810. !detail::has_header_token(res.headers, "Connection", "close")) {
  12811. int dummy_status;
  12812. if (req.body_read_started_ ||
  12813. !detail::read_content(
  12814. strm, req, payload_max_length_, dummy_status, nullptr,
  12815. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12816. connection_closed = true;
  12817. }
  12818. }
  12819. return ret;
  12820. }
  12821. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12822. inline bool Server::process_and_close_socket(socket_t sock) {
  12823. std::string remote_addr;
  12824. int remote_port = 0;
  12825. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12826. std::string local_addr;
  12827. int local_port = 0;
  12828. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12829. bool websocket_upgraded = false;
  12830. auto ret = serve_guarded([&]() {
  12831. return detail::process_server_socket(
  12832. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12833. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12834. write_timeout_usec_,
  12835. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12836. return process_request(strm, remote_addr, remote_port, local_addr,
  12837. local_port, close_connection,
  12838. connection_closed, nullptr,
  12839. &websocket_upgraded);
  12840. });
  12841. });
  12842. detail::drain_and_close_socket(sock);
  12843. return ret;
  12844. }
  12845. inline void Server::output_log(const Request &req, const Response &res) const {
  12846. if (logger_) {
  12847. std::lock_guard<std::mutex> guard(logger_mutex_);
  12848. logger_(req, res);
  12849. }
  12850. }
  12851. inline void Server::output_pre_compression_log(const Request &req,
  12852. const Response &res) const {
  12853. if (pre_compression_logger_) {
  12854. std::lock_guard<std::mutex> guard(logger_mutex_);
  12855. pre_compression_logger_(req, res);
  12856. }
  12857. }
  12858. inline void Server::output_error_log(const Error &err,
  12859. const Request *req) const {
  12860. if (error_logger_) {
  12861. std::lock_guard<std::mutex> guard(logger_mutex_);
  12862. error_logger_(err, req);
  12863. }
  12864. }
  12865. /*
  12866. * Group 5: ClientImpl and Client (Universal) implementation
  12867. */
  12868. // HTTP client implementation
  12869. inline ClientImpl::ClientImpl(const std::string &host)
  12870. : ClientImpl(host, 80, std::string(), std::string()) {}
  12871. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12872. : ClientImpl(host, port, std::string(), std::string()) {}
  12873. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12874. const std::string &client_cert_path,
  12875. const std::string &client_key_path)
  12876. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12877. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12878. inline ClientImpl::~ClientImpl() {
  12879. // Wait until all the requests in flight are handled.
  12880. size_t retry_count = 10;
  12881. while (retry_count-- > 0) {
  12882. {
  12883. std::lock_guard<std::mutex> guard(socket_mutex_);
  12884. if (socket_requests_in_flight_ == 0) { break; }
  12885. }
  12886. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12887. }
  12888. std::lock_guard<std::mutex> guard(socket_mutex_);
  12889. shutdown_socket(socket_);
  12890. close_socket(socket_);
  12891. }
  12892. inline bool ClientImpl::is_valid() const { return true; }
  12893. inline bool
  12894. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12895. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12896. if (no_proxy_entries_.empty()) { return true; }
  12897. // host_ is const so its normalized form is invariant; cache it. The
  12898. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12899. if (host == host_) {
  12900. if (!host_normalized_valid_) {
  12901. host_normalized_ = detail::normalize_target(host_);
  12902. host_normalized_valid_ = true;
  12903. }
  12904. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12905. }
  12906. auto target = detail::normalize_target(host);
  12907. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12908. }
  12909. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12910. if (is_proxy_enabled_for_host(host_)) {
  12911. return detail::create_client_socket(
  12912. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12913. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12914. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12915. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12916. }
  12917. // Check is custom IP or hostname specified for host_
  12918. std::string connect_host;
  12919. std::string ip;
  12920. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12921. return detail::create_client_socket(
  12922. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12923. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12924. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12925. write_timeout_usec_, interface_, error);
  12926. }
  12927. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12928. Error &error) {
  12929. auto sock = create_client_socket(error);
  12930. if (sock == INVALID_SOCKET) { return false; }
  12931. socket.sock = sock;
  12932. return true;
  12933. }
  12934. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12935. return create_and_connect_socket(socket, error);
  12936. }
  12937. inline bool ClientImpl::setup_proxy_connection(
  12938. Socket & /*socket*/,
  12939. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12940. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12941. return true;
  12942. }
  12943. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12944. bool /*shutdown_gracefully*/) {
  12945. // If there are any requests in flight from threads other than us, then it's
  12946. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12947. assert(socket_requests_in_flight_ == 0 ||
  12948. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12949. }
  12950. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12951. if (socket.sock == INVALID_SOCKET) { return; }
  12952. detail::shutdown_socket(socket.sock);
  12953. }
  12954. inline void ClientImpl::close_socket(Socket &socket) {
  12955. // If there are requests in flight in another thread, usually closing
  12956. // the socket will be fine and they will simply receive an error when
  12957. // using the closed socket, but it is still a bug since rarely the OS
  12958. // may reassign the socket id to be used for a new socket, and then
  12959. // suddenly they will be operating on a live socket that is different
  12960. // than the one they intended!
  12961. assert(socket_requests_in_flight_ == 0 ||
  12962. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12963. // It is also a bug if this happens while SSL is still active
  12964. #ifdef CPPHTTPLIB_SSL_ENABLED
  12965. assert(socket.ssl == nullptr);
  12966. #endif
  12967. if (socket.sock == INVALID_SOCKET) { return; }
  12968. detail::close_socket(socket.sock);
  12969. socket.sock = INVALID_SOCKET;
  12970. }
  12971. inline void ClientImpl::disconnect(bool gracefully) {
  12972. shutdown_ssl(socket_, gracefully);
  12973. shutdown_socket(socket_);
  12974. close_socket(socket_);
  12975. }
  12976. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12977. Response &res,
  12978. bool skip_100_continue) const {
  12979. std::array<char, 2048> buf{};
  12980. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12981. if (!line_reader.getline()) { return false; }
  12982. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12983. res.reason)) {
  12984. return req.method == "CONNECT";
  12985. }
  12986. // Skip interim responses, such as 100 Continue (unless Expect:
  12987. // 100-continue is handled by the caller) and 103 Early Hints, along with
  12988. // their header fields. 101 ends HTTP on the connection, so it is final.
  12989. while (skip_100_continue && 100 <= res.status && res.status < 200 &&
  12990. res.status != StatusCode::SwitchingProtocol_101) {
  12991. Headers interim_headers;
  12992. if (!detail::read_headers(strm, interim_headers)) { return false; }
  12993. if (!line_reader.getline()) { return false; } // next response line
  12994. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12995. res.reason)) {
  12996. return false;
  12997. }
  12998. }
  12999. return true;
  13000. }
  13001. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13002. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13003. auto ret = send_(req, res, error);
  13004. if (error == Error::SSLPeerCouldBeClosed_) {
  13005. assert(!ret);
  13006. ret = send_(req, res, error);
  13007. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13008. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13009. }
  13010. return ret;
  13011. }
  13012. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13013. {
  13014. std::lock_guard<std::mutex> guard(socket_mutex_);
  13015. // Set this to false immediately - if it ever gets set to true by the end
  13016. // of the request, we know another thread instructed us to close the
  13017. // socket.
  13018. socket_should_be_closed_when_request_is_done_ = false;
  13019. auto is_alive = false;
  13020. if (socket_.is_open()) {
  13021. is_alive = detail::is_socket_alive(socket_.sock);
  13022. #ifdef CPPHTTPLIB_SSL_ENABLED
  13023. if (is_alive && is_ssl()) {
  13024. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13025. is_alive = false;
  13026. }
  13027. }
  13028. #endif
  13029. if (!is_alive) {
  13030. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13031. disconnect(/*gracefully=*/false);
  13032. }
  13033. }
  13034. if (!is_alive) {
  13035. if (!ensure_socket_connection(socket_, error)) {
  13036. output_error_log(error, &req);
  13037. return false;
  13038. }
  13039. {
  13040. auto success = true;
  13041. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13042. error)) {
  13043. if (!success) { output_error_log(error, &req); }
  13044. return success;
  13045. }
  13046. }
  13047. }
  13048. // Mark the current socket as being in use so that it cannot be closed by
  13049. // anyone else while this request is ongoing, even though we will be
  13050. // releasing the mutex.
  13051. if (socket_requests_in_flight_ > 1) {
  13052. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13053. }
  13054. socket_requests_in_flight_ += 1;
  13055. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13056. }
  13057. for (const auto &header : default_headers_) {
  13058. if (req.headers.find(header.first) == req.headers.end()) {
  13059. req.headers.insert(header);
  13060. }
  13061. }
  13062. auto ret = false;
  13063. auto close_connection = !keep_alive_;
  13064. auto se = detail::scope_exit([&]() {
  13065. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13066. std::lock_guard<std::mutex> guard(socket_mutex_);
  13067. socket_requests_in_flight_ -= 1;
  13068. if (socket_requests_in_flight_ <= 0) {
  13069. assert(socket_requests_in_flight_ == 0);
  13070. socket_requests_are_from_thread_ = std::thread::id();
  13071. }
  13072. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13073. !ret) {
  13074. disconnect(/*gracefully=*/true);
  13075. }
  13076. });
  13077. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13078. return handle_request(strm, req, res, close_connection, error);
  13079. });
  13080. if (!ret) {
  13081. if (error == Error::Success) {
  13082. error = Error::Unknown;
  13083. output_error_log(error, &req);
  13084. }
  13085. }
  13086. return ret;
  13087. }
  13088. inline Result ClientImpl::send(const Request &req) {
  13089. auto req2 = req;
  13090. return send_(std::move(req2));
  13091. }
  13092. inline Result ClientImpl::send_(Request &&req) {
  13093. auto res = detail::make_unique<Response>();
  13094. auto error = Error::Success;
  13095. auto ret = send(req, *res, error);
  13096. #ifdef CPPHTTPLIB_SSL_ENABLED
  13097. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13098. last_ssl_error_, last_backend_error_};
  13099. #else
  13100. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13101. #endif
  13102. }
  13103. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13104. const std::string &ct) {
  13105. (void)for_stream;
  13106. // Default headers are meant for the origin and may carry its credentials, so
  13107. // keep them off the CONNECT request the proxy reads.
  13108. if (r.method != "CONNECT") {
  13109. for (const auto &header : default_headers_) {
  13110. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13111. }
  13112. }
  13113. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13114. // prepend it rather than appending it after the caller's own fields.
  13115. if (!r.has_header("Host")) {
  13116. r.headers.emplace_front(
  13117. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13118. address_family_));
  13119. }
  13120. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13121. if (!r.content_receiver) {
  13122. if (!r.has_header("Accept-Encoding")) {
  13123. std::string accept_encoding;
  13124. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13125. accept_encoding = "br";
  13126. #endif
  13127. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13128. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13129. accept_encoding += "gzip, deflate";
  13130. #endif
  13131. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13132. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13133. accept_encoding += "zstd";
  13134. #endif
  13135. r.set_header("Accept-Encoding", accept_encoding);
  13136. }
  13137. detail::add_default_user_agent_header(r);
  13138. }
  13139. if (!r.body.empty()) {
  13140. if (!ct.empty() && !r.has_header("Content-Type")) {
  13141. r.headers.emplace("Content-Type", ct);
  13142. }
  13143. if (!r.has_header("Content-Length")) {
  13144. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13145. }
  13146. }
  13147. }
  13148. inline ClientImpl::StreamHandle
  13149. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13150. const Params &params, const Headers &headers,
  13151. const std::string &body,
  13152. const std::string &content_type) {
  13153. StreamHandle handle;
  13154. handle.response = detail::make_unique<Response>();
  13155. handle.error = Error::Success;
  13156. // Encode the target exactly like the buffered send path does, so that the
  13157. // same `path` produces the same request line through either API.
  13158. auto raw_query_path =
  13159. params.empty() ? path : append_query_params(path, params);
  13160. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13161. handle.connection_ = detail::make_unique<ClientConnection>();
  13162. {
  13163. std::lock_guard<std::mutex> guard(socket_mutex_);
  13164. auto is_alive = false;
  13165. if (socket_.is_open()) {
  13166. is_alive = detail::is_socket_alive(socket_.sock);
  13167. #ifdef CPPHTTPLIB_SSL_ENABLED
  13168. if (is_alive && is_ssl()) {
  13169. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13170. is_alive = false;
  13171. }
  13172. }
  13173. #endif
  13174. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13175. }
  13176. if (!is_alive) {
  13177. if (!ensure_socket_connection(socket_, handle.error)) {
  13178. handle.response.reset();
  13179. return handle;
  13180. }
  13181. {
  13182. auto success = true;
  13183. auto start_time = std::chrono::steady_clock::now();
  13184. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13185. success, handle.error)) {
  13186. if (!success) { handle.response.reset(); }
  13187. return handle;
  13188. }
  13189. }
  13190. }
  13191. transfer_socket_ownership_to_handle(handle);
  13192. }
  13193. #ifdef CPPHTTPLIB_SSL_ENABLED
  13194. if (is_ssl() && handle.connection_->session) {
  13195. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13196. handle.connection_->sock, handle.connection_->session,
  13197. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13198. write_timeout_usec_);
  13199. } else {
  13200. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13201. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13202. write_timeout_sec_, write_timeout_usec_);
  13203. }
  13204. #else
  13205. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13206. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13207. write_timeout_sec_, write_timeout_usec_);
  13208. #endif
  13209. handle.stream_ = handle.socket_stream_.get();
  13210. Request req;
  13211. req.method = method;
  13212. req.path = query_path;
  13213. req.headers = headers;
  13214. req.body = body;
  13215. prepare_default_headers(req, true, content_type);
  13216. auto &strm = *handle.stream_;
  13217. // Build the request line and headers in memory first, like write_request()
  13218. // does, so that a rejected header leaves nothing on the wire.
  13219. {
  13220. detail::BufferStream bstrm;
  13221. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13222. handle.error = Error::Write;
  13223. handle.response.reset();
  13224. return handle;
  13225. }
  13226. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13227. handle.error)) {
  13228. handle.response.reset();
  13229. return handle;
  13230. }
  13231. const auto &data = bstrm.get_buffer();
  13232. if (!detail::write_data(strm, data.data(), data.size())) {
  13233. handle.error = Error::Write;
  13234. handle.response.reset();
  13235. return handle;
  13236. }
  13237. }
  13238. if (!body.empty()) {
  13239. if (strm.write(body.data(), body.size()) < 0) {
  13240. handle.error = Error::Write;
  13241. handle.response.reset();
  13242. return handle;
  13243. }
  13244. }
  13245. if (!read_response_line(strm, req, *handle.response) ||
  13246. !detail::read_headers(strm, handle.response->headers)) {
  13247. handle.error = Error::Read;
  13248. handle.response.reset();
  13249. return handle;
  13250. }
  13251. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13252. // (204/304) response legitimately carries framing headers with no body.
  13253. if (method != "HEAD" &&
  13254. handle.response->status != StatusCode::NoContent_204 &&
  13255. handle.response->status != StatusCode::NotModified_304 &&
  13256. detail::has_conflicting_content_length(handle.response->headers)) {
  13257. handle.error = Error::Read;
  13258. handle.response.reset();
  13259. return handle;
  13260. }
  13261. handle.body_reader_.stream = handle.stream_;
  13262. handle.body_reader_.payload_max_length = payload_max_length_;
  13263. if (handle.response->has_header("Content-Length")) {
  13264. bool is_invalid = false;
  13265. auto content_length = detail::get_header_value_u64(
  13266. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13267. if (is_invalid) {
  13268. handle.error = Error::Read;
  13269. handle.response.reset();
  13270. return handle;
  13271. }
  13272. handle.body_reader_.has_content_length = true;
  13273. handle.body_reader_.content_length = content_length;
  13274. }
  13275. handle.body_reader_.chunked =
  13276. detail::is_chunked_transfer_encoding(handle.response->headers);
  13277. auto content_encoding = detail::get_combined_header_value(
  13278. handle.response->headers, "Content-Encoding");
  13279. if (!content_encoding.empty()) {
  13280. // Same policy as prepare_content_receiver(): reject a coding we know about
  13281. // but were not built with, pass an unrecognized one through as-is.
  13282. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13283. if (!handle.decompressor_) {
  13284. if (detail::is_known_content_encoding(content_encoding)) {
  13285. handle.error = Error::UnsupportedContentEncoding;
  13286. handle.response.reset();
  13287. return handle;
  13288. }
  13289. } else if (!handle.decompressor_->is_valid()) {
  13290. handle.error = Error::Compression;
  13291. handle.response.reset();
  13292. return handle;
  13293. }
  13294. }
  13295. return handle;
  13296. }
  13297. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13298. if (!is_valid() || !response) { return -1; }
  13299. if (decompressor_) { return read_with_decompression(buf, len); }
  13300. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13301. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13302. trailers_parsed_ = true;
  13303. if (body_reader_.chunked_decoder) {
  13304. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13305. response->trailers, response->headers)) {
  13306. return n;
  13307. }
  13308. } else {
  13309. detail::ChunkedDecoder dec(*stream_);
  13310. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13311. return n;
  13312. }
  13313. }
  13314. }
  13315. return n;
  13316. }
  13317. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13318. size_t len) {
  13319. if (decompress_offset_ < decompress_buffer_.size()) {
  13320. auto available = decompress_buffer_.size() - decompress_offset_;
  13321. auto to_copy = (std::min)(len, available);
  13322. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13323. decompress_offset_ += to_copy;
  13324. decompressed_bytes_read_ += to_copy;
  13325. return static_cast<ssize_t>(to_copy);
  13326. }
  13327. decompress_buffer_.clear();
  13328. decompress_offset_ = 0;
  13329. constexpr size_t kDecompressionBufferSize = 8192;
  13330. char compressed_buf[kDecompressionBufferSize];
  13331. while (true) {
  13332. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13333. sizeof(compressed_buf));
  13334. if (n <= 0) { return n; }
  13335. bool decompress_ok = decompressor_->decompress(
  13336. compressed_buf, static_cast<size_t>(n),
  13337. [this](const char *data, size_t data_len) {
  13338. decompress_buffer_.append(data, data_len);
  13339. auto limit = body_reader_.payload_max_length;
  13340. return limit == 0 ||
  13341. decompressed_bytes_read_ + decompress_buffer_.size() <= limit;
  13342. });
  13343. if (!decompress_ok) {
  13344. body_reader_.last_error = Error::Read;
  13345. return -1;
  13346. }
  13347. if (!decompress_buffer_.empty()) { break; }
  13348. }
  13349. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13350. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13351. decompress_offset_ = to_copy;
  13352. decompressed_bytes_read_ += to_copy;
  13353. return static_cast<ssize_t>(to_copy);
  13354. }
  13355. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13356. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13357. return;
  13358. }
  13359. trailers_parsed_ = true;
  13360. const auto bufsiz = 128;
  13361. char line_buf[bufsiz];
  13362. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13363. if (!line_reader.getline()) { return; }
  13364. if (!detail::parse_trailers(line_reader, response->trailers,
  13365. response->headers)) {
  13366. return;
  13367. }
  13368. }
  13369. namespace detail {
  13370. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13371. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13372. size_t &out_chunk_offset,
  13373. size_t &out_chunk_total) {
  13374. if (finished) { return 0; }
  13375. if (chunk_remaining == 0) {
  13376. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13377. if (!lr.getline()) { return -1; }
  13378. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13379. // the line terminator is never mistaken for line content.
  13380. const char *eol = lr.ptr() + lr.size();
  13381. if (lr.end_with_crlf()) {
  13382. eol -= 2;
  13383. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13384. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13385. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13386. // has to come off here or the check below would reject the line.
  13387. eol -= 1;
  13388. }
  13389. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13390. const char *p = lr.ptr();
  13391. int v = 0;
  13392. if (p == eol || !is_hex(*p, v)) { return -1; }
  13393. size_t chunk_len = 0;
  13394. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13395. for (; p < eol && is_hex(*p, v); ++p) {
  13396. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13397. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13398. }
  13399. while (p < eol && is_space_or_tab(*p)) {
  13400. ++p;
  13401. }
  13402. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13403. // terminator, and it is built from tokens and quoted-strings, so it never
  13404. // holds a CR, LF or any other control character. getline() reads up to the
  13405. // CRLF, so a bare LF left in here would be swallowed as extension text
  13406. // while an intermediary that ends the line on it delimits the chunks
  13407. // differently, and the two disagree on where the body ends (request
  13408. // smuggling).
  13409. if (p < eol && *p != ';') { return -1; }
  13410. for (; p < eol; ++p) {
  13411. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13412. }
  13413. if (chunk_len == 0) {
  13414. chunk_remaining = 0;
  13415. finished = true;
  13416. out_chunk_offset = 0;
  13417. out_chunk_total = 0;
  13418. return 0;
  13419. }
  13420. chunk_remaining = chunk_len;
  13421. last_chunk_total = chunk_remaining;
  13422. last_chunk_offset = 0;
  13423. }
  13424. auto to_read = (std::min)(chunk_remaining, len);
  13425. auto n = strm.read(buf, to_read);
  13426. if (n <= 0) { return -1; }
  13427. auto offset_before = last_chunk_offset;
  13428. last_chunk_offset += static_cast<size_t>(n);
  13429. chunk_remaining -= static_cast<size_t>(n);
  13430. out_chunk_offset = offset_before;
  13431. out_chunk_total = last_chunk_total;
  13432. if (chunk_remaining == 0) {
  13433. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13434. if (!lr.getline()) { return -1; }
  13435. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13436. }
  13437. return n;
  13438. }
  13439. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13440. const Headers &src_headers) {
  13441. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13442. if (!lr.getline()) { return false; }
  13443. return parse_trailers(lr, dest, src_headers);
  13444. }
  13445. } // namespace detail
  13446. inline void
  13447. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13448. handle.connection_->sock = socket_.sock;
  13449. #ifdef CPPHTTPLIB_SSL_ENABLED
  13450. handle.connection_->session = socket_.ssl;
  13451. socket_.ssl = nullptr;
  13452. #endif
  13453. socket_.sock = INVALID_SOCKET;
  13454. }
  13455. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13456. Response &res, bool close_connection,
  13457. Error &error) {
  13458. if (req.path.empty()) {
  13459. error = Error::Connection;
  13460. output_error_log(error, &req);
  13461. return false;
  13462. }
  13463. auto req_save = req;
  13464. bool ret;
  13465. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13466. auto req2 = req;
  13467. req2.path = "http://" +
  13468. detail::make_host_and_port_string(host_, port_, false) +
  13469. req.path;
  13470. ret = process_request(strm, req2, res, close_connection, error);
  13471. req = std::move(req2);
  13472. req.path = req_save.path;
  13473. } else {
  13474. ret = process_request(strm, req, res, close_connection, error);
  13475. }
  13476. if (!ret) { return false; }
  13477. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13478. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13479. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13480. // for this to be safe.
  13481. // This is safe to call because handle_request is only called by send_
  13482. // which locks the request mutex during the process. It would be a bug
  13483. // to call it from a different thread since it's a thread-safety issue
  13484. // to do these things to the socket if another thread is using the socket.
  13485. std::lock_guard<std::mutex> guard(socket_mutex_);
  13486. disconnect(/*gracefully=*/true);
  13487. }
  13488. if (300 < res.status && res.status < 400 && follow_location_) {
  13489. req = std::move(req_save);
  13490. // The client that followed the redirect has answered any challenge it
  13491. // could. Retrying below would sign another host's challenge and send it
  13492. // here.
  13493. return redirect(req, res, error);
  13494. }
  13495. #ifdef CPPHTTPLIB_SSL_ENABLED
  13496. if ((res.status == StatusCode::Unauthorized_401 ||
  13497. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13498. req.authorization_count_ < 5) {
  13499. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13500. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13501. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13502. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13503. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13504. return ret;
  13505. }
  13506. const auto &username =
  13507. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13508. const auto &password =
  13509. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13510. if (!username.empty() && !password.empty()) {
  13511. std::map<std::string, std::string> auth;
  13512. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13513. Request new_req = req;
  13514. new_req.authorization_count_ += 1;
  13515. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13516. : "Authorization");
  13517. new_req.headers.insert(detail::make_digest_authentication_header(
  13518. req, auth, new_req.authorization_count_, detail::random_string(10),
  13519. username, password, is_proxy));
  13520. Response new_res;
  13521. ret = send(new_req, new_res, error);
  13522. if (ret) { res = std::move(new_res); }
  13523. }
  13524. }
  13525. }
  13526. #endif
  13527. return ret;
  13528. }
  13529. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13530. if (req.redirect_count_ == 0) {
  13531. error = Error::ExceedRedirectCount;
  13532. output_error_log(error, &req);
  13533. return false;
  13534. }
  13535. auto location = res.get_header_value("location");
  13536. if (location.empty()) { return false; }
  13537. detail::UrlComponents uc;
  13538. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13539. uc)) {
  13540. return false;
  13541. }
  13542. // Only follow http/https redirects
  13543. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13544. return false;
  13545. }
  13546. auto scheme = is_ssl() ? "https" : "http";
  13547. auto next_scheme = std::move(uc.scheme);
  13548. auto next_host = std::move(uc.host);
  13549. auto port_str = std::move(uc.port);
  13550. auto next_path = std::move(uc.path);
  13551. auto next_query = std::move(uc.query);
  13552. auto next_port = port_;
  13553. if (!port_str.empty()) {
  13554. if (!detail::parse_port(port_str, next_port)) { return false; }
  13555. } else if (!next_scheme.empty()) {
  13556. next_port = next_scheme == "https" ? 443 : 80;
  13557. }
  13558. if (next_scheme.empty()) { next_scheme = scheme; }
  13559. if (next_host.empty()) { next_host = host_; }
  13560. if (next_path.empty()) { next_path = "/"; }
  13561. auto path = std::move(next_path) + next_query;
  13562. // Same host redirect - use current client
  13563. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13564. return detail::redirect(*this, req, res, path, location, error);
  13565. }
  13566. // Cross-host/scheme redirect - create new client with robust setup
  13567. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13568. path, location, error);
  13569. }
  13570. // New method for robust redirect client creation
  13571. inline bool ClientImpl::create_redirect_client(
  13572. const std::string &scheme, const std::string &host, int port, Request &req,
  13573. Response &res, const std::string &path, const std::string &location,
  13574. Error &error) {
  13575. // Determine if we need SSL
  13576. auto need_ssl = (scheme == "https");
  13577. // Clean up request headers that are host/client specific
  13578. // Remove headers that should not be carried over to new host
  13579. auto headers_to_remove = std::vector<std::string>{
  13580. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13581. for (const auto &header_name : headers_to_remove) {
  13582. auto it = req.headers.find(header_name);
  13583. while (it != req.headers.end()) {
  13584. it = req.headers.erase(it);
  13585. it = req.headers.find(header_name);
  13586. }
  13587. }
  13588. // Create appropriate client type and handle redirect
  13589. if (need_ssl) {
  13590. #ifdef CPPHTTPLIB_SSL_ENABLED
  13591. // Create SSL client for HTTPS redirect
  13592. SSLClient redirect_client(host, port);
  13593. // Setup basic client configuration first
  13594. setup_redirect_client(redirect_client);
  13595. redirect_client.enable_server_certificate_verification(
  13596. server_certificate_verification_);
  13597. redirect_client.enable_server_hostname_verification(
  13598. server_hostname_verification_);
  13599. redirect_client.system_ca_mode_ = system_ca_mode_;
  13600. // Transfer CA certificate to redirect client
  13601. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13602. ca_cert_pem_.size());
  13603. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13604. if (is_ssl()) {
  13605. auto &self = static_cast<SSLClient &>(*this);
  13606. // A store given to set_ca_cert_store() lives only in this client's
  13607. // context, so pass on the CA certificates the context holds.
  13608. if (self.ca_cert_store_set_) {
  13609. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13610. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13611. }
  13612. redirect_client.set_session_verifier(self.session_verifier_);
  13613. if (self.server_certificate_verifier_) {
  13614. redirect_client.set_server_certificate_verifier(
  13615. self.server_certificate_verifier_);
  13616. }
  13617. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13618. redirect_client.enable_windows_cert_verification_ =
  13619. self.enable_windows_cert_verification_;
  13620. #endif
  13621. }
  13622. // Client certificates are set through constructor for SSLClient
  13623. // NOTE: SSLClient constructor already takes client_cert_path and
  13624. // client_key_path so we need to create it properly if client certs are
  13625. // needed
  13626. // Execute the redirect
  13627. return detail::redirect(redirect_client, req, res, path, location, error);
  13628. #else
  13629. // SSL not supported - set appropriate error
  13630. error = Error::SSLConnection;
  13631. output_error_log(error, &req);
  13632. return false;
  13633. #endif
  13634. } else {
  13635. // HTTP redirect
  13636. ClientImpl redirect_client(host, port);
  13637. // Setup client with robust configuration
  13638. setup_redirect_client(redirect_client);
  13639. // Execute the redirect
  13640. return detail::redirect(redirect_client, req, res, path, location, error);
  13641. }
  13642. }
  13643. // New method for robust client setup (based on basic_manual_redirect.cpp
  13644. // logic)
  13645. template <typename ClientType>
  13646. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13647. // Copy basic settings first
  13648. client.set_connection_timeout(connection_timeout_sec_,
  13649. connection_timeout_usec_);
  13650. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13651. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13652. client.set_max_timeout(max_timeout_msec_);
  13653. if (has_payload_max_length_) {
  13654. client.set_payload_max_length(payload_max_length_);
  13655. }
  13656. client.set_keep_alive(keep_alive_);
  13657. client.set_follow_location(
  13658. true); // Enable redirects to handle multi-step redirects
  13659. client.set_path_encode(path_encode_);
  13660. client.set_compress(compress_);
  13661. client.set_decompress(decompress_);
  13662. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13663. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13664. // 15.4, credentials must not be forwarded when redirecting to a different
  13665. // host. This function is only called for cross-host redirects; same-host
  13666. // redirects are handled directly in ClientImpl::redirect().
  13667. // Copy the proxy configuration unconditionally; the per-target bypass is
  13668. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13669. // still use the proxy.
  13670. client.no_proxy_entries_ = no_proxy_entries_;
  13671. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13672. client.set_proxy(proxy_host_, proxy_port_);
  13673. if (!proxy_basic_auth_username_.empty() ||
  13674. !proxy_basic_auth_password_.empty()) {
  13675. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13676. proxy_basic_auth_password_);
  13677. }
  13678. if (!proxy_bearer_token_auth_token_.empty()) {
  13679. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13680. }
  13681. #ifdef CPPHTTPLIB_SSL_ENABLED
  13682. if (!proxy_digest_auth_username_.empty()) {
  13683. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13684. proxy_digest_auth_password_);
  13685. }
  13686. #endif
  13687. }
  13688. // Copy network and socket settings
  13689. client.addr_map_ = addr_map_;
  13690. client.set_address_family(address_family_);
  13691. client.set_tcp_nodelay(tcp_nodelay_);
  13692. client.set_ipv6_v6only(ipv6_v6only_);
  13693. if (socket_options_) { client.set_socket_options(socket_options_); }
  13694. if (!interface_.empty()) { client.set_interface(interface_); }
  13695. // Copy logging and headers
  13696. if (logger_) { client.set_logger(logger_); }
  13697. if (error_logger_) { client.set_error_logger(error_logger_); }
  13698. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13699. // Each new client should generate its own headers based on its target host
  13700. }
  13701. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13702. const Request &req,
  13703. Error &error) const {
  13704. auto is_shutting_down = []() { return false; };
  13705. if (req.is_chunked_content_provider_) {
  13706. auto compressor = compress_ ? detail::create_compressor().first
  13707. : std::unique_ptr<detail::compressor>();
  13708. if (!compressor) {
  13709. compressor = detail::make_unique<detail::nocompressor>();
  13710. }
  13711. return detail::write_content_chunked(strm, req.content_provider_,
  13712. is_shutting_down, *compressor, error);
  13713. } else {
  13714. return detail::write_content_with_progress(
  13715. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13716. req.upload_progress, error);
  13717. }
  13718. }
  13719. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13720. bool close_connection, Error &error,
  13721. bool skip_body, bool &rejected_locally) {
  13722. rejected_locally = false;
  13723. // Prepare additional headers
  13724. if (close_connection) {
  13725. if (!req.has_header("Connection")) {
  13726. req.set_header("Connection", "close");
  13727. }
  13728. }
  13729. std::string ct_for_defaults;
  13730. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13731. ct_for_defaults = "text/plain";
  13732. }
  13733. prepare_default_headers(req, false, ct_for_defaults);
  13734. if (req.body.empty()) {
  13735. if (req.content_provider_) {
  13736. if (!req.is_chunked_content_provider_) {
  13737. if (!req.has_header("Content-Length")) {
  13738. auto length = std::to_string(req.content_length_);
  13739. req.set_header("Content-Length", length);
  13740. }
  13741. }
  13742. } else {
  13743. if (req.method == "POST" || req.method == "PUT" ||
  13744. req.method == "PATCH") {
  13745. req.set_header("Content-Length", "0");
  13746. }
  13747. }
  13748. }
  13749. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13750. // it opens is read by the origin. Each credential goes only to its own hop.
  13751. auto is_connect = req.method == "CONNECT";
  13752. if (!is_connect && !req.has_header("Authorization")) {
  13753. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13754. req.headers.insert(make_basic_authentication_header(
  13755. basic_auth_username_, basic_auth_password_, false));
  13756. } else if (!bearer_token_auth_token_.empty()) {
  13757. req.headers.insert(make_bearer_token_authentication_header(
  13758. bearer_token_auth_token_, false));
  13759. }
  13760. }
  13761. // Proxy-Authorization is only sent when the proxy reads this message —
  13762. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13763. // would leak proxy credentials to the destination server.
  13764. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13765. if ((!proxy_basic_auth_username_.empty() ||
  13766. !proxy_basic_auth_password_.empty()) &&
  13767. !req.has_header("Proxy-Authorization")) {
  13768. req.headers.insert(make_basic_authentication_header(
  13769. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13770. }
  13771. if (!proxy_bearer_token_auth_token_.empty() &&
  13772. !req.has_header("Proxy-Authorization")) {
  13773. req.headers.insert(make_bearer_token_authentication_header(
  13774. proxy_bearer_token_auth_token_, true));
  13775. }
  13776. }
  13777. // Request line and headers
  13778. {
  13779. detail::BufferStream bstrm;
  13780. // Extract the query from req.path. The encoding itself is delegated to
  13781. // `encode_request_target`; the raw query is still needed here to decide
  13782. // between populating `req.params` from it and falling back to building a
  13783. // query out of caller-supplied `req.params`.
  13784. auto query_pos = req.path.find('?');
  13785. auto query_part = query_pos == std::string::npos
  13786. ? std::string()
  13787. : req.path.substr(query_pos + 1);
  13788. auto path_with_query =
  13789. detail::encode_request_target(req.path, path_encode_);
  13790. if (!query_part.empty()) {
  13791. // The query already came in through `req.path`; still populate
  13792. // `req.params` for handlers/users who read them.
  13793. detail::parse_query_text(query_part, req.params);
  13794. } else if (!req.params.empty()) {
  13795. // No query in `req.path`; build one from `req.params` so existing
  13796. // callers that pass `Params` separately continue to work.
  13797. path_with_query = append_query_params(path_with_query, req.params);
  13798. }
  13799. // Write request line and headers
  13800. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13801. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13802. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13803. // fail the request cleanly instead of emitting a request-line-less,
  13804. // header-injecting request.
  13805. error = Error::Write;
  13806. rejected_locally = true;
  13807. output_error_log(error, &req);
  13808. return false;
  13809. }
  13810. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13811. error)) {
  13812. rejected_locally = true;
  13813. output_error_log(error, &req);
  13814. return false;
  13815. }
  13816. // Flush buffer
  13817. auto &data = bstrm.get_buffer();
  13818. if (!detail::write_data(strm, data.data(), data.size())) {
  13819. error = Error::Write;
  13820. output_error_log(error, &req);
  13821. return false;
  13822. }
  13823. }
  13824. // After sending request line and headers, wait briefly for an early server
  13825. // response (e.g. 4xx) and avoid sending a potentially large request body
  13826. // unnecessarily. This workaround is only enabled on Windows because Unix
  13827. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13828. // buffering can accept large writes even when the peer already responded.
  13829. // Check the stream first (which covers SSL via `is_readable()`), then
  13830. // fall back to select on the socket. Only perform the wait for very large
  13831. // request bodies to avoid interfering with normal small requests and
  13832. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13833. // response. Skip this check when using Expect: 100-continue, as the protocol
  13834. // handles early responses properly.
  13835. #if defined(_WIN32)
  13836. if (!skip_body &&
  13837. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13838. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13839. auto start = std::chrono::high_resolution_clock::now();
  13840. for (;;) {
  13841. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13842. // from SSL internals. If the underlying socket is readable, assume an
  13843. // early response may be present.
  13844. auto sock = strm.socket();
  13845. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13846. return false;
  13847. }
  13848. // Fallback to stream-level check for non-socket streams or when the
  13849. // socket isn't reporting readable. Avoid using `is_readable()` for
  13850. // SSL, since `SSL_pending()` may report buffered records that do not
  13851. // indicate a complete application-level response yet.
  13852. if (!is_ssl() && strm.is_readable()) { return false; }
  13853. auto now = std::chrono::high_resolution_clock::now();
  13854. auto elapsed =
  13855. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13856. .count();
  13857. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13858. break;
  13859. }
  13860. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13861. }
  13862. }
  13863. #endif
  13864. // Body
  13865. if (skip_body) { return true; }
  13866. return write_request_body(strm, req, error);
  13867. }
  13868. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13869. Error &error) {
  13870. if (req.body.empty()) {
  13871. return write_content_with_provider(strm, req, error);
  13872. }
  13873. if (req.upload_progress) {
  13874. auto body_size = req.body.size();
  13875. size_t written = 0;
  13876. auto data = req.body.data();
  13877. while (written < body_size) {
  13878. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13879. if (!detail::write_data(strm, data + written, to_write)) {
  13880. error = Error::Write;
  13881. output_error_log(error, &req);
  13882. return false;
  13883. }
  13884. written += to_write;
  13885. if (!req.upload_progress(written, body_size)) {
  13886. error = Error::Canceled;
  13887. output_error_log(error, &req);
  13888. return false;
  13889. }
  13890. }
  13891. } else {
  13892. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13893. error = Error::Write;
  13894. output_error_log(error, &req);
  13895. return false;
  13896. }
  13897. }
  13898. return true;
  13899. }
  13900. inline std::unique_ptr<Response>
  13901. ClientImpl::send_with_content_provider_and_receiver(
  13902. Request &req, const char *body, size_t content_length,
  13903. ContentProvider content_provider,
  13904. ContentProviderWithoutLength content_provider_without_length,
  13905. const std::string &content_type, ContentReceiver content_receiver,
  13906. Error &error) {
  13907. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13908. auto enc = compress_
  13909. ? detail::create_compressor()
  13910. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13911. nullptr, nullptr);
  13912. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13913. if (enc.first && !content_provider_without_length) {
  13914. auto &compressor = enc.first;
  13915. if (content_provider) {
  13916. auto ok = true;
  13917. auto finished = false;
  13918. size_t offset = 0;
  13919. DataSink data_sink;
  13920. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13921. if (ok) {
  13922. auto last = offset + data_len == content_length;
  13923. auto ret = compressor->compress(
  13924. data, data_len, last,
  13925. [&](const char *compressed_data, size_t compressed_data_len) {
  13926. req.body.append(compressed_data, compressed_data_len);
  13927. return true;
  13928. });
  13929. if (ret) {
  13930. offset += data_len;
  13931. } else {
  13932. ok = false;
  13933. }
  13934. }
  13935. return ok;
  13936. };
  13937. // As in detail::write_content_with_progress(): the body is framed by
  13938. // content_length, so a provider that finishes early has truncated it.
  13939. // Stop and report that instead of calling the provider forever.
  13940. data_sink.done = [&]() { finished = true; };
  13941. while (ok && !finished && offset < content_length) {
  13942. if (!content_provider(offset, content_length - offset, data_sink)) {
  13943. error = Error::Canceled;
  13944. output_error_log(error, &req);
  13945. return nullptr;
  13946. }
  13947. }
  13948. // A short body here means either the provider stopped early or the
  13949. // compressor gave up. The branch below reports a failing compressor as
  13950. // Error::Compression, so keep the two distinguishable.
  13951. if (offset < content_length) {
  13952. error = ok ? Error::Write : Error::Compression;
  13953. output_error_log(error, &req);
  13954. return nullptr;
  13955. }
  13956. } else {
  13957. if (!compressor->compress(body, content_length, true,
  13958. [&](const char *data, size_t data_len) {
  13959. req.body.append(data, data_len);
  13960. return true;
  13961. })) {
  13962. error = Error::Compression;
  13963. output_error_log(error, &req);
  13964. return nullptr;
  13965. }
  13966. }
  13967. } else {
  13968. if (content_provider) {
  13969. req.content_length_ = content_length;
  13970. req.content_provider_ = std::move(content_provider);
  13971. req.is_chunked_content_provider_ = false;
  13972. } else if (content_provider_without_length) {
  13973. req.content_length_ = 0;
  13974. req.content_provider_ = detail::ContentProviderAdapter(
  13975. std::move(content_provider_without_length));
  13976. req.is_chunked_content_provider_ = true;
  13977. req.set_header("Transfer-Encoding", "chunked");
  13978. } else {
  13979. req.body.assign(body, content_length);
  13980. }
  13981. }
  13982. if (content_receiver) {
  13983. req.content_receiver =
  13984. [content_receiver](const char *data, size_t data_length,
  13985. size_t /*offset*/, size_t /*total_length*/) {
  13986. return content_receiver(data, data_length);
  13987. };
  13988. }
  13989. auto res = detail::make_unique<Response>();
  13990. return send(req, *res, error) ? std::move(res) : nullptr;
  13991. }
  13992. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13993. const std::string &method, const std::string &path, const Headers &headers,
  13994. const char *body, size_t content_length, ContentProvider content_provider,
  13995. ContentProviderWithoutLength content_provider_without_length,
  13996. const std::string &content_type, ContentReceiver content_receiver,
  13997. UploadProgress progress) {
  13998. Request req;
  13999. req.method = method;
  14000. req.headers = headers;
  14001. req.path = path;
  14002. req.upload_progress = std::move(progress);
  14003. if (max_timeout_msec_ > 0) {
  14004. req.start_time_ = std::chrono::steady_clock::now();
  14005. }
  14006. auto error = Error::Success;
  14007. auto res = send_with_content_provider_and_receiver(
  14008. req, body, content_length, std::move(content_provider),
  14009. std::move(content_provider_without_length), content_type,
  14010. std::move(content_receiver), error);
  14011. #ifdef CPPHTTPLIB_SSL_ENABLED
  14012. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14013. last_backend_error_};
  14014. #else
  14015. return Result{std::move(res), error, std::move(req.headers)};
  14016. #endif
  14017. }
  14018. inline void ClientImpl::output_log(const Request &req,
  14019. const Response &res) const {
  14020. if (logger_) {
  14021. std::lock_guard<std::mutex> guard(logger_mutex_);
  14022. logger_(req, res);
  14023. }
  14024. }
  14025. inline void ClientImpl::output_error_log(const Error &err,
  14026. const Request *req) const {
  14027. if (error_logger_) {
  14028. std::lock_guard<std::mutex> guard(logger_mutex_);
  14029. error_logger_(err, req);
  14030. }
  14031. }
  14032. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14033. Response &res, bool close_connection,
  14034. Error &error) {
  14035. // Auto-add Expect: 100-continue for large bodies
  14036. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14037. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14038. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14039. req.set_header("Expect", "100-continue");
  14040. }
  14041. }
  14042. // Check for Expect: 100-continue
  14043. auto expect_100_continue =
  14044. detail::has_header_token(req.headers, "Expect", "100-continue");
  14045. // Send request (skip body if using Expect: 100-continue)
  14046. auto rejected_locally = false;
  14047. auto write_request_success =
  14048. write_request(strm, req, close_connection, error, expect_100_continue,
  14049. rejected_locally);
  14050. // A failed write normally still reads the response below, since the server
  14051. // may have answered early (e.g. 413/414) and closed while the body was being
  14052. // sent. A request rejected before any byte reached the socket gets no such
  14053. // response, and waiting for one would block until the read timeout.
  14054. if (rejected_locally) { return false; }
  14055. #ifdef CPPHTTPLIB_SSL_ENABLED
  14056. if (is_ssl() && !expect_100_continue) {
  14057. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14058. if (!is_proxy_enabled) {
  14059. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14060. error = Error::SSLPeerCouldBeClosed_;
  14061. output_error_log(error, &req);
  14062. return false;
  14063. }
  14064. }
  14065. }
  14066. #endif
  14067. // Handle Expect: 100-continue.
  14068. //
  14069. // Wait for an interim/early response by attempting to read the status line
  14070. // under a short timeout, instead of trusting raw socket readability. Over
  14071. // TLS, post-handshake records (e.g. session tickets) make the socket
  14072. // readable without any HTTP response being available; relying on
  14073. // `select_read` there caused the body to be withheld forever and the
  14074. // request to fail with `Read` (#2458). If no status line arrives within the
  14075. // timeout, send the body anyway (matching curl's behavior).
  14076. auto status_line_read = false;
  14077. if (expect_100_continue && write_request_success) {
  14078. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14079. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14080. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14081. strm.set_read_timeout(sec, usec);
  14082. status_line_read = read_response_line(strm, req, res, false);
  14083. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14084. }
  14085. if (!status_line_read) {
  14086. // No interim response within the timeout: send the body and handle the
  14087. // response as usual.
  14088. if (!write_request_body(strm, req, error)) { return false; }
  14089. expect_100_continue = false; // Switch to normal response handling
  14090. }
  14091. }
  14092. // Receive response and headers
  14093. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14094. if ((!status_line_read &&
  14095. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14096. !detail::read_headers(strm, res.headers)) {
  14097. if (write_request_success) { error = Error::Read; }
  14098. output_error_log(error, &req);
  14099. return false;
  14100. }
  14101. if (!write_request_success) { return false; }
  14102. // Handle Expect: 100-continue response
  14103. if (expect_100_continue) {
  14104. if (res.status == StatusCode::Continue_100) {
  14105. // Server accepted, send the body
  14106. if (!write_request_body(strm, req, error)) { return false; }
  14107. // Read the actual response
  14108. res.headers.clear();
  14109. res.body.clear();
  14110. if (!read_response_line(strm, req, res) ||
  14111. !detail::read_headers(strm, res.headers)) {
  14112. error = Error::Read;
  14113. output_error_log(error, &req);
  14114. return false;
  14115. }
  14116. } else {
  14117. // A final response came first, so the body this request declared was
  14118. // never sent, and the server may still be waiting for it. The
  14119. // connection cannot carry another request.
  14120. std::lock_guard<std::mutex> guard(socket_mutex_);
  14121. socket_should_be_closed_when_request_is_done_ = true;
  14122. }
  14123. }
  14124. // Body
  14125. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14126. req.method != "CONNECT") {
  14127. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14128. // whose final transfer coding is not chunked is not ambiguous: its body
  14129. // runs until the server closes the connection, so it is not rejected.
  14130. // HEAD/204 are excluded above and a 304 carries no body.
  14131. if (res.status != StatusCode::NotModified_304 &&
  14132. detail::has_conflicting_content_length(res.headers)) {
  14133. error = Error::Read;
  14134. output_error_log(error, &req);
  14135. return false;
  14136. }
  14137. auto redirect = 300 < res.status && res.status < 400 &&
  14138. res.status != StatusCode::NotModified_304 &&
  14139. follow_location_;
  14140. if (req.response_handler && !redirect) {
  14141. if (!req.response_handler(res)) {
  14142. error = Error::Canceled;
  14143. output_error_log(error, &req);
  14144. return false;
  14145. }
  14146. }
  14147. auto out =
  14148. req.content_receiver
  14149. ? static_cast<ContentReceiverWithProgress>(
  14150. [&](const char *buf, size_t n, size_t off, size_t len) {
  14151. if (redirect) { return true; }
  14152. auto ret = req.content_receiver(buf, n, off, len);
  14153. if (!ret) {
  14154. error = Error::Canceled;
  14155. output_error_log(error, &req);
  14156. }
  14157. return ret;
  14158. })
  14159. : static_cast<ContentReceiverWithProgress>(
  14160. [&](const char *buf, size_t n, size_t /*off*/,
  14161. size_t /*len*/) {
  14162. assert(res.body.size() + n <= res.body.max_size());
  14163. if (payload_max_length_ > 0 &&
  14164. (res.body.size() >= payload_max_length_ ||
  14165. n > payload_max_length_ - res.body.size())) {
  14166. return false;
  14167. }
  14168. res.body.append(buf, n);
  14169. return true;
  14170. });
  14171. auto progress = [&](size_t current, size_t total) {
  14172. if (!req.download_progress || redirect) { return true; }
  14173. auto ret = req.download_progress(current, total);
  14174. if (!ret) {
  14175. error = Error::Canceled;
  14176. output_error_log(error, &req);
  14177. }
  14178. return ret;
  14179. };
  14180. if (res.has_header("Content-Length")) {
  14181. if (!req.content_receiver) {
  14182. auto len = res.get_header_value_u64("Content-Length");
  14183. if (len > res.body.max_size()) {
  14184. error = Error::Read;
  14185. output_error_log(error, &req);
  14186. return false;
  14187. }
  14188. // Content-Length is only the server's claim, so reserve no more than
  14189. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14190. // body has arrived. A longer body grows as it is read.
  14191. auto reserve_len =
  14192. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14193. if (payload_max_length_ > 0) {
  14194. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14195. }
  14196. res.body.reserve(reserve_len);
  14197. }
  14198. }
  14199. if (res.status != StatusCode::NotModified_304) {
  14200. auto content_status = 0;
  14201. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14202. ? (std::numeric_limits<size_t>::max)()
  14203. : payload_max_length_;
  14204. if (!detail::read_content(strm, res, max_length, content_status,
  14205. std::move(progress), std::move(out),
  14206. decompress_)) {
  14207. if (error != Error::Canceled) {
  14208. // Tell the caller apart from a plain read failure when the body could
  14209. // not be decoded because of its Content-Encoding.
  14210. switch (content_status) {
  14211. case StatusCode::UnsupportedMediaType_415:
  14212. error = Error::UnsupportedContentEncoding;
  14213. break;
  14214. case StatusCode::InternalServerError_500:
  14215. error = Error::Compression;
  14216. break;
  14217. default: error = Error::Read; break;
  14218. }
  14219. }
  14220. output_error_log(error, &req);
  14221. return false;
  14222. }
  14223. }
  14224. }
  14225. // Log
  14226. output_log(req, res);
  14227. return true;
  14228. }
  14229. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14230. const std::string &boundary, const UploadFormDataItems &items,
  14231. const FormDataProviderItems &provider_items) const {
  14232. size_t cur_item = 0;
  14233. size_t cur_start = 0;
  14234. // cur_item and cur_start are copied to within the std::function and
  14235. // maintain state between successive calls
  14236. return [&, cur_item, cur_start](size_t offset,
  14237. DataSink &sink) mutable -> bool {
  14238. if (!offset && !items.empty()) {
  14239. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14240. return true;
  14241. } else if (cur_item < provider_items.size()) {
  14242. if (!cur_start) {
  14243. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14244. provider_items[cur_item], boundary);
  14245. offset += begin.size();
  14246. cur_start = offset;
  14247. sink.os << begin;
  14248. }
  14249. DataSink cur_sink;
  14250. auto has_data = true;
  14251. cur_sink.write = sink.write;
  14252. // Forward is_writable so a provider item asking whether it may keep
  14253. // going gets the outer sink's answer rather than the default `true`.
  14254. cur_sink.is_writable = sink.is_writable;
  14255. cur_sink.done = [&]() { has_data = false; };
  14256. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14257. return false;
  14258. }
  14259. if (!has_data) {
  14260. sink.os << detail::serialize_multipart_formdata_item_end();
  14261. cur_item++;
  14262. cur_start = 0;
  14263. }
  14264. return true;
  14265. } else {
  14266. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14267. sink.done();
  14268. return true;
  14269. }
  14270. };
  14271. }
  14272. inline bool ClientImpl::process_socket(
  14273. const Socket &socket,
  14274. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14275. std::function<bool(Stream &strm)> callback) {
  14276. return detail::process_client_socket(
  14277. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14278. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14279. }
  14280. inline bool ClientImpl::is_ssl() const { return false; }
  14281. inline Result ClientImpl::Get(const std::string &path,
  14282. DownloadProgress progress) {
  14283. return Get(path, Headers(), std::move(progress));
  14284. }
  14285. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14286. DownloadProgress progress) {
  14287. return Get(path, params, Headers(), std::move(progress));
  14288. }
  14289. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14290. const Headers &headers,
  14291. DownloadProgress progress) {
  14292. if (params.empty()) { return Get(path, headers); }
  14293. std::string path_with_query = append_query_params(path, params);
  14294. return Get(path_with_query, headers, std::move(progress));
  14295. }
  14296. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14297. DownloadProgress progress) {
  14298. Request req;
  14299. req.method = "GET";
  14300. req.path = path;
  14301. req.headers = headers;
  14302. req.download_progress = std::move(progress);
  14303. if (max_timeout_msec_ > 0) {
  14304. req.start_time_ = std::chrono::steady_clock::now();
  14305. }
  14306. return send_(std::move(req));
  14307. }
  14308. inline Result ClientImpl::Get(const std::string &path,
  14309. ContentReceiver content_receiver,
  14310. DownloadProgress progress) {
  14311. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14312. std::move(progress));
  14313. }
  14314. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14315. ContentReceiver content_receiver,
  14316. DownloadProgress progress) {
  14317. return Get(path, headers, nullptr, std::move(content_receiver),
  14318. std::move(progress));
  14319. }
  14320. inline Result ClientImpl::Get(const std::string &path,
  14321. ResponseHandler response_handler,
  14322. ContentReceiver content_receiver,
  14323. DownloadProgress progress) {
  14324. return Get(path, Headers(), std::move(response_handler),
  14325. std::move(content_receiver), std::move(progress));
  14326. }
  14327. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14328. ResponseHandler response_handler,
  14329. ContentReceiver content_receiver,
  14330. DownloadProgress progress) {
  14331. Request req;
  14332. req.method = "GET";
  14333. req.path = path;
  14334. req.headers = headers;
  14335. req.response_handler = std::move(response_handler);
  14336. req.content_receiver =
  14337. [content_receiver](const char *data, size_t data_length,
  14338. size_t /*offset*/, size_t /*total_length*/) {
  14339. return content_receiver(data, data_length);
  14340. };
  14341. req.download_progress = std::move(progress);
  14342. if (max_timeout_msec_ > 0) {
  14343. req.start_time_ = std::chrono::steady_clock::now();
  14344. }
  14345. return send_(std::move(req));
  14346. }
  14347. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14348. const Headers &headers,
  14349. ContentReceiver content_receiver,
  14350. DownloadProgress progress) {
  14351. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14352. std::move(progress));
  14353. }
  14354. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14355. const Headers &headers,
  14356. ResponseHandler response_handler,
  14357. ContentReceiver content_receiver,
  14358. DownloadProgress progress) {
  14359. if (params.empty()) {
  14360. return Get(path, headers, std::move(response_handler),
  14361. std::move(content_receiver), std::move(progress));
  14362. }
  14363. std::string path_with_query = append_query_params(path, params);
  14364. return Get(path_with_query, headers, std::move(response_handler),
  14365. std::move(content_receiver), std::move(progress));
  14366. }
  14367. inline Result ClientImpl::Head(const std::string &path) {
  14368. return Head(path, Headers());
  14369. }
  14370. inline Result ClientImpl::Head(const std::string &path,
  14371. const Headers &headers) {
  14372. Request req;
  14373. req.method = "HEAD";
  14374. req.headers = headers;
  14375. req.path = path;
  14376. if (max_timeout_msec_ > 0) {
  14377. req.start_time_ = std::chrono::steady_clock::now();
  14378. }
  14379. return send_(std::move(req));
  14380. }
  14381. inline Result ClientImpl::Post(const std::string &path) {
  14382. return Post(path, std::string(), std::string());
  14383. }
  14384. inline Result ClientImpl::Post(const std::string &path,
  14385. const Headers &headers) {
  14386. return Post(path, headers, nullptr, 0, std::string());
  14387. }
  14388. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14389. size_t content_length,
  14390. const std::string &content_type,
  14391. UploadProgress progress) {
  14392. return Post(path, Headers(), body, content_length, content_type, progress);
  14393. }
  14394. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14395. const std::string &content_type,
  14396. UploadProgress progress) {
  14397. return Post(path, Headers(), body, content_type, progress);
  14398. }
  14399. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14400. return Post(path, Headers(), params);
  14401. }
  14402. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14403. ContentProvider content_provider,
  14404. const std::string &content_type,
  14405. UploadProgress progress) {
  14406. return Post(path, Headers(), content_length, std::move(content_provider),
  14407. content_type, progress);
  14408. }
  14409. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14410. ContentProvider content_provider,
  14411. const std::string &content_type,
  14412. ContentReceiver content_receiver,
  14413. UploadProgress progress) {
  14414. return Post(path, Headers(), content_length, std::move(content_provider),
  14415. content_type, std::move(content_receiver), progress);
  14416. }
  14417. inline Result ClientImpl::Post(const std::string &path,
  14418. ContentProviderWithoutLength content_provider,
  14419. const std::string &content_type,
  14420. UploadProgress progress) {
  14421. return Post(path, Headers(), std::move(content_provider), content_type,
  14422. progress);
  14423. }
  14424. inline Result ClientImpl::Post(const std::string &path,
  14425. ContentProviderWithoutLength content_provider,
  14426. const std::string &content_type,
  14427. ContentReceiver content_receiver,
  14428. UploadProgress progress) {
  14429. return Post(path, Headers(), std::move(content_provider), content_type,
  14430. std::move(content_receiver), progress);
  14431. }
  14432. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14433. const Params &params) {
  14434. auto query = detail::params_to_query_str(params);
  14435. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14436. }
  14437. inline Result ClientImpl::Post(const std::string &path,
  14438. const UploadFormDataItems &items,
  14439. UploadProgress progress) {
  14440. return Post(path, Headers(), items, progress);
  14441. }
  14442. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14443. const UploadFormDataItems &items,
  14444. UploadProgress progress) {
  14445. const auto &boundary = detail::make_multipart_data_boundary();
  14446. const auto &content_type =
  14447. detail::serialize_multipart_formdata_get_content_type(boundary);
  14448. auto content_length = detail::get_multipart_content_length(items, boundary);
  14449. return Post(path, headers, content_length,
  14450. detail::make_multipart_content_provider(items, boundary),
  14451. content_type, progress);
  14452. }
  14453. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14454. const UploadFormDataItems &items,
  14455. const std::string &boundary,
  14456. UploadProgress progress) {
  14457. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14458. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14459. }
  14460. const auto &content_type =
  14461. detail::serialize_multipart_formdata_get_content_type(boundary);
  14462. auto content_length = detail::get_multipart_content_length(items, boundary);
  14463. return Post(path, headers, content_length,
  14464. detail::make_multipart_content_provider(items, boundary),
  14465. content_type, progress);
  14466. }
  14467. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14468. const char *body, size_t content_length,
  14469. const std::string &content_type,
  14470. UploadProgress progress) {
  14471. return send_with_content_provider_and_receiver(
  14472. "POST", path, headers, body, content_length, nullptr, nullptr,
  14473. content_type, nullptr, progress);
  14474. }
  14475. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14476. const std::string &body,
  14477. const std::string &content_type,
  14478. UploadProgress progress) {
  14479. return send_with_content_provider_and_receiver(
  14480. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14481. content_type, nullptr, progress);
  14482. }
  14483. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14484. size_t content_length,
  14485. ContentProvider content_provider,
  14486. const std::string &content_type,
  14487. UploadProgress progress) {
  14488. return send_with_content_provider_and_receiver(
  14489. "POST", path, headers, nullptr, content_length,
  14490. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14491. }
  14492. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14493. size_t content_length,
  14494. ContentProvider content_provider,
  14495. const std::string &content_type,
  14496. ContentReceiver content_receiver,
  14497. DownloadProgress progress) {
  14498. return send_with_content_provider_and_receiver(
  14499. "POST", path, headers, nullptr, content_length,
  14500. std::move(content_provider), nullptr, content_type,
  14501. std::move(content_receiver), std::move(progress));
  14502. }
  14503. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14504. ContentProviderWithoutLength content_provider,
  14505. const std::string &content_type,
  14506. UploadProgress progress) {
  14507. return send_with_content_provider_and_receiver(
  14508. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14509. content_type, nullptr, progress);
  14510. }
  14511. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14512. ContentProviderWithoutLength content_provider,
  14513. const std::string &content_type,
  14514. ContentReceiver content_receiver,
  14515. DownloadProgress progress) {
  14516. return send_with_content_provider_and_receiver(
  14517. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14518. content_type, std::move(content_receiver), std::move(progress));
  14519. }
  14520. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14521. const UploadFormDataItems &items,
  14522. const FormDataProviderItems &provider_items,
  14523. UploadProgress progress) {
  14524. const auto &boundary = detail::make_multipart_data_boundary();
  14525. const auto &content_type =
  14526. detail::serialize_multipart_formdata_get_content_type(boundary);
  14527. return send_with_content_provider_and_receiver(
  14528. "POST", path, headers, nullptr, 0, nullptr,
  14529. get_multipart_content_provider(boundary, items, provider_items),
  14530. content_type, nullptr, progress);
  14531. }
  14532. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14533. const std::string &body,
  14534. const std::string &content_type,
  14535. ContentReceiver content_receiver,
  14536. DownloadProgress progress) {
  14537. Request req;
  14538. req.method = "POST";
  14539. req.path = path;
  14540. req.headers = headers;
  14541. req.body = body;
  14542. req.content_receiver =
  14543. [content_receiver](const char *data, size_t data_length,
  14544. size_t /*offset*/, size_t /*total_length*/) {
  14545. return content_receiver(data, data_length);
  14546. };
  14547. req.download_progress = std::move(progress);
  14548. if (max_timeout_msec_ > 0) {
  14549. req.start_time_ = std::chrono::steady_clock::now();
  14550. }
  14551. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14552. return send_(std::move(req));
  14553. }
  14554. inline Result ClientImpl::Put(const std::string &path) {
  14555. return Put(path, std::string(), std::string());
  14556. }
  14557. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14558. return Put(path, headers, nullptr, 0, std::string());
  14559. }
  14560. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14561. size_t content_length,
  14562. const std::string &content_type,
  14563. UploadProgress progress) {
  14564. return Put(path, Headers(), body, content_length, content_type, progress);
  14565. }
  14566. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14567. const std::string &content_type,
  14568. UploadProgress progress) {
  14569. return Put(path, Headers(), body, content_type, progress);
  14570. }
  14571. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14572. return Put(path, Headers(), params);
  14573. }
  14574. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14575. ContentProvider content_provider,
  14576. const std::string &content_type,
  14577. UploadProgress progress) {
  14578. return Put(path, Headers(), content_length, std::move(content_provider),
  14579. content_type, progress);
  14580. }
  14581. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14582. ContentProvider content_provider,
  14583. const std::string &content_type,
  14584. ContentReceiver content_receiver,
  14585. UploadProgress progress) {
  14586. return Put(path, Headers(), content_length, std::move(content_provider),
  14587. content_type, std::move(content_receiver), progress);
  14588. }
  14589. inline Result ClientImpl::Put(const std::string &path,
  14590. ContentProviderWithoutLength content_provider,
  14591. const std::string &content_type,
  14592. UploadProgress progress) {
  14593. return Put(path, Headers(), std::move(content_provider), content_type,
  14594. progress);
  14595. }
  14596. inline Result ClientImpl::Put(const std::string &path,
  14597. ContentProviderWithoutLength content_provider,
  14598. const std::string &content_type,
  14599. ContentReceiver content_receiver,
  14600. UploadProgress progress) {
  14601. return Put(path, Headers(), std::move(content_provider), content_type,
  14602. std::move(content_receiver), progress);
  14603. }
  14604. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14605. const Params &params) {
  14606. auto query = detail::params_to_query_str(params);
  14607. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14608. }
  14609. inline Result ClientImpl::Put(const std::string &path,
  14610. const UploadFormDataItems &items,
  14611. UploadProgress progress) {
  14612. return Put(path, Headers(), items, progress);
  14613. }
  14614. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14615. const UploadFormDataItems &items,
  14616. UploadProgress progress) {
  14617. const auto &boundary = detail::make_multipart_data_boundary();
  14618. const auto &content_type =
  14619. detail::serialize_multipart_formdata_get_content_type(boundary);
  14620. auto content_length = detail::get_multipart_content_length(items, boundary);
  14621. return Put(path, headers, content_length,
  14622. detail::make_multipart_content_provider(items, boundary),
  14623. content_type, progress);
  14624. }
  14625. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14626. const UploadFormDataItems &items,
  14627. const std::string &boundary,
  14628. UploadProgress progress) {
  14629. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14630. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14631. }
  14632. const auto &content_type =
  14633. detail::serialize_multipart_formdata_get_content_type(boundary);
  14634. auto content_length = detail::get_multipart_content_length(items, boundary);
  14635. return Put(path, headers, content_length,
  14636. detail::make_multipart_content_provider(items, boundary),
  14637. content_type, progress);
  14638. }
  14639. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14640. const char *body, size_t content_length,
  14641. const std::string &content_type,
  14642. UploadProgress progress) {
  14643. return send_with_content_provider_and_receiver(
  14644. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14645. content_type, nullptr, progress);
  14646. }
  14647. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14648. const std::string &body,
  14649. const std::string &content_type,
  14650. UploadProgress progress) {
  14651. return send_with_content_provider_and_receiver(
  14652. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14653. content_type, nullptr, progress);
  14654. }
  14655. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14656. size_t content_length,
  14657. ContentProvider content_provider,
  14658. const std::string &content_type,
  14659. UploadProgress progress) {
  14660. return send_with_content_provider_and_receiver(
  14661. "PUT", path, headers, nullptr, content_length,
  14662. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14663. }
  14664. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14665. size_t content_length,
  14666. ContentProvider content_provider,
  14667. const std::string &content_type,
  14668. ContentReceiver content_receiver,
  14669. UploadProgress progress) {
  14670. return send_with_content_provider_and_receiver(
  14671. "PUT", path, headers, nullptr, content_length,
  14672. std::move(content_provider), nullptr, content_type,
  14673. std::move(content_receiver), progress);
  14674. }
  14675. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14676. ContentProviderWithoutLength content_provider,
  14677. const std::string &content_type,
  14678. UploadProgress progress) {
  14679. return send_with_content_provider_and_receiver(
  14680. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14681. content_type, nullptr, progress);
  14682. }
  14683. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14684. ContentProviderWithoutLength content_provider,
  14685. const std::string &content_type,
  14686. ContentReceiver content_receiver,
  14687. UploadProgress progress) {
  14688. return send_with_content_provider_and_receiver(
  14689. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14690. content_type, std::move(content_receiver), progress);
  14691. }
  14692. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14693. const UploadFormDataItems &items,
  14694. const FormDataProviderItems &provider_items,
  14695. UploadProgress progress) {
  14696. const auto &boundary = detail::make_multipart_data_boundary();
  14697. const auto &content_type =
  14698. detail::serialize_multipart_formdata_get_content_type(boundary);
  14699. return send_with_content_provider_and_receiver(
  14700. "PUT", path, headers, nullptr, 0, nullptr,
  14701. get_multipart_content_provider(boundary, items, provider_items),
  14702. content_type, nullptr, progress);
  14703. }
  14704. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14705. const std::string &body,
  14706. const std::string &content_type,
  14707. ContentReceiver content_receiver,
  14708. DownloadProgress progress) {
  14709. Request req;
  14710. req.method = "PUT";
  14711. req.path = path;
  14712. req.headers = headers;
  14713. req.body = body;
  14714. req.content_receiver =
  14715. [content_receiver](const char *data, size_t data_length,
  14716. size_t /*offset*/, size_t /*total_length*/) {
  14717. return content_receiver(data, data_length);
  14718. };
  14719. req.download_progress = std::move(progress);
  14720. if (max_timeout_msec_ > 0) {
  14721. req.start_time_ = std::chrono::steady_clock::now();
  14722. }
  14723. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14724. return send_(std::move(req));
  14725. }
  14726. inline Result ClientImpl::Patch(const std::string &path) {
  14727. return Patch(path, std::string(), std::string());
  14728. }
  14729. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14730. UploadProgress progress) {
  14731. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14732. }
  14733. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14734. size_t content_length,
  14735. const std::string &content_type,
  14736. UploadProgress progress) {
  14737. return Patch(path, Headers(), body, content_length, content_type, progress);
  14738. }
  14739. inline Result ClientImpl::Patch(const std::string &path,
  14740. const std::string &body,
  14741. const std::string &content_type,
  14742. UploadProgress progress) {
  14743. return Patch(path, Headers(), body, content_type, progress);
  14744. }
  14745. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14746. return Patch(path, Headers(), params);
  14747. }
  14748. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14749. ContentProvider content_provider,
  14750. const std::string &content_type,
  14751. UploadProgress progress) {
  14752. return Patch(path, Headers(), content_length, std::move(content_provider),
  14753. content_type, progress);
  14754. }
  14755. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14756. ContentProvider content_provider,
  14757. const std::string &content_type,
  14758. ContentReceiver content_receiver,
  14759. UploadProgress progress) {
  14760. return Patch(path, Headers(), content_length, std::move(content_provider),
  14761. content_type, std::move(content_receiver), progress);
  14762. }
  14763. inline Result ClientImpl::Patch(const std::string &path,
  14764. ContentProviderWithoutLength content_provider,
  14765. const std::string &content_type,
  14766. UploadProgress progress) {
  14767. return Patch(path, Headers(), std::move(content_provider), content_type,
  14768. progress);
  14769. }
  14770. inline Result ClientImpl::Patch(const std::string &path,
  14771. ContentProviderWithoutLength content_provider,
  14772. const std::string &content_type,
  14773. ContentReceiver content_receiver,
  14774. UploadProgress progress) {
  14775. return Patch(path, Headers(), std::move(content_provider), content_type,
  14776. std::move(content_receiver), progress);
  14777. }
  14778. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14779. const Params &params) {
  14780. auto query = detail::params_to_query_str(params);
  14781. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14782. }
  14783. inline Result ClientImpl::Patch(const std::string &path,
  14784. const UploadFormDataItems &items,
  14785. UploadProgress progress) {
  14786. return Patch(path, Headers(), items, progress);
  14787. }
  14788. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14789. const UploadFormDataItems &items,
  14790. UploadProgress progress) {
  14791. const auto &boundary = detail::make_multipart_data_boundary();
  14792. const auto &content_type =
  14793. detail::serialize_multipart_formdata_get_content_type(boundary);
  14794. auto content_length = detail::get_multipart_content_length(items, boundary);
  14795. return Patch(path, headers, content_length,
  14796. detail::make_multipart_content_provider(items, boundary),
  14797. content_type, progress);
  14798. }
  14799. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14800. const UploadFormDataItems &items,
  14801. const std::string &boundary,
  14802. UploadProgress progress) {
  14803. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14804. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14805. }
  14806. const auto &content_type =
  14807. detail::serialize_multipart_formdata_get_content_type(boundary);
  14808. auto content_length = detail::get_multipart_content_length(items, boundary);
  14809. return Patch(path, headers, content_length,
  14810. detail::make_multipart_content_provider(items, boundary),
  14811. content_type, progress);
  14812. }
  14813. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14814. const char *body, size_t content_length,
  14815. const std::string &content_type,
  14816. UploadProgress progress) {
  14817. return send_with_content_provider_and_receiver(
  14818. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14819. content_type, nullptr, progress);
  14820. }
  14821. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14822. const std::string &body,
  14823. const std::string &content_type,
  14824. UploadProgress progress) {
  14825. return send_with_content_provider_and_receiver(
  14826. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14827. content_type, nullptr, progress);
  14828. }
  14829. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14830. size_t content_length,
  14831. ContentProvider content_provider,
  14832. const std::string &content_type,
  14833. UploadProgress progress) {
  14834. return send_with_content_provider_and_receiver(
  14835. "PATCH", path, headers, nullptr, content_length,
  14836. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14837. }
  14838. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14839. size_t content_length,
  14840. ContentProvider content_provider,
  14841. const std::string &content_type,
  14842. ContentReceiver content_receiver,
  14843. UploadProgress progress) {
  14844. return send_with_content_provider_and_receiver(
  14845. "PATCH", path, headers, nullptr, content_length,
  14846. std::move(content_provider), nullptr, content_type,
  14847. std::move(content_receiver), progress);
  14848. }
  14849. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14850. ContentProviderWithoutLength content_provider,
  14851. const std::string &content_type,
  14852. UploadProgress progress) {
  14853. return send_with_content_provider_and_receiver(
  14854. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14855. content_type, nullptr, progress);
  14856. }
  14857. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14858. ContentProviderWithoutLength content_provider,
  14859. const std::string &content_type,
  14860. ContentReceiver content_receiver,
  14861. UploadProgress progress) {
  14862. return send_with_content_provider_and_receiver(
  14863. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14864. content_type, std::move(content_receiver), progress);
  14865. }
  14866. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14867. const UploadFormDataItems &items,
  14868. const FormDataProviderItems &provider_items,
  14869. UploadProgress progress) {
  14870. const auto &boundary = detail::make_multipart_data_boundary();
  14871. const auto &content_type =
  14872. detail::serialize_multipart_formdata_get_content_type(boundary);
  14873. return send_with_content_provider_and_receiver(
  14874. "PATCH", path, headers, nullptr, 0, nullptr,
  14875. get_multipart_content_provider(boundary, items, provider_items),
  14876. content_type, nullptr, progress);
  14877. }
  14878. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14879. const std::string &body,
  14880. const std::string &content_type,
  14881. ContentReceiver content_receiver,
  14882. DownloadProgress progress) {
  14883. Request req;
  14884. req.method = "PATCH";
  14885. req.path = path;
  14886. req.headers = headers;
  14887. req.body = body;
  14888. req.content_receiver =
  14889. [content_receiver](const char *data, size_t data_length,
  14890. size_t /*offset*/, size_t /*total_length*/) {
  14891. return content_receiver(data, data_length);
  14892. };
  14893. req.download_progress = std::move(progress);
  14894. if (max_timeout_msec_ > 0) {
  14895. req.start_time_ = std::chrono::steady_clock::now();
  14896. }
  14897. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14898. return send_(std::move(req));
  14899. }
  14900. inline Result ClientImpl::Delete(const std::string &path,
  14901. DownloadProgress progress) {
  14902. return Delete(path, Headers(), std::string(), std::string(), progress);
  14903. }
  14904. inline Result ClientImpl::Delete(const std::string &path,
  14905. const Headers &headers,
  14906. DownloadProgress progress) {
  14907. return Delete(path, headers, std::string(), std::string(), progress);
  14908. }
  14909. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14910. size_t content_length,
  14911. const std::string &content_type,
  14912. DownloadProgress progress) {
  14913. return Delete(path, Headers(), body, content_length, content_type, progress);
  14914. }
  14915. inline Result ClientImpl::Delete(const std::string &path,
  14916. const std::string &body,
  14917. const std::string &content_type,
  14918. DownloadProgress progress) {
  14919. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14920. progress);
  14921. }
  14922. inline Result ClientImpl::Delete(const std::string &path,
  14923. const Headers &headers,
  14924. const std::string &body,
  14925. const std::string &content_type,
  14926. DownloadProgress progress) {
  14927. return Delete(path, headers, body.data(), body.size(), content_type,
  14928. progress);
  14929. }
  14930. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14931. DownloadProgress progress) {
  14932. return Delete(path, Headers(), params, progress);
  14933. }
  14934. inline Result ClientImpl::Delete(const std::string &path,
  14935. const Headers &headers, const Params &params,
  14936. DownloadProgress progress) {
  14937. auto query = detail::params_to_query_str(params);
  14938. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14939. progress);
  14940. }
  14941. inline Result ClientImpl::Delete(const std::string &path,
  14942. const Headers &headers, const char *body,
  14943. size_t content_length,
  14944. const std::string &content_type,
  14945. DownloadProgress progress) {
  14946. Request req;
  14947. req.method = "DELETE";
  14948. req.headers = headers;
  14949. req.path = path;
  14950. req.download_progress = std::move(progress);
  14951. if (max_timeout_msec_ > 0) {
  14952. req.start_time_ = std::chrono::steady_clock::now();
  14953. }
  14954. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14955. req.body.assign(body, content_length);
  14956. return send_(std::move(req));
  14957. }
  14958. inline Result ClientImpl::Options(const std::string &path) {
  14959. return Options(path, Headers());
  14960. }
  14961. inline Result ClientImpl::Options(const std::string &path,
  14962. const Headers &headers) {
  14963. Request req;
  14964. req.method = "OPTIONS";
  14965. req.headers = headers;
  14966. req.path = path;
  14967. if (max_timeout_msec_ > 0) {
  14968. req.start_time_ = std::chrono::steady_clock::now();
  14969. }
  14970. return send_(std::move(req));
  14971. }
  14972. inline void ClientImpl::stop() {
  14973. std::lock_guard<std::mutex> guard(socket_mutex_);
  14974. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14975. // do is to shutdown_socket, so that threads using this socket suddenly
  14976. // discover they can't read/write any more and error out. Everything else
  14977. // (closing the socket, shutting ssl down) is unsafe because these actions
  14978. // are not thread-safe.
  14979. if (socket_requests_in_flight_ > 0) {
  14980. shutdown_socket(socket_);
  14981. // Aside from that, we set a flag for the socket to be closed when we're
  14982. // done.
  14983. socket_should_be_closed_when_request_is_done_ = true;
  14984. return;
  14985. }
  14986. disconnect(/*gracefully=*/true);
  14987. }
  14988. inline std::string ClientImpl::host() const { return host_; }
  14989. inline int ClientImpl::port() const { return port_; }
  14990. inline size_t ClientImpl::is_socket_open() const {
  14991. std::lock_guard<std::mutex> guard(socket_mutex_);
  14992. return socket_.is_open();
  14993. }
  14994. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14995. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14996. connection_timeout_sec_ = sec;
  14997. connection_timeout_usec_ = usec;
  14998. }
  14999. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15000. read_timeout_sec_ = sec;
  15001. read_timeout_usec_ = usec;
  15002. }
  15003. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15004. write_timeout_sec_ = sec;
  15005. write_timeout_usec_ = usec;
  15006. }
  15007. inline void ClientImpl::set_max_timeout(time_t msec) {
  15008. max_timeout_msec_ = msec;
  15009. }
  15010. inline void ClientImpl::set_basic_auth(const std::string &username,
  15011. const std::string &password) {
  15012. basic_auth_username_ = username;
  15013. basic_auth_password_ = password;
  15014. }
  15015. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15016. bearer_token_auth_token_ = token;
  15017. }
  15018. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15019. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15020. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15021. inline void
  15022. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15023. addr_map_ = std::move(addr_map);
  15024. }
  15025. inline void ClientImpl::set_default_headers(Headers headers) {
  15026. default_headers_ = std::move(headers);
  15027. }
  15028. inline void ClientImpl::set_header_writer(
  15029. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15030. header_writer_ = writer;
  15031. }
  15032. inline void ClientImpl::set_address_family(int family) {
  15033. address_family_ = family;
  15034. }
  15035. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15036. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15037. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15038. socket_options_ = std::move(socket_options);
  15039. }
  15040. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15041. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15042. inline void ClientImpl::set_payload_max_length(size_t length) {
  15043. payload_max_length_ = length;
  15044. has_payload_max_length_ = true;
  15045. }
  15046. inline void ClientImpl::set_interface(const std::string &intf) {
  15047. interface_ = intf;
  15048. }
  15049. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15050. proxy_host_ = host;
  15051. proxy_port_ = port;
  15052. std::lock_guard<std::mutex> guard(socket_mutex_);
  15053. disconnect(/*gracefully=*/true);
  15054. }
  15055. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15056. const std::string &password) {
  15057. proxy_basic_auth_username_ = username;
  15058. proxy_basic_auth_password_ = password;
  15059. }
  15060. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15061. proxy_bearer_token_auth_token_ = token;
  15062. }
  15063. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15064. std::vector<detail::NoProxyEntry> parsed;
  15065. parsed.reserve(patterns.size());
  15066. for (const auto &p : patterns) {
  15067. auto trimmed = detail::trim_copy(p);
  15068. if (trimmed.empty()) { continue; }
  15069. detail::NoProxyEntry entry;
  15070. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15071. parsed.push_back(std::move(entry));
  15072. }
  15073. }
  15074. no_proxy_entries_ = std::move(parsed);
  15075. std::lock_guard<std::mutex> guard(socket_mutex_);
  15076. disconnect(/*gracefully=*/true);
  15077. }
  15078. #ifdef CPPHTTPLIB_SSL_ENABLED
  15079. inline void ClientImpl::set_digest_auth(const std::string &username,
  15080. const std::string &password) {
  15081. digest_auth_username_ = username;
  15082. digest_auth_password_ = password;
  15083. }
  15084. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15085. const std::string &ca_cert_dir_path) {
  15086. ca_cert_file_path_ = ca_cert_file_path;
  15087. ca_cert_dir_path_ = ca_cert_dir_path;
  15088. }
  15089. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15090. const std::string &password) {
  15091. proxy_digest_auth_username_ = username;
  15092. proxy_digest_auth_password_ = password;
  15093. }
  15094. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15095. server_certificate_verification_ = enabled;
  15096. }
  15097. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15098. server_hostname_verification_ = enabled;
  15099. }
  15100. inline void ClientImpl::enable_system_ca(bool enabled) {
  15101. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15102. }
  15103. #endif
  15104. inline void ClientImpl::set_logger(Logger logger) {
  15105. logger_ = std::move(logger);
  15106. }
  15107. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15108. error_logger_ = std::move(error_logger);
  15109. }
  15110. /*
  15111. * SSL/TLS Common Implementation
  15112. */
  15113. inline ClientConnection::~ClientConnection() {
  15114. #ifdef CPPHTTPLIB_SSL_ENABLED
  15115. if (session) {
  15116. tls::shutdown(session, true);
  15117. tls::free_session(session);
  15118. session = nullptr;
  15119. }
  15120. #endif
  15121. if (sock != INVALID_SOCKET) {
  15122. detail::close_socket(sock);
  15123. sock = INVALID_SOCKET;
  15124. }
  15125. }
  15126. // Universal client implementation
  15127. inline Client::Client(const std::string &scheme_host_port)
  15128. : Client(scheme_host_port, std::string(), std::string()) {}
  15129. inline Client::Client(const std::string &scheme_host_port,
  15130. const std::string &client_cert_path,
  15131. const std::string &client_key_path) {
  15132. detail::UrlComponents uc;
  15133. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15134. auto &scheme = uc.scheme;
  15135. #ifdef CPPHTTPLIB_SSL_ENABLED
  15136. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15137. #else
  15138. if (!scheme.empty() && scheme != "http") {
  15139. #endif
  15140. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15141. std::string msg = "'" + scheme + "' scheme is not supported.";
  15142. throw std::invalid_argument(msg);
  15143. #endif
  15144. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15145. return;
  15146. }
  15147. auto is_ssl = scheme == "https";
  15148. auto host = std::move(uc.host);
  15149. auto port = is_ssl ? 443 : 80;
  15150. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15151. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15152. return;
  15153. }
  15154. if (is_ssl) {
  15155. #ifdef CPPHTTPLIB_SSL_ENABLED
  15156. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15157. client_key_path);
  15158. is_ssl_ = is_ssl;
  15159. #endif
  15160. } else {
  15161. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15162. client_key_path);
  15163. }
  15164. } else {
  15165. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15166. // if port param below changes.
  15167. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15168. client_cert_path, client_key_path);
  15169. }
  15170. }
  15171. inline Client::Client(const std::string &host, int port)
  15172. : Client(host, port, std::string(), std::string()) {}
  15173. inline Client::Client(const std::string &host, int port,
  15174. const std::string &client_cert_path,
  15175. const std::string &client_key_path)
  15176. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15177. client_key_path)) {}
  15178. inline Client::~Client() = default;
  15179. inline bool Client::is_valid() const {
  15180. return cli_ != nullptr && cli_->is_valid();
  15181. }
  15182. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15183. return cli_->Get(path, std::move(progress));
  15184. }
  15185. inline Result Client::Get(const std::string &path, const Headers &headers,
  15186. DownloadProgress progress) {
  15187. return cli_->Get(path, headers, std::move(progress));
  15188. }
  15189. inline Result Client::Get(const std::string &path,
  15190. ContentReceiver content_receiver,
  15191. DownloadProgress progress) {
  15192. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15193. }
  15194. inline Result Client::Get(const std::string &path, const Headers &headers,
  15195. ContentReceiver content_receiver,
  15196. DownloadProgress progress) {
  15197. return cli_->Get(path, headers, std::move(content_receiver),
  15198. std::move(progress));
  15199. }
  15200. inline Result Client::Get(const std::string &path,
  15201. ResponseHandler response_handler,
  15202. ContentReceiver content_receiver,
  15203. DownloadProgress progress) {
  15204. return cli_->Get(path, std::move(response_handler),
  15205. std::move(content_receiver), std::move(progress));
  15206. }
  15207. inline Result Client::Get(const std::string &path, const Headers &headers,
  15208. ResponseHandler response_handler,
  15209. ContentReceiver content_receiver,
  15210. DownloadProgress progress) {
  15211. return cli_->Get(path, headers, std::move(response_handler),
  15212. std::move(content_receiver), std::move(progress));
  15213. }
  15214. inline Result Client::Get(const std::string &path, const Params &params,
  15215. DownloadProgress progress) {
  15216. return cli_->Get(path, params, std::move(progress));
  15217. }
  15218. inline Result Client::Get(const std::string &path, const Params &params,
  15219. const Headers &headers, DownloadProgress progress) {
  15220. return cli_->Get(path, params, headers, std::move(progress));
  15221. }
  15222. inline Result Client::Get(const std::string &path, const Params &params,
  15223. const Headers &headers,
  15224. ContentReceiver content_receiver,
  15225. DownloadProgress progress) {
  15226. return cli_->Get(path, params, headers, std::move(content_receiver),
  15227. std::move(progress));
  15228. }
  15229. inline Result Client::Get(const std::string &path, const Params &params,
  15230. const Headers &headers,
  15231. ResponseHandler response_handler,
  15232. ContentReceiver content_receiver,
  15233. DownloadProgress progress) {
  15234. return cli_->Get(path, params, headers, std::move(response_handler),
  15235. std::move(content_receiver), std::move(progress));
  15236. }
  15237. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15238. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15239. return cli_->Head(path, headers);
  15240. }
  15241. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15242. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15243. return cli_->Post(path, headers);
  15244. }
  15245. inline Result Client::Post(const std::string &path, const char *body,
  15246. size_t content_length,
  15247. const std::string &content_type,
  15248. UploadProgress progress) {
  15249. return cli_->Post(path, body, content_length, content_type, progress);
  15250. }
  15251. inline Result Client::Post(const std::string &path, const Headers &headers,
  15252. const char *body, size_t content_length,
  15253. const std::string &content_type,
  15254. UploadProgress progress) {
  15255. return cli_->Post(path, headers, body, content_length, content_type,
  15256. progress);
  15257. }
  15258. inline Result Client::Post(const std::string &path, const std::string &body,
  15259. const std::string &content_type,
  15260. UploadProgress progress) {
  15261. return cli_->Post(path, body, content_type, progress);
  15262. }
  15263. inline Result Client::Post(const std::string &path, const Headers &headers,
  15264. const std::string &body,
  15265. const std::string &content_type,
  15266. UploadProgress progress) {
  15267. return cli_->Post(path, headers, body, content_type, progress);
  15268. }
  15269. inline Result Client::Post(const std::string &path, size_t content_length,
  15270. ContentProvider content_provider,
  15271. const std::string &content_type,
  15272. UploadProgress progress) {
  15273. return cli_->Post(path, content_length, std::move(content_provider),
  15274. content_type, progress);
  15275. }
  15276. inline Result Client::Post(const std::string &path, size_t content_length,
  15277. ContentProvider content_provider,
  15278. const std::string &content_type,
  15279. ContentReceiver content_receiver,
  15280. UploadProgress progress) {
  15281. return cli_->Post(path, content_length, std::move(content_provider),
  15282. content_type, std::move(content_receiver), progress);
  15283. }
  15284. inline Result Client::Post(const std::string &path,
  15285. ContentProviderWithoutLength content_provider,
  15286. const std::string &content_type,
  15287. UploadProgress progress) {
  15288. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15289. }
  15290. inline Result Client::Post(const std::string &path,
  15291. ContentProviderWithoutLength content_provider,
  15292. const std::string &content_type,
  15293. ContentReceiver content_receiver,
  15294. UploadProgress progress) {
  15295. return cli_->Post(path, std::move(content_provider), content_type,
  15296. std::move(content_receiver), progress);
  15297. }
  15298. inline Result Client::Post(const std::string &path, const Headers &headers,
  15299. size_t content_length,
  15300. ContentProvider content_provider,
  15301. const std::string &content_type,
  15302. UploadProgress progress) {
  15303. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15304. content_type, progress);
  15305. }
  15306. inline Result Client::Post(const std::string &path, const Headers &headers,
  15307. size_t content_length,
  15308. ContentProvider content_provider,
  15309. const std::string &content_type,
  15310. ContentReceiver content_receiver,
  15311. DownloadProgress progress) {
  15312. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15313. content_type, std::move(content_receiver), progress);
  15314. }
  15315. inline Result Client::Post(const std::string &path, const Headers &headers,
  15316. ContentProviderWithoutLength content_provider,
  15317. const std::string &content_type,
  15318. UploadProgress progress) {
  15319. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15320. progress);
  15321. }
  15322. inline Result Client::Post(const std::string &path, const Headers &headers,
  15323. ContentProviderWithoutLength content_provider,
  15324. const std::string &content_type,
  15325. ContentReceiver content_receiver,
  15326. DownloadProgress progress) {
  15327. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15328. std::move(content_receiver), progress);
  15329. }
  15330. inline Result Client::Post(const std::string &path, const Params &params) {
  15331. return cli_->Post(path, params);
  15332. }
  15333. inline Result Client::Post(const std::string &path, const Headers &headers,
  15334. const Params &params) {
  15335. return cli_->Post(path, headers, params);
  15336. }
  15337. inline Result Client::Post(const std::string &path,
  15338. const UploadFormDataItems &items,
  15339. UploadProgress progress) {
  15340. return cli_->Post(path, items, progress);
  15341. }
  15342. inline Result Client::Post(const std::string &path, const Headers &headers,
  15343. const UploadFormDataItems &items,
  15344. UploadProgress progress) {
  15345. return cli_->Post(path, headers, items, progress);
  15346. }
  15347. inline Result Client::Post(const std::string &path, const Headers &headers,
  15348. const UploadFormDataItems &items,
  15349. const std::string &boundary,
  15350. UploadProgress progress) {
  15351. return cli_->Post(path, headers, items, boundary, progress);
  15352. }
  15353. inline Result Client::Post(const std::string &path, const Headers &headers,
  15354. const UploadFormDataItems &items,
  15355. const FormDataProviderItems &provider_items,
  15356. UploadProgress progress) {
  15357. return cli_->Post(path, headers, items, provider_items, progress);
  15358. }
  15359. inline Result Client::Post(const std::string &path, const Headers &headers,
  15360. const std::string &body,
  15361. const std::string &content_type,
  15362. ContentReceiver content_receiver,
  15363. DownloadProgress progress) {
  15364. return cli_->Post(path, headers, body, content_type,
  15365. std::move(content_receiver), progress);
  15366. }
  15367. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15368. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15369. return cli_->Put(path, headers);
  15370. }
  15371. inline Result Client::Put(const std::string &path, const char *body,
  15372. size_t content_length,
  15373. const std::string &content_type,
  15374. UploadProgress progress) {
  15375. return cli_->Put(path, body, content_length, content_type, progress);
  15376. }
  15377. inline Result Client::Put(const std::string &path, const Headers &headers,
  15378. const char *body, size_t content_length,
  15379. const std::string &content_type,
  15380. UploadProgress progress) {
  15381. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15382. }
  15383. inline Result Client::Put(const std::string &path, const std::string &body,
  15384. const std::string &content_type,
  15385. UploadProgress progress) {
  15386. return cli_->Put(path, body, content_type, progress);
  15387. }
  15388. inline Result Client::Put(const std::string &path, const Headers &headers,
  15389. const std::string &body,
  15390. const std::string &content_type,
  15391. UploadProgress progress) {
  15392. return cli_->Put(path, headers, body, content_type, progress);
  15393. }
  15394. inline Result Client::Put(const std::string &path, size_t content_length,
  15395. ContentProvider content_provider,
  15396. const std::string &content_type,
  15397. UploadProgress progress) {
  15398. return cli_->Put(path, content_length, std::move(content_provider),
  15399. content_type, progress);
  15400. }
  15401. inline Result Client::Put(const std::string &path, size_t content_length,
  15402. ContentProvider content_provider,
  15403. const std::string &content_type,
  15404. ContentReceiver content_receiver,
  15405. UploadProgress progress) {
  15406. return cli_->Put(path, content_length, std::move(content_provider),
  15407. content_type, std::move(content_receiver), progress);
  15408. }
  15409. inline Result Client::Put(const std::string &path,
  15410. ContentProviderWithoutLength content_provider,
  15411. const std::string &content_type,
  15412. UploadProgress progress) {
  15413. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15414. }
  15415. inline Result Client::Put(const std::string &path,
  15416. ContentProviderWithoutLength content_provider,
  15417. const std::string &content_type,
  15418. ContentReceiver content_receiver,
  15419. UploadProgress progress) {
  15420. return cli_->Put(path, std::move(content_provider), content_type,
  15421. std::move(content_receiver), progress);
  15422. }
  15423. inline Result Client::Put(const std::string &path, const Headers &headers,
  15424. size_t content_length,
  15425. ContentProvider content_provider,
  15426. const std::string &content_type,
  15427. UploadProgress progress) {
  15428. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15429. content_type, progress);
  15430. }
  15431. inline Result Client::Put(const std::string &path, const Headers &headers,
  15432. size_t content_length,
  15433. ContentProvider content_provider,
  15434. const std::string &content_type,
  15435. ContentReceiver content_receiver,
  15436. UploadProgress progress) {
  15437. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15438. content_type, std::move(content_receiver), progress);
  15439. }
  15440. inline Result Client::Put(const std::string &path, const Headers &headers,
  15441. ContentProviderWithoutLength content_provider,
  15442. const std::string &content_type,
  15443. UploadProgress progress) {
  15444. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15445. progress);
  15446. }
  15447. inline Result Client::Put(const std::string &path, const Headers &headers,
  15448. ContentProviderWithoutLength content_provider,
  15449. const std::string &content_type,
  15450. ContentReceiver content_receiver,
  15451. UploadProgress progress) {
  15452. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15453. std::move(content_receiver), progress);
  15454. }
  15455. inline Result Client::Put(const std::string &path, const Params &params) {
  15456. return cli_->Put(path, params);
  15457. }
  15458. inline Result Client::Put(const std::string &path, const Headers &headers,
  15459. const Params &params) {
  15460. return cli_->Put(path, headers, params);
  15461. }
  15462. inline Result Client::Put(const std::string &path,
  15463. const UploadFormDataItems &items,
  15464. UploadProgress progress) {
  15465. return cli_->Put(path, items, progress);
  15466. }
  15467. inline Result Client::Put(const std::string &path, const Headers &headers,
  15468. const UploadFormDataItems &items,
  15469. UploadProgress progress) {
  15470. return cli_->Put(path, headers, items, progress);
  15471. }
  15472. inline Result Client::Put(const std::string &path, const Headers &headers,
  15473. const UploadFormDataItems &items,
  15474. const std::string &boundary,
  15475. UploadProgress progress) {
  15476. return cli_->Put(path, headers, items, boundary, progress);
  15477. }
  15478. inline Result Client::Put(const std::string &path, const Headers &headers,
  15479. const UploadFormDataItems &items,
  15480. const FormDataProviderItems &provider_items,
  15481. UploadProgress progress) {
  15482. return cli_->Put(path, headers, items, provider_items, progress);
  15483. }
  15484. inline Result Client::Put(const std::string &path, const Headers &headers,
  15485. const std::string &body,
  15486. const std::string &content_type,
  15487. ContentReceiver content_receiver,
  15488. DownloadProgress progress) {
  15489. return cli_->Put(path, headers, body, content_type, content_receiver,
  15490. progress);
  15491. }
  15492. inline Result Client::Patch(const std::string &path) {
  15493. return cli_->Patch(path);
  15494. }
  15495. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15496. return cli_->Patch(path, headers);
  15497. }
  15498. inline Result Client::Patch(const std::string &path, const char *body,
  15499. size_t content_length,
  15500. const std::string &content_type,
  15501. UploadProgress progress) {
  15502. return cli_->Patch(path, body, content_length, content_type, progress);
  15503. }
  15504. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15505. const char *body, size_t content_length,
  15506. const std::string &content_type,
  15507. UploadProgress progress) {
  15508. return cli_->Patch(path, headers, body, content_length, content_type,
  15509. progress);
  15510. }
  15511. inline Result Client::Patch(const std::string &path, const std::string &body,
  15512. const std::string &content_type,
  15513. UploadProgress progress) {
  15514. return cli_->Patch(path, body, content_type, progress);
  15515. }
  15516. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15517. const std::string &body,
  15518. const std::string &content_type,
  15519. UploadProgress progress) {
  15520. return cli_->Patch(path, headers, body, content_type, progress);
  15521. }
  15522. inline Result Client::Patch(const std::string &path, size_t content_length,
  15523. ContentProvider content_provider,
  15524. const std::string &content_type,
  15525. UploadProgress progress) {
  15526. return cli_->Patch(path, content_length, std::move(content_provider),
  15527. content_type, progress);
  15528. }
  15529. inline Result Client::Patch(const std::string &path, size_t content_length,
  15530. ContentProvider content_provider,
  15531. const std::string &content_type,
  15532. ContentReceiver content_receiver,
  15533. UploadProgress progress) {
  15534. return cli_->Patch(path, content_length, std::move(content_provider),
  15535. content_type, std::move(content_receiver), progress);
  15536. }
  15537. inline Result Client::Patch(const std::string &path,
  15538. ContentProviderWithoutLength content_provider,
  15539. const std::string &content_type,
  15540. UploadProgress progress) {
  15541. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15542. }
  15543. inline Result Client::Patch(const std::string &path,
  15544. ContentProviderWithoutLength content_provider,
  15545. const std::string &content_type,
  15546. ContentReceiver content_receiver,
  15547. UploadProgress progress) {
  15548. return cli_->Patch(path, std::move(content_provider), content_type,
  15549. std::move(content_receiver), progress);
  15550. }
  15551. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15552. size_t content_length,
  15553. ContentProvider content_provider,
  15554. const std::string &content_type,
  15555. UploadProgress progress) {
  15556. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15557. content_type, progress);
  15558. }
  15559. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15560. size_t content_length,
  15561. ContentProvider content_provider,
  15562. const std::string &content_type,
  15563. ContentReceiver content_receiver,
  15564. UploadProgress progress) {
  15565. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15566. content_type, std::move(content_receiver), progress);
  15567. }
  15568. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15569. ContentProviderWithoutLength content_provider,
  15570. const std::string &content_type,
  15571. UploadProgress progress) {
  15572. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15573. progress);
  15574. }
  15575. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15576. ContentProviderWithoutLength content_provider,
  15577. const std::string &content_type,
  15578. ContentReceiver content_receiver,
  15579. UploadProgress progress) {
  15580. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15581. std::move(content_receiver), progress);
  15582. }
  15583. inline Result Client::Patch(const std::string &path, const Params &params) {
  15584. return cli_->Patch(path, params);
  15585. }
  15586. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15587. const Params &params) {
  15588. return cli_->Patch(path, headers, params);
  15589. }
  15590. inline Result Client::Patch(const std::string &path,
  15591. const UploadFormDataItems &items,
  15592. UploadProgress progress) {
  15593. return cli_->Patch(path, items, progress);
  15594. }
  15595. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15596. const UploadFormDataItems &items,
  15597. UploadProgress progress) {
  15598. return cli_->Patch(path, headers, items, progress);
  15599. }
  15600. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15601. const UploadFormDataItems &items,
  15602. const std::string &boundary,
  15603. UploadProgress progress) {
  15604. return cli_->Patch(path, headers, items, boundary, progress);
  15605. }
  15606. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15607. const UploadFormDataItems &items,
  15608. const FormDataProviderItems &provider_items,
  15609. UploadProgress progress) {
  15610. return cli_->Patch(path, headers, items, provider_items, progress);
  15611. }
  15612. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15613. const std::string &body,
  15614. const std::string &content_type,
  15615. ContentReceiver content_receiver,
  15616. DownloadProgress progress) {
  15617. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15618. progress);
  15619. }
  15620. inline Result Client::Delete(const std::string &path,
  15621. DownloadProgress progress) {
  15622. return cli_->Delete(path, progress);
  15623. }
  15624. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15625. DownloadProgress progress) {
  15626. return cli_->Delete(path, headers, progress);
  15627. }
  15628. inline Result Client::Delete(const std::string &path, const char *body,
  15629. size_t content_length,
  15630. const std::string &content_type,
  15631. DownloadProgress progress) {
  15632. return cli_->Delete(path, body, content_length, content_type, progress);
  15633. }
  15634. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15635. const char *body, size_t content_length,
  15636. const std::string &content_type,
  15637. DownloadProgress progress) {
  15638. return cli_->Delete(path, headers, body, content_length, content_type,
  15639. progress);
  15640. }
  15641. inline Result Client::Delete(const std::string &path, const std::string &body,
  15642. const std::string &content_type,
  15643. DownloadProgress progress) {
  15644. return cli_->Delete(path, body, content_type, progress);
  15645. }
  15646. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15647. const std::string &body,
  15648. const std::string &content_type,
  15649. DownloadProgress progress) {
  15650. return cli_->Delete(path, headers, body, content_type, progress);
  15651. }
  15652. inline Result Client::Delete(const std::string &path, const Params &params,
  15653. DownloadProgress progress) {
  15654. return cli_->Delete(path, params, progress);
  15655. }
  15656. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15657. const Params &params, DownloadProgress progress) {
  15658. return cli_->Delete(path, headers, params, progress);
  15659. }
  15660. inline Result Client::Options(const std::string &path) {
  15661. return cli_->Options(path);
  15662. }
  15663. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15664. return cli_->Options(path, headers);
  15665. }
  15666. inline ClientImpl::StreamHandle
  15667. Client::open_stream(const std::string &method, const std::string &path,
  15668. const Params &params, const Headers &headers,
  15669. const std::string &body, const std::string &content_type) {
  15670. return cli_->open_stream(method, path, params, headers, body, content_type);
  15671. }
  15672. inline bool Client::send(Request &req, Response &res, Error &error) {
  15673. return cli_->send(req, res, error);
  15674. }
  15675. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15676. inline void Client::stop() { cli_->stop(); }
  15677. inline std::string Client::host() const { return cli_->host(); }
  15678. inline int Client::port() const { return cli_->port(); }
  15679. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15680. inline socket_t Client::socket() const { return cli_->socket(); }
  15681. inline void
  15682. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15683. cli_->set_hostname_addr_map(std::move(addr_map));
  15684. }
  15685. inline void Client::set_default_headers(Headers headers) {
  15686. cli_->set_default_headers(std::move(headers));
  15687. }
  15688. inline void Client::set_header_writer(
  15689. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15690. cli_->set_header_writer(writer);
  15691. }
  15692. inline void Client::set_address_family(int family) {
  15693. cli_->set_address_family(family);
  15694. }
  15695. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15696. inline void Client::set_socket_options(SocketOptions socket_options) {
  15697. cli_->set_socket_options(std::move(socket_options));
  15698. }
  15699. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15700. cli_->set_connection_timeout(sec, usec);
  15701. }
  15702. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15703. cli_->set_read_timeout(sec, usec);
  15704. }
  15705. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15706. cli_->set_write_timeout(sec, usec);
  15707. }
  15708. inline void Client::set_basic_auth(const std::string &username,
  15709. const std::string &password) {
  15710. cli_->set_basic_auth(username, password);
  15711. }
  15712. inline void Client::set_bearer_token_auth(const std::string &token) {
  15713. cli_->set_bearer_token_auth(token);
  15714. }
  15715. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15716. inline void Client::set_follow_location(bool on) {
  15717. cli_->set_follow_location(on);
  15718. }
  15719. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15720. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15721. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15722. inline void Client::set_payload_max_length(size_t length) {
  15723. cli_->set_payload_max_length(length);
  15724. }
  15725. inline void Client::set_interface(const std::string &intf) {
  15726. cli_->set_interface(intf);
  15727. }
  15728. inline void Client::set_proxy(const std::string &host, int port) {
  15729. cli_->set_proxy(host, port);
  15730. }
  15731. inline void Client::set_proxy_basic_auth(const std::string &username,
  15732. const std::string &password) {
  15733. cli_->set_proxy_basic_auth(username, password);
  15734. }
  15735. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15736. cli_->set_proxy_bearer_token_auth(token);
  15737. }
  15738. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15739. cli_->set_no_proxy(patterns);
  15740. }
  15741. inline void Client::set_logger(Logger logger) {
  15742. cli_->set_logger(std::move(logger));
  15743. }
  15744. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15745. cli_->set_error_logger(std::move(error_logger));
  15746. }
  15747. /*
  15748. * Group 6: SSL Server and Client implementation
  15749. */
  15750. #ifdef CPPHTTPLIB_SSL_ENABLED
  15751. // SSL HTTP server implementation
  15752. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15753. const char *client_ca_cert_file_path,
  15754. const char *client_ca_cert_dir_path,
  15755. const char *private_key_password) {
  15756. using namespace tls;
  15757. ctx_ = create_server_context();
  15758. if (!ctx_) { return; }
  15759. // Load server certificate and private key
  15760. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15761. private_key_password)) {
  15762. last_ssl_error_ = static_cast<int>(get_error());
  15763. free_context(ctx_);
  15764. ctx_ = nullptr;
  15765. return;
  15766. }
  15767. // Load client CA certificates for client authentication
  15768. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15769. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15770. client_ca_cert_dir_path)) {
  15771. last_ssl_error_ = static_cast<int>(get_error());
  15772. free_context(ctx_);
  15773. ctx_ = nullptr;
  15774. return;
  15775. }
  15776. // Enable client certificate verification
  15777. set_verify_client(ctx_, true);
  15778. }
  15779. }
  15780. inline SSLServer::SSLServer(const PemMemory &pem) {
  15781. using namespace tls;
  15782. ctx_ = create_server_context();
  15783. if (ctx_) {
  15784. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15785. pem.private_key_password)) {
  15786. last_ssl_error_ = static_cast<int>(get_error());
  15787. free_context(ctx_);
  15788. ctx_ = nullptr;
  15789. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15790. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15791. last_ssl_error_ = static_cast<int>(get_error());
  15792. free_context(ctx_);
  15793. ctx_ = nullptr;
  15794. } else {
  15795. set_verify_client(ctx_, true);
  15796. }
  15797. }
  15798. }
  15799. }
  15800. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15801. using namespace tls;
  15802. ctx_ = create_server_context();
  15803. if (ctx_) {
  15804. if (!setup_callback(ctx_)) {
  15805. free_context(ctx_);
  15806. ctx_ = nullptr;
  15807. }
  15808. }
  15809. }
  15810. inline SSLServer::~SSLServer() {
  15811. if (ctx_) { tls::free_context(ctx_); }
  15812. }
  15813. inline bool SSLServer::is_valid() const {
  15814. return ctx_ != nullptr && Server::is_valid();
  15815. }
  15816. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15817. using namespace tls;
  15818. session_t session = nullptr;
  15819. {
  15820. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15821. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15822. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15823. if (session) { handshakes_in_progress_++; }
  15824. }
  15825. if (!session) {
  15826. last_ssl_error_ = static_cast<int>(get_error());
  15827. detail::shutdown_socket(sock);
  15828. detail::close_socket(sock);
  15829. return false;
  15830. }
  15831. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15832. bool handshake_done = false;
  15833. bool ret = false;
  15834. bool websocket_upgraded = false;
  15835. auto cleanup = detail::scope_exit([&] {
  15836. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15837. free_session(session);
  15838. detail::shutdown_socket(sock);
  15839. detail::close_socket(sock);
  15840. });
  15841. // Perform TLS accept handshake with timeout
  15842. TlsError tls_err;
  15843. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15844. read_timeout_usec_, &tls_err);
  15845. {
  15846. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15847. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15848. }
  15849. if (!accepted) {
  15850. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15851. // Map TlsError to legacy ssl_error for backward compatibility
  15852. if (tls_err.code == ErrorCode::WantRead) {
  15853. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15854. } else if (tls_err.code == ErrorCode::WantWrite) {
  15855. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15856. } else {
  15857. last_ssl_error_ = SSL_ERROR_SSL;
  15858. }
  15859. #else
  15860. last_ssl_error_ = static_cast<int>(get_error());
  15861. #endif
  15862. return false;
  15863. }
  15864. handshake_done = true;
  15865. std::string remote_addr;
  15866. int remote_port = 0;
  15867. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15868. std::string local_addr;
  15869. int local_port = 0;
  15870. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15871. ret = serve_guarded([&]() {
  15872. return detail::process_server_socket_ssl(
  15873. svr_sock_, session, sock, keep_alive_max_count_,
  15874. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15875. write_timeout_sec_, write_timeout_usec_,
  15876. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15877. return process_request(
  15878. strm, remote_addr, remote_port, local_addr, local_port,
  15879. close_connection, connection_closed,
  15880. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15881. });
  15882. });
  15883. return ret;
  15884. }
  15885. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15886. const char *key_pem,
  15887. const char *client_ca_pem,
  15888. const char *password) {
  15889. if (!ctx_) { return false; }
  15890. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15891. updates_pending_++;
  15892. auto se = detail::scope_exit([&] {
  15893. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  15894. });
  15895. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  15896. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15897. return false;
  15898. }
  15899. if (client_ca_pem) {
  15900. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15901. }
  15902. return true;
  15903. }
  15904. // SSL HTTP client implementation
  15905. inline SSLClient::~SSLClient() {
  15906. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15907. // base function rather than the derived function once we get to the
  15908. // base class destructor, and won't free the SSL (causing a leak).
  15909. // This must happen before the context is freed below: some backends
  15910. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15911. // context, so freeing the context first leaves close_notify reading
  15912. // freed memory.
  15913. shutdown_ssl_impl(socket_, true);
  15914. if (ctx_) {
  15915. tls::free_context(ctx_);
  15916. ctx_ = nullptr;
  15917. }
  15918. }
  15919. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15920. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15921. shutdown_ssl_impl(socket, shutdown_gracefully);
  15922. }
  15923. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15924. bool shutdown_gracefully) {
  15925. if (socket.sock == INVALID_SOCKET) {
  15926. assert(socket.ssl == nullptr);
  15927. return;
  15928. }
  15929. if (socket.ssl) {
  15930. tls::shutdown(socket.ssl, shutdown_gracefully);
  15931. {
  15932. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15933. tls::free_session(socket.ssl);
  15934. }
  15935. socket.ssl = nullptr;
  15936. }
  15937. assert(socket.ssl == nullptr);
  15938. }
  15939. inline bool SSLClient::process_socket(
  15940. const Socket &socket,
  15941. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15942. std::function<bool(Stream &strm)> callback) {
  15943. assert(socket.ssl);
  15944. return detail::process_client_socket_ssl(
  15945. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15946. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15947. std::move(callback));
  15948. }
  15949. inline bool SSLClient::is_ssl() const { return true; }
  15950. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15951. if (!is_valid()) {
  15952. error = Error::SSLConnection;
  15953. return false;
  15954. }
  15955. return ClientImpl::create_and_connect_socket(socket, error);
  15956. }
  15957. inline bool SSLClient::setup_proxy_connection(
  15958. Socket &socket,
  15959. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15960. Response &res, bool &success, Error &error) {
  15961. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15962. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15963. return false;
  15964. }
  15965. if (!initialize_ssl(socket, error)) {
  15966. success = false;
  15967. return false;
  15968. }
  15969. return true;
  15970. }
  15971. // Assumes that socket_mutex_ is locked and that there are no requests in
  15972. // flight
  15973. inline bool SSLClient::connect_with_proxy(
  15974. Socket &socket,
  15975. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15976. Response &res, bool &success, Error &error) {
  15977. success = true;
  15978. Response proxy_res;
  15979. if (!detail::process_client_socket(
  15980. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15981. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15982. start_time, [&](Stream &strm) {
  15983. Request req2;
  15984. req2.method = "CONNECT";
  15985. req2.path =
  15986. detail::make_host_and_port_string_always_port(host_, port_);
  15987. if (max_timeout_msec_ > 0) {
  15988. req2.start_time_ = std::chrono::steady_clock::now();
  15989. }
  15990. return process_request(strm, req2, proxy_res, false, error);
  15991. })) {
  15992. // Thread-safe to close everything because we are assuming there are no
  15993. // requests in flight
  15994. shutdown_ssl(socket, true);
  15995. shutdown_socket(socket);
  15996. close_socket(socket);
  15997. success = false;
  15998. return false;
  15999. }
  16000. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16001. if (!proxy_digest_auth_username_.empty() &&
  16002. !proxy_digest_auth_password_.empty()) {
  16003. std::map<std::string, std::string> auth;
  16004. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16005. // Close the current socket and create a new one for the authenticated
  16006. // request
  16007. shutdown_ssl(socket, true);
  16008. shutdown_socket(socket);
  16009. close_socket(socket);
  16010. // Create a new socket for the authenticated CONNECT request
  16011. if (!ensure_socket_connection(socket, error)) {
  16012. success = false;
  16013. output_error_log(error, nullptr);
  16014. return false;
  16015. }
  16016. proxy_res = Response();
  16017. if (!detail::process_client_socket(
  16018. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16019. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16020. start_time, [&](Stream &strm) {
  16021. Request req3;
  16022. req3.method = "CONNECT";
  16023. req3.path = detail::make_host_and_port_string_always_port(
  16024. host_, port_);
  16025. req3.headers.insert(detail::make_digest_authentication_header(
  16026. req3, auth, 1, detail::random_string(10),
  16027. proxy_digest_auth_username_, proxy_digest_auth_password_,
  16028. true));
  16029. if (max_timeout_msec_ > 0) {
  16030. req3.start_time_ = std::chrono::steady_clock::now();
  16031. }
  16032. return process_request(strm, req3, proxy_res, false, error);
  16033. })) {
  16034. // Thread-safe to close everything because we are assuming there are
  16035. // no requests in flight
  16036. shutdown_ssl(socket, true);
  16037. shutdown_socket(socket);
  16038. close_socket(socket);
  16039. success = false;
  16040. return false;
  16041. }
  16042. }
  16043. }
  16044. }
  16045. // If status code is not 200, proxy request is failed.
  16046. // Set error to ProxyConnection. A refusal such as 407 is returned as the
  16047. // response of the request, so the caller sees why; any other status would
  16048. // read as the answer of the origin, which it never reached.
  16049. if (proxy_res.status != StatusCode::OK_200) {
  16050. error = Error::ProxyConnection;
  16051. output_error_log(error, nullptr);
  16052. if (400 <= proxy_res.status && proxy_res.status < 600) {
  16053. res = std::move(proxy_res);
  16054. } else {
  16055. success = false;
  16056. }
  16057. // Thread-safe to close everything because we are assuming there are
  16058. // no requests in flight
  16059. shutdown_ssl(socket, true);
  16060. shutdown_socket(socket);
  16061. close_socket(socket);
  16062. return false;
  16063. }
  16064. return true;
  16065. }
  16066. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16067. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16068. if (is_proxy_enabled_for_host(host_)) { return true; }
  16069. if (!initialize_ssl(socket, error)) {
  16070. shutdown_socket(socket);
  16071. close_socket(socket);
  16072. return false;
  16073. }
  16074. return true;
  16075. }
  16076. // SSL HTTP client implementation
  16077. inline SSLClient::SSLClient(const std::string &host)
  16078. : SSLClient(host, 443, std::string(), std::string()) {}
  16079. inline SSLClient::SSLClient(const std::string &host, int port)
  16080. : SSLClient(host, port, std::string(), std::string()) {}
  16081. inline void SSLClient::init_ctx() {
  16082. ctx_ = tls::create_client_context();
  16083. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16084. }
  16085. inline void SSLClient::reset_ctx_on_error() {
  16086. last_backend_error_ = tls::get_error();
  16087. tls::free_context(ctx_);
  16088. ctx_ = nullptr;
  16089. }
  16090. inline SSLClient::SSLClient(const std::string &host, int port,
  16091. const std::string &client_cert_path,
  16092. const std::string &client_key_path,
  16093. const std::string &private_key_password)
  16094. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16095. init_ctx();
  16096. if (!ctx_) { return; }
  16097. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16098. const char *password =
  16099. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16100. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16101. client_key_path.c_str(), password)) {
  16102. reset_ctx_on_error();
  16103. }
  16104. }
  16105. }
  16106. inline SSLClient::SSLClient(const std::string &host, int port,
  16107. const PemMemory &pem)
  16108. : ClientImpl(host, port) {
  16109. init_ctx();
  16110. if (!ctx_) { return; }
  16111. if (pem.cert_pem && pem.key_pem) {
  16112. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16113. pem.private_key_password)) {
  16114. reset_ctx_on_error();
  16115. }
  16116. }
  16117. }
  16118. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16119. if (ca_cert_store && ctx_) {
  16120. // set_ca_store takes ownership of ca_cert_store
  16121. tls::set_ca_store(ctx_, ca_cert_store);
  16122. ca_cert_store_set_ = true;
  16123. } else if (ca_cert_store) {
  16124. tls::free_ca_store(ca_cert_store);
  16125. }
  16126. }
  16127. inline void
  16128. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16129. if (!ctx_) { return; }
  16130. server_certificate_verifier_ = verifier;
  16131. tls::set_verify_callback(ctx_, std::move(verifier));
  16132. }
  16133. inline void SSLClient::set_session_verifier(
  16134. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16135. session_verifier_ = std::move(verifier);
  16136. }
  16137. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16138. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16139. enable_windows_cert_verification_ = enabled;
  16140. }
  16141. #endif
  16142. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16143. std::size_t size) {
  16144. if (ctx_ && ca_cert && size > 0) {
  16145. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16146. tls::load_ca_pem(ctx_, ca_cert, size);
  16147. }
  16148. }
  16149. inline bool SSLClient::load_certs() {
  16150. auto ret = true;
  16151. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16152. // one client is shared across concurrent requests here.
  16153. std::call_once(initialize_cert_, [&]() {
  16154. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16155. ret = detail::load_client_ca_config(
  16156. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16157. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16158. last_backend_error_);
  16159. });
  16160. return ret;
  16161. }
  16162. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16163. // Load CA certificates if server verification is enabled
  16164. if (server_certificate_verification_) {
  16165. if (!load_certs()) {
  16166. error = Error::SSLLoadingCerts;
  16167. output_error_log(error, nullptr);
  16168. return false;
  16169. }
  16170. }
  16171. detail::ClientTlsSessionOptions options;
  16172. options.server_hostname_verification = server_hostname_verification_;
  16173. options.session_verifier = session_verifier_;
  16174. options.ctx_mutex = &ctx_mutex_;
  16175. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16176. // Skip Schannel when a custom CA cert is specified, as the Windows
  16177. // certificate store would not know about user-provided CA certificates.
  16178. // Also skip when system CA trust is explicitly disabled.
  16179. options.windows_cert_verification =
  16180. enable_windows_cert_verification_ &&
  16181. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16182. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16183. // Only a verifier set through set_server_certificate_verifier() is seen
  16184. // here, not one installed with tls::set_verify_callback() directly.
  16185. options.server_certificate_verifier_set =
  16186. static_cast<bool>(server_certificate_verifier_);
  16187. #endif
  16188. tls::session_t session = nullptr;
  16189. // Use scope_exit to ensure session is freed on error paths
  16190. bool success = false;
  16191. auto session_guard = detail::scope_exit([&] {
  16192. if (!success) { tls::free_session(session); }
  16193. });
  16194. detail::ClientTlsSessionError tls_error;
  16195. if (!detail::setup_client_tls_session(
  16196. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16197. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16198. options)) {
  16199. error = tls_error.error;
  16200. last_ssl_error_ = tls_error.ssl_error;
  16201. last_backend_error_ = tls_error.backend_error;
  16202. output_error_log(error, nullptr);
  16203. return false;
  16204. }
  16205. success = true;
  16206. socket.ssl = session;
  16207. return true;
  16208. }
  16209. inline void Client::set_digest_auth(const std::string &username,
  16210. const std::string &password) {
  16211. cli_->set_digest_auth(username, password);
  16212. }
  16213. inline void Client::set_proxy_digest_auth(const std::string &username,
  16214. const std::string &password) {
  16215. cli_->set_proxy_digest_auth(username, password);
  16216. }
  16217. inline void Client::enable_server_certificate_verification(bool enabled) {
  16218. cli_->enable_server_certificate_verification(enabled);
  16219. }
  16220. inline void Client::enable_server_hostname_verification(bool enabled) {
  16221. cli_->enable_server_hostname_verification(enabled);
  16222. }
  16223. inline void Client::enable_system_ca(bool enabled) {
  16224. cli_->enable_system_ca(enabled);
  16225. }
  16226. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16227. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16228. if (is_ssl_) {
  16229. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16230. enabled);
  16231. }
  16232. }
  16233. #endif
  16234. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16235. const std::string &ca_cert_dir_path) {
  16236. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16237. }
  16238. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16239. if (is_ssl_) {
  16240. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16241. } else if (ca_cert_store) {
  16242. tls::free_ca_store(ca_cert_store);
  16243. }
  16244. }
  16245. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16246. if (is_ssl_) {
  16247. // Use the PEM-based path so the CA data is retained for redirect transfer
  16248. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16249. }
  16250. }
  16251. inline void
  16252. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16253. if (is_ssl_) {
  16254. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16255. std::move(verifier));
  16256. }
  16257. }
  16258. inline void Client::set_session_verifier(
  16259. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16260. if (is_ssl_) {
  16261. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16262. }
  16263. }
  16264. inline tls::ctx_t Client::tls_context() const {
  16265. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16266. return nullptr;
  16267. }
  16268. #endif // CPPHTTPLIB_SSL_ENABLED
  16269. /*
  16270. * Group 7: TLS abstraction layer - Common API
  16271. */
  16272. #ifdef CPPHTTPLIB_SSL_ENABLED
  16273. namespace tls {
  16274. // Helper for PeerCert construction
  16275. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16276. return PeerCert(get_peer_cert(session));
  16277. }
  16278. namespace impl {
  16279. // Check if a string is an IPv4 address
  16280. inline bool is_ipv4_address(const std::string &str) {
  16281. int dots = 0;
  16282. for (char c : str) {
  16283. if (c == '.') {
  16284. dots++;
  16285. } else if (!detail::is_ascii_digit(c)) {
  16286. return false;
  16287. }
  16288. }
  16289. return dots == 3;
  16290. }
  16291. // Parse IPv4 address string to bytes
  16292. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16293. const char *p = str.c_str();
  16294. for (int i = 0; i < 4; i++) {
  16295. if (i > 0) {
  16296. if (*p != '.') { return false; }
  16297. p++;
  16298. }
  16299. int val = 0;
  16300. int digits = 0;
  16301. while (detail::is_ascii_digit(*p)) {
  16302. val = val * 10 + (*p - '0');
  16303. if (val > 255) { return false; }
  16304. p++;
  16305. digits++;
  16306. }
  16307. if (digits == 0) { return false; }
  16308. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16309. if (digits > 1 && *(p - digits) == '0') { return false; }
  16310. out[i] = static_cast<unsigned char>(val);
  16311. }
  16312. return *p == '\0';
  16313. }
  16314. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16315. // `out` must have room for at least 16 bytes. Returns the address length
  16316. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16317. // literal. Used to match a host against iPAddress SANs the same way the
  16318. // OpenSSL backend does via X509_check_ip.
  16319. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16320. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16321. struct in6_addr addr6 = {};
  16322. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16323. memcpy(out, &addr6, 16);
  16324. return 16;
  16325. }
  16326. return 0;
  16327. }
  16328. #ifdef _WIN32
  16329. // Enumerate Windows system certificates and call callback with DER data
  16330. template <typename Callback>
  16331. inline bool enumerate_windows_system_certs(Callback cb) {
  16332. bool loaded = false;
  16333. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16334. for (auto store_name : store_names) {
  16335. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16336. if (hStore) {
  16337. PCCERT_CONTEXT pContext = nullptr;
  16338. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16339. nullptr) {
  16340. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16341. loaded = true;
  16342. }
  16343. }
  16344. CertCloseStore(hStore, 0);
  16345. }
  16346. }
  16347. return loaded;
  16348. }
  16349. #endif
  16350. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16351. // Enumerate macOS Keychain certificates and call callback with DER data
  16352. template <typename Callback>
  16353. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16354. bool loaded = false;
  16355. const SecTrustSettingsDomain domains[] = {
  16356. kSecTrustSettingsDomainSystem,
  16357. kSecTrustSettingsDomainAdmin,
  16358. kSecTrustSettingsDomainUser,
  16359. };
  16360. for (auto domain : domains) {
  16361. CFArrayRef certs = nullptr;
  16362. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16363. if (status != errSecSuccess || !certs) {
  16364. if (certs) CFRelease(certs);
  16365. continue;
  16366. }
  16367. CFIndex count = CFArrayGetCount(certs);
  16368. for (CFIndex i = 0; i < count; i++) {
  16369. SecCertificateRef cert =
  16370. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16371. CFDataRef data = SecCertificateCopyData(cert);
  16372. if (data) {
  16373. if (cb(CFDataGetBytePtr(data),
  16374. static_cast<size_t>(CFDataGetLength(data)))) {
  16375. loaded = true;
  16376. }
  16377. CFRelease(data);
  16378. }
  16379. }
  16380. CFRelease(certs);
  16381. }
  16382. return loaded;
  16383. }
  16384. #endif
  16385. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16386. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16387. // Common CA certificate file paths on Linux/Unix
  16388. inline const char **system_ca_paths() {
  16389. static const char *paths[] = {
  16390. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16391. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16392. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16393. "/etc/pki/tls/cacert.pem", // OpenELEC
  16394. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16395. nullptr};
  16396. return paths;
  16397. }
  16398. // Common CA certificate directory paths on Linux/Unix
  16399. inline const char **system_ca_dirs() {
  16400. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16401. "/etc/pki/tls/certs", // RHEL/CentOS
  16402. "/usr/share/ca-certificates", // Other
  16403. nullptr};
  16404. return dirs;
  16405. }
  16406. #endif
  16407. } // namespace impl
  16408. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16409. const char *ca_dir) {
  16410. if (!ctx) { return false; }
  16411. bool success = true;
  16412. if (ca_file && *ca_file) {
  16413. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16414. }
  16415. if (ca_dir && *ca_dir) {
  16416. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16417. }
  16418. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16419. // Set CA list for client certificate request (CertificateRequest message)
  16420. if (ca_file && *ca_file) {
  16421. auto list = SSL_load_client_CA_file(ca_file);
  16422. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16423. }
  16424. #endif
  16425. return success;
  16426. }
  16427. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16428. const char *password) {
  16429. return set_client_cert_pem(ctx, cert, key, password);
  16430. }
  16431. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16432. const char *key_path, const char *password) {
  16433. return set_client_cert_file(ctx, cert_path, key_path, password);
  16434. }
  16435. // PeerCert implementation
  16436. inline PeerCert::PeerCert() = default;
  16437. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16438. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16439. other.cert_ = nullptr;
  16440. }
  16441. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16442. if (this != &other) {
  16443. if (cert_) { free_cert(cert_); }
  16444. cert_ = other.cert_;
  16445. other.cert_ = nullptr;
  16446. }
  16447. return *this;
  16448. }
  16449. inline PeerCert::~PeerCert() {
  16450. if (cert_) { free_cert(cert_); }
  16451. }
  16452. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16453. inline std::string PeerCert::subject_cn() const {
  16454. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16455. }
  16456. inline std::string PeerCert::issuer_name() const {
  16457. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16458. }
  16459. inline bool PeerCert::check_hostname(const char *hostname) const {
  16460. return cert_ ? verify_hostname(cert_, hostname) : false;
  16461. }
  16462. inline std::vector<SanEntry> PeerCert::sans() const {
  16463. std::vector<SanEntry> result;
  16464. if (cert_) { get_cert_sans(cert_, result); }
  16465. return result;
  16466. }
  16467. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16468. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16469. }
  16470. inline std::string PeerCert::serial() const {
  16471. return cert_ ? get_cert_serial(cert_) : std::string();
  16472. }
  16473. // VerifyContext method implementations
  16474. inline std::string VerifyContext::subject_cn() const {
  16475. return cert ? get_cert_subject_cn(cert) : std::string();
  16476. }
  16477. inline std::string VerifyContext::issuer_name() const {
  16478. return cert ? get_cert_issuer_name(cert) : std::string();
  16479. }
  16480. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16481. return cert ? verify_hostname(cert, hostname) : false;
  16482. }
  16483. inline std::vector<SanEntry> VerifyContext::sans() const {
  16484. std::vector<SanEntry> result;
  16485. if (cert) { get_cert_sans(cert, result); }
  16486. return result;
  16487. }
  16488. inline bool VerifyContext::validity(time_t &not_before,
  16489. time_t &not_after) const {
  16490. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16491. }
  16492. inline std::string VerifyContext::serial() const {
  16493. return cert ? get_cert_serial(cert) : std::string();
  16494. }
  16495. // TlsError static method implementation
  16496. inline std::string TlsError::verify_error_to_string(long error_code) {
  16497. return verify_error_string(error_code);
  16498. }
  16499. } // namespace tls
  16500. // Request::peer_cert() implementation
  16501. inline tls::PeerCert Request::peer_cert() const {
  16502. return tls::get_peer_cert_from_session(ssl);
  16503. }
  16504. // Request::sni() implementation
  16505. inline std::string Request::sni() const {
  16506. if (!ssl) { return std::string(); }
  16507. const char *s = tls::get_sni(ssl);
  16508. return s ? std::string(s) : std::string();
  16509. }
  16510. #endif // CPPHTTPLIB_SSL_ENABLED
  16511. /*
  16512. * Group 8: TLS abstraction layer - OpenSSL backend
  16513. */
  16514. /*
  16515. * OpenSSL Backend Implementation
  16516. */
  16517. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16518. namespace tls {
  16519. namespace impl {
  16520. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16521. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16522. switch (ssl_error) {
  16523. case SSL_ERROR_NONE: return ErrorCode::Success;
  16524. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16525. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16526. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16527. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16528. case SSL_ERROR_SSL:
  16529. default: return ErrorCode::Fatal;
  16530. }
  16531. }
  16532. // Helper: Create client CA list from PEM string
  16533. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16534. // Caller takes ownership of returned list
  16535. inline STACK_OF(X509_NAME) *
  16536. create_client_ca_list_from_pem(const char *ca_pem) {
  16537. if (!ca_pem) { return nullptr; }
  16538. auto ca_list = sk_X509_NAME_new_null();
  16539. if (!ca_list) { return nullptr; }
  16540. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16541. if (!bio) {
  16542. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16543. return nullptr;
  16544. }
  16545. X509 *cert = nullptr;
  16546. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16547. nullptr) {
  16548. const X509_NAME *name = X509_get_subject_name(cert);
  16549. if (name) {
  16550. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16551. }
  16552. X509_free(cert);
  16553. }
  16554. BIO_free(bio);
  16555. return ca_list;
  16556. }
  16557. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16558. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16559. long /*argl*/, void * /*argp*/) {
  16560. delete static_cast<VerifyCallback *>(ptr);
  16561. }
  16562. // The SSL_CTX owns its verify callback, so each client or server sees only
  16563. // its own, on whichever thread runs the handshake.
  16564. inline int verify_callback_index() {
  16565. static const auto index = SSL_CTX_get_ex_new_index(
  16566. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16567. return index;
  16568. }
  16569. // OpenSSL verify callback wrapper
  16570. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16571. // Get SSL object from X509_STORE_CTX
  16572. auto ssl = static_cast<SSL *>(
  16573. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16574. if (!ssl) { return preverify_ok; }
  16575. auto callback = static_cast<VerifyCallback *>(
  16576. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16577. if (!callback) { return preverify_ok; }
  16578. // Get current certificate and depth
  16579. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16580. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16581. int error = X509_STORE_CTX_get_error(ctx);
  16582. // Build context
  16583. VerifyContext verify_ctx;
  16584. verify_ctx.session = static_cast<session_t>(ssl);
  16585. verify_ctx.cert = static_cast<cert_t>(cert);
  16586. verify_ctx.depth = depth;
  16587. verify_ctx.preverify_ok = (preverify_ok != 0);
  16588. verify_ctx.error_code = error;
  16589. verify_ctx.error_string =
  16590. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16591. return (*callback)(verify_ctx) ? 1 : 0;
  16592. }
  16593. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16594. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16595. // that must be released with release_store_objects
  16596. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16597. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16598. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16599. #endif
  16600. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16601. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16602. return X509_STORE_get1_objects(store);
  16603. #else
  16604. return X509_STORE_get0_objects(store);
  16605. #endif
  16606. }
  16607. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16608. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16609. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16610. #else
  16611. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16612. #endif
  16613. }
  16614. } // namespace impl
  16615. inline ctx_t create_client_context() {
  16616. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16617. if (ctx) {
  16618. // Disable auto-retry to properly handle non-blocking I/O
  16619. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16620. // Set minimum TLS version
  16621. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16622. }
  16623. return static_cast<ctx_t>(ctx);
  16624. }
  16625. inline void free_context(ctx_t ctx) {
  16626. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16627. }
  16628. inline bool set_min_version(ctx_t ctx, Version version) {
  16629. if (!ctx) return false;
  16630. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16631. static_cast<int>(version)) == 1;
  16632. }
  16633. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16634. if (!ctx || !pem || len == 0) return false;
  16635. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16636. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16637. if (!store) return false;
  16638. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16639. if (!bio) return false;
  16640. bool ok = true;
  16641. X509 *cert = nullptr;
  16642. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16643. nullptr) {
  16644. if (X509_STORE_add_cert(store, cert) != 1) {
  16645. // Ignore duplicate errors
  16646. auto err = ERR_peek_last_error();
  16647. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16648. ok = false;
  16649. }
  16650. }
  16651. X509_free(cert);
  16652. if (!ok) break;
  16653. }
  16654. BIO_free(bio);
  16655. // Clear any "no more certificates" errors
  16656. ERR_clear_error();
  16657. return ok;
  16658. }
  16659. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16660. if (!ctx || !file_path) return false;
  16661. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16662. nullptr) == 1;
  16663. }
  16664. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16665. if (!ctx || !dir_path) return false;
  16666. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16667. dir_path) == 1;
  16668. }
  16669. inline bool load_system_certs(ctx_t ctx) {
  16670. if (!ctx) return false;
  16671. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16672. #ifdef _WIN32
  16673. // Windows: Load from system certificate store (ROOT and CA)
  16674. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16675. if (!store) return false;
  16676. bool loaded_any = false;
  16677. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16678. for (auto store_name : store_names) {
  16679. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16680. if (!hStore) continue;
  16681. PCCERT_CONTEXT pContext = nullptr;
  16682. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16683. nullptr) {
  16684. const unsigned char *data = pContext->pbCertEncoded;
  16685. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16686. if (x509) {
  16687. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16688. X509_free(x509);
  16689. }
  16690. }
  16691. CertCloseStore(hStore, 0);
  16692. }
  16693. return loaded_any;
  16694. #elif defined(__APPLE__)
  16695. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16696. // macOS: Load from Keychain
  16697. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16698. if (!store) return false;
  16699. bool loaded_any = false;
  16700. const SecTrustSettingsDomain domains[] = {
  16701. kSecTrustSettingsDomainSystem,
  16702. kSecTrustSettingsDomainAdmin,
  16703. kSecTrustSettingsDomainUser,
  16704. };
  16705. for (auto domain : domains) {
  16706. CFArrayRef certs = nullptr;
  16707. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16708. !certs) {
  16709. if (certs) CFRelease(certs);
  16710. continue;
  16711. }
  16712. auto count = CFArrayGetCount(certs);
  16713. for (CFIndex i = 0; i < count; i++) {
  16714. auto cert = reinterpret_cast<SecCertificateRef>(
  16715. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16716. CFDataRef der = SecCertificateCopyData(cert);
  16717. if (der) {
  16718. const unsigned char *data = CFDataGetBytePtr(der);
  16719. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16720. if (x509) {
  16721. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16722. X509_free(x509);
  16723. }
  16724. CFRelease(der);
  16725. }
  16726. }
  16727. CFRelease(certs);
  16728. }
  16729. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16730. #else
  16731. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16732. #endif
  16733. #else
  16734. // Other Unix: use default verify paths
  16735. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16736. #endif
  16737. }
  16738. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16739. const char *password) {
  16740. if (!ctx || !cert || !key) return false;
  16741. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16742. // Load certificate
  16743. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16744. if (!cert_bio) return false;
  16745. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16746. BIO_free(cert_bio);
  16747. if (!x509) return false;
  16748. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16749. X509_free(x509);
  16750. if (!cert_ok) return false;
  16751. // Load private key
  16752. auto key_bio = BIO_new_mem_buf(key, -1);
  16753. if (!key_bio) return false;
  16754. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16755. password ? const_cast<char *>(password)
  16756. : nullptr);
  16757. BIO_free(key_bio);
  16758. if (!pkey) return false;
  16759. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16760. EVP_PKEY_free(pkey);
  16761. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16762. }
  16763. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16764. const char *key_path, const char *password) {
  16765. if (!ctx || !cert_path || !key_path) return false;
  16766. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16767. if (password && password[0] != '\0') {
  16768. SSL_CTX_set_default_passwd_cb_userdata(
  16769. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16770. }
  16771. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16772. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16773. }
  16774. inline ctx_t create_server_context() {
  16775. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16776. if (ctx) {
  16777. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16778. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16779. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16780. }
  16781. return static_cast<ctx_t>(ctx);
  16782. }
  16783. inline void set_verify_client(ctx_t ctx, bool require) {
  16784. if (!ctx) return;
  16785. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16786. require
  16787. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16788. : SSL_VERIFY_NONE,
  16789. nullptr);
  16790. }
  16791. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16792. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16793. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16794. SSL *ssl = SSL_new(ssl_ctx);
  16795. if (!ssl) return nullptr;
  16796. // Disable auto-retry for proper non-blocking I/O handling
  16797. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16798. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16799. if (!bio) {
  16800. SSL_free(ssl);
  16801. return nullptr;
  16802. }
  16803. SSL_set_bio(ssl, bio, bio);
  16804. return static_cast<session_t>(ssl);
  16805. }
  16806. inline void free_session(session_t session) {
  16807. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16808. }
  16809. inline bool set_sni(session_t session, const char *hostname,
  16810. bool /*verify_hostname*/) {
  16811. if (!session || !hostname) return false;
  16812. auto ssl = static_cast<SSL *>(session);
  16813. // Set SNI (Server Name Indication) only - does not enable verification.
  16814. // OpenSSL never binds identity checking to SNI (that happens post-
  16815. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16816. #if defined(OPENSSL_IS_BORINGSSL)
  16817. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16818. #else
  16819. // Direct call instead of macro to suppress -Wold-style-cast warning
  16820. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16821. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16822. #endif
  16823. }
  16824. inline TlsError connect(session_t session) {
  16825. if (!session) { return TlsError(); }
  16826. auto ssl = static_cast<SSL *>(session);
  16827. auto ret = SSL_connect(ssl);
  16828. TlsError err;
  16829. if (ret == 1) {
  16830. err.code = ErrorCode::Success;
  16831. } else {
  16832. auto ssl_err = SSL_get_error(ssl, ret);
  16833. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16834. err.backend_code = ERR_get_error();
  16835. }
  16836. return err;
  16837. }
  16838. inline TlsError accept(session_t session) {
  16839. if (!session) { return TlsError(); }
  16840. auto ssl = static_cast<SSL *>(session);
  16841. auto ret = SSL_accept(ssl);
  16842. TlsError err;
  16843. if (ret == 1) {
  16844. err.code = ErrorCode::Success;
  16845. } else {
  16846. auto ssl_err = SSL_get_error(ssl, ret);
  16847. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16848. err.backend_code = ERR_get_error();
  16849. }
  16850. return err;
  16851. }
  16852. inline bool connect_nonblocking(session_t session, socket_t sock,
  16853. time_t timeout_sec, time_t timeout_usec,
  16854. TlsError *err) {
  16855. if (!session) {
  16856. if (err) { err->code = ErrorCode::Fatal; }
  16857. return false;
  16858. }
  16859. auto ssl = static_cast<SSL *>(session);
  16860. auto bio = SSL_get_rbio(ssl);
  16861. // Set non-blocking mode for handshake
  16862. detail::set_nonblocking(sock, true);
  16863. if (bio) { BIO_set_nbio(bio, 1); }
  16864. auto cleanup = detail::scope_exit([&]() {
  16865. // Restore blocking mode after handshake
  16866. if (bio) { BIO_set_nbio(bio, 0); }
  16867. detail::set_nonblocking(sock, false);
  16868. });
  16869. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16870. auto res = 0;
  16871. while ((res = SSL_connect(ssl)) != 1) {
  16872. auto ssl_err = SSL_get_error(ssl, res);
  16873. switch (ssl_err) {
  16874. case SSL_ERROR_WANT_READ:
  16875. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16876. break;
  16877. case SSL_ERROR_WANT_WRITE:
  16878. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16879. break;
  16880. default: break;
  16881. }
  16882. if (err) {
  16883. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16884. err->backend_code = ERR_get_error();
  16885. }
  16886. return false;
  16887. }
  16888. if (err) { err->code = ErrorCode::Success; }
  16889. return true;
  16890. }
  16891. inline bool accept_nonblocking(session_t session, socket_t sock,
  16892. time_t timeout_sec, time_t timeout_usec,
  16893. TlsError *err) {
  16894. if (!session) {
  16895. if (err) { err->code = ErrorCode::Fatal; }
  16896. return false;
  16897. }
  16898. auto ssl = static_cast<SSL *>(session);
  16899. auto bio = SSL_get_rbio(ssl);
  16900. // Set non-blocking mode for handshake
  16901. detail::set_nonblocking(sock, true);
  16902. if (bio) { BIO_set_nbio(bio, 1); }
  16903. auto cleanup = detail::scope_exit([&]() {
  16904. // Restore blocking mode after handshake
  16905. if (bio) { BIO_set_nbio(bio, 0); }
  16906. detail::set_nonblocking(sock, false);
  16907. });
  16908. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16909. auto res = 0;
  16910. while ((res = SSL_accept(ssl)) != 1) {
  16911. auto ssl_err = SSL_get_error(ssl, res);
  16912. switch (ssl_err) {
  16913. case SSL_ERROR_WANT_READ:
  16914. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16915. break;
  16916. case SSL_ERROR_WANT_WRITE:
  16917. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16918. break;
  16919. default: break;
  16920. }
  16921. if (err) {
  16922. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16923. err->backend_code = ERR_get_error();
  16924. }
  16925. return false;
  16926. }
  16927. if (err) { err->code = ErrorCode::Success; }
  16928. return true;
  16929. }
  16930. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16931. if (!session || !buf) {
  16932. err.code = ErrorCode::Fatal;
  16933. return -1;
  16934. }
  16935. auto ssl = static_cast<SSL *>(session);
  16936. constexpr auto max_len =
  16937. static_cast<size_t>((std::numeric_limits<int>::max)());
  16938. if (len > max_len) { len = max_len; }
  16939. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16940. if (ret > 0) {
  16941. err.code = ErrorCode::Success;
  16942. return ret;
  16943. }
  16944. auto ssl_err = SSL_get_error(ssl, ret);
  16945. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16946. if (err.code == ErrorCode::PeerClosed) {
  16947. return 0;
  16948. } // Gracefully handle the peer closed state.
  16949. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16950. return -1;
  16951. }
  16952. inline ssize_t write(session_t session, const void *buf, size_t len,
  16953. TlsError &err) {
  16954. if (!session || !buf) {
  16955. err.code = ErrorCode::Fatal;
  16956. return -1;
  16957. }
  16958. auto ssl = static_cast<SSL *>(session);
  16959. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16960. if (ret > 0) {
  16961. err.code = ErrorCode::Success;
  16962. return ret;
  16963. }
  16964. auto ssl_err = SSL_get_error(ssl, ret);
  16965. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16966. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16967. return -1;
  16968. }
  16969. inline int pending(const_session_t session) {
  16970. if (!session) return 0;
  16971. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16972. }
  16973. inline void shutdown(session_t session, bool graceful) {
  16974. if (!session) return;
  16975. auto ssl = static_cast<SSL *>(session);
  16976. if (graceful) {
  16977. // Send close_notify without waiting for the peer's. The connection is
  16978. // closed right after this, so a unidirectional shutdown is enough, and an
  16979. // idle peer that never answers would otherwise hold this thread until the
  16980. // read timeout. The other backends do not wait either.
  16981. SSL_shutdown(ssl);
  16982. }
  16983. }
  16984. inline bool is_peer_closed(session_t session, socket_t sock) {
  16985. if (!session) return true;
  16986. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16987. detail::set_nonblocking(sock, true);
  16988. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16989. auto ssl = static_cast<SSL *>(session);
  16990. char buf;
  16991. auto ret = SSL_peek(ssl, &buf, 1);
  16992. if (ret > 0) return false;
  16993. auto err = SSL_get_error(ssl, ret);
  16994. return err == SSL_ERROR_ZERO_RETURN;
  16995. }
  16996. inline cert_t get_peer_cert(const_session_t session) {
  16997. if (!session) return nullptr;
  16998. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16999. static_cast<SSL *>(const_cast<void *>(session))));
  17000. }
  17001. inline size_t get_peer_certs(const_session_t session,
  17002. std::vector<cert_t> &certs) {
  17003. certs.clear();
  17004. if (!session) { return 0; }
  17005. auto ssl = static_cast<const SSL *>(session);
  17006. // On the server side, the chain leaves out the peer's own certificate
  17007. if (SSL_is_server(ssl)) {
  17008. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17009. }
  17010. auto sk = SSL_get_peer_cert_chain(ssl);
  17011. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  17012. auto x509 = sk_X509_value(sk, i);
  17013. X509_up_ref(x509);
  17014. certs.push_back(static_cast<cert_t>(x509));
  17015. }
  17016. return certs.size();
  17017. }
  17018. inline void free_cert(cert_t cert) {
  17019. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17020. }
  17021. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17022. if (!cert || !hostname) return false;
  17023. auto x509 = static_cast<X509 *>(cert);
  17024. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17025. if (detail::is_ip_address(hostname)) {
  17026. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17027. }
  17028. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17029. }
  17030. inline uint64_t hostname_mismatch_code() {
  17031. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17032. }
  17033. inline long get_verify_result(const_session_t session) {
  17034. if (!session) return X509_V_ERR_UNSPECIFIED;
  17035. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17036. }
  17037. inline std::string get_cert_subject_cn(cert_t cert) {
  17038. if (!cert) return "";
  17039. auto x509 = static_cast<X509 *>(cert);
  17040. auto subject_name = X509_get_subject_name(x509);
  17041. if (!subject_name) return "";
  17042. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17043. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17044. if (idx < 0) return "";
  17045. auto entry = X509_NAME_get_entry(subject_name, idx);
  17046. if (!entry) return "";
  17047. auto data = X509_NAME_ENTRY_get_data(entry);
  17048. if (!data) return "";
  17049. return std::string(
  17050. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17051. static_cast<size_t>(ASN1_STRING_length(data)));
  17052. }
  17053. inline std::string get_cert_issuer_name(cert_t cert) {
  17054. if (!cert) return "";
  17055. auto x509 = static_cast<X509 *>(cert);
  17056. auto issuer_name = X509_get_issuer_name(x509);
  17057. if (!issuer_name) return "";
  17058. char buf[256];
  17059. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17060. return std::string(buf);
  17061. }
  17062. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17063. sans.clear();
  17064. if (!cert) return false;
  17065. auto x509 = static_cast<X509 *>(cert);
  17066. auto names = static_cast<GENERAL_NAMES *>(
  17067. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17068. if (!names) return true; // No SANs is valid
  17069. auto count = sk_GENERAL_NAME_num(names);
  17070. for (decltype(count) i = 0; i < count; i++) {
  17071. auto gen = sk_GENERAL_NAME_value(names, i);
  17072. if (!gen) continue;
  17073. SanEntry entry;
  17074. switch (gen->type) {
  17075. case GEN_DNS:
  17076. entry.type = SanType::DNS;
  17077. if (gen->d.dNSName) {
  17078. entry.value = std::string(
  17079. reinterpret_cast<const char *>(
  17080. ASN1_STRING_get0_data(gen->d.dNSName)),
  17081. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17082. }
  17083. break;
  17084. case GEN_IPADD:
  17085. entry.type = SanType::IP;
  17086. if (gen->d.iPAddress) {
  17087. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17088. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17089. if (len == 4) {
  17090. // IPv4
  17091. char buf[INET_ADDRSTRLEN];
  17092. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17093. entry.value = buf;
  17094. } else if (len == 16) {
  17095. // IPv6
  17096. char buf[INET6_ADDRSTRLEN];
  17097. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17098. entry.value = buf;
  17099. }
  17100. }
  17101. break;
  17102. case GEN_EMAIL:
  17103. entry.type = SanType::EMAIL;
  17104. if (gen->d.rfc822Name) {
  17105. entry.value = std::string(
  17106. reinterpret_cast<const char *>(
  17107. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17108. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17109. }
  17110. break;
  17111. case GEN_URI:
  17112. entry.type = SanType::URI;
  17113. if (gen->d.uniformResourceIdentifier) {
  17114. entry.value = std::string(
  17115. reinterpret_cast<const char *>(
  17116. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17117. static_cast<size_t>(
  17118. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17119. }
  17120. break;
  17121. default: entry.type = SanType::OTHER; break;
  17122. }
  17123. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17124. }
  17125. GENERAL_NAMES_free(names);
  17126. return true;
  17127. }
  17128. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17129. time_t &not_after) {
  17130. if (!cert) return false;
  17131. auto x509 = static_cast<X509 *>(cert);
  17132. auto nb = X509_get0_notBefore(x509);
  17133. auto na = X509_get0_notAfter(x509);
  17134. if (!nb || !na) return false;
  17135. ASN1_TIME *epoch = ASN1_TIME_new();
  17136. if (!epoch) return false;
  17137. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17138. if (!ASN1_TIME_set(epoch, 0)) return false;
  17139. int pday, psec;
  17140. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17141. not_before = 86400 * (time_t)pday + psec;
  17142. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17143. not_after = 86400 * (time_t)pday + psec;
  17144. return true;
  17145. }
  17146. inline std::string get_cert_serial(cert_t cert) {
  17147. if (!cert) return "";
  17148. auto x509 = static_cast<X509 *>(cert);
  17149. auto serial = X509_get_serialNumber(x509);
  17150. if (!serial) return "";
  17151. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17152. if (!bn) return "";
  17153. auto hex = BN_bn2hex(bn);
  17154. BN_free(bn);
  17155. if (!hex) return "";
  17156. std::string result(hex);
  17157. OPENSSL_free(hex);
  17158. return result;
  17159. }
  17160. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17161. if (!cert) return false;
  17162. auto x509 = static_cast<X509 *>(cert);
  17163. auto len = i2d_X509(x509, nullptr);
  17164. if (len < 0) return false;
  17165. der.resize(static_cast<size_t>(len));
  17166. auto p = der.data();
  17167. i2d_X509(x509, &p);
  17168. return true;
  17169. }
  17170. inline const char *get_sni(const_session_t session) {
  17171. if (!session) return nullptr;
  17172. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17173. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17174. }
  17175. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17176. inline uint64_t get_error() { return ERR_get_error(); }
  17177. inline std::string error_string(uint64_t code) {
  17178. char buf[256];
  17179. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17180. return std::string(buf);
  17181. }
  17182. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17183. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17184. if (!mem) { return nullptr; }
  17185. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17186. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17187. if (!inf) { return nullptr; }
  17188. auto store = X509_STORE_new();
  17189. if (store) {
  17190. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17191. auto itmp = sk_X509_INFO_value(inf, i);
  17192. if (!itmp) { continue; }
  17193. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17194. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17195. }
  17196. }
  17197. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17198. return static_cast<ca_store_t>(store);
  17199. }
  17200. inline void free_ca_store(ca_store_t store) {
  17201. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17202. }
  17203. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17204. if (!ctx || !store) { return false; }
  17205. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17206. auto x509_store = static_cast<X509_STORE *>(store);
  17207. // Check if same store is already set
  17208. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17209. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17210. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17211. return true;
  17212. }
  17213. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17214. certs.clear();
  17215. if (!ctx) { return 0; }
  17216. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17217. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17218. if (!store) { return 0; }
  17219. auto objs = impl::get_store_objects(store);
  17220. if (!objs) { return 0; }
  17221. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17222. auto count = sk_X509_OBJECT_num(objs);
  17223. for (decltype(count) i = 0; i < count; i++) {
  17224. auto obj = sk_X509_OBJECT_value(objs, i);
  17225. if (!obj) { continue; }
  17226. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17227. auto x509 = X509_OBJECT_get0_X509(obj);
  17228. if (x509) {
  17229. // Increment reference count so caller can free it
  17230. X509_up_ref(x509);
  17231. certs.push_back(static_cast<cert_t>(x509));
  17232. }
  17233. }
  17234. }
  17235. return certs.size();
  17236. }
  17237. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17238. std::vector<std::string> names;
  17239. if (!ctx) { return names; }
  17240. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17241. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17242. if (!store) { return names; }
  17243. auto objs = impl::get_store_objects(store);
  17244. if (!objs) { return names; }
  17245. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17246. auto count = sk_X509_OBJECT_num(objs);
  17247. for (decltype(count) i = 0; i < count; i++) {
  17248. auto obj = sk_X509_OBJECT_value(objs, i);
  17249. if (!obj) { continue; }
  17250. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17251. auto x509 = X509_OBJECT_get0_X509(obj);
  17252. if (x509) {
  17253. auto subject = X509_get_subject_name(x509);
  17254. if (subject) {
  17255. char buf[512];
  17256. X509_NAME_oneline(subject, buf, sizeof(buf));
  17257. names.push_back(buf);
  17258. }
  17259. }
  17260. }
  17261. }
  17262. return names;
  17263. }
  17264. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17265. const char *key_pem, const char *password) {
  17266. if (!ctx || !cert_pem || !key_pem) { return false; }
  17267. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17268. // Load certificate from PEM
  17269. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17270. if (!cert_bio) { return false; }
  17271. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17272. BIO_free(cert_bio);
  17273. if (!cert) { return false; }
  17274. // Load private key from PEM
  17275. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17276. if (!key_bio) {
  17277. X509_free(cert);
  17278. return false;
  17279. }
  17280. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17281. password ? const_cast<char *>(password)
  17282. : nullptr);
  17283. BIO_free(key_bio);
  17284. if (!key) {
  17285. X509_free(cert);
  17286. return false;
  17287. }
  17288. // Update certificate and key
  17289. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17290. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17291. X509_free(cert);
  17292. EVP_PKEY_free(key);
  17293. return ret;
  17294. }
  17295. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17296. if (!ctx || !ca_pem) { return false; }
  17297. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17298. // Create new X509_STORE from PEM
  17299. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17300. if (!store) { return false; }
  17301. // SSL_CTX_set_cert_store takes ownership
  17302. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17303. // Set client CA list for client certificate request
  17304. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17305. if (ca_list) {
  17306. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17307. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17308. }
  17309. return true;
  17310. }
  17311. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17312. if (!ctx) { return false; }
  17313. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17314. auto index = impl::verify_callback_index();
  17315. if (index < 0) { return false; }
  17316. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17317. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17318. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17319. if (stored) {
  17320. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17321. } else {
  17322. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17323. }
  17324. return true;
  17325. }
  17326. inline long get_verify_error(const_session_t session) {
  17327. if (!session) { return -1; }
  17328. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17329. return SSL_get_verify_result(ssl);
  17330. }
  17331. inline std::string verify_error_string(long error_code) {
  17332. if (error_code == X509_V_OK) { return ""; }
  17333. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17334. return str ? str : "unknown error";
  17335. }
  17336. } // namespace tls
  17337. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17338. /*
  17339. * Group 9: TLS abstraction layer - Mbed TLS backend
  17340. */
  17341. /*
  17342. * Mbed TLS Backend Implementation
  17343. */
  17344. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17345. namespace tls {
  17346. namespace impl {
  17347. // Mbed TLS session wrapper
  17348. struct MbedTlsSession {
  17349. mbedtls_ssl_context ssl;
  17350. socket_t sock = INVALID_SOCKET;
  17351. std::string hostname; // For client: set via set_sni
  17352. std::string sni_hostname; // For server: received from client via SNI callback
  17353. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17354. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17355. // (e.g. a response that arrived while this side was still in its post-write
  17356. // check), the byte is pushed back here and served by the next read().
  17357. unsigned char peeked_byte = 0;
  17358. bool has_peeked_byte = false;
  17359. // Set by set_sni() when the caller disabled hostname verification, so the
  17360. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17361. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17362. // OpenSSL and wolfSSL keep them independent).
  17363. bool suppress_hostname_mismatch = false;
  17364. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17365. // ever runs the callback of its own context.
  17366. VerifyCallback verify_callback;
  17367. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17368. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17369. MbedTlsSession(const MbedTlsSession &) = delete;
  17370. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17371. };
  17372. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17373. // queue)
  17374. inline int &mbedtls_last_error() {
  17375. static thread_local int err = 0;
  17376. return err;
  17377. }
  17378. // Helper to map Mbed TLS error to ErrorCode
  17379. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17380. uint32_t verify_flags) {
  17381. if (ret == 0) { return ErrorCode::Success; }
  17382. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17383. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17384. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17385. return ErrorCode::PeerClosed;
  17386. }
  17387. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17388. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17389. out_errno = errno;
  17390. return ErrorCode::SyscallError;
  17391. }
  17392. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17393. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17394. // the handshake's chain verification (see set_sni()); a mismatch there
  17395. // is reported the same way as any other verify_flags bit. Report it as
  17396. // HostnameMismatch, matching the other backends and the post-handshake
  17397. // identity check below, but only when naming is the sole problem -
  17398. // if the chain itself is also untrusted/expired/etc., that takes
  17399. // priority over the naming detail.
  17400. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17401. return ErrorCode::HostnameMismatch;
  17402. }
  17403. return ErrorCode::CertVerifyFailed;
  17404. }
  17405. return ErrorCode::Fatal;
  17406. }
  17407. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17408. // return value, including the verify-flags-dependent HostnameMismatch
  17409. // mapping; shared by connect() and connect_nonblocking() so the
  17410. // backend_code policy for that mapping only lives in one place.
  17411. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17412. int ret) {
  17413. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17414. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17415. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17416. ? static_cast<uint64_t>(verify_flags)
  17417. : static_cast<uint64_t>(-ret);
  17418. }
  17419. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17420. // non-fatal notification delivered between records, not an error and not
  17421. // application data, so I/O calls that see it should just be retried. Kept in
  17422. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17423. // splitting the closing brace across an #if.
  17424. inline bool mbedtls_is_session_ticket(int ret) {
  17425. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17426. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17427. #else
  17428. (void)ret;
  17429. return false;
  17430. #endif
  17431. }
  17432. // BIO-like send callback for Mbed TLS
  17433. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17434. size_t len) {
  17435. auto sock = *static_cast<socket_t *>(ctx);
  17436. #ifdef _WIN32
  17437. auto ret =
  17438. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17439. if (ret == SOCKET_ERROR) {
  17440. int err = WSAGetLastError();
  17441. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17442. return MBEDTLS_ERR_NET_SEND_FAILED;
  17443. }
  17444. #else
  17445. auto ret = send(sock, buf, len, 0);
  17446. if (ret < 0) {
  17447. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17448. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17449. }
  17450. return MBEDTLS_ERR_NET_SEND_FAILED;
  17451. }
  17452. #endif
  17453. return static_cast<int>(ret);
  17454. }
  17455. // BIO-like recv callback for Mbed TLS
  17456. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17457. auto sock = *static_cast<socket_t *>(ctx);
  17458. #ifdef _WIN32
  17459. auto ret =
  17460. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17461. if (ret == SOCKET_ERROR) {
  17462. int err = WSAGetLastError();
  17463. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17464. return MBEDTLS_ERR_NET_RECV_FAILED;
  17465. }
  17466. #else
  17467. auto ret = recv(sock, buf, len, 0);
  17468. if (ret < 0) {
  17469. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17470. return MBEDTLS_ERR_SSL_WANT_READ;
  17471. }
  17472. return MBEDTLS_ERR_NET_RECV_FAILED;
  17473. }
  17474. #endif
  17475. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17476. return static_cast<int>(ret);
  17477. }
  17478. // MbedTlsContext constructor/destructor implementations
  17479. inline MbedTlsContext::MbedTlsContext() {
  17480. mbedtls_ssl_config_init(&conf);
  17481. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17482. mbedtls_entropy_init(&entropy);
  17483. mbedtls_ctr_drbg_init(&ctr_drbg);
  17484. #endif
  17485. mbedtls_x509_crt_init(&ca_chain);
  17486. mbedtls_x509_crt_init(&own_cert);
  17487. mbedtls_pk_init(&own_key);
  17488. }
  17489. inline MbedTlsContext::~MbedTlsContext() {
  17490. mbedtls_pk_free(&own_key);
  17491. mbedtls_x509_crt_free(&own_cert);
  17492. mbedtls_x509_crt_free(&ca_chain);
  17493. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17494. mbedtls_ctr_drbg_free(&ctr_drbg);
  17495. mbedtls_entropy_free(&entropy);
  17496. #endif
  17497. mbedtls_ssl_config_free(&conf);
  17498. }
  17499. // Thread-local storage for SNI captured during handshake
  17500. // This is needed because the SNI callback doesn't have a way to pass
  17501. // session-specific data before the session is fully set up
  17502. inline std::string &mbedpending_sni() {
  17503. static thread_local std::string sni;
  17504. return sni;
  17505. }
  17506. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17507. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17508. const unsigned char *name, size_t name_len) {
  17509. (void)p_ctx;
  17510. (void)ssl;
  17511. // Store SNI name in thread-local storage
  17512. // It will be retrieved and stored in the session after handshake
  17513. if (name && name_len > 0) {
  17514. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17515. } else {
  17516. mbedpending_sni().clear();
  17517. }
  17518. return 0; // Accept any SNI
  17519. }
  17520. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17521. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17522. }
  17523. // Verify callback used when hostname verification is disabled for a session
  17524. // that has no user-supplied verify callback of its own.
  17525. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17526. mbedtls_x509_crt *, int,
  17527. uint32_t *flags) {
  17528. (void)data;
  17529. mbedtls_clear_cn_mismatch(flags);
  17530. return 0;
  17531. }
  17532. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17533. int cert_depth, uint32_t *flags);
  17534. // MbedTLS verify callback wrapper
  17535. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17536. int cert_depth, uint32_t *flags) {
  17537. // data points to the MbedTlsSession
  17538. auto *session = static_cast<MbedTlsSession *>(data);
  17539. // set_sni() disabled hostname verification for this session: drop the
  17540. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17541. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17542. // SNI. The final pass/fail decision still comes from the remaining flags
  17543. // (or, below, from the user's own verify callback).
  17544. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17545. // Build context
  17546. VerifyContext verify_ctx;
  17547. verify_ctx.session = static_cast<session_t>(session);
  17548. verify_ctx.cert = static_cast<cert_t>(crt);
  17549. verify_ctx.depth = cert_depth;
  17550. verify_ctx.preverify_ok = (*flags == 0);
  17551. verify_ctx.error_code = static_cast<long>(*flags);
  17552. // Convert Mbed TLS flags to error string
  17553. static thread_local char error_buf[256];
  17554. if (*flags != 0) {
  17555. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17556. verify_ctx.error_string = error_buf;
  17557. } else {
  17558. verify_ctx.error_string = nullptr;
  17559. }
  17560. bool accepted = session->verify_callback(verify_ctx);
  17561. if (accepted) {
  17562. *flags = 0; // Clear all error flags
  17563. return 0;
  17564. }
  17565. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17566. }
  17567. } // namespace impl
  17568. inline ctx_t create_client_context() {
  17569. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17570. if (!ctx) { return nullptr; }
  17571. ctx->is_server = false;
  17572. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17573. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17574. if (!detail::ensure_mbedtls_psa_crypto()) {
  17575. delete ctx;
  17576. return nullptr;
  17577. }
  17578. int ret;
  17579. #else
  17580. // Seed the random number generator
  17581. const char *pers = "httplib_client";
  17582. int ret = mbedtls_ctr_drbg_seed(
  17583. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17584. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17585. if (ret != 0) {
  17586. impl::mbedtls_last_error() = ret;
  17587. delete ctx;
  17588. return nullptr;
  17589. }
  17590. #endif
  17591. // Set up SSL config for client
  17592. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17593. MBEDTLS_SSL_TRANSPORT_STREAM,
  17594. MBEDTLS_SSL_PRESET_DEFAULT);
  17595. if (ret != 0) {
  17596. impl::mbedtls_last_error() = ret;
  17597. delete ctx;
  17598. return nullptr;
  17599. }
  17600. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17601. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17602. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17603. #endif
  17604. // Default: verify peer certificate
  17605. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17606. // Set minimum TLS version to 1.2
  17607. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17608. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17609. #else
  17610. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17611. MBEDTLS_SSL_MINOR_VERSION_3);
  17612. #endif
  17613. return static_cast<ctx_t>(ctx);
  17614. }
  17615. inline ctx_t create_server_context() {
  17616. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17617. if (!ctx) { return nullptr; }
  17618. ctx->is_server = true;
  17619. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17620. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17621. if (!detail::ensure_mbedtls_psa_crypto()) {
  17622. delete ctx;
  17623. return nullptr;
  17624. }
  17625. int ret;
  17626. #else
  17627. // Seed the random number generator
  17628. const char *pers = "httplib_server";
  17629. int ret = mbedtls_ctr_drbg_seed(
  17630. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17631. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17632. if (ret != 0) {
  17633. impl::mbedtls_last_error() = ret;
  17634. delete ctx;
  17635. return nullptr;
  17636. }
  17637. #endif
  17638. // Set up SSL config for server
  17639. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17640. MBEDTLS_SSL_TRANSPORT_STREAM,
  17641. MBEDTLS_SSL_PRESET_DEFAULT);
  17642. if (ret != 0) {
  17643. impl::mbedtls_last_error() = ret;
  17644. delete ctx;
  17645. return nullptr;
  17646. }
  17647. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17648. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17649. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17650. #endif
  17651. // Default: don't verify client
  17652. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17653. // Set minimum TLS version to 1.2
  17654. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17655. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17656. #else
  17657. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17658. MBEDTLS_SSL_MINOR_VERSION_3);
  17659. #endif
  17660. // Set SNI callback to capture client's SNI hostname
  17661. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17662. return static_cast<ctx_t>(ctx);
  17663. }
  17664. inline void free_context(ctx_t ctx) {
  17665. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17666. }
  17667. inline bool set_min_version(ctx_t ctx, Version version) {
  17668. if (!ctx) { return false; }
  17669. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17670. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17671. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17672. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17673. if (version >= Version::TLS1_3) {
  17674. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17675. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17676. #endif
  17677. }
  17678. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17679. #else
  17680. // Mbed TLS 2.x uses major/minor version numbers
  17681. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17682. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17683. if (version >= Version::TLS1_3) {
  17684. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17685. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17686. #else
  17687. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17688. #endif
  17689. }
  17690. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17691. #endif
  17692. return true;
  17693. }
  17694. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17695. if (!ctx || !pem) { return false; }
  17696. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17697. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17698. // Add null terminator if not present
  17699. std::string pem_str(pem, len);
  17700. int ret = mbedtls_x509_crt_parse(
  17701. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17702. pem_str.size() + 1);
  17703. if (ret != 0) {
  17704. impl::mbedtls_last_error() = ret;
  17705. return false;
  17706. }
  17707. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17708. return true;
  17709. }
  17710. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17711. if (!ctx || !file_path) { return false; }
  17712. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17713. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17714. if (ret != 0) {
  17715. impl::mbedtls_last_error() = ret;
  17716. return false;
  17717. }
  17718. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17719. return true;
  17720. }
  17721. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17722. if (!ctx || !dir_path) { return false; }
  17723. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17724. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17725. if (ret < 0) { // Returns number of certs on success, negative on error
  17726. impl::mbedtls_last_error() = ret;
  17727. return false;
  17728. }
  17729. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17730. return true;
  17731. }
  17732. inline bool load_system_certs(ctx_t ctx) {
  17733. if (!ctx) { return false; }
  17734. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17735. bool loaded = false;
  17736. #ifdef _WIN32
  17737. loaded = impl::enumerate_windows_system_certs(
  17738. [&](const unsigned char *data, size_t len) {
  17739. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17740. });
  17741. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17742. loaded = impl::enumerate_macos_keychain_certs(
  17743. [&](const unsigned char *data, size_t len) {
  17744. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17745. });
  17746. #else
  17747. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17748. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17749. loaded = true;
  17750. break;
  17751. }
  17752. }
  17753. if (!loaded) {
  17754. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17755. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17756. loaded = true;
  17757. break;
  17758. }
  17759. }
  17760. }
  17761. #endif
  17762. if (loaded) {
  17763. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17764. }
  17765. return loaded;
  17766. }
  17767. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17768. const char *password) {
  17769. if (!ctx || !cert || !key) { return false; }
  17770. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17771. // Parse certificate
  17772. std::string cert_str(cert);
  17773. int ret = mbedtls_x509_crt_parse(
  17774. &mctx->own_cert,
  17775. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17776. cert_str.size() + 1);
  17777. if (ret != 0) {
  17778. impl::mbedtls_last_error() = ret;
  17779. return false;
  17780. }
  17781. // Parse private key
  17782. std::string key_str(key);
  17783. const unsigned char *pwd =
  17784. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17785. size_t pwd_len = password ? strlen(password) : 0;
  17786. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17787. ret = mbedtls_pk_parse_key(
  17788. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17789. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17790. &mctx->ctr_drbg);
  17791. #else
  17792. ret = mbedtls_pk_parse_key(
  17793. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17794. key_str.size() + 1, pwd, pwd_len);
  17795. #endif
  17796. if (ret != 0) {
  17797. impl::mbedtls_last_error() = ret;
  17798. return false;
  17799. }
  17800. // Verify that the certificate and private key match.
  17801. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17802. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17803. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17804. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17805. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17806. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17807. #else
  17808. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17809. #endif
  17810. if (ret != 0) {
  17811. impl::mbedtls_last_error() = ret;
  17812. return false;
  17813. }
  17814. #endif
  17815. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17816. if (ret != 0) {
  17817. impl::mbedtls_last_error() = ret;
  17818. return false;
  17819. }
  17820. return true;
  17821. }
  17822. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17823. const char *key_path, const char *password) {
  17824. if (!ctx || !cert_path || !key_path) { return false; }
  17825. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17826. // Parse certificate file
  17827. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17828. if (ret != 0) {
  17829. impl::mbedtls_last_error() = ret;
  17830. return false;
  17831. }
  17832. // Parse private key file
  17833. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17834. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17835. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17836. #else
  17837. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17838. #endif
  17839. if (ret != 0) {
  17840. impl::mbedtls_last_error() = ret;
  17841. return false;
  17842. }
  17843. // Verify that the certificate and private key match.
  17844. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17845. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17846. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17847. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17848. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17849. #else
  17850. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17851. #endif
  17852. if (ret != 0) {
  17853. impl::mbedtls_last_error() = ret;
  17854. return false;
  17855. }
  17856. #endif
  17857. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17858. if (ret != 0) {
  17859. impl::mbedtls_last_error() = ret;
  17860. return false;
  17861. }
  17862. return true;
  17863. }
  17864. inline void set_verify_client(ctx_t ctx, bool require) {
  17865. if (!ctx) { return; }
  17866. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17867. mctx->verify_client = require;
  17868. if (require) {
  17869. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17870. } else {
  17871. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17872. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17873. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17874. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17875. : MBEDTLS_SSL_VERIFY_NONE);
  17876. }
  17877. }
  17878. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17879. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17880. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17881. auto session = new (std::nothrow) impl::MbedTlsSession();
  17882. if (!session) { return nullptr; }
  17883. session->sock = sock;
  17884. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17885. if (ret != 0) {
  17886. impl::mbedtls_last_error() = ret;
  17887. delete session;
  17888. return nullptr;
  17889. }
  17890. // Explicitly opt out of in-handshake hostname verification by default;
  17891. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17892. // fails outright when no hostname was set. set_sni() installs the real
  17893. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17894. // caller verifies the certificate identity post-handshake via
  17895. // verify_hostname().
  17896. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17897. // Set BIO callbacks
  17898. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17899. impl::mbedtls_net_recv_cb, nullptr);
  17900. // Set per-session verify callback with session pointer if callback is
  17901. // registered
  17902. session->verify_callback = mctx->verify_callback;
  17903. if (session->verify_callback) {
  17904. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17905. session);
  17906. }
  17907. return static_cast<session_t>(session);
  17908. }
  17909. inline void free_session(session_t session) {
  17910. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17911. }
  17912. inline bool set_sni(session_t session, const char *hostname,
  17913. bool verify_hostname) {
  17914. if (!session || !hostname) { return false; }
  17915. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17916. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17917. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17918. // independently, so a disabled hostname check is handled below by masking
  17919. // the resulting mismatch flag instead of skipping this call.
  17920. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17921. if (ret != 0) {
  17922. impl::mbedtls_last_error() = ret;
  17923. return false;
  17924. }
  17925. msession->hostname = hostname;
  17926. if (!verify_hostname) {
  17927. msession->suppress_hostname_mismatch = true;
  17928. // If a user verify callback is already wired for this session,
  17929. // mbedtls_verify_callback() masks the mismatch flag itself before
  17930. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17931. // here would be redundant. Otherwise install the masking callback alone.
  17932. if (!msession->verify_callback) {
  17933. mbedtls_ssl_set_verify(&msession->ssl,
  17934. impl::mbedtls_mask_hostname_mismatch_callback,
  17935. msession);
  17936. }
  17937. }
  17938. return true;
  17939. }
  17940. inline TlsError connect(session_t session) {
  17941. TlsError err;
  17942. if (!session) {
  17943. err.code = ErrorCode::Fatal;
  17944. return err;
  17945. }
  17946. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17947. int ret;
  17948. do {
  17949. ret = mbedtls_ssl_handshake(&msession->ssl);
  17950. } while (impl::mbedtls_is_session_ticket(ret));
  17951. if (ret == 0) {
  17952. err.code = ErrorCode::Success;
  17953. } else {
  17954. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17955. impl::mbedtls_last_error() = ret;
  17956. }
  17957. return err;
  17958. }
  17959. inline TlsError accept(session_t session) {
  17960. // Same as connect for Mbed TLS - handshake works for both client and server
  17961. auto result = connect(session);
  17962. // After successful handshake, capture SNI from thread-local storage
  17963. if (result.code == ErrorCode::Success && session) {
  17964. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17965. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17966. impl::mbedpending_sni().clear();
  17967. }
  17968. return result;
  17969. }
  17970. inline bool connect_nonblocking(session_t session, socket_t sock,
  17971. time_t timeout_sec, time_t timeout_usec,
  17972. TlsError *err) {
  17973. if (!session) {
  17974. if (err) { err->code = ErrorCode::Fatal; }
  17975. return false;
  17976. }
  17977. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17978. // Set socket to non-blocking mode
  17979. detail::set_nonblocking(sock, true);
  17980. auto cleanup =
  17981. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17982. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17983. int ret;
  17984. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17985. // Non-fatal TLS 1.3 ticket; retry immediately.
  17986. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17987. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17988. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17989. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17990. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17991. }
  17992. // TlsError or timeout
  17993. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17994. impl::mbedtls_last_error() = ret;
  17995. return false;
  17996. }
  17997. if (err) { err->code = ErrorCode::Success; }
  17998. return true;
  17999. }
  18000. inline bool accept_nonblocking(session_t session, socket_t sock,
  18001. time_t timeout_sec, time_t timeout_usec,
  18002. TlsError *err) {
  18003. // Same implementation as connect for Mbed TLS
  18004. bool result =
  18005. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18006. // After successful handshake, capture SNI from thread-local storage
  18007. if (result && session) {
  18008. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18009. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18010. impl::mbedpending_sni().clear();
  18011. }
  18012. return result;
  18013. }
  18014. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18015. if (!session || !buf) {
  18016. err.code = ErrorCode::Fatal;
  18017. return -1;
  18018. }
  18019. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18020. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18021. if (msession->has_peeked_byte) {
  18022. if (len == 0) { return 0; }
  18023. auto p = static_cast<unsigned char *>(buf);
  18024. p[0] = msession->peeked_byte;
  18025. msession->has_peeked_byte = false;
  18026. size_t n = 1;
  18027. // Top up with any already-decrypted bytes without risking a block.
  18028. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18029. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18030. if (extra > 0) { n += static_cast<size_t>(extra); }
  18031. }
  18032. err.code = ErrorCode::Success;
  18033. return static_cast<ssize_t>(n);
  18034. }
  18035. int ret;
  18036. do {
  18037. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18038. len);
  18039. } while (impl::mbedtls_is_session_ticket(ret));
  18040. if (ret > 0) {
  18041. err.code = ErrorCode::Success;
  18042. return static_cast<ssize_t>(ret);
  18043. }
  18044. if (ret == 0) {
  18045. err.code = ErrorCode::PeerClosed;
  18046. return 0;
  18047. }
  18048. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18049. err.backend_code = static_cast<uint64_t>(-ret);
  18050. impl::mbedtls_last_error() = ret;
  18051. // mbedTLS signals a clean close_notify via a negative error code rather
  18052. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18053. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18054. return -1;
  18055. }
  18056. inline ssize_t write(session_t session, const void *buf, size_t len,
  18057. TlsError &err) {
  18058. if (!session || !buf) {
  18059. err.code = ErrorCode::Fatal;
  18060. return -1;
  18061. }
  18062. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18063. int ret;
  18064. do {
  18065. ret = mbedtls_ssl_write(&msession->ssl,
  18066. static_cast<const unsigned char *>(buf), len);
  18067. } while (impl::mbedtls_is_session_ticket(ret));
  18068. if (ret > 0) {
  18069. err.code = ErrorCode::Success;
  18070. return static_cast<ssize_t>(ret);
  18071. }
  18072. if (ret == 0) {
  18073. err.code = ErrorCode::PeerClosed;
  18074. return 0;
  18075. }
  18076. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18077. err.backend_code = static_cast<uint64_t>(-ret);
  18078. impl::mbedtls_last_error() = ret;
  18079. return -1;
  18080. }
  18081. inline int pending(const_session_t session) {
  18082. if (!session) { return 0; }
  18083. auto msession =
  18084. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18085. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18086. (msession->has_peeked_byte ? 1 : 0);
  18087. }
  18088. inline void shutdown(session_t session, bool graceful) {
  18089. if (!session) { return; }
  18090. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18091. if (graceful) {
  18092. // Try to send close_notify, but don't block forever
  18093. int ret;
  18094. int attempts = 0;
  18095. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18096. attempts < 3) {
  18097. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18098. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18099. break;
  18100. }
  18101. attempts++;
  18102. }
  18103. }
  18104. }
  18105. inline bool is_peer_closed(session_t session, socket_t sock) {
  18106. if (!session || sock == INVALID_SOCKET) { return true; }
  18107. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18108. // Check if there's already decrypted or pushed-back data available.
  18109. // If so, the connection is definitely alive.
  18110. if (msession->has_peeked_byte ||
  18111. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18112. return false;
  18113. }
  18114. // Set socket to non-blocking to avoid blocking on read
  18115. detail::set_nonblocking(sock, true);
  18116. auto cleanup =
  18117. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18118. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18119. // on application data — e.g. a response that already arrived — push the
  18120. // byte back so the next read() delivers it instead of losing it.
  18121. unsigned char buf;
  18122. int ret;
  18123. do {
  18124. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18125. } while (impl::mbedtls_is_session_ticket(ret));
  18126. // If we got data or WANT_READ (would block), connection is alive
  18127. if (ret > 0) {
  18128. msession->peeked_byte = buf;
  18129. msession->has_peeked_byte = true;
  18130. return false;
  18131. }
  18132. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18133. // If we get a peer close notify or a connection reset, the peer is closed
  18134. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18135. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18136. }
  18137. inline cert_t get_peer_cert(const_session_t session) {
  18138. if (!session) { return nullptr; }
  18139. auto msession =
  18140. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18141. // Mbed TLS returns a pointer to the internal peer cert chain.
  18142. // WARNING: This pointer is only valid while the session is active.
  18143. // Do not use the certificate after calling free_session().
  18144. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18145. return const_cast<mbedtls_x509_crt *>(cert);
  18146. }
  18147. inline size_t get_peer_certs(const_session_t session,
  18148. std::vector<cert_t> &certs) {
  18149. certs.clear();
  18150. // Mbed TLS parses the whole received chain into a list headed by the peer
  18151. // certificate, owned by the session like get_peer_cert()'s result
  18152. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18153. crt && crt->raw.len > 0; crt = crt->next) {
  18154. certs.push_back(static_cast<cert_t>(crt));
  18155. }
  18156. return certs.size();
  18157. }
  18158. inline void free_cert(cert_t cert) {
  18159. // Mbed TLS: peer certificate is owned by the SSL context.
  18160. // No-op here, but callers should still call this for cross-backend
  18161. // portability.
  18162. (void)cert;
  18163. }
  18164. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18165. if (!cert || !hostname) { return false; }
  18166. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18167. std::string host_str(hostname);
  18168. // Check if hostname is an IP address (IPv4 or IPv6)
  18169. unsigned char ip_bytes[16];
  18170. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18171. auto is_ip = ip_len > 0;
  18172. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18173. // in buf.tag and the raw value in buf.p / buf.len.
  18174. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18175. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18176. const unsigned char *p = san->buf.p;
  18177. size_t len = san->buf.len;
  18178. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18179. if (is_ip) {
  18180. // For an IP host, only a matching iPAddress SAN of the same family
  18181. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18182. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18183. memcmp(p, ip_bytes, ip_len) == 0) {
  18184. return true;
  18185. }
  18186. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18187. std::string san_name(reinterpret_cast<const char *>(p), len);
  18188. if (detail::match_hostname(san_name, host_str)) { return true; }
  18189. }
  18190. san = san->next;
  18191. }
  18192. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18193. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18194. // the OpenSSL backend's X509_check_ip behaves the same way).
  18195. if (!is_ip) {
  18196. char cn[256];
  18197. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18198. if (ret > 0) {
  18199. std::string cn_str(cn);
  18200. // Look for "CN=" in the DN string
  18201. size_t cn_pos = cn_str.find("CN=");
  18202. if (cn_pos != std::string::npos) {
  18203. size_t start = cn_pos + 3;
  18204. size_t end = cn_str.find(',', start);
  18205. std::string cn_value =
  18206. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18207. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18208. }
  18209. }
  18210. }
  18211. return false;
  18212. }
  18213. inline uint64_t hostname_mismatch_code() {
  18214. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18215. }
  18216. inline long get_verify_result(const_session_t session) {
  18217. if (!session) { return -1; }
  18218. auto msession =
  18219. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18220. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18221. // Return 0 (X509_V_OK equivalent) if verification passed
  18222. return flags == 0 ? 0 : static_cast<long>(flags);
  18223. }
  18224. inline std::string get_cert_subject_cn(cert_t cert) {
  18225. if (!cert) return "";
  18226. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18227. // Find the CN in the subject
  18228. const mbedtls_x509_name *name = &x509->subject;
  18229. while (name != nullptr) {
  18230. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18231. return std::string(reinterpret_cast<const char *>(name->val.p),
  18232. name->val.len);
  18233. }
  18234. name = name->next;
  18235. }
  18236. return "";
  18237. }
  18238. inline std::string get_cert_issuer_name(cert_t cert) {
  18239. if (!cert) return "";
  18240. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18241. // Build a human-readable issuer name string
  18242. char buf[512];
  18243. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18244. if (ret < 0) return "";
  18245. return std::string(buf);
  18246. }
  18247. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18248. sans.clear();
  18249. if (!cert) return false;
  18250. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18251. // Parse the Subject Alternative Name extension
  18252. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18253. while (cur != nullptr) {
  18254. if (cur->buf.len > 0) {
  18255. const unsigned char *p = cur->buf.p;
  18256. size_t value_len = cur->buf.len;
  18257. SanEntry entry;
  18258. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18259. case MBEDTLS_X509_SAN_DNS_NAME:
  18260. entry.type = SanType::DNS;
  18261. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18262. break;
  18263. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18264. entry.type = SanType::IP;
  18265. if (value_len == 4) {
  18266. // IPv4
  18267. char buf[16];
  18268. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18269. entry.value = buf;
  18270. } else if (value_len == 16) {
  18271. // IPv6
  18272. char buf[64];
  18273. snprintf(buf, sizeof(buf),
  18274. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18275. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18276. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18277. p[10], p[11], p[12], p[13], p[14], p[15]);
  18278. entry.value = buf;
  18279. }
  18280. break;
  18281. case MBEDTLS_X509_SAN_RFC822_NAME:
  18282. entry.type = SanType::EMAIL;
  18283. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18284. break;
  18285. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18286. entry.type = SanType::URI;
  18287. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18288. break;
  18289. default: entry.type = SanType::OTHER; break;
  18290. }
  18291. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18292. }
  18293. cur = cur->next;
  18294. }
  18295. return true;
  18296. }
  18297. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18298. time_t &not_after) {
  18299. if (!cert) return false;
  18300. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18301. // Convert mbedtls_x509_time to time_t
  18302. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18303. struct tm tm_time = {};
  18304. tm_time.tm_year = t.year - 1900;
  18305. tm_time.tm_mon = t.mon - 1;
  18306. tm_time.tm_mday = t.day;
  18307. tm_time.tm_hour = t.hour;
  18308. tm_time.tm_min = t.min;
  18309. tm_time.tm_sec = t.sec;
  18310. #ifdef _WIN32
  18311. return _mkgmtime(&tm_time);
  18312. #else
  18313. return timegm(&tm_time);
  18314. #endif
  18315. };
  18316. not_before = to_time_t(x509->valid_from);
  18317. not_after = to_time_t(x509->valid_to);
  18318. return true;
  18319. }
  18320. inline std::string get_cert_serial(cert_t cert) {
  18321. if (!cert) return "";
  18322. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18323. // Convert serial number to hex string
  18324. std::string result;
  18325. result.reserve(x509->serial.len * 2);
  18326. for (size_t i = 0; i < x509->serial.len; i++) {
  18327. char hex[3];
  18328. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18329. result += hex;
  18330. }
  18331. return result;
  18332. }
  18333. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18334. if (!cert) return false;
  18335. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18336. if (!crt->raw.p || crt->raw.len == 0) return false;
  18337. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18338. return true;
  18339. }
  18340. inline const char *get_sni(const_session_t session) {
  18341. if (!session) return nullptr;
  18342. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18343. // For server: return SNI received from client during handshake
  18344. if (!msession->sni_hostname.empty()) {
  18345. return msession->sni_hostname.c_str();
  18346. }
  18347. // For client: return the hostname set via set_sni
  18348. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18349. return nullptr;
  18350. }
  18351. inline uint64_t peek_error() {
  18352. // Mbed TLS doesn't have an error queue, return the last error
  18353. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18354. }
  18355. inline uint64_t get_error() {
  18356. // Mbed TLS doesn't have an error queue, return and clear the last error
  18357. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18358. impl::mbedtls_last_error() = 0;
  18359. return err;
  18360. }
  18361. inline std::string error_string(uint64_t code) {
  18362. char buf[256];
  18363. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18364. return std::string(buf);
  18365. }
  18366. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18367. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18368. if (!ca_chain) { return nullptr; }
  18369. mbedtls_x509_crt_init(ca_chain);
  18370. // mbedtls_x509_crt_parse expects null-terminated PEM
  18371. int ret = mbedtls_x509_crt_parse(ca_chain,
  18372. reinterpret_cast<const unsigned char *>(pem),
  18373. len + 1); // +1 for null terminator
  18374. if (ret != 0) {
  18375. // Try without +1 in case PEM is already null-terminated
  18376. ret = mbedtls_x509_crt_parse(
  18377. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18378. if (ret != 0) {
  18379. mbedtls_x509_crt_free(ca_chain);
  18380. delete ca_chain;
  18381. return nullptr;
  18382. }
  18383. }
  18384. return static_cast<ca_store_t>(ca_chain);
  18385. }
  18386. inline void free_ca_store(ca_store_t store) {
  18387. if (store) {
  18388. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18389. mbedtls_x509_crt_free(ca_chain);
  18390. delete ca_chain;
  18391. }
  18392. }
  18393. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18394. if (!ctx || !store) { return false; }
  18395. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18396. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18397. // Free existing CA chain
  18398. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18399. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18400. // Copy the CA chain (deep copy)
  18401. // Parse from the raw data of the source cert
  18402. mbedtls_x509_crt *src = ca_chain;
  18403. while (src != nullptr) {
  18404. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18405. src->raw.len);
  18406. if (ret != 0) {
  18407. free_ca_store(store);
  18408. return false;
  18409. }
  18410. src = src->next;
  18411. }
  18412. // This function takes ownership of the store; the chain was deep-copied
  18413. // above, so release the source
  18414. free_ca_store(store);
  18415. // Update the SSL config to use the new CA chain
  18416. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18417. return true;
  18418. }
  18419. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18420. certs.clear();
  18421. if (!ctx) { return 0; }
  18422. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18423. // Iterate through the CA chain
  18424. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18425. while (cert != nullptr && cert->raw.len > 0) {
  18426. // Create a copy of the certificate for the caller
  18427. auto *copy = new mbedtls_x509_crt;
  18428. mbedtls_x509_crt_init(copy);
  18429. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18430. if (ret == 0) {
  18431. certs.push_back(static_cast<cert_t>(copy));
  18432. } else {
  18433. mbedtls_x509_crt_free(copy);
  18434. delete copy;
  18435. }
  18436. cert = cert->next;
  18437. }
  18438. return certs.size();
  18439. }
  18440. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18441. std::vector<std::string> names;
  18442. if (!ctx) { return names; }
  18443. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18444. // Iterate through the CA chain
  18445. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18446. while (cert != nullptr && cert->raw.len > 0) {
  18447. char buf[512];
  18448. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18449. if (ret > 0) { names.push_back(buf); }
  18450. cert = cert->next;
  18451. }
  18452. return names;
  18453. }
  18454. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18455. const char *key_pem, const char *password) {
  18456. if (!ctx || !cert_pem || !key_pem) { return false; }
  18457. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18458. // Free existing certificate and key
  18459. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18460. mbedtls_pk_free(&mbed_ctx->own_key);
  18461. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18462. mbedtls_pk_init(&mbed_ctx->own_key);
  18463. // Parse certificate PEM
  18464. int ret = mbedtls_x509_crt_parse(
  18465. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18466. strlen(cert_pem) + 1);
  18467. if (ret != 0) {
  18468. impl::mbedtls_last_error() = ret;
  18469. return false;
  18470. }
  18471. // Parse private key PEM
  18472. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18473. ret = mbedtls_pk_parse_key(
  18474. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18475. strlen(key_pem) + 1,
  18476. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18477. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18478. &mbed_ctx->ctr_drbg);
  18479. #else
  18480. ret = mbedtls_pk_parse_key(
  18481. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18482. strlen(key_pem) + 1,
  18483. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18484. password ? strlen(password) : 0);
  18485. #endif
  18486. if (ret != 0) {
  18487. impl::mbedtls_last_error() = ret;
  18488. return false;
  18489. }
  18490. // Configure SSL to use the new certificate and key
  18491. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18492. &mbed_ctx->own_key);
  18493. if (ret != 0) {
  18494. impl::mbedtls_last_error() = ret;
  18495. return false;
  18496. }
  18497. return true;
  18498. }
  18499. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18500. if (!ctx || !ca_pem) { return false; }
  18501. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18502. // Free existing CA chain
  18503. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18504. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18505. // Parse CA PEM
  18506. int ret = mbedtls_x509_crt_parse(
  18507. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18508. strlen(ca_pem) + 1);
  18509. if (ret != 0) {
  18510. impl::mbedtls_last_error() = ret;
  18511. return false;
  18512. }
  18513. // Update SSL config to use new CA chain
  18514. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18515. return true;
  18516. }
  18517. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18518. if (!ctx) { return false; }
  18519. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18520. // create_session() hands each session its own copy to run.
  18521. mbed_ctx->verify_callback = std::move(callback);
  18522. if (mbed_ctx->verify_callback) {
  18523. // Set OPTIONAL mode to ensure callback is called even when verification
  18524. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18525. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18526. }
  18527. return true;
  18528. }
  18529. inline long get_verify_error(const_session_t session) {
  18530. if (!session) { return -1; }
  18531. auto *msession =
  18532. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18533. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18534. }
  18535. inline std::string verify_error_string(long error_code) {
  18536. if (error_code == 0) { return ""; }
  18537. char buf[256];
  18538. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18539. static_cast<uint32_t>(error_code));
  18540. // Remove trailing newline if present
  18541. std::string result(buf);
  18542. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18543. result.pop_back();
  18544. }
  18545. return result;
  18546. }
  18547. } // namespace tls
  18548. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18549. /*
  18550. * Group 10: TLS abstraction layer - wolfSSL backend
  18551. */
  18552. /*
  18553. * wolfSSL Backend Implementation
  18554. */
  18555. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18556. namespace tls {
  18557. namespace impl {
  18558. // wolfSSL session wrapper
  18559. struct WolfSSLSession {
  18560. WOLFSSL *ssl = nullptr;
  18561. socket_t sock = INVALID_SOCKET;
  18562. std::string hostname; // For client: set via set_sni
  18563. std::string sni_hostname; // For server: received from client via SNI callback
  18564. WolfSSLSession() = default;
  18565. ~WolfSSLSession() {
  18566. if (ssl) { wolfSSL_free(ssl); }
  18567. }
  18568. WolfSSLSession(const WolfSSLSession &) = delete;
  18569. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18570. };
  18571. // Thread-local error code accessor for wolfSSL
  18572. inline uint64_t &wolfssl_last_error() {
  18573. static thread_local uint64_t err = 0;
  18574. return err;
  18575. }
  18576. // Helper to map wolfSSL error to ErrorCode.
  18577. // ssl_error is the value from wolfSSL_get_error().
  18578. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18579. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18580. int &out_errno) {
  18581. switch (ssl_error) {
  18582. case SSL_ERROR_NONE: return ErrorCode::Success;
  18583. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18584. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18585. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18586. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18587. default:
  18588. if (ssl) {
  18589. // wolfSSL stores the low-level error code as a negative value.
  18590. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18591. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18592. if (low_err == DOMAIN_NAME_MISMATCH) {
  18593. return ErrorCode::HostnameMismatch;
  18594. }
  18595. // Check verify result to distinguish cert verification from generic SSL
  18596. // errors.
  18597. long vr = wolfSSL_get_verify_result(ssl);
  18598. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18599. }
  18600. return ErrorCode::Fatal;
  18601. }
  18602. }
  18603. // WolfSSLContext constructor/destructor implementations
  18604. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18605. inline WolfSSLContext::~WolfSSLContext() {
  18606. if (ctx) { wolfSSL_CTX_free(ctx); }
  18607. }
  18608. // Thread-local storage for SNI captured during handshake
  18609. inline std::string &wolfssl_pending_sni() {
  18610. static thread_local std::string sni;
  18611. return sni;
  18612. }
  18613. // SNI callback for wolfSSL server to capture client's SNI hostname
  18614. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18615. (void)ret;
  18616. (void)exArg;
  18617. void *name_data = nullptr;
  18618. unsigned short name_len =
  18619. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18620. if (name_data && name_len > 0) {
  18621. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18622. name_len);
  18623. } else {
  18624. wolfssl_pending_sni().clear();
  18625. }
  18626. return 0; // Continue regardless
  18627. }
  18628. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18629. // runs the verify callback of its own context.
  18630. inline int context_ex_data_index() {
  18631. static const auto index =
  18632. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18633. return index;
  18634. }
  18635. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18636. // other tls:: function takes.
  18637. inline int session_ex_data_index() {
  18638. static const auto index =
  18639. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18640. return index;
  18641. }
  18642. // wolfSSL verify callback wrapper
  18643. inline int wolfssl_verify_callback(int preverify_ok,
  18644. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18645. // Get the WOLFSSL object from the X509_STORE_CTX
  18646. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18647. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18648. if (!ssl) { return preverify_ok; }
  18649. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18650. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18651. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18652. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18653. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18654. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18655. VerifyContext verify_ctx;
  18656. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18657. verify_ctx.cert = static_cast<cert_t>(cert);
  18658. verify_ctx.depth = depth;
  18659. verify_ctx.preverify_ok = (preverify_ok != 0);
  18660. verify_ctx.error_code = static_cast<long>(err);
  18661. if (err != 0) {
  18662. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18663. } else {
  18664. verify_ctx.error_string = nullptr;
  18665. }
  18666. bool accepted = wctx->verify_callback(verify_ctx);
  18667. return accepted ? 1 : 0;
  18668. }
  18669. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18670. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18671. wolfSSL_CTX_set_default_passwd_cb(
  18672. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18673. auto *pwd = static_cast<const char *>(userdata);
  18674. if (!pwd) return 0;
  18675. auto len = static_cast<int>(strlen(pwd));
  18676. if (len > size) len = size;
  18677. memcpy(buf, pwd, static_cast<size_t>(len));
  18678. return len;
  18679. });
  18680. }
  18681. } // namespace impl
  18682. inline ctx_t create_client_context() {
  18683. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18684. if (!ctx) { return nullptr; }
  18685. ctx->is_server = false;
  18686. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18687. if (!method) {
  18688. delete ctx;
  18689. return nullptr;
  18690. }
  18691. ctx->ctx = wolfSSL_CTX_new(method);
  18692. if (!ctx->ctx ||
  18693. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18694. WOLFSSL_SUCCESS) {
  18695. delete ctx;
  18696. return nullptr;
  18697. }
  18698. // Default: verify peer certificate
  18699. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18700. return static_cast<ctx_t>(ctx);
  18701. }
  18702. inline ctx_t create_server_context() {
  18703. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18704. if (!ctx) { return nullptr; }
  18705. ctx->is_server = true;
  18706. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18707. if (!method) {
  18708. delete ctx;
  18709. return nullptr;
  18710. }
  18711. ctx->ctx = wolfSSL_CTX_new(method);
  18712. if (!ctx->ctx ||
  18713. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18714. WOLFSSL_SUCCESS) {
  18715. delete ctx;
  18716. return nullptr;
  18717. }
  18718. // Default: don't verify client
  18719. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18720. // Enable SNI on server
  18721. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18722. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18723. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18724. return static_cast<ctx_t>(ctx);
  18725. }
  18726. inline void free_context(ctx_t ctx) {
  18727. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18728. }
  18729. inline bool set_min_version(ctx_t ctx, Version version) {
  18730. if (!ctx) { return false; }
  18731. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18732. int min_ver = WOLFSSL_TLSV1_2;
  18733. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18734. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18735. }
  18736. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18737. if (!ctx || !pem) { return false; }
  18738. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18739. int ret = wolfSSL_CTX_load_verify_buffer(
  18740. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18741. static_cast<long>(len), SSL_FILETYPE_PEM);
  18742. if (ret != SSL_SUCCESS) {
  18743. impl::wolfssl_last_error() =
  18744. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18745. return false;
  18746. }
  18747. wctx->ca_pem_data_.append(pem, len);
  18748. return true;
  18749. }
  18750. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18751. if (!ctx || !file_path) { return false; }
  18752. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18753. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18754. if (ret != SSL_SUCCESS) {
  18755. impl::wolfssl_last_error() =
  18756. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18757. return false;
  18758. }
  18759. return true;
  18760. }
  18761. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18762. if (!ctx || !dir_path) { return false; }
  18763. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18764. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18765. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18766. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18767. // immediately. Return true even on failure since the CA file may have
  18768. // already been loaded, matching OpenSSL's lenient behavior.
  18769. (void)ret;
  18770. return true;
  18771. }
  18772. inline bool load_system_certs(ctx_t ctx) {
  18773. if (!ctx) { return false; }
  18774. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18775. bool loaded = false;
  18776. #ifdef _WIN32
  18777. loaded = impl::enumerate_windows_system_certs(
  18778. [&](const unsigned char *data, size_t len) {
  18779. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18780. static_cast<long>(len),
  18781. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18782. });
  18783. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18784. loaded = impl::enumerate_macos_keychain_certs(
  18785. [&](const unsigned char *data, size_t len) {
  18786. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18787. static_cast<long>(len),
  18788. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18789. });
  18790. #else
  18791. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18792. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18793. SSL_SUCCESS) {
  18794. loaded = true;
  18795. break;
  18796. }
  18797. }
  18798. if (!loaded) {
  18799. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18800. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18801. SSL_SUCCESS) {
  18802. loaded = true;
  18803. break;
  18804. }
  18805. }
  18806. }
  18807. #endif
  18808. return loaded;
  18809. }
  18810. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18811. const char *password) {
  18812. if (!ctx || !cert || !key) { return false; }
  18813. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18814. // Load certificate
  18815. int ret = wolfSSL_CTX_use_certificate_buffer(
  18816. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18817. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18818. if (ret != SSL_SUCCESS) {
  18819. impl::wolfssl_last_error() =
  18820. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18821. return false;
  18822. }
  18823. // Set password callback if password is provided
  18824. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18825. // Load private key
  18826. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18827. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18828. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18829. if (ret != SSL_SUCCESS) {
  18830. impl::wolfssl_last_error() =
  18831. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18832. return false;
  18833. }
  18834. // Verify that the certificate and private key match
  18835. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18836. }
  18837. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18838. const char *key_path, const char *password) {
  18839. if (!ctx || !cert_path || !key_path) { return false; }
  18840. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18841. // Load certificate file
  18842. int ret =
  18843. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18844. if (ret != SSL_SUCCESS) {
  18845. impl::wolfssl_last_error() =
  18846. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18847. return false;
  18848. }
  18849. // Set password callback if password is provided
  18850. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18851. // Load private key file
  18852. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18853. if (ret != SSL_SUCCESS) {
  18854. impl::wolfssl_last_error() =
  18855. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18856. return false;
  18857. }
  18858. // Verify that the certificate and private key match
  18859. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18860. }
  18861. inline void set_verify_client(ctx_t ctx, bool require) {
  18862. if (!ctx) { return; }
  18863. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18864. wctx->verify_client = require;
  18865. if (require) {
  18866. wolfSSL_CTX_set_verify(
  18867. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18868. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18869. } else {
  18870. if (wctx->verify_callback) {
  18871. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18872. impl::wolfssl_verify_callback);
  18873. } else {
  18874. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18875. }
  18876. }
  18877. }
  18878. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18879. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18880. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18881. auto session = new (std::nothrow) impl::WolfSSLSession();
  18882. if (!session) { return nullptr; }
  18883. session->sock = sock;
  18884. session->ssl = wolfSSL_new(wctx->ctx);
  18885. if (!session->ssl) {
  18886. impl::wolfssl_last_error() =
  18887. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18888. delete session;
  18889. return nullptr;
  18890. }
  18891. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  18892. session) != WOLFSSL_SUCCESS) {
  18893. delete session;
  18894. return nullptr;
  18895. }
  18896. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18897. return static_cast<session_t>(session);
  18898. }
  18899. inline void free_session(session_t session) {
  18900. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18901. }
  18902. inline bool set_sni(session_t session, const char *hostname,
  18903. bool verify_hostname) {
  18904. if (!session || !hostname) { return false; }
  18905. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18906. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18907. static_cast<word16>(strlen(hostname)));
  18908. if (ret != WOLFSSL_SUCCESS) {
  18909. impl::wolfssl_last_error() =
  18910. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18911. return false;
  18912. }
  18913. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18914. // separately from the SNI extension sent above; skip it when hostname
  18915. // verification is disabled so only the chain is checked, matching OpenSSL.
  18916. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18917. wsession->hostname = hostname;
  18918. return true;
  18919. }
  18920. inline TlsError connect(session_t session) {
  18921. TlsError err;
  18922. if (!session) {
  18923. err.code = ErrorCode::Fatal;
  18924. return err;
  18925. }
  18926. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18927. int ret = wolfSSL_connect(wsession->ssl);
  18928. if (ret == SSL_SUCCESS) {
  18929. err.code = ErrorCode::Success;
  18930. } else {
  18931. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18932. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18933. err.backend_code = static_cast<uint64_t>(ssl_error);
  18934. impl::wolfssl_last_error() = err.backend_code;
  18935. }
  18936. return err;
  18937. }
  18938. inline TlsError accept(session_t session) {
  18939. TlsError err;
  18940. if (!session) {
  18941. err.code = ErrorCode::Fatal;
  18942. return err;
  18943. }
  18944. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18945. int ret = wolfSSL_accept(wsession->ssl);
  18946. if (ret == SSL_SUCCESS) {
  18947. err.code = ErrorCode::Success;
  18948. // Capture SNI from thread-local storage after successful handshake
  18949. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18950. impl::wolfssl_pending_sni().clear();
  18951. } else {
  18952. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18953. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18954. err.backend_code = static_cast<uint64_t>(ssl_error);
  18955. impl::wolfssl_last_error() = err.backend_code;
  18956. }
  18957. return err;
  18958. }
  18959. inline bool connect_nonblocking(session_t session, socket_t sock,
  18960. time_t timeout_sec, time_t timeout_usec,
  18961. TlsError *err) {
  18962. if (!session) {
  18963. if (err) { err->code = ErrorCode::Fatal; }
  18964. return false;
  18965. }
  18966. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18967. // Set socket to non-blocking mode
  18968. detail::set_nonblocking(sock, true);
  18969. auto cleanup =
  18970. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18971. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18972. int ret;
  18973. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18974. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18975. if (ssl_error == SSL_ERROR_WANT_READ) {
  18976. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18977. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18978. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18979. }
  18980. // Error or timeout
  18981. if (err) {
  18982. err->code =
  18983. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18984. err->backend_code = static_cast<uint64_t>(ssl_error);
  18985. }
  18986. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18987. return false;
  18988. }
  18989. if (err) { err->code = ErrorCode::Success; }
  18990. return true;
  18991. }
  18992. inline bool accept_nonblocking(session_t session, socket_t sock,
  18993. time_t timeout_sec, time_t timeout_usec,
  18994. TlsError *err) {
  18995. if (!session) {
  18996. if (err) { err->code = ErrorCode::Fatal; }
  18997. return false;
  18998. }
  18999. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19000. // Set socket to non-blocking mode
  19001. detail::set_nonblocking(sock, true);
  19002. auto cleanup =
  19003. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19004. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19005. int ret;
  19006. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19007. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19008. if (ssl_error == SSL_ERROR_WANT_READ) {
  19009. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19010. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19011. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19012. }
  19013. // Error or timeout
  19014. if (err) {
  19015. err->code =
  19016. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19017. err->backend_code = static_cast<uint64_t>(ssl_error);
  19018. }
  19019. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19020. return false;
  19021. }
  19022. if (err) { err->code = ErrorCode::Success; }
  19023. // Capture SNI from thread-local storage after successful handshake
  19024. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19025. impl::wolfssl_pending_sni().clear();
  19026. return true;
  19027. }
  19028. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19029. if (!session || !buf) {
  19030. err.code = ErrorCode::Fatal;
  19031. return -1;
  19032. }
  19033. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19034. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19035. if (ret > 0) {
  19036. err.code = ErrorCode::Success;
  19037. return static_cast<ssize_t>(ret);
  19038. }
  19039. if (ret == 0) {
  19040. err.code = ErrorCode::PeerClosed;
  19041. return 0;
  19042. }
  19043. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19044. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19045. err.backend_code = static_cast<uint64_t>(ssl_error);
  19046. impl::wolfssl_last_error() = err.backend_code;
  19047. return -1;
  19048. }
  19049. inline ssize_t write(session_t session, const void *buf, size_t len,
  19050. TlsError &err) {
  19051. if (!session || !buf) {
  19052. err.code = ErrorCode::Fatal;
  19053. return -1;
  19054. }
  19055. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19056. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19057. if (ret > 0) {
  19058. err.code = ErrorCode::Success;
  19059. return static_cast<ssize_t>(ret);
  19060. }
  19061. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19062. // Treat this as an error (return -1) so callers don't spin in a
  19063. // write loop adding zero to the offset.
  19064. if (ret == 0) {
  19065. err.code = ErrorCode::PeerClosed;
  19066. return -1;
  19067. }
  19068. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19069. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19070. err.backend_code = static_cast<uint64_t>(ssl_error);
  19071. impl::wolfssl_last_error() = err.backend_code;
  19072. return -1;
  19073. }
  19074. inline int pending(const_session_t session) {
  19075. if (!session) { return 0; }
  19076. auto wsession =
  19077. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19078. return wolfSSL_pending(wsession->ssl);
  19079. }
  19080. inline void shutdown(session_t session, bool graceful) {
  19081. if (!session) { return; }
  19082. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19083. if (graceful) {
  19084. int ret;
  19085. int attempts = 0;
  19086. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19087. attempts < 3) {
  19088. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19089. if (ssl_error != SSL_ERROR_WANT_READ &&
  19090. ssl_error != SSL_ERROR_WANT_WRITE) {
  19091. break;
  19092. }
  19093. attempts++;
  19094. }
  19095. } else {
  19096. wolfSSL_shutdown(wsession->ssl);
  19097. }
  19098. }
  19099. inline bool is_peer_closed(session_t session, socket_t sock) {
  19100. if (!session || sock == INVALID_SOCKET) { return true; }
  19101. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19102. // Check if there's already decrypted data available
  19103. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19104. // Set socket to non-blocking to avoid blocking on read
  19105. detail::set_nonblocking(sock, true);
  19106. auto cleanup =
  19107. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19108. // Peek 1 byte to check connection status without consuming data
  19109. unsigned char buf;
  19110. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19111. // If we got data or WANT_READ (would block), connection is alive
  19112. if (ret > 0) { return false; }
  19113. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19114. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19115. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19116. ret == 0;
  19117. }
  19118. inline cert_t get_peer_cert(const_session_t session) {
  19119. if (!session) { return nullptr; }
  19120. auto wsession =
  19121. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19122. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19123. return static_cast<cert_t>(cert);
  19124. }
  19125. inline size_t get_peer_certs(const_session_t session,
  19126. std::vector<cert_t> &certs) {
  19127. certs.clear();
  19128. if (!session) { return 0; }
  19129. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19130. #ifdef SESSION_CERTS
  19131. auto wsession =
  19132. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19133. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19134. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19135. for (int i = 0; i < count; i++) {
  19136. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19137. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19138. }
  19139. #endif
  19140. return certs.size();
  19141. }
  19142. inline void free_cert(cert_t cert) {
  19143. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19144. }
  19145. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19146. if (!cert || !hostname) { return false; }
  19147. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19148. std::string host_str(hostname);
  19149. // Check if hostname is an IP address (IPv4 or IPv6)
  19150. unsigned char ip_bytes[16];
  19151. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19152. auto is_ip = ip_len > 0;
  19153. // Check Subject Alternative Names
  19154. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19155. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19156. if (san_names) {
  19157. int san_count = wolfSSL_sk_num(san_names);
  19158. for (int i = 0; i < san_count; i++) {
  19159. auto *names =
  19160. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19161. if (!names) continue;
  19162. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19163. // DNS name
  19164. unsigned char *dns_name = nullptr;
  19165. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19166. if (dns_name && dns_len > 0) {
  19167. std::string san_name(reinterpret_cast<char *>(dns_name),
  19168. static_cast<size_t>(dns_len));
  19169. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19170. if (detail::match_hostname(san_name, host_str)) {
  19171. wolfSSL_sk_free(san_names);
  19172. return true;
  19173. }
  19174. }
  19175. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19176. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19177. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19178. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19179. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19180. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19181. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19182. wolfSSL_sk_free(san_names);
  19183. return true;
  19184. }
  19185. }
  19186. }
  19187. wolfSSL_sk_free(san_names);
  19188. }
  19189. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19190. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19191. // the OpenSSL backend's X509_check_ip behaves the same way).
  19192. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19193. if (subject) {
  19194. char cn[256] = {};
  19195. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19196. sizeof(cn));
  19197. if (cn_len > 0) {
  19198. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19199. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19200. }
  19201. }
  19202. return false;
  19203. }
  19204. inline uint64_t hostname_mismatch_code() {
  19205. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19206. }
  19207. inline long get_verify_result(const_session_t session) {
  19208. if (!session) { return -1; }
  19209. auto wsession =
  19210. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19211. long result = wolfSSL_get_verify_result(wsession->ssl);
  19212. return result;
  19213. }
  19214. inline std::string get_cert_subject_cn(cert_t cert) {
  19215. if (!cert) return "";
  19216. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19217. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19218. if (!subject) return "";
  19219. char cn[256] = {};
  19220. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19221. sizeof(cn));
  19222. if (cn_len <= 0) return "";
  19223. return std::string(cn, static_cast<size_t>(cn_len));
  19224. }
  19225. inline std::string get_cert_issuer_name(cert_t cert) {
  19226. if (!cert) return "";
  19227. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19228. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19229. if (!issuer) return "";
  19230. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19231. if (!name_str) return "";
  19232. std::string result(name_str);
  19233. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19234. return result;
  19235. }
  19236. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19237. sans.clear();
  19238. if (!cert) return false;
  19239. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19240. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19241. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19242. if (!san_names) return true; // No SANs is not an error
  19243. int count = wolfSSL_sk_num(san_names);
  19244. for (int i = 0; i < count; i++) {
  19245. auto *name =
  19246. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19247. if (!name) continue;
  19248. SanEntry entry;
  19249. switch (name->type) {
  19250. case WOLFSSL_GEN_DNS: {
  19251. entry.type = SanType::DNS;
  19252. unsigned char *dns_name = nullptr;
  19253. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19254. if (dns_name && dns_len > 0) {
  19255. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19256. static_cast<size_t>(dns_len));
  19257. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19258. }
  19259. break;
  19260. }
  19261. case WOLFSSL_GEN_IPADD: {
  19262. entry.type = SanType::IP;
  19263. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19264. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19265. if (ip_data && ip_len == 4) {
  19266. char buf[16];
  19267. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19268. ip_data[2], ip_data[3]);
  19269. entry.value = buf;
  19270. } else if (ip_data && ip_len == 16) {
  19271. char buf[64];
  19272. snprintf(buf, sizeof(buf),
  19273. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19274. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19275. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19276. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19277. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19278. ip_data[14], ip_data[15]);
  19279. entry.value = buf;
  19280. }
  19281. break;
  19282. }
  19283. case WOLFSSL_GEN_EMAIL:
  19284. entry.type = SanType::EMAIL;
  19285. {
  19286. unsigned char *email = nullptr;
  19287. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19288. if (email && email_len > 0) {
  19289. entry.value = std::string(reinterpret_cast<char *>(email),
  19290. static_cast<size_t>(email_len));
  19291. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19292. }
  19293. }
  19294. break;
  19295. case WOLFSSL_GEN_URI:
  19296. entry.type = SanType::URI;
  19297. {
  19298. unsigned char *uri = nullptr;
  19299. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19300. &uri, name->d.uniformResourceIdentifier);
  19301. if (uri && uri_len > 0) {
  19302. entry.value = std::string(reinterpret_cast<char *>(uri),
  19303. static_cast<size_t>(uri_len));
  19304. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19305. }
  19306. }
  19307. break;
  19308. default: entry.type = SanType::OTHER; break;
  19309. }
  19310. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19311. }
  19312. wolfSSL_sk_free(san_names);
  19313. return true;
  19314. }
  19315. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19316. time_t &not_after) {
  19317. if (!cert) return false;
  19318. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19319. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19320. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19321. if (!nb || !na) return false;
  19322. // wolfSSL_ASN1_TIME_to_tm is available
  19323. struct tm tm_nb = {}, tm_na = {};
  19324. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19325. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19326. #ifdef _WIN32
  19327. not_before = _mkgmtime(&tm_nb);
  19328. not_after = _mkgmtime(&tm_na);
  19329. #else
  19330. not_before = timegm(&tm_nb);
  19331. not_after = timegm(&tm_na);
  19332. #endif
  19333. return true;
  19334. }
  19335. inline std::string get_cert_serial(cert_t cert) {
  19336. if (!cert) return "";
  19337. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19338. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19339. if (!serial_asn1) return "";
  19340. // Get the serial number data
  19341. int len = serial_asn1->length;
  19342. unsigned char *data = serial_asn1->data;
  19343. if (!data || len <= 0) return "";
  19344. std::string result;
  19345. result.reserve(static_cast<size_t>(len) * 2);
  19346. for (int i = 0; i < len; i++) {
  19347. char hex[3];
  19348. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19349. result += hex;
  19350. }
  19351. return result;
  19352. }
  19353. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19354. if (!cert) return false;
  19355. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19356. int der_len = 0;
  19357. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19358. if (!der_data || der_len <= 0) return false;
  19359. der.assign(der_data, der_data + der_len);
  19360. return true;
  19361. }
  19362. inline const char *get_sni(const_session_t session) {
  19363. if (!session) return nullptr;
  19364. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19365. // For server: return SNI received from client during handshake
  19366. if (!wsession->sni_hostname.empty()) {
  19367. return wsession->sni_hostname.c_str();
  19368. }
  19369. // For client: return the hostname set via set_sni
  19370. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19371. return nullptr;
  19372. }
  19373. inline uint64_t peek_error() {
  19374. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19375. }
  19376. inline uint64_t get_error() {
  19377. uint64_t err = impl::wolfssl_last_error();
  19378. impl::wolfssl_last_error() = 0;
  19379. return err;
  19380. }
  19381. inline std::string error_string(uint64_t code) {
  19382. char buf[256];
  19383. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19384. return std::string(buf);
  19385. }
  19386. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19387. if (!pem || len == 0) { return nullptr; }
  19388. // Validate by attempting to load into a temporary ctx
  19389. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19390. if (!tmp_ctx) { return nullptr; }
  19391. int ret = wolfSSL_CTX_load_verify_buffer(
  19392. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19393. static_cast<long>(len), SSL_FILETYPE_PEM);
  19394. wolfSSL_CTX_free(tmp_ctx);
  19395. if (ret != SSL_SUCCESS) { return nullptr; }
  19396. return static_cast<ca_store_t>(
  19397. new impl::WolfSSLCAStore{std::string(pem, len)});
  19398. }
  19399. inline void free_ca_store(ca_store_t store) {
  19400. delete static_cast<impl::WolfSSLCAStore *>(store);
  19401. }
  19402. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19403. if (!ctx || !store) { return false; }
  19404. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19405. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19406. int ret = wolfSSL_CTX_load_verify_buffer(
  19407. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19408. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19409. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19410. // This function takes ownership of the store; the PEM data was copied into
  19411. // the context, so release the source
  19412. free_ca_store(store);
  19413. return ret == SSL_SUCCESS;
  19414. }
  19415. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19416. certs.clear();
  19417. if (!ctx) { return 0; }
  19418. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19419. if (wctx->ca_pem_data_.empty()) { return 0; }
  19420. const std::string &pem = wctx->ca_pem_data_;
  19421. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19422. const std::string end_marker = "-----END CERTIFICATE-----";
  19423. size_t pos = 0;
  19424. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19425. size_t end_pos = pem.find(end_marker, pos);
  19426. if (end_pos == std::string::npos) { break; }
  19427. end_pos += end_marker.size();
  19428. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19429. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19430. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19431. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19432. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19433. pos = end_pos;
  19434. }
  19435. return certs.size();
  19436. }
  19437. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19438. std::vector<std::string> names;
  19439. if (!ctx) { return names; }
  19440. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19441. if (wctx->ca_pem_data_.empty()) { return names; }
  19442. const std::string &pem = wctx->ca_pem_data_;
  19443. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19444. const std::string end_marker = "-----END CERTIFICATE-----";
  19445. size_t pos = 0;
  19446. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19447. size_t end_pos = pem.find(end_marker, pos);
  19448. if (end_pos == std::string::npos) { break; }
  19449. end_pos += end_marker.size();
  19450. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19451. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19452. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19453. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19454. if (x509) {
  19455. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19456. if (subject) {
  19457. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19458. if (name_str) {
  19459. names.push_back(name_str);
  19460. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19461. }
  19462. }
  19463. wolfSSL_X509_free(x509);
  19464. }
  19465. pos = end_pos;
  19466. }
  19467. return names;
  19468. }
  19469. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19470. const char *key_pem, const char *password) {
  19471. if (!ctx || !cert_pem || !key_pem) { return false; }
  19472. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19473. // Load new certificate
  19474. int ret = wolfSSL_CTX_use_certificate_buffer(
  19475. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19476. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19477. if (ret != SSL_SUCCESS) {
  19478. impl::wolfssl_last_error() =
  19479. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19480. return false;
  19481. }
  19482. // Set password if provided
  19483. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19484. // Load new private key
  19485. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19486. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19487. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19488. if (ret != SSL_SUCCESS) {
  19489. impl::wolfssl_last_error() =
  19490. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19491. return false;
  19492. }
  19493. return true;
  19494. }
  19495. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19496. if (!ctx || !ca_pem) { return false; }
  19497. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19498. int ret = wolfSSL_CTX_load_verify_buffer(
  19499. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19500. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19501. if (ret != SSL_SUCCESS) {
  19502. impl::wolfssl_last_error() =
  19503. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19504. return false;
  19505. }
  19506. return true;
  19507. }
  19508. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19509. if (!ctx) { return false; }
  19510. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19511. wctx->verify_callback = std::move(callback);
  19512. if (wctx->verify_callback) {
  19513. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19514. impl::wolfssl_verify_callback);
  19515. } else {
  19516. wolfSSL_CTX_set_verify(
  19517. wctx->ctx,
  19518. wctx->verify_client
  19519. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19520. : SSL_VERIFY_NONE,
  19521. nullptr);
  19522. }
  19523. return true;
  19524. }
  19525. inline long get_verify_error(const_session_t session) {
  19526. if (!session) { return -1; }
  19527. auto *wsession =
  19528. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19529. return wolfSSL_get_verify_result(wsession->ssl);
  19530. }
  19531. inline std::string verify_error_string(long error_code) {
  19532. if (error_code == 0) { return ""; }
  19533. const char *str =
  19534. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19535. return str ? std::string(str) : std::string();
  19536. }
  19537. } // namespace tls
  19538. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19539. // WebSocket implementation
  19540. namespace ws {
  19541. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19542. bool fin) {
  19543. std::lock_guard<std::mutex> lock(write_mutex_);
  19544. if (closed_) { return false; }
  19545. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19546. }
  19547. inline ReadResult WebSocket::read(std::string &msg) {
  19548. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is malformed,
  19549. // which is answered with a protocol error instead.
  19550. auto answer_close = [&](const std::string &payload) {
  19551. if (closed_.exchange(true)) { return; }
  19552. auto reply = payload;
  19553. if (!impl::is_valid_close_payload(payload)) {
  19554. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19555. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19556. }
  19557. std::lock_guard<std::mutex> lock(write_mutex_);
  19558. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19559. reply.size(), true, !is_server_);
  19560. };
  19561. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19562. while (!closed_) {
  19563. Opcode opcode;
  19564. std::string payload;
  19565. bool fin;
  19566. impl::FrameRead r =
  19567. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19568. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19569. // A timeout landed on a frame boundary: the connection is untouched and
  19570. // still usable, so hand control back without closing it. That is only
  19571. // useful to a caller who asked for the timeout; the compile-time default
  19572. // is a backstop against a peer gone quiet, and elapsing it closes the
  19573. // connection so a plain `while (ws.read(msg))` loop ends.
  19574. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19575. if (r != impl::FrameRead::Ok) {
  19576. closed_ = true;
  19577. return Fail;
  19578. }
  19579. switch (opcode) {
  19580. case Opcode::Ping: {
  19581. std::lock_guard<std::mutex> lock(write_mutex_);
  19582. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19583. payload.size(), true, !is_server_);
  19584. continue;
  19585. }
  19586. case Opcode::Pong: {
  19587. std::lock_guard<std::mutex> lock(ping_mutex_);
  19588. unacked_pings_ = 0;
  19589. continue;
  19590. }
  19591. case Opcode::Close: {
  19592. answer_close(payload);
  19593. return Fail;
  19594. }
  19595. case Opcode::Text:
  19596. case Opcode::Binary: {
  19597. auto result = opcode == Opcode::Text ? Text : Binary;
  19598. msg = std::move(payload);
  19599. // Handle fragmentation
  19600. if (!fin) {
  19601. while (true) {
  19602. Opcode cont_opcode;
  19603. std::string cont_payload;
  19604. bool cont_fin;
  19605. // A timeout is not reportable here: half of a fragmented message is
  19606. // already in `msg` and read() has no way to resume it, so it is a
  19607. // failure like any other. Timeouts are only ever seen on a message
  19608. // boundary.
  19609. // Only what is left of the limit, but room for a control frame,
  19610. // which may come between the fragments.
  19611. auto max_len =
  19612. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19613. ? size_t(0)
  19614. : (std::max)(size_t(125),
  19615. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19616. msg.size());
  19617. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19618. cont_fin, is_server_,
  19619. max_len) != impl::FrameRead::Ok) {
  19620. closed_ = true;
  19621. return Fail;
  19622. }
  19623. if (cont_opcode == Opcode::Ping) {
  19624. std::lock_guard<std::mutex> lock(write_mutex_);
  19625. detail::write_websocket_frame(
  19626. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19627. true, !is_server_);
  19628. continue;
  19629. }
  19630. if (cont_opcode == Opcode::Pong) {
  19631. std::lock_guard<std::mutex> lock(ping_mutex_);
  19632. unacked_pings_ = 0;
  19633. continue;
  19634. }
  19635. if (cont_opcode == Opcode::Close) {
  19636. answer_close(cont_payload);
  19637. return Fail;
  19638. }
  19639. // RFC 6455: continuation frames must use opcode 0x0
  19640. if (cont_opcode != Opcode::Continuation) {
  19641. closed_ = true;
  19642. return Fail;
  19643. }
  19644. msg += cont_payload;
  19645. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19646. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19647. closed_ = true;
  19648. return Fail;
  19649. }
  19650. if (cont_fin) { break; }
  19651. }
  19652. }
  19653. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19654. if (result == Text && !impl::is_valid_utf8(msg)) {
  19655. // close() takes the read lock to wait for the peer's Close reply, so
  19656. // it must not run while this thread still holds it.
  19657. read_lock.unlock();
  19658. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19659. return Fail;
  19660. }
  19661. return result;
  19662. }
  19663. default: closed_ = true; return Fail;
  19664. }
  19665. }
  19666. return Fail;
  19667. }
  19668. inline bool WebSocket::send(const std::string &data) {
  19669. return send_frame(Opcode::Text, data.data(), data.size());
  19670. }
  19671. inline bool WebSocket::send(const char *data, size_t len) {
  19672. return send_frame(Opcode::Binary, data, len);
  19673. }
  19674. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19675. if (closed_.exchange(true)) { return; }
  19676. ping_cv_.notify_all();
  19677. std::string payload;
  19678. auto code = static_cast<uint16_t>(status);
  19679. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19680. payload.push_back(static_cast<char>(code & 0xFF));
  19681. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19682. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19683. payload += reason.substr(0, 123);
  19684. {
  19685. std::lock_guard<std::mutex> lock(write_mutex_);
  19686. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19687. payload.size(), true, !is_server_);
  19688. }
  19689. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19690. // Close response before closing the TCP connection.
  19691. //
  19692. // Wait only when no other thread is parsing frames. When one is, it is the
  19693. // thread positioned to see the peer's reply, and reading here would take
  19694. // bytes out of the message it is assembling. Bailing out also leaves the
  19695. // stream, including its read timeout, entirely to that thread.
  19696. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19697. if (!read_lock.owns_lock()) { return; }
  19698. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19699. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19700. Opcode op;
  19701. std::string resp;
  19702. bool fin;
  19703. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19704. impl::FrameRead::Ok) {
  19705. if (op == Opcode::Close) { break; }
  19706. }
  19707. }
  19708. inline WebSocket::~WebSocket() {
  19709. {
  19710. std::lock_guard<std::mutex> lock(ping_mutex_);
  19711. closed_ = true;
  19712. }
  19713. ping_cv_.notify_all();
  19714. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19715. }
  19716. inline void WebSocket::start_heartbeat() {
  19717. if (ping_interval_sec_ == 0) { return; }
  19718. ping_thread_ = std::thread([this]() {
  19719. std::unique_lock<std::mutex> lock(ping_mutex_);
  19720. // The predicate keeps a spurious wakeup from sending a ping early
  19721. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19722. [this]() { return closed_.load(); })) {
  19723. // If the peer has failed to respond to the previous pings, give up.
  19724. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19725. // opt-in liveness check controlled by max_missed_pongs_.
  19726. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19727. lock.unlock();
  19728. close(CloseStatus::GoingAway, "pong timeout");
  19729. // Wake a read() blocked on the unresponsive peer. Only the read side
  19730. // is shut down: a TLS backend answers the EOF with an alert, and
  19731. // writing it to a socket closed for writing raises SIGPIPE.
  19732. #ifdef _WIN32
  19733. shutdown(strm_.socket(), SD_RECEIVE);
  19734. #else
  19735. shutdown(strm_.socket(), SHUT_RD);
  19736. #endif
  19737. return;
  19738. }
  19739. lock.unlock();
  19740. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19741. lock.lock();
  19742. closed_ = true;
  19743. break;
  19744. }
  19745. lock.lock();
  19746. unacked_pings_++;
  19747. }
  19748. });
  19749. }
  19750. inline const Request &WebSocket::request() const { return req_; }
  19751. inline bool WebSocket::is_open() const { return !closed_; }
  19752. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19753. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19754. // poll(), where 0 would instead mean "return immediately", so hand it the
  19755. // negative poll uses for an unbounded wait.
  19756. if (sec == 0 && usec == 0) { sec = -1; }
  19757. strm_.set_read_timeout(sec, usec);
  19758. read_timeout_set_ = true;
  19759. }
  19760. // WebSocketClient implementation
  19761. inline WebSocketClient::WebSocketClient(
  19762. const std::string &scheme_host_port_path, const Headers &headers)
  19763. : headers_(headers) {
  19764. detail::UrlComponents uc;
  19765. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19766. !uc.host.empty() && !uc.path.empty()) {
  19767. auto &scheme = uc.scheme;
  19768. #ifdef CPPHTTPLIB_SSL_ENABLED
  19769. if (scheme != "ws" && scheme != "wss") {
  19770. #else
  19771. if (scheme != "ws") {
  19772. #endif
  19773. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19774. std::string msg = "'" + scheme + "' scheme is not supported.";
  19775. throw std::invalid_argument(msg);
  19776. #endif
  19777. return;
  19778. }
  19779. auto is_ssl = scheme == "wss";
  19780. host_ = std::move(uc.host);
  19781. port_ = is_ssl ? 443 : 80;
  19782. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19783. path_ = std::move(uc.path);
  19784. if (!uc.query.empty()) { path_ += uc.query; }
  19785. #ifdef CPPHTTPLIB_SSL_ENABLED
  19786. is_ssl_ = is_ssl;
  19787. if (is_ssl_) {
  19788. // The context lives as long as the client so that CA configuration
  19789. // survives reconnects; sessions are created per connection.
  19790. tls_ctx_ = tls::create_client_context();
  19791. if (!tls_ctx_) { return; }
  19792. }
  19793. #else
  19794. if (is_ssl) { return; }
  19795. #endif
  19796. is_valid_ = true;
  19797. }
  19798. }
  19799. #ifdef CPPHTTPLIB_SSL_ENABLED
  19800. inline WebSocketClient::WebSocketClient(
  19801. const std::string &scheme_host_port_path, const PemMemory &pem,
  19802. const Headers &headers)
  19803. : WebSocketClient(scheme_host_port_path, headers) {
  19804. // For ws:// URLs the client certificate is silently ignored, consistent
  19805. // with the TLS-only setters such as set_ca_cert_path().
  19806. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19807. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19808. pem.private_key_password)) {
  19809. tls::free_context(tls_ctx_);
  19810. tls_ctx_ = nullptr;
  19811. is_valid_ = false;
  19812. }
  19813. }
  19814. }
  19815. #endif
  19816. inline WebSocketClient::~WebSocketClient() {
  19817. shutdown_and_close();
  19818. #ifdef CPPHTTPLIB_SSL_ENABLED
  19819. if (tls_ctx_) {
  19820. tls::free_context(tls_ctx_);
  19821. tls_ctx_ = nullptr;
  19822. }
  19823. #endif
  19824. }
  19825. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19826. inline void WebSocketClient::shutdown_and_close() {
  19827. // Send the close frame while the TLS session is still alive: ws_ holds an
  19828. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19829. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19830. if (ws_ && ws_->is_open()) { ws_->close(); }
  19831. ws_.reset();
  19832. #ifdef CPPHTTPLIB_SSL_ENABLED
  19833. if (is_ssl_) {
  19834. if (tls_session_) {
  19835. tls::shutdown(tls_session_, true);
  19836. tls::free_session(tls_session_);
  19837. tls_session_ = nullptr;
  19838. }
  19839. }
  19840. #endif
  19841. if (sock_ != INVALID_SOCKET) {
  19842. detail::shutdown_socket(sock_);
  19843. detail::close_socket(sock_);
  19844. sock_ = INVALID_SOCKET;
  19845. }
  19846. }
  19847. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19848. Error &error, int &ssl_error,
  19849. uint64_t &ssl_backend_error) {
  19850. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19851. // The streams wait with poll(), where 0 instead means "return immediately",
  19852. // so they are given the negative poll uses for an unbounded wait.
  19853. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19854. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19855. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19856. // The handshake belongs to establishing the connection, so an unset read
  19857. // timeout leaves it bounded by the connection timeout instead of forever.
  19858. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19859. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19860. #ifdef CPPHTTPLIB_SSL_ENABLED
  19861. if (is_ssl_) {
  19862. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19863. // is not safe to call concurrently on one client to begin with, since
  19864. // nothing else here is guarded either.
  19865. if (server_certificate_verification_ && !certs_loaded_) {
  19866. uint64_t backend_error = 0;
  19867. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19868. ca_cert_dir_path_, custom_ca_loaded_,
  19869. system_ca_mode_, backend_error);
  19870. certs_loaded_ = true;
  19871. }
  19872. detail::ClientTlsSessionOptions options;
  19873. options.server_hostname_verification = server_hostname_verification_;
  19874. detail::ClientTlsSessionError tls_error;
  19875. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19876. server_certificate_verification_,
  19877. hs_sec, hs_usec, &tls_error,
  19878. options)) {
  19879. error = tls_error.error;
  19880. ssl_error = tls_error.ssl_error;
  19881. ssl_backend_error = tls_error.backend_error;
  19882. return false;
  19883. }
  19884. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19885. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19886. write_timeout_usec_));
  19887. return true;
  19888. }
  19889. #else
  19890. (void)error;
  19891. (void)ssl_error;
  19892. (void)ssl_backend_error;
  19893. (void)hs_sec;
  19894. (void)hs_usec;
  19895. #endif
  19896. strm = std::unique_ptr<Stream>(
  19897. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19898. write_timeout_sec_, write_timeout_usec_));
  19899. return true;
  19900. }
  19901. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19902. #ifdef CPPHTTPLIB_SSL_ENABLED
  19903. auto is_ssl = is_ssl_;
  19904. #else
  19905. auto is_ssl = false;
  19906. #endif
  19907. if (!req.has_header("Host")) {
  19908. req.headers.emplace("Host", detail::make_default_host_header_value(
  19909. host_, port_, is_ssl, address_family_));
  19910. }
  19911. detail::add_default_user_agent_header(req);
  19912. }
  19913. inline Result WebSocketClient::connect() {
  19914. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19915. shutdown_and_close();
  19916. // Check is custom IP or hostname specified for host_
  19917. std::string connect_host;
  19918. std::string ip;
  19919. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19920. auto error = Error::Success;
  19921. sock_ = detail::create_client_socket(
  19922. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19923. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19924. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19925. write_timeout_usec_, interface_, error);
  19926. if (sock_ == INVALID_SOCKET) {
  19927. if (error == Error::Success) { error = Error::Connection; }
  19928. return Result{error, -1, Headers{}};
  19929. }
  19930. std::unique_ptr<Stream> strm;
  19931. auto stream_error = Error::SSLConnection;
  19932. int ssl_error = 0;
  19933. uint64_t ssl_backend_error = 0;
  19934. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19935. shutdown_and_close();
  19936. #ifdef CPPHTTPLIB_SSL_ENABLED
  19937. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19938. #else
  19939. return Result{stream_error, -1, Headers{}};
  19940. #endif
  19941. }
  19942. Request req;
  19943. req.method = "GET";
  19944. req.path = path_;
  19945. req.headers = headers_;
  19946. prepare_default_headers(req);
  19947. detail::WebSocketUpgradeResponse upgrade;
  19948. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19949. shutdown_and_close();
  19950. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19951. }
  19952. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19953. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19954. websocket_ping_interval_sec_,
  19955. websocket_max_missed_pongs_));
  19956. // The stream was created with the timeout already; tell the WebSocket
  19957. // whether it came from the caller, so read() knows to report it as Timeout.
  19958. ws_->read_timeout_set_ = read_timeout_set_;
  19959. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19960. }
  19961. inline ReadResult WebSocketClient::read(std::string &msg) {
  19962. if (!ws_) { return Fail; }
  19963. return ws_->read(msg);
  19964. }
  19965. inline bool WebSocketClient::send(const std::string &data) {
  19966. if (!ws_) { return false; }
  19967. return ws_->send(data);
  19968. }
  19969. inline bool WebSocketClient::send(const char *data, size_t len) {
  19970. if (!ws_) { return false; }
  19971. return ws_->send(data, len);
  19972. }
  19973. inline void WebSocketClient::close(CloseStatus status,
  19974. const std::string &reason) {
  19975. if (ws_) { ws_->close(status, reason); }
  19976. }
  19977. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19978. inline const std::string &WebSocketClient::subprotocol() const {
  19979. return subprotocol_;
  19980. }
  19981. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19982. read_timeout_sec_ = sec;
  19983. read_timeout_usec_ = usec;
  19984. read_timeout_set_ = true;
  19985. // The members above only seed the next connect(); read() consults the
  19986. // stream, so an already-open connection has to be told directly.
  19987. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19988. }
  19989. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19990. write_timeout_sec_ = sec;
  19991. write_timeout_usec_ = usec;
  19992. }
  19993. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19994. websocket_ping_interval_sec_ = sec;
  19995. }
  19996. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19997. websocket_max_missed_pongs_ = count;
  19998. }
  19999. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20000. inline void WebSocketClient::set_address_family(int family) {
  20001. address_family_ = family;
  20002. }
  20003. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20004. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20005. socket_options_ = std::move(socket_options);
  20006. }
  20007. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20008. connection_timeout_sec_ = sec;
  20009. connection_timeout_usec_ = usec;
  20010. }
  20011. inline void WebSocketClient::set_interface(const std::string &intf) {
  20012. interface_ = intf;
  20013. }
  20014. inline void WebSocketClient::set_hostname_addr_map(
  20015. std::map<std::string, std::string> addr_map) {
  20016. addr_map_ = std::move(addr_map);
  20017. }
  20018. #ifdef CPPHTTPLIB_SSL_ENABLED
  20019. inline void
  20020. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20021. const std::string &ca_cert_dir_path) {
  20022. ca_cert_file_path_ = ca_cert_file_path;
  20023. ca_cert_dir_path_ = ca_cert_dir_path;
  20024. }
  20025. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20026. if (store && tls_ctx_) {
  20027. // set_ca_store takes ownership of store
  20028. tls::set_ca_store(tls_ctx_, store);
  20029. custom_ca_loaded_ = true;
  20030. } else if (store) {
  20031. tls::free_ca_store(store);
  20032. }
  20033. }
  20034. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20035. std::size_t size) {
  20036. if (tls_ctx_ && ca_cert && size > 0) {
  20037. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20038. custom_ca_loaded_ = true;
  20039. }
  20040. }
  20041. inline void
  20042. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20043. server_certificate_verification_ = enabled;
  20044. }
  20045. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20046. server_hostname_verification_ = enabled;
  20047. }
  20048. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20049. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20050. }
  20051. #endif // CPPHTTPLIB_SSL_ENABLED
  20052. } // namespace ws
  20053. // ----------------------------------------------------------------------------
  20054. } // namespace httplib
  20055. #endif // CPPHTTPLIB_HTTPLIB_H