httplib.h 811 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622
  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/socket.h>
  285. #include <sys/un.h>
  286. #include <unistd.h>
  287. using socket_t = int;
  288. #ifndef INVALID_SOCKET
  289. #define INVALID_SOCKET (-1)
  290. #endif
  291. #endif //_WIN32
  292. #if defined(__APPLE__)
  293. #include <TargetConditionals.h>
  294. #endif
  295. #include <algorithm>
  296. #include <array>
  297. #include <atomic>
  298. #include <cassert>
  299. #include <chrono>
  300. #include <climits>
  301. #include <condition_variable>
  302. #include <cstdlib>
  303. #include <cstring>
  304. #include <errno.h>
  305. #include <exception>
  306. #include <fcntl.h>
  307. #include <fstream>
  308. #include <functional>
  309. #include <iomanip>
  310. #include <iostream>
  311. #include <iterator>
  312. #include <list>
  313. #include <map>
  314. #include <memory>
  315. #include <mutex>
  316. #include <random>
  317. #include <regex>
  318. #include <set>
  319. #include <sstream>
  320. #include <string>
  321. #include <sys/stat.h>
  322. #include <system_error>
  323. #include <thread>
  324. #include <type_traits>
  325. #include <unordered_map>
  326. #include <unordered_set>
  327. #include <utility>
  328. #include <vector>
  329. // On macOS with a TLS backend, enable Keychain root certificates by default
  330. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  331. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  332. // only; on those platforms the user must provide a CA bundle explicitly.
  333. #if defined(__APPLE__) && defined(__clang__) && \
  334. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  335. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  336. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  337. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  338. #if TARGET_OS_OSX
  339. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  340. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  341. #endif
  342. #endif
  343. #endif
  344. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  345. defined(__APPLE__) && !TARGET_OS_OSX
  346. #error \
  347. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  348. #endif
  349. // On Windows, enable Schannel certificate verification by default
  350. // unless the user explicitly opts out.
  351. #if defined(_WIN32) && \
  352. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  353. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  354. #endif
  355. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  356. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  357. #if TARGET_OS_MAC && defined(__clang__)
  358. #include <CFNetwork/CFHost.h>
  359. #include <CoreFoundation/CoreFoundation.h>
  360. #endif
  361. #endif
  362. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  363. #ifdef _WIN32
  364. #include <wincrypt.h>
  365. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  366. // used
  367. #undef X509_NAME
  368. #undef X509_CERT_PAIR
  369. #undef X509_EXTENSIONS
  370. #undef PKCS7_SIGNER_INFO
  371. #ifdef _MSC_VER
  372. #pragma comment(lib, "crypt32.lib")
  373. #endif
  374. #endif // _WIN32
  375. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  376. #if TARGET_OS_OSX
  377. #include <Security/Security.h>
  378. #endif
  379. #endif
  380. #include <openssl/err.h>
  381. #include <openssl/evp.h>
  382. #include <openssl/rand.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. // For a literal, without building a std::string from it.
  564. template <size_t N>
  565. inline bool equal(const std::string &a, const char (&b)[N]) {
  566. return a.size() == N - 1 &&
  567. std::equal(a.begin(), a.end(), b, [](char ca, char cb) {
  568. return to_lower(ca) == to_lower(cb);
  569. });
  570. }
  571. struct equal_to {
  572. bool operator()(const std::string &a, const std::string &b) const {
  573. return equal(a, b);
  574. }
  575. };
  576. struct hash {
  577. size_t operator()(const std::string &key) const {
  578. size_t h = 0;
  579. for (auto c : key) {
  580. // Unsets the 6 high bits of h, therefore no overflow happens
  581. h = (((std::numeric_limits<size_t>::max)() >> 6) & h * 33) ^
  582. static_cast<unsigned char>(to_lower(c));
  583. }
  584. return h;
  585. }
  586. };
  587. template <typename T>
  588. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  589. detail::case_ignore::equal_to>;
  590. } // namespace case_ignore
  591. // This is based on
  592. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  593. struct scope_exit {
  594. explicit scope_exit(std::function<void(void)> &&f)
  595. : exit_function(std::move(f)), execute_on_destruction{true} {}
  596. scope_exit(scope_exit &&rhs) noexcept
  597. : exit_function(std::move(rhs.exit_function)),
  598. execute_on_destruction{rhs.execute_on_destruction} {
  599. rhs.release();
  600. }
  601. ~scope_exit() {
  602. if (execute_on_destruction) { this->exit_function(); }
  603. }
  604. void release() { this->execute_on_destruction = false; }
  605. private:
  606. scope_exit(const scope_exit &) = delete;
  607. void operator=(const scope_exit &) = delete;
  608. scope_exit &operator=(scope_exit &&) = delete;
  609. std::function<void(void)> exit_function;
  610. bool execute_on_destruction;
  611. };
  612. // Simple from_chars implementation for integer and double types (C++17
  613. // substitute)
  614. template <typename T> struct from_chars_result {
  615. const char *ptr;
  616. std::errc ec;
  617. };
  618. template <typename T>
  619. inline from_chars_result<T> from_chars(const char *first, const char *last,
  620. T &value, int base = 10) {
  621. value = 0;
  622. const char *p = first;
  623. bool negative = false;
  624. if (p != last && *p == '-') {
  625. negative = true;
  626. ++p;
  627. }
  628. if (p == last) { return {first, std::errc::invalid_argument}; }
  629. T result = 0;
  630. for (; p != last; ++p) {
  631. char c = *p;
  632. int digit = -1;
  633. if (is_ascii_digit(c)) {
  634. digit = c - '0';
  635. } else if ('a' <= c && c <= 'z') {
  636. digit = c - 'a' + 10;
  637. } else if ('A' <= c && c <= 'Z') {
  638. digit = c - 'A' + 10;
  639. } else {
  640. break;
  641. }
  642. if (digit < 0 || digit >= base) { break; }
  643. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  644. return {p, std::errc::result_out_of_range};
  645. }
  646. result = result * base + digit;
  647. }
  648. if (p == first || (negative && p == first + 1)) {
  649. return {first, std::errc::invalid_argument};
  650. }
  651. value = negative ? T(0) - result : result;
  652. return {p, std::errc{}};
  653. }
  654. // from_chars for double (hand-written, locale-independent)
  655. //
  656. // The only double consumed by this library is the HTTP quality value, whose
  657. // grammar is (RFC 9110 12.4.2):
  658. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  659. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  660. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  661. // '.' always the decimal separator (std::strtod would instead read it from the
  662. // global C locale, mis-parsing q-values once an embedder calls
  663. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  664. // the result to [0, 1], so inputs outside that range need not be distinguished
  665. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  666. // cases that exponent and wide-range handling would introduce.
  667. inline from_chars_result<double> from_chars(const char *first, const char *last,
  668. double &value) {
  669. value = 0.0;
  670. const char *p = first;
  671. // Each 1eN is exactly representable, so a single final division by the
  672. // matching entry yields a correctly-rounded result.
  673. static const double powers_of_ten[] = {
  674. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  675. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  676. const int max_frac_digits =
  677. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  678. // Accumulate digits into a 64-bit integer and remember how many were
  679. // fractional. Two independent caps keep this bounded and safe:
  680. // * accumulation saturates before mantissa could overflow uint64_t, and
  681. // * frac_digits is capped at max_frac_digits so it is always a valid index
  682. // into powers_of_ten (without this an input like "0.000...0" would never
  683. // grow mantissa, so the saturation cap alone would not bound it).
  684. // Both caps only drop digits far beyond the precision a q-value needs; any
  685. // value they would change is well outside [0, 1] and rejected by the caller.
  686. uint64_t mantissa = 0;
  687. int frac_digits = 0;
  688. bool seen_digit = false;
  689. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  690. auto accumulate = [&](char c) {
  691. if (mantissa <= limit) {
  692. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  693. return true;
  694. }
  695. return false;
  696. };
  697. for (; p != last && is_ascii_digit(*p); ++p) {
  698. seen_digit = true;
  699. accumulate(*p);
  700. }
  701. if (p != last && *p == '.') {
  702. ++p;
  703. for (; p != last && is_ascii_digit(*p); ++p) {
  704. seen_digit = true;
  705. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  706. }
  707. }
  708. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  709. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  710. return {p, std::errc{}};
  711. }
  712. inline bool parse_int_in_range(const char *s, size_t len, int lo, int hi,
  713. int &out) {
  714. int val = 0;
  715. auto r = from_chars(s, s + len, val);
  716. if (r.ec != std::errc{} || r.ptr != s + len || val < lo || val > hi) {
  717. return false;
  718. }
  719. out = val;
  720. return true;
  721. }
  722. inline bool parse_port(const char *s, size_t len, int &port) {
  723. return parse_int_in_range(s, len, 1, 65535, port);
  724. }
  725. inline bool parse_port(const std::string &s, int &port) {
  726. return parse_port(s.data(), s.size(), port);
  727. }
  728. struct UrlComponents {
  729. std::string scheme;
  730. std::string host;
  731. std::string port;
  732. std::string path;
  733. std::string query;
  734. };
  735. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  736. uc = {};
  737. size_t pos = 0;
  738. auto sep = url.find("://");
  739. if (sep != std::string::npos) {
  740. uc.scheme = url.substr(0, sep);
  741. // Scheme must be [a-z]+ only
  742. if (uc.scheme.empty()) { return false; }
  743. for (auto c : uc.scheme) {
  744. if (c < 'a' || c > 'z') { return false; }
  745. }
  746. pos = sep + 3;
  747. } else if (url.compare(0, 2, "//") == 0) {
  748. pos = 2;
  749. }
  750. auto has_authority_prefix = pos > 0;
  751. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  752. url[0] != '?' && url[0] != '#');
  753. if (has_authority) {
  754. // userinfo is not supported, and a backslash that some parsers take for
  755. // '/' would leave them seeing another host than this one.
  756. if (url.find_first_of("@\\", pos) < url.find_first_of("/?#", pos)) {
  757. return false;
  758. }
  759. if (pos < url.size() && url[pos] == '[') {
  760. auto close = url.find(']', pos);
  761. if (close == std::string::npos) { return false; }
  762. uc.host = url.substr(pos + 1, close - pos - 1);
  763. // IPv6 host must be [a-fA-F0-9:]+ only
  764. if (uc.host.empty()) { return false; }
  765. for (auto c : uc.host) {
  766. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  767. (c >= 'A' && c <= 'F') || c == ':')) {
  768. return false;
  769. }
  770. }
  771. pos = close + 1;
  772. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  773. // path, query or fragment delimiter (or the end of input). Otherwise the
  774. // trailing bytes would be folded into the path while the connection
  775. // still targets the bracketed address.
  776. if (pos < url.size()) {
  777. auto c = url[pos];
  778. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  779. }
  780. } else {
  781. auto end = url.find_first_of(":/?#", pos);
  782. if (end == std::string::npos) { end = url.size(); }
  783. uc.host = url.substr(pos, end - pos);
  784. pos = end;
  785. }
  786. if (pos < url.size() && url[pos] == ':') {
  787. ++pos;
  788. auto end = url.find_first_of("/?#", pos);
  789. if (end == std::string::npos) { end = url.size(); }
  790. uc.port = url.substr(pos, end - pos);
  791. pos = end;
  792. }
  793. // Without :// or //, the entire input must be consumed as host[:port].
  794. // If there is leftover (path, query, etc.), this is not a valid
  795. // host[:port] string — clear and reparse as a plain path.
  796. if (!has_authority_prefix && pos < url.size()) {
  797. uc.host.clear();
  798. uc.port.clear();
  799. pos = 0;
  800. }
  801. }
  802. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  803. auto end = url.find_first_of("?#", pos);
  804. if (end == std::string::npos) { end = url.size(); }
  805. uc.path = url.substr(pos, end - pos);
  806. pos = end;
  807. }
  808. if (pos < url.size() && url[pos] == '?') {
  809. auto end = url.find('#', pos);
  810. if (end == std::string::npos) { end = url.size(); }
  811. uc.query = url.substr(pos, end - pos);
  812. }
  813. return true;
  814. }
  815. // Resolves a relative-path or query-only Location value against the path of
  816. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  817. // references starting with '/' are returned unchanged.
  818. inline std::string resolve_relative_location(const std::string &location,
  819. const std::string &base) {
  820. if (location.empty() || location[0] == '/') { return location; }
  821. // A ':' in the first segment means the value has a scheme.
  822. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  823. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  824. auto base_path = base.substr(0, base.find_first_of("?#"));
  825. if (location[0] == '?') { return base_path + location; }
  826. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  827. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  828. // Remove "." and ".." segments from the merged path.
  829. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  830. std::string path;
  831. size_t i = 0;
  832. while (i < path_end) {
  833. auto next = (std::min)(merged.find('/', i + 1), path_end);
  834. auto segment = merged.substr(i + 1, next - i - 1);
  835. auto is_last = next == path_end;
  836. if (segment == "." || segment == "..") {
  837. if (segment == "..") {
  838. path.erase((std::min)(path.rfind('/'), path.size()));
  839. }
  840. if (is_last) { path += '/'; }
  841. } else {
  842. path += '/';
  843. path += segment;
  844. }
  845. i = next;
  846. }
  847. if (path.empty()) { path = "/"; }
  848. return path + merged.substr(path_end);
  849. }
  850. } // namespace detail
  851. enum class SSLVerifierResponse {
  852. // no decision has been made, use the built-in certificate verifier
  853. NoDecisionMade,
  854. // connection certificate is verified and accepted
  855. CertificateAccepted,
  856. // connection certificate was processed but is rejected
  857. CertificateRejected
  858. };
  859. // System CA loading policy for SSL clients. Auto (the default) loads system
  860. // CA certs only when no custom CA is configured; enable_system_ca() switches
  861. // to an explicit policy.
  862. enum class SystemCAMode { Auto, Enabled, Disabled };
  863. enum StatusCode {
  864. // Information responses
  865. Continue_100 = 100,
  866. SwitchingProtocol_101 = 101,
  867. Processing_102 = 102,
  868. EarlyHints_103 = 103,
  869. // Successful responses
  870. OK_200 = 200,
  871. Created_201 = 201,
  872. Accepted_202 = 202,
  873. NonAuthoritativeInformation_203 = 203,
  874. NoContent_204 = 204,
  875. ResetContent_205 = 205,
  876. PartialContent_206 = 206,
  877. MultiStatus_207 = 207,
  878. AlreadyReported_208 = 208,
  879. IMUsed_226 = 226,
  880. // Redirection messages
  881. MultipleChoices_300 = 300,
  882. MovedPermanently_301 = 301,
  883. Found_302 = 302,
  884. SeeOther_303 = 303,
  885. NotModified_304 = 304,
  886. UseProxy_305 = 305,
  887. unused_306 = 306,
  888. TemporaryRedirect_307 = 307,
  889. PermanentRedirect_308 = 308,
  890. // Client error responses
  891. BadRequest_400 = 400,
  892. Unauthorized_401 = 401,
  893. PaymentRequired_402 = 402,
  894. Forbidden_403 = 403,
  895. NotFound_404 = 404,
  896. MethodNotAllowed_405 = 405,
  897. NotAcceptable_406 = 406,
  898. ProxyAuthenticationRequired_407 = 407,
  899. RequestTimeout_408 = 408,
  900. Conflict_409 = 409,
  901. Gone_410 = 410,
  902. LengthRequired_411 = 411,
  903. PreconditionFailed_412 = 412,
  904. PayloadTooLarge_413 = 413,
  905. UriTooLong_414 = 414,
  906. UnsupportedMediaType_415 = 415,
  907. RangeNotSatisfiable_416 = 416,
  908. ExpectationFailed_417 = 417,
  909. ImATeapot_418 = 418,
  910. MisdirectedRequest_421 = 421,
  911. UnprocessableContent_422 = 422,
  912. Locked_423 = 423,
  913. FailedDependency_424 = 424,
  914. TooEarly_425 = 425,
  915. UpgradeRequired_426 = 426,
  916. PreconditionRequired_428 = 428,
  917. TooManyRequests_429 = 429,
  918. RequestHeaderFieldsTooLarge_431 = 431,
  919. UnavailableForLegalReasons_451 = 451,
  920. // Server error responses
  921. InternalServerError_500 = 500,
  922. NotImplemented_501 = 501,
  923. BadGateway_502 = 502,
  924. ServiceUnavailable_503 = 503,
  925. GatewayTimeout_504 = 504,
  926. HttpVersionNotSupported_505 = 505,
  927. VariantAlsoNegotiates_506 = 506,
  928. InsufficientStorage_507 = 507,
  929. LoopDetected_508 = 508,
  930. NotExtended_510 = 510,
  931. NetworkAuthenticationRequired_511 = 511,
  932. };
  933. namespace detail {
  934. // A multimap that keeps its entries in the order they were inserted.
  935. //
  936. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  937. // fields sharing a field name significant and forbids a proxy from reordering
  938. // them, and a query string's parameters are meaningful in the order the caller
  939. // wrote them. Neither standard container expresses it: std::unordered_multimap
  940. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  941. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  942. // key, which would drop control data such as Host behind whatever else the
  943. // message carries and alphabetise a query string.
  944. //
  945. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  946. // scan, which beats hashing for the handful of entries a message carries
  947. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  948. //
  949. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  950. // Params, whose parameter names are case-sensitive, not.
  951. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  952. public:
  953. using key_type = std::string;
  954. using mapped_type = Mapped;
  955. using value_type = std::pair<std::string, Mapped>;
  956. using size_type = std::size_t;
  957. using difference_type = std::ptrdiff_t;
  958. using reference = value_type &;
  959. using const_reference = const value_type &;
  960. private:
  961. static size_type npos() { return static_cast<size_type>(-1); }
  962. static bool keys_equal(const std::string &a, const std::string &b) {
  963. return KeyEqual()(a, b);
  964. }
  965. // Iterating yields every entry in insertion order, but equal_range() and
  966. // find() have to walk only the entries sharing one key, which are not
  967. // adjacent. Both are the same iterator type: key_idx_ selects between the
  968. // two traversals, and since equality compares only the position, an iterator
  969. // restricted to one key still compares equal to end().
  970. template <typename V> class iterator_t {
  971. public:
  972. using iterator_category = std::bidirectional_iterator_tag;
  973. using value_type = insertion_ordered_multimap::value_type;
  974. using difference_type = insertion_ordered_multimap::difference_type;
  975. using pointer = V *;
  976. using reference = V &;
  977. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  978. template <typename U,
  979. typename std::enable_if<std::is_convertible<U *, V *>::value,
  980. int>::type = 0>
  981. iterator_t(const iterator_t<U> &rhs)
  982. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  983. key_idx_(rhs.key_idx_) {}
  984. reference operator*() const { return data_[idx_]; }
  985. pointer operator->() const { return data_ + idx_; }
  986. iterator_t &operator++() {
  987. // Saturating, so that advancing past the last entry of a key stays at
  988. // end() instead of running off the container.
  989. if (idx_ >= size_) { return *this; }
  990. ++idx_;
  991. if (key_idx_ != npos()) {
  992. while (idx_ < size_ && !matches(idx_)) {
  993. ++idx_;
  994. }
  995. }
  996. return *this;
  997. }
  998. iterator_t operator++(int) {
  999. auto tmp = *this;
  1000. ++*this;
  1001. return tmp;
  1002. }
  1003. iterator_t &operator--() {
  1004. if (idx_ == 0) { return *this; }
  1005. --idx_;
  1006. if (key_idx_ != npos()) {
  1007. while (idx_ > 0 && !matches(idx_)) {
  1008. --idx_;
  1009. }
  1010. }
  1011. return *this;
  1012. }
  1013. iterator_t operator--(int) {
  1014. auto tmp = *this;
  1015. --*this;
  1016. return tmp;
  1017. }
  1018. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  1019. return idx_ == rhs.idx_;
  1020. }
  1021. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  1022. return idx_ != rhs.idx_;
  1023. }
  1024. private:
  1025. friend class insertion_ordered_multimap;
  1026. template <typename> friend class iterator_t;
  1027. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1028. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1029. bool matches(size_type i) const {
  1030. return keys_equal(data_[i].first, data_[key_idx_].first);
  1031. }
  1032. V *data_;
  1033. size_type idx_;
  1034. size_type size_;
  1035. size_type key_idx_;
  1036. };
  1037. public:
  1038. using iterator = iterator_t<value_type>;
  1039. using const_iterator = iterator_t<const value_type>;
  1040. insertion_ordered_multimap() = default;
  1041. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1042. : entries_(il) {}
  1043. template <typename InputIt>
  1044. insertion_ordered_multimap(InputIt first, InputIt last)
  1045. : entries_(first, last) {}
  1046. iterator begin() { return make_iter(0, npos()); }
  1047. iterator end() { return make_iter(entries_.size(), npos()); }
  1048. const_iterator begin() const { return make_citer(0, npos()); }
  1049. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1050. const_iterator cbegin() const { return begin(); }
  1051. const_iterator cend() const { return end(); }
  1052. bool empty() const { return entries_.empty(); }
  1053. size_type size() const { return entries_.size(); }
  1054. void clear() { entries_.clear(); }
  1055. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1056. iterator insert(const value_type &val) {
  1057. entries_.push_back(val);
  1058. return make_iter(entries_.size() - 1, npos());
  1059. }
  1060. iterator insert(value_type &&val) {
  1061. entries_.push_back(std::move(val));
  1062. return make_iter(entries_.size() - 1, npos());
  1063. }
  1064. template <typename... Args> iterator emplace(Args &&...args) {
  1065. entries_.emplace_back(std::forward<Args>(args)...);
  1066. return make_iter(entries_.size() - 1, npos());
  1067. }
  1068. // For entries that have to lead the message, such as the Host header field
  1069. // (RFC 9110 5.3 recommends sending control data first).
  1070. template <typename... Args> iterator emplace_front(Args &&...args) {
  1071. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1072. return make_iter(0, npos());
  1073. }
  1074. iterator find(const std::string &key) {
  1075. auto i = index_of(key);
  1076. return i == npos() ? end() : make_iter(i, i);
  1077. }
  1078. const_iterator find(const std::string &key) const {
  1079. auto i = index_of(key);
  1080. return i == npos() ? end() : make_citer(i, i);
  1081. }
  1082. size_type count(const std::string &key) const {
  1083. size_type n = 0;
  1084. for (const auto &entry : entries_) {
  1085. if (keys_equal(entry.first, key)) { n++; }
  1086. }
  1087. return n;
  1088. }
  1089. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1090. auto i = index_of(key);
  1091. return i == npos() ? std::make_pair(end(), end())
  1092. : std::make_pair(make_iter(i, i), end());
  1093. }
  1094. std::pair<const_iterator, const_iterator>
  1095. equal_range(const std::string &key) const {
  1096. auto i = index_of(key);
  1097. return i == npos() ? std::make_pair(end(), end())
  1098. : std::make_pair(make_citer(i, i), end());
  1099. }
  1100. size_type erase(const std::string &key) {
  1101. auto before = entries_.size();
  1102. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1103. [&](const value_type &entry) {
  1104. return keys_equal(entry.first, key);
  1105. }),
  1106. entries_.end());
  1107. return before - entries_.size();
  1108. }
  1109. iterator erase(const_iterator pos) {
  1110. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1111. return make_iter(pos.idx_, npos());
  1112. }
  1113. // Erases what iterating [first, last) would actually visit, so erasing an
  1114. // equal_range() removes only the entries with that key, not everything
  1115. // positioned between them.
  1116. iterator erase(const_iterator first, const_iterator last) {
  1117. auto from = first.idx_;
  1118. auto to = last.idx_;
  1119. if (from >= to) { return make_iter(from, npos()); }
  1120. auto begin_it = entries_.begin();
  1121. auto from_it = begin_it + static_cast<difference_type>(from);
  1122. auto to_it = begin_it + static_cast<difference_type>(to);
  1123. if (first.key_idx_ == npos()) {
  1124. entries_.erase(from_it, to_it);
  1125. } else {
  1126. auto key = entries_[first.key_idx_].first;
  1127. auto keep = from_it;
  1128. for (auto it = from_it; it != to_it; ++it) {
  1129. if (!keys_equal(it->first, key)) {
  1130. if (keep != it) { *keep = std::move(*it); }
  1131. ++keep;
  1132. }
  1133. }
  1134. if (keep != to_it) {
  1135. keep = std::move(to_it, entries_.end(), keep);
  1136. } else {
  1137. keep = entries_.end();
  1138. }
  1139. entries_.erase(keep, entries_.end());
  1140. }
  1141. return make_iter(from, npos());
  1142. }
  1143. friend bool operator==(const insertion_ordered_multimap &lhs,
  1144. const insertion_ordered_multimap &rhs) {
  1145. return lhs.entries_ == rhs.entries_;
  1146. }
  1147. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1148. const insertion_ordered_multimap &rhs) {
  1149. return !(lhs == rhs);
  1150. }
  1151. private:
  1152. size_type index_of(const std::string &key) const {
  1153. for (size_type i = 0; i < entries_.size(); i++) {
  1154. if (keys_equal(entries_[i].first, key)) { return i; }
  1155. }
  1156. return npos();
  1157. }
  1158. iterator make_iter(size_type idx, size_type key_idx) {
  1159. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1160. }
  1161. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1162. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1163. }
  1164. std::vector<value_type> entries_;
  1165. };
  1166. } // namespace detail
  1167. using Headers =
  1168. detail::insertion_ordered_multimap<std::string,
  1169. detail::case_ignore::equal_to>;
  1170. // Query parameter names are case-sensitive, unlike header field names.
  1171. using Params =
  1172. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1173. using Match = std::smatch;
  1174. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1175. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1176. /*
  1177. * detail: type-erased storage used by UserData.
  1178. * ABI-stable regardless of C++ standard — always uses this custom
  1179. * implementation instead of std::any.
  1180. */
  1181. namespace detail {
  1182. using any_type_id = const void *;
  1183. template <typename T> any_type_id any_typeid() noexcept {
  1184. static const char id = 0;
  1185. return &id;
  1186. }
  1187. struct any_storage {
  1188. virtual ~any_storage() = default;
  1189. virtual std::unique_ptr<any_storage> clone() const = 0;
  1190. virtual any_type_id type_id() const noexcept = 0;
  1191. };
  1192. template <typename T> struct any_value final : any_storage {
  1193. T value;
  1194. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1195. std::unique_ptr<any_storage> clone() const override {
  1196. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1197. }
  1198. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1199. };
  1200. } // namespace detail
  1201. class UserData {
  1202. public:
  1203. UserData() = default;
  1204. UserData(UserData &&) noexcept = default;
  1205. UserData &operator=(UserData &&) noexcept = default;
  1206. UserData(const UserData &o) {
  1207. for (const auto &e : o.entries_) {
  1208. if (e.second) { entries_[e.first] = e.second->clone(); }
  1209. }
  1210. }
  1211. UserData &operator=(const UserData &o) {
  1212. if (this != &o) {
  1213. entries_.clear();
  1214. for (const auto &e : o.entries_) {
  1215. if (e.second) { entries_[e.first] = e.second->clone(); }
  1216. }
  1217. }
  1218. return *this;
  1219. }
  1220. template <typename T> void set(const std::string &key, T &&value) {
  1221. using D = typename std::decay<T>::type;
  1222. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1223. }
  1224. template <typename T> T *get(const std::string &key) noexcept {
  1225. auto it = entries_.find(key);
  1226. if (it == entries_.end() || !it->second) { return nullptr; }
  1227. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1228. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1229. }
  1230. template <typename T> const T *get(const std::string &key) const noexcept {
  1231. auto it = entries_.find(key);
  1232. if (it == entries_.end() || !it->second) { return nullptr; }
  1233. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1234. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1235. }
  1236. bool has(const std::string &key) const noexcept {
  1237. return entries_.find(key) != entries_.end();
  1238. }
  1239. void erase(const std::string &key) { entries_.erase(key); }
  1240. void clear() noexcept { entries_.clear(); }
  1241. private:
  1242. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1243. entries_;
  1244. };
  1245. struct Response;
  1246. using ResponseHandler = std::function<bool(const Response &response)>;
  1247. struct FormData {
  1248. std::string name;
  1249. std::string content;
  1250. std::string filename;
  1251. std::string content_type;
  1252. Headers headers;
  1253. };
  1254. struct FormField {
  1255. std::string name;
  1256. std::string content;
  1257. Headers headers;
  1258. };
  1259. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1260. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1261. // should see the parts as they were sent. A std::multimap sorts by field name
  1262. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1263. // than the case-insensitive predicate Headers uses.
  1264. using FormFields =
  1265. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1266. using FormFiles =
  1267. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1268. struct MultipartFormData {
  1269. FormFields fields; // Text fields from multipart
  1270. FormFiles files; // Files from multipart
  1271. // Text field access
  1272. std::string get_field(const std::string &key, size_t id = 0) const;
  1273. std::vector<std::string> get_fields(const std::string &key) const;
  1274. bool has_field(const std::string &key) const;
  1275. size_t get_field_count(const std::string &key) const;
  1276. // File access
  1277. FormData get_file(const std::string &key, size_t id = 0) const;
  1278. std::vector<FormData> get_files(const std::string &key) const;
  1279. bool has_file(const std::string &key) const;
  1280. size_t get_file_count(const std::string &key) const;
  1281. };
  1282. struct UploadFormData {
  1283. std::string name;
  1284. std::string content;
  1285. std::string filename;
  1286. std::string content_type;
  1287. };
  1288. using UploadFormDataItems = std::vector<UploadFormData>;
  1289. class DataSink {
  1290. public:
  1291. DataSink() : os(&sb_), sb_(*this) {}
  1292. DataSink(const DataSink &) = delete;
  1293. DataSink &operator=(const DataSink &) = delete;
  1294. DataSink(DataSink &&) = delete;
  1295. DataSink &operator=(DataSink &&) = delete;
  1296. std::function<bool(const char *data, size_t data_len)> write;
  1297. // Only `write` is mandatory. The rest are defaulted so that a provider
  1298. // calling one on a writer that does not set it gets sensible behaviour
  1299. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1300. // `this` is safe: DataSink is neither copyable nor movable.
  1301. std::function<bool()> is_writable = []() { return true; };
  1302. std::function<void()> done = []() {};
  1303. std::function<void(const Headers &trailer)> done_with_trailer =
  1304. [this](const Headers & /*trailer*/) { done(); };
  1305. std::ostream os;
  1306. private:
  1307. class data_sink_streambuf final : public std::streambuf {
  1308. public:
  1309. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1310. protected:
  1311. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1312. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1313. return 0;
  1314. }
  1315. private:
  1316. DataSink &sink_;
  1317. };
  1318. data_sink_streambuf sb_;
  1319. };
  1320. using ContentProvider =
  1321. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1322. using ContentProviderWithoutLength =
  1323. std::function<bool(size_t offset, DataSink &sink)>;
  1324. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1325. struct FormDataProvider {
  1326. std::string name;
  1327. ContentProviderWithoutLength provider;
  1328. std::string filename;
  1329. std::string content_type;
  1330. };
  1331. using FormDataProviderItems = std::vector<FormDataProvider>;
  1332. inline FormDataProvider
  1333. make_file_provider(const std::string &name, const std::string &filepath,
  1334. const std::string &filename = std::string(),
  1335. const std::string &content_type = std::string()) {
  1336. FormDataProvider fdp;
  1337. fdp.name = name;
  1338. fdp.filename = filename.empty() ? filepath : filename;
  1339. fdp.content_type = content_type;
  1340. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1341. std::ifstream f(filepath, std::ios::binary);
  1342. if (!f) { return false; }
  1343. if (offset > 0) {
  1344. f.seekg(static_cast<std::streamoff>(offset));
  1345. if (!f.good()) {
  1346. sink.done();
  1347. return true;
  1348. }
  1349. }
  1350. char buf[8192];
  1351. f.read(buf, sizeof(buf));
  1352. auto n = static_cast<size_t>(f.gcount());
  1353. if (n > 0) { return sink.write(buf, n); }
  1354. sink.done(); // EOF
  1355. return true;
  1356. };
  1357. return fdp;
  1358. }
  1359. inline std::pair<size_t, ContentProvider>
  1360. make_file_body(const std::string &filepath) {
  1361. size_t size = 0;
  1362. {
  1363. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1364. if (!f) { return {0, ContentProvider{}}; }
  1365. size = static_cast<size_t>(f.tellg());
  1366. }
  1367. ContentProvider provider = [filepath](size_t offset, size_t length,
  1368. DataSink &sink) -> bool {
  1369. std::ifstream f(filepath, std::ios::binary);
  1370. if (!f) { return false; }
  1371. f.seekg(static_cast<std::streamoff>(offset));
  1372. if (!f.good()) { return false; }
  1373. char buf[8192];
  1374. while (length > 0) {
  1375. auto to_read = (std::min)(sizeof(buf), length);
  1376. f.read(buf, static_cast<std::streamsize>(to_read));
  1377. auto n = static_cast<size_t>(f.gcount());
  1378. // The file is shorter than the size make_file_body() measured, which the
  1379. // caller has already committed to as Content-Length. The body cannot be
  1380. // completed, so fail as every other error here does.
  1381. if (n == 0) { return false; }
  1382. if (!sink.write(buf, n)) { return false; }
  1383. length -= n;
  1384. }
  1385. return true;
  1386. };
  1387. return {size, std::move(provider)};
  1388. }
  1389. using ContentReceiverWithProgress = std::function<bool(
  1390. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1391. using ContentReceiver =
  1392. std::function<bool(const char *data, size_t data_length)>;
  1393. using FormDataHeader = std::function<bool(const FormData &file)>;
  1394. class ContentReader {
  1395. public:
  1396. using Reader = std::function<bool(ContentReceiver receiver)>;
  1397. using FormDataReader =
  1398. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1399. ContentReader(Reader reader, FormDataReader multipart_reader)
  1400. : reader_(std::move(reader)),
  1401. formdata_reader_(std::move(multipart_reader)) {}
  1402. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1403. return formdata_reader_(std::move(header), std::move(receiver));
  1404. }
  1405. bool operator()(ContentReceiver receiver) const {
  1406. return reader_(std::move(receiver));
  1407. }
  1408. Reader reader_;
  1409. FormDataReader formdata_reader_;
  1410. };
  1411. using Range = std::pair<ssize_t, ssize_t>;
  1412. using Ranges = std::vector<Range>;
  1413. #ifdef CPPHTTPLIB_SSL_ENABLED
  1414. // TLS abstraction layer - public type definitions and API
  1415. namespace tls {
  1416. // Opaque handles (defined as void* for abstraction)
  1417. using ctx_t = void *;
  1418. using session_t = void *;
  1419. using const_session_t = const void *; // For read-only session access
  1420. using cert_t = void *;
  1421. using ca_store_t = void *;
  1422. // TLS versions
  1423. enum class Version {
  1424. TLS1_2 = 0x0303,
  1425. TLS1_3 = 0x0304,
  1426. };
  1427. // Subject Alternative Names (SAN) entry types
  1428. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1429. // SAN entry structure
  1430. struct SanEntry {
  1431. SanType type;
  1432. std::string value;
  1433. };
  1434. // Verification context for certificate verification callback
  1435. struct VerifyContext {
  1436. session_t session; // TLS session handle
  1437. cert_t cert; // Current certificate being verified
  1438. int depth; // Certificate chain depth (0 = leaf)
  1439. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1440. long error_code; // Backend-specific error code (0 = no error)
  1441. const char *error_string; // Human-readable error description
  1442. // Certificate introspection methods
  1443. std::string subject_cn() const;
  1444. std::string issuer_name() const;
  1445. bool check_hostname(const char *hostname) const;
  1446. std::vector<SanEntry> sans() const;
  1447. bool validity(time_t &not_before, time_t &not_after) const;
  1448. std::string serial() const;
  1449. };
  1450. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1451. // TlsError codes for TLS operations (backend-independent)
  1452. enum class ErrorCode : int {
  1453. Success = 0,
  1454. WantRead, // Non-blocking: need to wait for read
  1455. WantWrite, // Non-blocking: need to wait for write
  1456. PeerClosed, // Peer closed the connection
  1457. Fatal, // Unrecoverable error
  1458. SyscallError, // System call error (check sys_errno)
  1459. CertVerifyFailed, // Certificate verification failed
  1460. HostnameMismatch, // Hostname verification failed
  1461. };
  1462. // TLS error information
  1463. struct TlsError {
  1464. ErrorCode code = ErrorCode::Fatal;
  1465. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1466. int sys_errno = 0; // errno when SyscallError
  1467. // Convert verification error code to human-readable string
  1468. static std::string verify_error_to_string(long error_code);
  1469. };
  1470. // RAII wrapper for peer certificate
  1471. class PeerCert {
  1472. public:
  1473. PeerCert();
  1474. PeerCert(PeerCert &&other) noexcept;
  1475. PeerCert &operator=(PeerCert &&other) noexcept;
  1476. ~PeerCert();
  1477. PeerCert(const PeerCert &) = delete;
  1478. PeerCert &operator=(const PeerCert &) = delete;
  1479. explicit operator bool() const;
  1480. std::string subject_cn() const;
  1481. std::string issuer_name() const;
  1482. bool check_hostname(const char *hostname) const;
  1483. std::vector<SanEntry> sans() const;
  1484. bool validity(time_t &not_before, time_t &not_after) const;
  1485. std::string serial() const;
  1486. private:
  1487. explicit PeerCert(cert_t cert);
  1488. cert_t cert_ = nullptr;
  1489. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1490. };
  1491. // Callback for TLS context setup (used by SSLServer constructor)
  1492. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1493. } // namespace tls
  1494. #endif
  1495. struct Request {
  1496. std::string method;
  1497. std::string path;
  1498. std::string matched_route;
  1499. Params params;
  1500. Headers headers;
  1501. Headers trailers;
  1502. std::string body;
  1503. std::string remote_addr;
  1504. int remote_port = -1;
  1505. std::string local_addr;
  1506. int local_port = -1;
  1507. // for server
  1508. std::string version;
  1509. std::string target;
  1510. MultipartFormData form;
  1511. Ranges ranges;
  1512. Match matches;
  1513. std::unordered_map<std::string, std::string> path_params;
  1514. std::function<bool()> is_connection_closed = []() { return true; };
  1515. // for client
  1516. std::vector<std::string> accept_content_types;
  1517. ResponseHandler response_handler;
  1518. ContentReceiverWithProgress content_receiver;
  1519. DownloadProgress download_progress;
  1520. UploadProgress upload_progress;
  1521. bool has_header(const std::string &key) const;
  1522. std::string get_header_value(const std::string &key, const char *def = "",
  1523. size_t id = 0) const;
  1524. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1525. size_t id = 0) const;
  1526. size_t get_header_value_count(const std::string &key) const;
  1527. void set_header(const std::string &key, const std::string &val);
  1528. bool has_trailer(const std::string &key) const;
  1529. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1530. size_t get_trailer_value_count(const std::string &key) const;
  1531. bool has_param(const std::string &key) const;
  1532. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1533. std::vector<std::string> get_param_values(const std::string &key) const;
  1534. size_t get_param_value_count(const std::string &key) const;
  1535. bool is_multipart_form_data() const;
  1536. // private members...
  1537. bool body_read_started_ = false;
  1538. bool body_consumed_ = false;
  1539. bool expect_100_continue_pending_ = false;
  1540. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1541. size_t content_length_ = 0;
  1542. ContentProvider content_provider_;
  1543. bool is_chunked_content_provider_ = false;
  1544. size_t authorization_count_ = 0;
  1545. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1546. (std::chrono::steady_clock::time_point::min)();
  1547. #ifdef CPPHTTPLIB_SSL_ENABLED
  1548. tls::const_session_t ssl = nullptr;
  1549. tls::PeerCert peer_cert() const;
  1550. std::string sni() const;
  1551. #endif
  1552. };
  1553. namespace detail {
  1554. // Declared up here, away from the rest of the compression helpers, because
  1555. // `Response` stores one.
  1556. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1557. } // namespace detail
  1558. struct Response {
  1559. std::string version;
  1560. int status = -1;
  1561. std::string reason;
  1562. Headers headers;
  1563. Headers trailers;
  1564. std::string body;
  1565. std::string location; // Redirect location
  1566. // User-defined context — set by pre-routing/pre-request handlers and read
  1567. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1568. UserData user_data;
  1569. bool has_header(const std::string &key) const;
  1570. std::string get_header_value(const std::string &key, const char *def = "",
  1571. size_t id = 0) const;
  1572. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1573. size_t id = 0) const;
  1574. size_t get_header_value_count(const std::string &key) const;
  1575. void set_header(const std::string &key, const std::string &val);
  1576. bool has_trailer(const std::string &key) const;
  1577. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1578. size_t get_trailer_value_count(const std::string &key) const;
  1579. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1580. void set_content(const char *s, size_t n, const std::string &content_type);
  1581. void set_content(const std::string &s, const std::string &content_type);
  1582. void set_content(std::string &&s, const std::string &content_type);
  1583. void set_content_provider(
  1584. size_t length, const std::string &content_type, ContentProvider provider,
  1585. ContentProviderResourceReleaser resource_releaser = nullptr);
  1586. void set_content_provider(
  1587. const std::string &content_type, ContentProviderWithoutLength provider,
  1588. ContentProviderResourceReleaser resource_releaser = nullptr);
  1589. void set_chunked_content_provider(
  1590. const std::string &content_type, ContentProviderWithoutLength provider,
  1591. ContentProviderResourceReleaser resource_releaser = nullptr);
  1592. void set_file_content(const std::string &path,
  1593. const std::string &content_type);
  1594. void set_file_content(const std::string &path);
  1595. Response() = default;
  1596. Response(const Response &) = default;
  1597. Response &operator=(const Response &) = default;
  1598. Response(Response &&) = default;
  1599. Response &operator=(Response &&) = default;
  1600. ~Response() {
  1601. if (content_provider_resource_releaser_) {
  1602. content_provider_resource_releaser_(content_provider_success_);
  1603. }
  1604. }
  1605. // private members...
  1606. size_t content_length_ = 0;
  1607. ContentProvider content_provider_;
  1608. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1609. bool is_chunked_content_provider_ = false;
  1610. bool is_file_content_provider_ = false;
  1611. bool content_provider_success_ = false;
  1612. std::string file_content_path_;
  1613. std::string file_content_content_type_;
  1614. // Content coding chosen for the response body, decided once so that the
  1615. // headers and the body cannot disagree: where the file is opened for a
  1616. // file-backed content provider (keeping the ETag honest), and in
  1617. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1618. // for every other kind of response.
  1619. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1620. };
  1621. enum class Error {
  1622. Success = 0,
  1623. Unknown,
  1624. Connection,
  1625. BindIPAddress,
  1626. Read,
  1627. Write,
  1628. ExceedRedirectCount,
  1629. Canceled,
  1630. SSLConnection,
  1631. SSLLoadingCerts,
  1632. SSLServerVerification,
  1633. SSLServerHostnameVerification,
  1634. UnsupportedMultipartBoundaryChars,
  1635. Compression,
  1636. ConnectionTimeout,
  1637. ProxyConnection,
  1638. ConnectionClosed,
  1639. Timeout,
  1640. ResourceExhaustion,
  1641. TooManyFormDataFiles,
  1642. ExceedMaxPayloadSize,
  1643. ExceedUriMaxLength,
  1644. ExceedMaxSocketDescriptorCount,
  1645. InvalidRequestLine,
  1646. InvalidHTTPMethod,
  1647. InvalidHTTPVersion,
  1648. InvalidHeaders,
  1649. MultipartParsing,
  1650. OpenFile,
  1651. Listen,
  1652. GetSockName,
  1653. UnsupportedAddressFamily,
  1654. HTTPParsing,
  1655. InvalidRangeHeader,
  1656. UnsupportedContentEncoding,
  1657. WebSocketHandshake,
  1658. UserCallbackException,
  1659. // For internal use only
  1660. SSLPeerCouldBeClosed_,
  1661. };
  1662. std::string to_string(Error error);
  1663. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1664. class Stream {
  1665. public:
  1666. virtual ~Stream() = default;
  1667. virtual bool is_readable() const = 0;
  1668. virtual bool wait_readable() const = 0;
  1669. virtual bool wait_writable() const = 0;
  1670. virtual bool is_peer_alive() const { return wait_writable(); }
  1671. virtual ssize_t read(char *ptr, size_t size) = 0;
  1672. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1673. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1674. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1675. virtual socket_t socket() const = 0;
  1676. virtual time_t duration() const = 0;
  1677. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1678. (void)sec;
  1679. (void)usec;
  1680. }
  1681. // Bounds the reads from now on to `msec` in total, on top of the timeout of
  1682. // each one. 0 lifts the bound.
  1683. virtual void set_max_timeout(time_t msec) { (void)msec; }
  1684. // Bytes already pulled off the socket and sitting in this stream's own
  1685. // buffer. Exposing them lets a line reader scan for a terminator in one
  1686. // pass instead of asking for a byte at a time. A stream that does no
  1687. // buffering of its own reports none, and readers fall back to read().
  1688. virtual const char *buffered_data(size_t &size) const {
  1689. size = 0;
  1690. return nullptr;
  1691. }
  1692. // Discards `size` bytes previously returned by buffered_data().
  1693. virtual void consume_buffered(size_t size) { (void)size; }
  1694. ssize_t write(const char *ptr);
  1695. ssize_t write(const std::string &s);
  1696. Error get_error() const { return error_; }
  1697. protected:
  1698. Error error_ = Error::Success;
  1699. };
  1700. class TaskQueue {
  1701. public:
  1702. TaskQueue() = default;
  1703. virtual ~TaskQueue() = default;
  1704. virtual bool enqueue(std::function<void()> fn) = 0;
  1705. virtual void shutdown() = 0;
  1706. virtual void on_idle() {}
  1707. };
  1708. class ThreadPool final : public TaskQueue {
  1709. public:
  1710. explicit ThreadPool(
  1711. size_t n, size_t max_n = 0, size_t mqr = 0,
  1712. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1713. ThreadPool(const ThreadPool &) = delete;
  1714. ~ThreadPool() override = default;
  1715. bool enqueue(std::function<void()> fn) override;
  1716. void shutdown() override;
  1717. private:
  1718. void worker(bool is_dynamic);
  1719. void move_to_finished(std::thread::id id);
  1720. void cleanup_finished_threads();
  1721. size_t base_thread_count_;
  1722. size_t max_thread_count_;
  1723. size_t max_queued_requests_;
  1724. time_t idle_timeout_sec_;
  1725. size_t idle_thread_count_;
  1726. bool shutdown_;
  1727. std::list<std::function<void()>> jobs_;
  1728. std::vector<std::thread> threads_; // base threads
  1729. std::list<std::thread> dynamic_threads_; // dynamic threads
  1730. std::vector<std::thread>
  1731. finished_threads_; // exited dynamic threads awaiting join
  1732. std::condition_variable cond_;
  1733. std::mutex mutex_;
  1734. };
  1735. using Logger = std::function<void(const Request &, const Response &)>;
  1736. // Forward declaration for Error type
  1737. enum class Error;
  1738. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1739. using SocketOptions = std::function<void(socket_t sock)>;
  1740. void default_socket_options(socket_t sock);
  1741. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1742. const char *status_message(int status);
  1743. std::string to_string(Error error);
  1744. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1745. std::string get_bearer_token_auth(const Request &req);
  1746. namespace detail {
  1747. class MatcherBase {
  1748. public:
  1749. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1750. virtual ~MatcherBase() = default;
  1751. const std::string &pattern() const { return pattern_; }
  1752. // Match request path and populate its matches and
  1753. virtual bool match(Request &request) const = 0;
  1754. private:
  1755. std::string pattern_;
  1756. };
  1757. /**
  1758. * Captures parameters in request path and stores them in Request::path_params
  1759. *
  1760. * Capture name is a substring of a pattern from : to /.
  1761. * The rest of the pattern is matched against the request path directly
  1762. * Parameters are captured starting from the next character after
  1763. * the end of the last matched static pattern fragment until the next /.
  1764. *
  1765. * Example pattern:
  1766. * "/path/fragments/:capture/more/fragments/:second_capture"
  1767. * Static fragments:
  1768. * "/path/fragments/", "more/fragments/"
  1769. *
  1770. * Given the following request path:
  1771. * "/path/fragments/:1/more/fragments/:2"
  1772. * the resulting capture will be
  1773. * {{"capture", "1"}, {"second_capture", "2"}}
  1774. */
  1775. class PathParamsMatcher final : public MatcherBase {
  1776. public:
  1777. PathParamsMatcher(const std::string &pattern);
  1778. bool match(Request &request) const override;
  1779. private:
  1780. // Treat segment separators as the end of path parameter capture
  1781. // Does not need to handle query parameters as they are parsed before path
  1782. // matching
  1783. static constexpr char separator = '/';
  1784. // Contains static path fragments to match against, excluding the '/' after
  1785. // path params
  1786. // Fragments are separated by path params
  1787. std::vector<std::string> static_fragments_;
  1788. // Stores the names of the path parameters to be used as keys in the
  1789. // Request::path_params map
  1790. std::vector<std::string> param_names_;
  1791. };
  1792. /**
  1793. * Performs std::regex_match on request path
  1794. * and stores the result in Request::matches
  1795. *
  1796. * Note that regex match is performed directly on the whole request.
  1797. * This means that wildcard patterns may match multiple path segments with /:
  1798. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1799. */
  1800. class RegexMatcher final : public MatcherBase {
  1801. public:
  1802. RegexMatcher(const std::string &pattern)
  1803. : MatcherBase(pattern), regex_(pattern) {}
  1804. bool match(Request &request) const override;
  1805. private:
  1806. std::regex regex_;
  1807. };
  1808. int close_socket(socket_t sock) noexcept;
  1809. bool is_accept_resource_error();
  1810. bool is_accept_transient_error();
  1811. ssize_t write_headers(Stream &strm, const Headers &headers);
  1812. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1813. time_t usec);
  1814. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1815. const std::string &boundary);
  1816. ContentProvider
  1817. make_multipart_content_provider(const UploadFormDataItems &items,
  1818. const std::string &boundary);
  1819. } // namespace detail
  1820. bool is_valid_multipart_boundary(const std::string &boundary);
  1821. // Serializer for multipart/form-data request bodies. The boundary is owned
  1822. // by the writer so that per-part framing and the final terminator always
  1823. // agree. Field names and filenames are escaped following the WHATWG HTML
  1824. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1825. // in content types.
  1826. class MultipartFormDataWriter {
  1827. public:
  1828. MultipartFormDataWriter();
  1829. // precondition: is_valid_multipart_boundary(boundary)
  1830. explicit MultipartFormDataWriter(std::string boundary);
  1831. const std::string &boundary() const;
  1832. std::string content_type() const;
  1833. // In-memory items -> whole body (known length)
  1834. std::string serialize(const UploadFormDataItems &items) const;
  1835. size_t content_length(const UploadFormDataItems &items) const;
  1836. // Per-part framing for streaming via a content provider
  1837. std::string item_begin(const UploadFormData &item) const;
  1838. static std::string item_end();
  1839. std::string finish() const;
  1840. private:
  1841. std::string boundary_;
  1842. };
  1843. class Server {
  1844. public:
  1845. using Handler = std::function<void(const Request &, Response &)>;
  1846. using ExceptionHandler =
  1847. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1848. enum class HandlerResponse {
  1849. Handled,
  1850. Unhandled,
  1851. };
  1852. using HandlerWithResponse =
  1853. std::function<HandlerResponse(const Request &, Response &)>;
  1854. using HandlerWithContentReader = std::function<void(
  1855. const Request &, Response &, const ContentReader &content_reader)>;
  1856. using Expect100ContinueHandler =
  1857. std::function<int(const Request &, Response &)>;
  1858. using StartHandler = std::function<void()>;
  1859. using WebSocketHandler =
  1860. std::function<void(const Request &, ws::WebSocket &)>;
  1861. using SubProtocolSelector =
  1862. std::function<std::string(const std::vector<std::string> &protocols)>;
  1863. Server();
  1864. virtual ~Server();
  1865. virtual bool is_valid() const;
  1866. Server &Get(const std::string &pattern, Handler handler);
  1867. Server &Post(const std::string &pattern, Handler handler);
  1868. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1869. Server &Put(const std::string &pattern, Handler handler);
  1870. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1871. Server &Patch(const std::string &pattern, Handler handler);
  1872. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1873. Server &Delete(const std::string &pattern, Handler handler);
  1874. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1875. Server &Options(const std::string &pattern, Handler handler);
  1876. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1877. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1878. // server accept it; an unregistered method is still rejected with 400.
  1879. // `method` must be a valid HTTP method token and must not be one of the
  1880. // built-in methods, which have their own registration functions above. A
  1881. // rejected registration makes is_valid() return false, so listen() fails.
  1882. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1883. Handler handler);
  1884. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1885. HandlerWithContentReader handler);
  1886. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1887. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1888. SubProtocolSelector sub_protocol_selector);
  1889. bool set_base_dir(const std::string &dir,
  1890. const std::string &mount_point = std::string());
  1891. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1892. Headers headers = Headers());
  1893. bool remove_mount_point(const std::string &mount_point);
  1894. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1895. const std::string &mime);
  1896. Server &set_default_file_mimetype(const std::string &mime);
  1897. Server &set_file_request_handler(Handler handler);
  1898. template <class ErrorHandlerFunc>
  1899. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1900. return set_error_handler_core(
  1901. std::forward<ErrorHandlerFunc>(handler),
  1902. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1903. }
  1904. Server &set_exception_handler(ExceptionHandler handler);
  1905. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1906. Server &set_post_routing_handler(Handler handler);
  1907. Server &set_pre_request_handler(HandlerWithResponse handler);
  1908. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1909. Server &set_start_handler(StartHandler handler);
  1910. Server &set_logger(Logger logger);
  1911. Server &set_pre_compression_logger(Logger logger);
  1912. Server &set_error_logger(ErrorLogger error_logger);
  1913. Server &set_address_family(int family);
  1914. Server &set_tcp_nodelay(bool on);
  1915. Server &set_ipv6_v6only(bool on);
  1916. Server &set_socket_options(SocketOptions socket_options);
  1917. Server &set_default_headers(Headers headers);
  1918. Server &
  1919. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1920. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1921. Server &set_keep_alive_max_count(size_t count);
  1922. Server &set_keep_alive_timeout(time_t sec);
  1923. template <class Rep, class Period>
  1924. Server &
  1925. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1926. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1927. template <class Rep, class Period>
  1928. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1929. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1930. template <class Rep, class Period>
  1931. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1932. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1933. template <class Rep, class Period>
  1934. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1935. Server &set_payload_max_length(size_t length);
  1936. Server &set_static_file_compression(bool on);
  1937. Server &set_static_file_compression_min_length(size_t length);
  1938. Server &set_static_file_compression_max_length(size_t length);
  1939. Server &set_websocket_ping_interval(time_t sec);
  1940. template <class Rep, class Period>
  1941. Server &set_websocket_ping_interval(
  1942. const std::chrono::duration<Rep, Period> &duration);
  1943. Server &set_websocket_max_missed_pongs(int count);
  1944. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1945. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1946. bool listen_after_bind();
  1947. bool listen(const std::string &host, int port, int socket_flags = 0);
  1948. bool is_running() const;
  1949. void wait_until_ready() const;
  1950. void stop() noexcept;
  1951. void decommission();
  1952. std::function<TaskQueue *(void)> new_task_queue;
  1953. protected:
  1954. bool process_request(Stream &strm, const std::string &remote_addr,
  1955. int remote_port, const std::string &local_addr,
  1956. int local_port, bool close_connection,
  1957. bool &connection_closed,
  1958. const std::function<void(Request &)> &setup_request,
  1959. bool *websocket_upgraded = nullptr);
  1960. // Runs the per-connection serving loop and stops an exception thrown by a
  1961. // user callback from escaping the worker thread.
  1962. //
  1963. // process_request() wraps only routing() in a try/catch. Content providers,
  1964. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1965. // handlers all run outside it, and the task queue calls the job without a
  1966. // catch, so an exception from any of those would terminate the process.
  1967. //
  1968. // No 500 is possible here: by the time a content provider runs, the status
  1969. // line and headers are already on the wire. Report it through the error
  1970. // logger and drop the connection, which is what the peer observes either
  1971. // way. Other connections are unaffected.
  1972. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1973. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1974. return serve();
  1975. #else
  1976. try {
  1977. return serve();
  1978. } catch (...) {
  1979. // The error logger is a user callback too, so it must not be able to
  1980. // throw the guard back open.
  1981. try {
  1982. output_error_log(Error::UserCallbackException, nullptr);
  1983. } catch (...) {}
  1984. return false;
  1985. }
  1986. #endif
  1987. }
  1988. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1989. std::vector<std::string> trusted_proxies_;
  1990. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1991. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1992. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1993. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1994. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1995. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1996. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1997. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1998. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1999. bool static_file_compression_ = false;
  2000. size_t static_file_compression_min_length_ =
  2001. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  2002. size_t static_file_compression_max_length_ =
  2003. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  2004. time_t websocket_ping_interval_sec_ =
  2005. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  2006. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  2007. private:
  2008. using Handlers =
  2009. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  2010. using HandlersForContentReader =
  2011. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  2012. HandlerWithContentReader>>;
  2013. // Both handler tables for one custom method live in a single entry, so that
  2014. // routing() needs only one map lookup per request to reach either of them.
  2015. struct CustomHandlerEntry {
  2016. Handlers handlers;
  2017. HandlersForContentReader handlers_for_content_reader;
  2018. };
  2019. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  2020. static std::unique_ptr<detail::MatcherBase>
  2021. make_matcher(const std::string &pattern);
  2022. static const std::set<std::string> &builtin_methods();
  2023. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  2024. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  2025. template <typename H>
  2026. Server &add_handler(
  2027. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  2028. const std::string &pattern, H handler) {
  2029. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2030. return *this;
  2031. }
  2032. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2033. Server &set_error_handler_core(Handler handler, std::false_type);
  2034. socket_t create_server_socket(const std::string &host, int port,
  2035. int socket_flags,
  2036. SocketOptions socket_options) const;
  2037. int bind_internal(const std::string &host, int port, int socket_flags);
  2038. bool listen_internal();
  2039. bool routing(Request &req, Response &res, Stream &strm);
  2040. bool handle_file_request(Request &req, Response &res);
  2041. bool check_if_not_modified(const Request &req, Response &res,
  2042. const std::string &etag, time_t mtime) const;
  2043. bool check_if_range(Request &req, const std::string &etag,
  2044. time_t mtime) const;
  2045. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2046. Stream &strm);
  2047. bool dispatch_request_for_content_reader(
  2048. Request &req, Response &res, ContentReader content_reader,
  2049. const HandlersForContentReader &handlers) const;
  2050. bool parse_request_line(const char *s, Request &req) const;
  2051. detail::EncodingType static_file_encoding(const Request &req,
  2052. const Response &res,
  2053. const std::string &content_type,
  2054. size_t length) const;
  2055. bool apply_static_file_compression(const Request &req, Response &res) const;
  2056. void apply_ranges(const Request &req, Response &res,
  2057. std::string &content_type, std::string &boundary) const;
  2058. bool write_response(Stream &strm, bool close_connection, Request &req,
  2059. Response &res);
  2060. bool write_response_with_content(Stream &strm, bool close_connection,
  2061. const Request &req, Response &res);
  2062. bool write_response_core(Stream &strm, bool close_connection,
  2063. const Request &req, Response &res,
  2064. bool need_apply_ranges);
  2065. bool write_content_with_provider(Stream &strm, const Request &req,
  2066. Response &res, const std::string &boundary,
  2067. const std::string &content_type);
  2068. bool read_content(Stream &strm, Request &req, Response &res);
  2069. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2070. Response &res,
  2071. ContentReceiver receiver,
  2072. FormDataHeader multipart_header,
  2073. ContentReceiver multipart_receiver);
  2074. bool read_content_core(Stream &strm, Request &req, Response &res,
  2075. ContentReceiver receiver,
  2076. FormDataHeader multipart_header,
  2077. ContentReceiver multipart_receiver) const;
  2078. virtual bool process_and_close_socket(socket_t sock);
  2079. void output_log(const Request &req, const Response &res) const;
  2080. void output_pre_compression_log(const Request &req,
  2081. const Response &res) const;
  2082. void output_error_log(const Error &err, const Request *req) const;
  2083. std::atomic<bool> is_running_{false};
  2084. std::atomic<bool> is_decommissioned{false};
  2085. // Set when CustomRoute() refuses a registration. Written before listen(),
  2086. // read by is_valid() on the same thread, so it needs no synchronization.
  2087. bool has_invalid_registration_ = false;
  2088. struct MountPointEntry {
  2089. std::string mount_point;
  2090. std::string base_dir;
  2091. std::string resolved_base_dir;
  2092. Headers headers;
  2093. };
  2094. std::vector<MountPointEntry> base_dirs_;
  2095. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2096. std::string default_file_mimetype_ = "application/octet-stream";
  2097. Handler file_request_handler_;
  2098. Handlers get_handlers_;
  2099. Handlers post_handlers_;
  2100. HandlersForContentReader post_handlers_for_content_reader_;
  2101. Handlers put_handlers_;
  2102. HandlersForContentReader put_handlers_for_content_reader_;
  2103. Handlers patch_handlers_;
  2104. HandlersForContentReader patch_handlers_for_content_reader_;
  2105. Handlers delete_handlers_;
  2106. HandlersForContentReader delete_handlers_for_content_reader_;
  2107. Handlers options_handlers_;
  2108. CustomHandlers custom_handlers_;
  2109. struct WebSocketHandlerEntry {
  2110. std::unique_ptr<detail::MatcherBase> matcher;
  2111. WebSocketHandler handler;
  2112. SubProtocolSelector sub_protocol_selector;
  2113. };
  2114. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2115. WebSocketHandlers websocket_handlers_;
  2116. HandlerWithResponse error_handler_;
  2117. ExceptionHandler exception_handler_;
  2118. HandlerWithResponse pre_routing_handler_;
  2119. Handler post_routing_handler_;
  2120. HandlerWithResponse pre_request_handler_;
  2121. Expect100ContinueHandler expect_100_continue_handler_;
  2122. StartHandler start_handler_;
  2123. mutable std::mutex logger_mutex_;
  2124. Logger logger_;
  2125. Logger pre_compression_logger_;
  2126. ErrorLogger error_logger_;
  2127. int address_family_ = AF_UNSPEC;
  2128. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2129. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2130. SocketOptions socket_options_ = default_socket_options;
  2131. Headers default_headers_;
  2132. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2133. detail::write_headers;
  2134. };
  2135. class Result {
  2136. public:
  2137. Result() = default;
  2138. Result(std::unique_ptr<Response> &&res, Error err,
  2139. Headers &&request_headers = Headers{})
  2140. : res_(std::move(res)), err_(err),
  2141. request_headers_(std::move(request_headers)) {}
  2142. // Response
  2143. operator bool() const { return res_ != nullptr; }
  2144. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2145. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2146. const Response &value() const { return *res_; }
  2147. Response &value() { return *res_; }
  2148. const Response &operator*() const { return *res_; }
  2149. Response &operator*() { return *res_; }
  2150. const Response *operator->() const { return res_.get(); }
  2151. Response *operator->() { return res_.get(); }
  2152. // Error
  2153. Error error() const { return err_; }
  2154. // Request Headers
  2155. bool has_request_header(const std::string &key) const;
  2156. std::string get_request_header_value(const std::string &key,
  2157. const char *def = "",
  2158. size_t id = 0) const;
  2159. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2160. size_t id = 0) const;
  2161. size_t get_request_header_value_count(const std::string &key) const;
  2162. private:
  2163. std::unique_ptr<Response> res_;
  2164. Error err_ = Error::Unknown;
  2165. Headers request_headers_;
  2166. #ifdef CPPHTTPLIB_SSL_ENABLED
  2167. public:
  2168. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2169. int ssl_error)
  2170. : res_(std::move(res)), err_(err),
  2171. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2172. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2173. int ssl_error, uint64_t ssl_backend_error)
  2174. : res_(std::move(res)), err_(err),
  2175. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2176. ssl_backend_error_(ssl_backend_error) {}
  2177. int ssl_error() const { return ssl_error_; }
  2178. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2179. private:
  2180. int ssl_error_ = 0;
  2181. uint64_t ssl_backend_error_ = 0;
  2182. #endif
  2183. };
  2184. struct ClientConnection {
  2185. socket_t sock = INVALID_SOCKET;
  2186. bool is_open() const { return sock != INVALID_SOCKET; }
  2187. ClientConnection() = default;
  2188. ~ClientConnection();
  2189. ClientConnection(const ClientConnection &) = delete;
  2190. ClientConnection &operator=(const ClientConnection &) = delete;
  2191. ClientConnection(ClientConnection &&other) noexcept
  2192. : sock(other.sock)
  2193. #ifdef CPPHTTPLIB_SSL_ENABLED
  2194. ,
  2195. session(other.session)
  2196. #endif
  2197. {
  2198. other.sock = INVALID_SOCKET;
  2199. #ifdef CPPHTTPLIB_SSL_ENABLED
  2200. other.session = nullptr;
  2201. #endif
  2202. }
  2203. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2204. if (this != &other) {
  2205. sock = other.sock;
  2206. other.sock = INVALID_SOCKET;
  2207. #ifdef CPPHTTPLIB_SSL_ENABLED
  2208. session = other.session;
  2209. other.session = nullptr;
  2210. #endif
  2211. }
  2212. return *this;
  2213. }
  2214. #ifdef CPPHTTPLIB_SSL_ENABLED
  2215. tls::session_t session = nullptr;
  2216. #endif
  2217. };
  2218. namespace detail {
  2219. struct ChunkedDecoder;
  2220. struct BodyReader {
  2221. Stream *stream = nullptr;
  2222. bool has_content_length = false;
  2223. size_t content_length = 0;
  2224. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2225. size_t bytes_read = 0;
  2226. bool chunked = false;
  2227. bool eof = false;
  2228. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2229. Error last_error = Error::Success;
  2230. ssize_t read(char *buf, size_t len);
  2231. bool has_error() const { return last_error != Error::Success; }
  2232. };
  2233. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2234. size_t len) {
  2235. (void)stream;
  2236. return br.read(buf, len);
  2237. }
  2238. class decompressor;
  2239. enum class NoProxyKind {
  2240. Wildcard, // "*"
  2241. HostnameSuffix, // "example.com" or ".example.com"
  2242. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2243. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2244. };
  2245. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2246. // Lets one CIDR matcher cover both families.
  2247. using IPBytes = std::array<uint8_t, 16>;
  2248. struct NoProxyEntry {
  2249. NoProxyKind kind = NoProxyKind::Wildcard;
  2250. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2251. IPBytes net{};
  2252. int prefix_bits = 0;
  2253. };
  2254. struct NormalizedTarget {
  2255. std::string hostname; // lowercase; brackets and trailing dot removed
  2256. bool is_ipv4 = false;
  2257. bool is_ipv6 = false;
  2258. IPBytes ip{};
  2259. };
  2260. } // namespace detail
  2261. class ClientImpl {
  2262. public:
  2263. explicit ClientImpl(const std::string &host);
  2264. explicit ClientImpl(const std::string &host, int port);
  2265. explicit ClientImpl(const std::string &host, int port,
  2266. const std::string &client_cert_path,
  2267. const std::string &client_key_path);
  2268. virtual ~ClientImpl();
  2269. virtual bool is_valid() const;
  2270. struct StreamHandle {
  2271. std::unique_ptr<Response> response;
  2272. Error error = Error::Success;
  2273. StreamHandle() = default;
  2274. StreamHandle(const StreamHandle &) = delete;
  2275. StreamHandle &operator=(const StreamHandle &) = delete;
  2276. StreamHandle(StreamHandle &&) = default;
  2277. StreamHandle &operator=(StreamHandle &&) = default;
  2278. ~StreamHandle() = default;
  2279. bool is_valid() const {
  2280. return response != nullptr && error == Error::Success;
  2281. }
  2282. ssize_t read(char *buf, size_t len);
  2283. void parse_trailers_if_needed();
  2284. Error get_read_error() const { return body_reader_.last_error; }
  2285. bool has_read_error() const { return body_reader_.has_error(); }
  2286. bool trailers_parsed_ = false;
  2287. private:
  2288. friend class ClientImpl;
  2289. ssize_t read_with_decompression(char *buf, size_t len);
  2290. std::unique_ptr<ClientConnection> connection_;
  2291. std::unique_ptr<Stream> socket_stream_;
  2292. Stream *stream_ = nullptr;
  2293. detail::BodyReader body_reader_;
  2294. std::unique_ptr<detail::decompressor> decompressor_;
  2295. std::string decompress_buffer_;
  2296. size_t decompress_offset_ = 0;
  2297. size_t decompressed_bytes_read_ = 0;
  2298. };
  2299. // clang-format off
  2300. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2301. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2302. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2303. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2304. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2305. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2306. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2307. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2308. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2309. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2310. Result Head(const std::string &path);
  2311. Result Head(const std::string &path, const Headers &headers);
  2312. Result Post(const std::string &path);
  2313. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2314. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2317. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2318. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2319. Result Post(const std::string &path, const Params &params);
  2320. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2321. Result Post(const std::string &path, const Headers &headers);
  2322. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2323. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2324. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2325. 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);
  2326. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2327. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2328. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2329. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2330. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2331. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2332. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2333. Result Put(const std::string &path);
  2334. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2335. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2338. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2339. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2340. Result Put(const std::string &path, const Params &params);
  2341. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2342. Result Put(const std::string &path, const Headers &headers);
  2343. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2344. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2345. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2346. 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);
  2347. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2348. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2349. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2350. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2351. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2352. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2353. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2354. Result Patch(const std::string &path);
  2355. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2356. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2357. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2358. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2359. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2360. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2361. Result Patch(const std::string &path, const Params &params);
  2362. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2363. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2364. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2365. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2366. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2367. 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);
  2368. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2369. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2370. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2371. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2372. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2373. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2374. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2375. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2376. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2377. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2378. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2379. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2380. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2381. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2382. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2383. Result Options(const std::string &path);
  2384. Result Options(const std::string &path, const Headers &headers);
  2385. // clang-format on
  2386. // Streaming API: Open a stream for reading response body incrementally
  2387. // Socket ownership is transferred to StreamHandle for true streaming
  2388. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2389. StreamHandle open_stream(const std::string &method, const std::string &path,
  2390. const Params &params = {},
  2391. const Headers &headers = {},
  2392. const std::string &body = {},
  2393. const std::string &content_type = {});
  2394. bool send(Request &req, Response &res, Error &error);
  2395. Result send(const Request &req);
  2396. void stop();
  2397. std::string host() const;
  2398. int port() const;
  2399. size_t is_socket_open() const;
  2400. socket_t socket() const;
  2401. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2402. void set_default_headers(Headers headers);
  2403. void
  2404. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2405. void set_address_family(int family);
  2406. void set_tcp_nodelay(bool on);
  2407. void set_ipv6_v6only(bool on);
  2408. void set_socket_options(SocketOptions socket_options);
  2409. void set_connection_timeout(time_t sec, time_t usec = 0);
  2410. template <class Rep, class Period>
  2411. void
  2412. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2413. void set_read_timeout(time_t sec, time_t usec = 0);
  2414. template <class Rep, class Period>
  2415. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2416. void set_write_timeout(time_t sec, time_t usec = 0);
  2417. template <class Rep, class Period>
  2418. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2419. void set_max_timeout(time_t msec);
  2420. template <class Rep, class Period>
  2421. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2422. void set_basic_auth(const std::string &username, const std::string &password);
  2423. void set_bearer_token_auth(const std::string &token);
  2424. void set_keep_alive(bool on);
  2425. void set_follow_location(bool on);
  2426. void set_path_encode(bool on);
  2427. void set_compress(bool on);
  2428. void set_decompress(bool on);
  2429. void set_payload_max_length(size_t length);
  2430. void set_interface(const std::string &intf);
  2431. void set_proxy(const std::string &host, int port);
  2432. void set_proxy_basic_auth(const std::string &username,
  2433. const std::string &password);
  2434. void set_proxy_bearer_token_auth(const std::string &token);
  2435. void set_no_proxy(const std::vector<std::string> &patterns);
  2436. void set_logger(Logger logger);
  2437. void set_error_logger(ErrorLogger error_logger);
  2438. protected:
  2439. struct Socket {
  2440. socket_t sock = INVALID_SOCKET;
  2441. // For Mbed TLS compatibility: start_time for request timeout tracking
  2442. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2443. bool is_open() const { return sock != INVALID_SOCKET; }
  2444. #ifdef CPPHTTPLIB_SSL_ENABLED
  2445. tls::session_t ssl = nullptr;
  2446. #endif
  2447. };
  2448. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2449. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2450. virtual bool setup_proxy_connection(
  2451. Socket &socket,
  2452. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2453. Response &res, bool &success, Error &error);
  2454. bool is_proxy_enabled_for_host(const std::string &host) const;
  2455. // All of:
  2456. // shutdown_ssl
  2457. // shutdown_socket
  2458. // close_socket
  2459. // disconnect
  2460. // should ONLY be called when socket_mutex_ is locked, and only when
  2461. // no other thread is using the socket.
  2462. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2463. void shutdown_socket(Socket &socket) const;
  2464. void close_socket(Socket &socket);
  2465. void disconnect(bool gracefully);
  2466. bool process_request(Stream &strm, Request &req, Response &res,
  2467. bool close_connection, Error &error);
  2468. bool write_content_with_provider(Stream &strm, const Request &req,
  2469. Error &error) const;
  2470. void output_log(const Request &req, const Response &res) const;
  2471. void output_error_log(const Error &err, const Request *req) const;
  2472. // Socket endpoint information
  2473. const std::string host_;
  2474. const int port_;
  2475. // Current open socket
  2476. Socket socket_;
  2477. mutable std::mutex socket_mutex_;
  2478. std::recursive_mutex request_mutex_;
  2479. // These are all protected under socket_mutex
  2480. size_t socket_requests_in_flight_ = 0;
  2481. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2482. bool socket_should_be_closed_when_request_is_done_ = false;
  2483. // Hostname to connection target map. The value is an IP literal or another
  2484. // hostname; only the connection target changes, never the identity.
  2485. std::map<std::string, std::string> addr_map_;
  2486. // Default headers
  2487. Headers default_headers_;
  2488. // Header writer
  2489. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2490. detail::write_headers;
  2491. // Settings
  2492. std::string client_cert_path_;
  2493. std::string client_key_path_;
  2494. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2495. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2496. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2497. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2498. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2499. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2500. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2501. std::string basic_auth_username_;
  2502. std::string basic_auth_password_;
  2503. std::string bearer_token_auth_token_;
  2504. bool keep_alive_ = false;
  2505. bool follow_location_ = false;
  2506. bool path_encode_ = true;
  2507. int address_family_ = AF_UNSPEC;
  2508. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2509. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2510. SocketOptions socket_options_ = nullptr;
  2511. bool compress_ = false;
  2512. bool decompress_ = true;
  2513. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2514. bool has_payload_max_length_ = false;
  2515. std::string interface_;
  2516. std::string proxy_host_;
  2517. int proxy_port_ = -1;
  2518. std::string proxy_basic_auth_username_;
  2519. std::string proxy_basic_auth_password_;
  2520. std::string proxy_bearer_token_auth_token_;
  2521. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2522. mutable detail::NormalizedTarget host_normalized_;
  2523. mutable bool host_normalized_valid_ = false;
  2524. mutable std::mutex logger_mutex_;
  2525. Logger logger_;
  2526. ErrorLogger error_logger_;
  2527. private:
  2528. bool send_(Request &req, Response &res, Error &error);
  2529. Result send_(Request &&req);
  2530. socket_t create_client_socket(Error &error) const;
  2531. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2532. bool skip_100_continue = true) const;
  2533. bool write_request(Stream &strm, Request &req, bool close_connection,
  2534. Error &error, bool skip_body, bool &rejected_locally);
  2535. bool write_request_body(Stream &strm, Request &req, Error &error);
  2536. void prepare_default_headers(Request &r, bool for_stream,
  2537. const std::string &ct);
  2538. bool redirect(Request &req, Response &res, Error &error);
  2539. bool create_redirect_client(const std::string &scheme,
  2540. const std::string &host, int port, Request &req,
  2541. Response &res, const std::string &path,
  2542. const std::string &location, Error &error);
  2543. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2544. bool handle_request(Stream &strm, Request &req, Response &res,
  2545. bool close_connection, Error &error);
  2546. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2547. Request &req, const char *body, size_t content_length,
  2548. ContentProvider content_provider,
  2549. ContentProviderWithoutLength content_provider_without_length,
  2550. const std::string &content_type, ContentReceiver content_receiver,
  2551. Error &error);
  2552. Result send_with_content_provider_and_receiver(
  2553. const std::string &method, const std::string &path,
  2554. const Headers &headers, const char *body, size_t content_length,
  2555. ContentProvider content_provider,
  2556. ContentProviderWithoutLength content_provider_without_length,
  2557. const std::string &content_type, ContentReceiver content_receiver,
  2558. UploadProgress progress);
  2559. ContentProviderWithoutLength get_multipart_content_provider(
  2560. const std::string &boundary, const UploadFormDataItems &items,
  2561. const FormDataProviderItems &provider_items) const;
  2562. virtual bool
  2563. process_socket(const Socket &socket,
  2564. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2565. std::function<bool(Stream &strm)> callback);
  2566. virtual bool is_ssl() const;
  2567. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2568. #ifdef CPPHTTPLIB_SSL_ENABLED
  2569. public:
  2570. void set_digest_auth(const std::string &username,
  2571. const std::string &password);
  2572. void set_proxy_digest_auth(const std::string &username,
  2573. const std::string &password);
  2574. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2575. const std::string &ca_cert_dir_path = std::string());
  2576. void enable_server_certificate_verification(bool enabled);
  2577. void enable_server_hostname_verification(bool enabled);
  2578. void enable_system_ca(bool enabled);
  2579. protected:
  2580. std::string digest_auth_username_;
  2581. std::string digest_auth_password_;
  2582. std::string proxy_digest_auth_username_;
  2583. std::string proxy_digest_auth_password_;
  2584. std::string ca_cert_file_path_;
  2585. std::string ca_cert_dir_path_;
  2586. bool server_certificate_verification_ = true;
  2587. bool server_hostname_verification_ = true;
  2588. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2589. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2590. int last_ssl_error_ = 0;
  2591. uint64_t last_backend_error_ = 0;
  2592. #endif
  2593. };
  2594. namespace detail {
  2595. // Stands in for a client that Client could not make from its arguments, so a
  2596. // request fails rather than going through a null pointer.
  2597. class InvalidClientImpl final : public ClientImpl {
  2598. public:
  2599. InvalidClientImpl() : ClientImpl(std::string(), 0) {}
  2600. bool is_valid() const override { return false; }
  2601. private:
  2602. bool create_and_connect_socket(Socket &, Error &error) override {
  2603. error = Error::Connection;
  2604. return false;
  2605. }
  2606. };
  2607. } // namespace detail
  2608. class Client {
  2609. public:
  2610. // Universal interface
  2611. explicit Client(const std::string &scheme_host_port);
  2612. explicit Client(const std::string &scheme_host_port,
  2613. const std::string &client_cert_path,
  2614. const std::string &client_key_path);
  2615. // HTTP only interface
  2616. explicit Client(const std::string &host, int port);
  2617. explicit Client(const std::string &host, int port,
  2618. const std::string &client_cert_path,
  2619. const std::string &client_key_path);
  2620. Client(Client &&) = default;
  2621. Client &operator=(Client &&) = default;
  2622. ~Client();
  2623. bool is_valid() const;
  2624. // clang-format off
  2625. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2626. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2627. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2628. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2629. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2630. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2631. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2632. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2633. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2634. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2635. Result Head(const std::string &path);
  2636. Result Head(const std::string &path, const Headers &headers);
  2637. Result Post(const std::string &path);
  2638. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2639. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2642. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2643. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2644. Result Post(const std::string &path, const Params &params);
  2645. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2646. Result Post(const std::string &path, const Headers &headers);
  2647. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2648. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2650. 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);
  2651. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2653. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2654. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2655. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2656. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2657. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2658. Result Put(const std::string &path);
  2659. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2660. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2661. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2662. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2663. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2664. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2665. Result Put(const std::string &path, const Params &params);
  2666. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2667. Result Put(const std::string &path, const Headers &headers);
  2668. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2669. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2670. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2671. 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);
  2672. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2673. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2674. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2675. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2676. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2677. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2678. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2679. Result Patch(const std::string &path);
  2680. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2681. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2682. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2683. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2684. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2685. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2686. Result Patch(const std::string &path, const Params &params);
  2687. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2688. Result Patch(const std::string &path, const Headers &headers);
  2689. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2690. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2691. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2692. 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);
  2693. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2694. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2695. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2696. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2697. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2698. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2699. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2700. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2701. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2702. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2703. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2704. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2705. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2706. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2707. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2708. Result Options(const std::string &path);
  2709. Result Options(const std::string &path, const Headers &headers);
  2710. // clang-format on
  2711. // Streaming API: Open a stream for reading response body incrementally
  2712. // Socket ownership is transferred to StreamHandle for true streaming
  2713. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2714. ClientImpl::StreamHandle open_stream(const std::string &method,
  2715. const std::string &path,
  2716. const Params &params = {},
  2717. const Headers &headers = {},
  2718. const std::string &body = {},
  2719. const std::string &content_type = {});
  2720. bool send(Request &req, Response &res, Error &error);
  2721. Result send(const Request &req);
  2722. void stop();
  2723. std::string host() const;
  2724. int port() const;
  2725. size_t is_socket_open() const;
  2726. socket_t socket() const;
  2727. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2728. void set_default_headers(Headers headers);
  2729. void
  2730. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2731. void set_address_family(int family);
  2732. void set_tcp_nodelay(bool on);
  2733. void set_socket_options(SocketOptions socket_options);
  2734. void set_connection_timeout(time_t sec, time_t usec = 0);
  2735. template <class Rep, class Period>
  2736. void
  2737. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2738. void set_read_timeout(time_t sec, time_t usec = 0);
  2739. template <class Rep, class Period>
  2740. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2741. void set_write_timeout(time_t sec, time_t usec = 0);
  2742. template <class Rep, class Period>
  2743. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2744. void set_max_timeout(time_t msec);
  2745. template <class Rep, class Period>
  2746. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2747. void set_basic_auth(const std::string &username, const std::string &password);
  2748. void set_bearer_token_auth(const std::string &token);
  2749. void set_keep_alive(bool on);
  2750. void set_follow_location(bool on);
  2751. void set_path_encode(bool on);
  2752. void set_compress(bool on);
  2753. void set_decompress(bool on);
  2754. void set_payload_max_length(size_t length);
  2755. void set_interface(const std::string &intf);
  2756. void set_proxy(const std::string &host, int port);
  2757. void set_proxy_basic_auth(const std::string &username,
  2758. const std::string &password);
  2759. void set_proxy_bearer_token_auth(const std::string &token);
  2760. void set_no_proxy(const std::vector<std::string> &patterns);
  2761. void set_logger(Logger logger);
  2762. void set_error_logger(ErrorLogger error_logger);
  2763. private:
  2764. std::unique_ptr<ClientImpl> cli_;
  2765. #ifdef CPPHTTPLIB_SSL_ENABLED
  2766. public:
  2767. void set_digest_auth(const std::string &username,
  2768. const std::string &password);
  2769. void set_proxy_digest_auth(const std::string &username,
  2770. const std::string &password);
  2771. void enable_server_certificate_verification(bool enabled);
  2772. void enable_server_hostname_verification(bool enabled);
  2773. void enable_system_ca(bool enabled);
  2774. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2775. const std::string &ca_cert_dir_path = std::string());
  2776. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2777. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2778. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2779. void set_session_verifier(
  2780. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2781. tls::ctx_t tls_context() const;
  2782. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2783. void enable_windows_certificate_verification(bool enabled);
  2784. #endif
  2785. private:
  2786. bool is_ssl_ = false;
  2787. #endif
  2788. };
  2789. #ifdef CPPHTTPLIB_SSL_ENABLED
  2790. class SSLServer : public Server {
  2791. public:
  2792. SSLServer(const char *cert_path, const char *private_key_path,
  2793. const char *client_ca_cert_file_path = nullptr,
  2794. const char *client_ca_cert_dir_path = nullptr,
  2795. const char *private_key_password = nullptr);
  2796. struct PemMemory {
  2797. const char *cert_pem;
  2798. size_t cert_pem_len;
  2799. const char *key_pem;
  2800. size_t key_pem_len;
  2801. const char *client_ca_pem;
  2802. size_t client_ca_pem_len;
  2803. const char *private_key_password;
  2804. };
  2805. explicit SSLServer(const PemMemory &pem);
  2806. // The callback receives the ctx_t handle which can be cast to the
  2807. // appropriate backend type (SSL_CTX* for OpenSSL,
  2808. // tls::impl::MbedTlsContext* for Mbed TLS)
  2809. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2810. ~SSLServer() override;
  2811. bool is_valid() const override;
  2812. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2813. const char *client_ca_pem = nullptr,
  2814. const char *password = nullptr);
  2815. tls::ctx_t tls_context() const { return ctx_; }
  2816. int ssl_last_error() const { return last_ssl_error_; }
  2817. private:
  2818. bool process_and_close_socket(socket_t sock) override;
  2819. tls::ctx_t ctx_ = nullptr;
  2820. // update_certs_pem() replaces the certificates and CAs that handshakes read
  2821. // from ctx_, so it waits for the handshakes in progress, which their timeout
  2822. // bounds, and new ones wait while it is pending so that they cannot keep it
  2823. // waiting.
  2824. std::mutex ctx_mutex_;
  2825. std::condition_variable ctx_cv_;
  2826. size_t handshakes_in_progress_ = 0;
  2827. size_t updates_pending_ = 0;
  2828. int last_ssl_error_ = 0;
  2829. };
  2830. class SSLClient final : public ClientImpl {
  2831. public:
  2832. explicit SSLClient(const std::string &host);
  2833. explicit SSLClient(const std::string &host, int port);
  2834. explicit SSLClient(const std::string &host, int port,
  2835. const std::string &client_cert_path,
  2836. const std::string &client_key_path,
  2837. const std::string &private_key_password = std::string());
  2838. struct PemMemory {
  2839. const char *cert_pem;
  2840. size_t cert_pem_len;
  2841. const char *key_pem;
  2842. size_t key_pem_len;
  2843. const char *private_key_password;
  2844. };
  2845. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2846. ~SSLClient() override;
  2847. bool is_valid() const override;
  2848. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2849. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2850. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2851. // Post-handshake session verifier (backend-independent)
  2852. void set_session_verifier(
  2853. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2854. tls::ctx_t tls_context() const { return ctx_; }
  2855. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2856. void enable_windows_certificate_verification(bool enabled);
  2857. #endif
  2858. private:
  2859. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2860. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2861. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2862. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2863. bool
  2864. process_socket(const Socket &socket,
  2865. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2866. std::function<bool(Stream &strm)> callback) override;
  2867. bool is_ssl() const override;
  2868. bool setup_proxy_connection(
  2869. Socket &socket,
  2870. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2871. Response &res, bool &success, Error &error) override;
  2872. bool connect_with_proxy(
  2873. Socket &sock,
  2874. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2875. Response &res, bool &success, Error &error);
  2876. bool initialize_ssl(Socket &socket, Error &error);
  2877. void init_ctx();
  2878. void reset_ctx_on_error();
  2879. bool load_certs();
  2880. tls::ctx_t ctx_ = nullptr;
  2881. std::mutex ctx_mutex_;
  2882. std::once_flag initialize_cert_;
  2883. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2884. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2885. // Used to keep custom CA configuration exclusive with system CA loading.
  2886. bool ca_cert_store_set_ = false;
  2887. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2888. // Like ca_cert_store_set_, keeps what ctx_ cannot report back: the verifier
  2889. // set_server_certificate_verifier() installed there.
  2890. tls::VerifyCallback server_certificate_verifier_;
  2891. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2892. bool enable_windows_cert_verification_ = true;
  2893. #endif
  2894. friend class ClientImpl;
  2895. };
  2896. #endif // CPPHTTPLIB_SSL_ENABLED
  2897. namespace detail {
  2898. template <typename T, typename U>
  2899. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2900. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2901. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2902. duration - std::chrono::seconds(sec))
  2903. .count();
  2904. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2905. }
  2906. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2907. return N - 1;
  2908. }
  2909. inline bool is_numeric(const std::string &str) {
  2910. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2911. }
  2912. // std::ranges::next(first, n, last) for C++11
  2913. template <typename It> inline It bounded_next(It first, size_t n, It last) {
  2914. for (; n > 0 && first != last; --n) {
  2915. ++first;
  2916. }
  2917. return first;
  2918. }
  2919. inline size_t get_header_value_u64(const Headers &headers,
  2920. const std::string &key, size_t def,
  2921. size_t id, bool &is_invalid_value) {
  2922. is_invalid_value = false;
  2923. auto rng = headers.equal_range(key);
  2924. auto it = bounded_next(rng.first, id, rng.second);
  2925. if (it != rng.second) {
  2926. if (is_numeric(it->second)) {
  2927. // Parse at size_t width so an out-of-range Content-Length is reported
  2928. // rather than silently saturated/truncated (a value above 2^32 would
  2929. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2930. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2931. size_t val = 0;
  2932. const auto &s = it->second;
  2933. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2934. if (r.ec == std::errc::result_out_of_range) {
  2935. is_invalid_value = true;
  2936. return (std::numeric_limits<size_t>::max)();
  2937. }
  2938. return val;
  2939. } else {
  2940. is_invalid_value = true;
  2941. }
  2942. }
  2943. return def;
  2944. }
  2945. inline size_t get_header_value_u64(const Headers &headers,
  2946. const std::string &key, size_t def,
  2947. size_t id) {
  2948. auto dummy = false;
  2949. return get_header_value_u64(headers, key, def, id, dummy);
  2950. }
  2951. } // namespace detail
  2952. template <class Rep, class Period>
  2953. inline Server &
  2954. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2955. detail::duration_to_sec_and_usec(
  2956. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2957. return *this;
  2958. }
  2959. template <class Rep, class Period>
  2960. inline Server &
  2961. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2962. detail::duration_to_sec_and_usec(
  2963. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2964. return *this;
  2965. }
  2966. template <class Rep, class Period>
  2967. inline Server &
  2968. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2969. detail::duration_to_sec_and_usec(
  2970. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2971. return *this;
  2972. }
  2973. template <class Rep, class Period>
  2974. inline void ClientImpl::set_connection_timeout(
  2975. const std::chrono::duration<Rep, Period> &duration) {
  2976. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2977. set_connection_timeout(sec, usec);
  2978. });
  2979. }
  2980. template <class Rep, class Period>
  2981. inline void ClientImpl::set_read_timeout(
  2982. const std::chrono::duration<Rep, Period> &duration) {
  2983. detail::duration_to_sec_and_usec(
  2984. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2985. }
  2986. template <class Rep, class Period>
  2987. inline void ClientImpl::set_write_timeout(
  2988. const std::chrono::duration<Rep, Period> &duration) {
  2989. detail::duration_to_sec_and_usec(
  2990. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2991. }
  2992. template <class Rep, class Period>
  2993. inline void ClientImpl::set_max_timeout(
  2994. const std::chrono::duration<Rep, Period> &duration) {
  2995. auto msec =
  2996. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2997. set_max_timeout(msec);
  2998. }
  2999. template <class Rep, class Period>
  3000. inline void Client::set_connection_timeout(
  3001. const std::chrono::duration<Rep, Period> &duration) {
  3002. cli_->set_connection_timeout(duration);
  3003. }
  3004. template <class Rep, class Period>
  3005. inline void
  3006. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3007. cli_->set_read_timeout(duration);
  3008. }
  3009. template <class Rep, class Period>
  3010. inline void
  3011. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3012. cli_->set_write_timeout(duration);
  3013. }
  3014. inline void Client::set_max_timeout(time_t msec) {
  3015. cli_->set_max_timeout(msec);
  3016. }
  3017. template <class Rep, class Period>
  3018. inline void
  3019. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  3020. cli_->set_max_timeout(duration);
  3021. }
  3022. /*
  3023. * Forward declarations and types that will be part of the .h file if split into
  3024. * .h + .cc.
  3025. */
  3026. std::string hosted_at(const std::string &hostname);
  3027. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  3028. // JavaScript-style URL encoding/decoding functions
  3029. std::string encode_uri_component(const std::string &value);
  3030. std::string encode_uri(const std::string &value);
  3031. std::string decode_uri_component(const std::string &value);
  3032. std::string decode_uri(const std::string &value);
  3033. // RFC 3986 compliant URL component encoding/decoding functions
  3034. std::string encode_path_component(const std::string &component);
  3035. std::string decode_path_component(const std::string &component);
  3036. std::string encode_query_component(const std::string &component,
  3037. bool space_as_plus = true);
  3038. std::string decode_query_component(const std::string &component,
  3039. bool plus_as_space = true);
  3040. std::string sanitize_filename(const std::string &filename);
  3041. std::string append_query_params(const std::string &path, const Params &params);
  3042. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  3043. std::pair<std::string, std::string>
  3044. make_basic_authentication_header(const std::string &username,
  3045. const std::string &password,
  3046. bool is_proxy = false);
  3047. namespace detail {
  3048. #if defined(_WIN32)
  3049. inline std::wstring u8string_to_wstring(const char *s) {
  3050. if (!s) { return std::wstring(); }
  3051. auto len = static_cast<int>(strlen(s));
  3052. if (!len) { return std::wstring(); }
  3053. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  3054. if (!wlen) { return std::wstring(); }
  3055. std::wstring ws;
  3056. ws.resize(wlen);
  3057. wlen = ::MultiByteToWideChar(
  3058. CP_UTF8, 0, s, len,
  3059. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3060. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3061. return ws;
  3062. }
  3063. #endif
  3064. struct FileStat {
  3065. FileStat(const std::string &path);
  3066. bool is_file() const;
  3067. bool is_dir() const;
  3068. time_t mtime() const;
  3069. size_t size() const;
  3070. private:
  3071. #if defined(_WIN32)
  3072. struct _stat st_;
  3073. #else
  3074. struct stat st_;
  3075. #endif
  3076. int ret_ = -1;
  3077. };
  3078. std::string make_host_and_port_string(const std::string &host, int port,
  3079. bool is_ssl);
  3080. template <typename T>
  3081. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3082. Error &error);
  3083. std::string trim_copy(const std::string &s);
  3084. void divide(
  3085. const char *data, std::size_t size, char d,
  3086. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3087. fn);
  3088. void divide(
  3089. const std::string &str, char d,
  3090. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3091. fn);
  3092. void split(const char *b, const char *e, char d,
  3093. std::function<void(const char *, const char *)> fn);
  3094. void split(const char *b, const char *e, char d, size_t m,
  3095. std::function<void(const char *, const char *)> fn);
  3096. bool split_find(const char *b, const char *e, char d,
  3097. std::function<bool(const char *, const char *)> fn);
  3098. bool has_header_token(const Headers &headers, const std::string &key,
  3099. const std::string &token);
  3100. std::string websocket_accept_key(const std::string &client_key);
  3101. bool is_websocket_upgrade(const Request &req);
  3102. bool process_client_socket(
  3103. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3104. time_t write_timeout_sec, time_t write_timeout_usec,
  3105. time_t max_timeout_msec,
  3106. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3107. std::function<bool(Stream &)> callback);
  3108. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3109. int port, int address_family, bool tcp_nodelay,
  3110. bool ipv6_v6only, SocketOptions socket_options,
  3111. time_t connection_timeout_sec,
  3112. time_t connection_timeout_usec,
  3113. time_t read_timeout_sec, time_t read_timeout_usec,
  3114. time_t write_timeout_sec,
  3115. time_t write_timeout_usec,
  3116. const std::string &intf, Error &error);
  3117. const char *get_header_value(const Headers &headers, const std::string &key,
  3118. const char *def, size_t id);
  3119. std::string get_combined_header_value(const Headers &headers,
  3120. const std::string &key);
  3121. std::string params_to_query_str(const Params &params);
  3122. void parse_query_text(const char *data, std::size_t size, Params &params);
  3123. void parse_query_text(const std::string &s, Params &params);
  3124. bool parse_multipart_boundary(const std::string &content_type,
  3125. std::string &boundary);
  3126. bool parse_range_header(const std::string &s, Ranges &ranges);
  3127. bool parse_accept_header(const std::string &s,
  3128. std::vector<std::string> &content_types);
  3129. void parse_disposition_params(const std::string &s, Params &params);
  3130. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3131. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3132. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3133. EncodingType encoding_type(const Request &req, const Response &res,
  3134. const std::string &content_type);
  3135. EncodingType encoding_type(const Request &req, const Response &res);
  3136. class BufferStream final : public Stream {
  3137. public:
  3138. BufferStream() = default;
  3139. ~BufferStream() override = default;
  3140. bool is_readable() const override;
  3141. bool wait_readable() const override;
  3142. bool wait_writable() const override;
  3143. ssize_t read(char *ptr, size_t size) override;
  3144. ssize_t write(const char *ptr, size_t size) override;
  3145. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3146. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3147. socket_t socket() const override;
  3148. time_t duration() const override;
  3149. const std::string &get_buffer() const;
  3150. private:
  3151. std::string buffer;
  3152. size_t position = 0;
  3153. };
  3154. class compressor {
  3155. public:
  3156. virtual ~compressor() = default;
  3157. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3158. virtual bool compress(const char *data, size_t data_length, bool last,
  3159. Callback callback) = 0;
  3160. };
  3161. class decompressor {
  3162. public:
  3163. virtual ~decompressor() = default;
  3164. virtual bool is_valid() const = 0;
  3165. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3166. virtual bool decompress(const char *data, size_t data_length,
  3167. Callback callback) = 0;
  3168. };
  3169. class nocompressor final : public compressor {
  3170. public:
  3171. ~nocompressor() override = default;
  3172. bool compress(const char *data, size_t data_length, bool /*last*/,
  3173. Callback callback) override;
  3174. };
  3175. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3176. class gzip_compressor final : public compressor {
  3177. public:
  3178. gzip_compressor();
  3179. ~gzip_compressor() override;
  3180. bool compress(const char *data, size_t data_length, bool last,
  3181. Callback callback) override;
  3182. private:
  3183. bool is_valid_ = false;
  3184. z_stream strm_;
  3185. };
  3186. class gzip_decompressor final : public decompressor {
  3187. public:
  3188. gzip_decompressor();
  3189. ~gzip_decompressor() override;
  3190. bool is_valid() const override;
  3191. bool decompress(const char *data, size_t data_length,
  3192. Callback callback) override;
  3193. private:
  3194. bool is_valid_ = false;
  3195. z_stream strm_;
  3196. };
  3197. #endif
  3198. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3199. class brotli_compressor final : public compressor {
  3200. public:
  3201. brotli_compressor();
  3202. ~brotli_compressor();
  3203. bool compress(const char *data, size_t data_length, bool last,
  3204. Callback callback) override;
  3205. private:
  3206. BrotliEncoderState *state_ = nullptr;
  3207. };
  3208. class brotli_decompressor final : public decompressor {
  3209. public:
  3210. brotli_decompressor();
  3211. ~brotli_decompressor();
  3212. bool is_valid() const override;
  3213. bool decompress(const char *data, size_t data_length,
  3214. Callback callback) override;
  3215. private:
  3216. BrotliDecoderResult decoder_r;
  3217. BrotliDecoderState *decoder_s = nullptr;
  3218. };
  3219. #endif
  3220. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3221. class zstd_compressor : public compressor {
  3222. public:
  3223. zstd_compressor();
  3224. ~zstd_compressor();
  3225. bool compress(const char *data, size_t data_length, bool last,
  3226. Callback callback) override;
  3227. private:
  3228. ZSTD_CCtx *ctx_ = nullptr;
  3229. };
  3230. class zstd_decompressor : public decompressor {
  3231. public:
  3232. zstd_decompressor();
  3233. ~zstd_decompressor();
  3234. bool is_valid() const override;
  3235. bool decompress(const char *data, size_t data_length,
  3236. Callback callback) override;
  3237. private:
  3238. ZSTD_DCtx *ctx_ = nullptr;
  3239. };
  3240. #endif
  3241. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3242. // to store data. The call can set memory on stack for performance.
  3243. class stream_line_reader {
  3244. public:
  3245. stream_line_reader(Stream &strm, char *fixed_buffer,
  3246. size_t fixed_buffer_size);
  3247. const char *ptr() const;
  3248. size_t size() const;
  3249. bool end_with_crlf() const;
  3250. bool getline();
  3251. private:
  3252. void append(char c);
  3253. void append(const char *data, size_t size);
  3254. Stream &strm_;
  3255. char *fixed_buffer_;
  3256. const size_t fixed_buffer_size_;
  3257. size_t fixed_buffer_used_size_ = 0;
  3258. std::string growable_buffer_;
  3259. };
  3260. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3261. const Headers &src_headers);
  3262. struct ChunkedDecoder {
  3263. Stream &strm;
  3264. size_t chunk_remaining = 0;
  3265. bool finished = false;
  3266. char line_buf[64];
  3267. size_t last_chunk_total = 0;
  3268. size_t last_chunk_offset = 0;
  3269. explicit ChunkedDecoder(Stream &s);
  3270. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3271. size_t &out_chunk_total);
  3272. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3273. };
  3274. // A regular file opened to be served: mapped on Windows, read with pread()
  3275. // elsewhere.
  3276. class mmap {
  3277. public:
  3278. mmap(const char *path);
  3279. ~mmap();
  3280. bool open(const char *path);
  3281. void close();
  3282. bool is_open() const;
  3283. size_t size() const;
  3284. // Copies up to len bytes from offset into buf and returns how many: fewer,
  3285. // down to 0, if the file has shrunk since it was opened.
  3286. size_t read(size_t offset, char *buf, size_t len) const;
  3287. private:
  3288. #if defined(_WIN32)
  3289. HANDLE hFile_ = NULL;
  3290. HANDLE hMapping_ = NULL;
  3291. void *addr_ = nullptr;
  3292. bool is_open_empty_file = false;
  3293. #else
  3294. int fd_ = -1;
  3295. #endif
  3296. size_t size_ = 0;
  3297. };
  3298. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3299. namespace fields {
  3300. bool is_token_char(char c);
  3301. bool is_token(const std::string &s);
  3302. bool is_field_name(const std::string &s);
  3303. bool is_vchar(char c);
  3304. bool is_obs_text(char c);
  3305. bool is_field_vchar(char c);
  3306. bool is_field_content(const std::string &s);
  3307. bool is_field_value(const std::string &s);
  3308. bool is_field_valid(const std::string &name, const std::string &value);
  3309. bool is_request_target(const std::string &s);
  3310. bool is_host(const std::string &s);
  3311. } // namespace fields
  3312. } // namespace detail
  3313. /*
  3314. * TLS Abstraction Layer Declarations
  3315. */
  3316. #ifdef CPPHTTPLIB_SSL_ENABLED
  3317. // TLS abstraction layer - backend-specific type declarations
  3318. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3319. namespace tls {
  3320. namespace impl {
  3321. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3322. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3323. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3324. struct MbedTlsContext {
  3325. mbedtls_ssl_config conf;
  3326. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3327. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3328. mbedtls_entropy_context entropy;
  3329. mbedtls_ctr_drbg_context ctr_drbg;
  3330. #endif
  3331. mbedtls_x509_crt ca_chain;
  3332. mbedtls_x509_crt own_cert;
  3333. mbedtls_pk_context own_key;
  3334. bool is_server = false;
  3335. bool verify_client = false;
  3336. VerifyCallback verify_callback;
  3337. MbedTlsContext();
  3338. ~MbedTlsContext();
  3339. MbedTlsContext(const MbedTlsContext &) = delete;
  3340. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3341. };
  3342. } // namespace impl
  3343. } // namespace tls
  3344. #endif
  3345. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3346. namespace tls {
  3347. namespace impl {
  3348. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3349. // This struct is accessible via tls::impl for use in SSL context
  3350. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3351. struct WolfSSLContext {
  3352. WOLFSSL_CTX *ctx = nullptr;
  3353. bool is_server = false;
  3354. bool verify_client = false;
  3355. VerifyCallback verify_callback;
  3356. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3357. WolfSSLContext();
  3358. ~WolfSSLContext();
  3359. WolfSSLContext(const WolfSSLContext &) = delete;
  3360. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3361. };
  3362. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3363. struct WolfSSLCAStore {
  3364. std::string pem_data;
  3365. };
  3366. } // namespace impl
  3367. } // namespace tls
  3368. #endif
  3369. #endif // CPPHTTPLIB_SSL_ENABLED
  3370. namespace stream {
  3371. class Result {
  3372. public:
  3373. Result();
  3374. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3375. Result(Result &&other) noexcept;
  3376. Result &operator=(Result &&other) noexcept;
  3377. Result(const Result &) = delete;
  3378. Result &operator=(const Result &) = delete;
  3379. // Response info
  3380. bool is_valid() const;
  3381. explicit operator bool() const;
  3382. int status() const;
  3383. const Headers &headers() const;
  3384. std::string get_header_value(const std::string &key,
  3385. const char *def = "") const;
  3386. bool has_header(const std::string &key) const;
  3387. Error error() const;
  3388. Error read_error() const;
  3389. bool has_read_error() const;
  3390. // Stream reading
  3391. bool next();
  3392. const char *data() const;
  3393. size_t size() const;
  3394. std::string read_all();
  3395. private:
  3396. ClientImpl::StreamHandle handle_;
  3397. std::string buffer_;
  3398. size_t current_size_ = 0;
  3399. size_t chunk_size_;
  3400. bool finished_ = false;
  3401. };
  3402. // GET
  3403. template <typename ClientType>
  3404. inline Result Get(ClientType &cli, const std::string &path,
  3405. size_t chunk_size = 8192) {
  3406. return Result{cli.open_stream("GET", path), chunk_size};
  3407. }
  3408. template <typename ClientType>
  3409. inline Result Get(ClientType &cli, const std::string &path,
  3410. const Headers &headers, size_t chunk_size = 8192) {
  3411. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3412. }
  3413. template <typename ClientType>
  3414. inline Result Get(ClientType &cli, const std::string &path,
  3415. const Params &params, size_t chunk_size = 8192) {
  3416. return Result{cli.open_stream("GET", path, params), chunk_size};
  3417. }
  3418. template <typename ClientType>
  3419. inline Result Get(ClientType &cli, const std::string &path,
  3420. const Params &params, const Headers &headers,
  3421. size_t chunk_size = 8192) {
  3422. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3423. }
  3424. // POST
  3425. template <typename ClientType>
  3426. inline Result Post(ClientType &cli, const std::string &path,
  3427. const std::string &body, const std::string &content_type,
  3428. size_t chunk_size = 8192) {
  3429. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3430. chunk_size};
  3431. }
  3432. template <typename ClientType>
  3433. inline Result Post(ClientType &cli, const std::string &path,
  3434. const Headers &headers, const std::string &body,
  3435. const std::string &content_type, size_t chunk_size = 8192) {
  3436. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3437. chunk_size};
  3438. }
  3439. template <typename ClientType>
  3440. inline Result Post(ClientType &cli, const std::string &path,
  3441. const Params &params, const std::string &body,
  3442. const std::string &content_type, size_t chunk_size = 8192) {
  3443. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3444. chunk_size};
  3445. }
  3446. template <typename ClientType>
  3447. inline Result Post(ClientType &cli, const std::string &path,
  3448. const Params &params, const Headers &headers,
  3449. const std::string &body, const std::string &content_type,
  3450. size_t chunk_size = 8192) {
  3451. return Result{
  3452. cli.open_stream("POST", path, params, headers, body, content_type),
  3453. chunk_size};
  3454. }
  3455. // PUT
  3456. template <typename ClientType>
  3457. inline Result Put(ClientType &cli, const std::string &path,
  3458. const std::string &body, const std::string &content_type,
  3459. size_t chunk_size = 8192) {
  3460. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3461. chunk_size};
  3462. }
  3463. template <typename ClientType>
  3464. inline Result Put(ClientType &cli, const std::string &path,
  3465. const Headers &headers, const std::string &body,
  3466. const std::string &content_type, size_t chunk_size = 8192) {
  3467. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3468. chunk_size};
  3469. }
  3470. template <typename ClientType>
  3471. inline Result Put(ClientType &cli, const std::string &path,
  3472. const Params &params, const std::string &body,
  3473. const std::string &content_type, size_t chunk_size = 8192) {
  3474. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3475. chunk_size};
  3476. }
  3477. template <typename ClientType>
  3478. inline Result Put(ClientType &cli, const std::string &path,
  3479. const Params &params, const Headers &headers,
  3480. const std::string &body, const std::string &content_type,
  3481. size_t chunk_size = 8192) {
  3482. return Result{
  3483. cli.open_stream("PUT", path, params, headers, body, content_type),
  3484. chunk_size};
  3485. }
  3486. // PATCH
  3487. template <typename ClientType>
  3488. inline Result Patch(ClientType &cli, const std::string &path,
  3489. const std::string &body, const std::string &content_type,
  3490. size_t chunk_size = 8192) {
  3491. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3492. chunk_size};
  3493. }
  3494. template <typename ClientType>
  3495. inline Result Patch(ClientType &cli, const std::string &path,
  3496. const Headers &headers, const std::string &body,
  3497. const std::string &content_type, size_t chunk_size = 8192) {
  3498. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3499. chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Patch(ClientType &cli, const std::string &path,
  3503. const Params &params, const std::string &body,
  3504. const std::string &content_type, size_t chunk_size = 8192) {
  3505. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3506. chunk_size};
  3507. }
  3508. template <typename ClientType>
  3509. inline Result Patch(ClientType &cli, const std::string &path,
  3510. const Params &params, const Headers &headers,
  3511. const std::string &body, const std::string &content_type,
  3512. size_t chunk_size = 8192) {
  3513. return Result{
  3514. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3515. chunk_size};
  3516. }
  3517. // DELETE
  3518. template <typename ClientType>
  3519. inline Result Delete(ClientType &cli, const std::string &path,
  3520. size_t chunk_size = 8192) {
  3521. return Result{cli.open_stream("DELETE", path), chunk_size};
  3522. }
  3523. template <typename ClientType>
  3524. inline Result Delete(ClientType &cli, const std::string &path,
  3525. const Headers &headers, size_t chunk_size = 8192) {
  3526. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3527. }
  3528. template <typename ClientType>
  3529. inline Result Delete(ClientType &cli, const std::string &path,
  3530. const std::string &body, const std::string &content_type,
  3531. size_t chunk_size = 8192) {
  3532. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3533. chunk_size};
  3534. }
  3535. template <typename ClientType>
  3536. inline Result Delete(ClientType &cli, const std::string &path,
  3537. const Headers &headers, const std::string &body,
  3538. const std::string &content_type,
  3539. size_t chunk_size = 8192) {
  3540. return Result{
  3541. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3542. chunk_size};
  3543. }
  3544. template <typename ClientType>
  3545. inline Result Delete(ClientType &cli, const std::string &path,
  3546. const Params &params, size_t chunk_size = 8192) {
  3547. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3548. }
  3549. template <typename ClientType>
  3550. inline Result Delete(ClientType &cli, const std::string &path,
  3551. const Params &params, const Headers &headers,
  3552. size_t chunk_size = 8192) {
  3553. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3554. }
  3555. template <typename ClientType>
  3556. inline Result Delete(ClientType &cli, const std::string &path,
  3557. const Params &params, const std::string &body,
  3558. const std::string &content_type,
  3559. size_t chunk_size = 8192) {
  3560. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3561. chunk_size};
  3562. }
  3563. template <typename ClientType>
  3564. inline Result Delete(ClientType &cli, const std::string &path,
  3565. const Params &params, const Headers &headers,
  3566. const std::string &body, const std::string &content_type,
  3567. size_t chunk_size = 8192) {
  3568. return Result{
  3569. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3570. chunk_size};
  3571. }
  3572. // HEAD
  3573. template <typename ClientType>
  3574. inline Result Head(ClientType &cli, const std::string &path,
  3575. size_t chunk_size = 8192) {
  3576. return Result{cli.open_stream("HEAD", path), chunk_size};
  3577. }
  3578. template <typename ClientType>
  3579. inline Result Head(ClientType &cli, const std::string &path,
  3580. const Headers &headers, size_t chunk_size = 8192) {
  3581. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3582. }
  3583. template <typename ClientType>
  3584. inline Result Head(ClientType &cli, const std::string &path,
  3585. const Params &params, size_t chunk_size = 8192) {
  3586. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3587. }
  3588. template <typename ClientType>
  3589. inline Result Head(ClientType &cli, const std::string &path,
  3590. const Params &params, const Headers &headers,
  3591. size_t chunk_size = 8192) {
  3592. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3593. }
  3594. // OPTIONS
  3595. template <typename ClientType>
  3596. inline Result Options(ClientType &cli, const std::string &path,
  3597. size_t chunk_size = 8192) {
  3598. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3599. }
  3600. template <typename ClientType>
  3601. inline Result Options(ClientType &cli, const std::string &path,
  3602. const Headers &headers, size_t chunk_size = 8192) {
  3603. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3604. }
  3605. template <typename ClientType>
  3606. inline Result Options(ClientType &cli, const std::string &path,
  3607. const Params &params, size_t chunk_size = 8192) {
  3608. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3609. }
  3610. template <typename ClientType>
  3611. inline Result Options(ClientType &cli, const std::string &path,
  3612. const Params &params, const Headers &headers,
  3613. size_t chunk_size = 8192) {
  3614. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3615. }
  3616. } // namespace stream
  3617. namespace sse {
  3618. struct SSEMessage {
  3619. std::string event; // Event type (default: "message")
  3620. std::string data; // Event payload
  3621. std::string id; // Event ID for Last-Event-ID header
  3622. SSEMessage();
  3623. void clear();
  3624. };
  3625. class SSEClient {
  3626. public:
  3627. using MessageHandler = std::function<void(const SSEMessage &)>;
  3628. using ErrorHandler = std::function<void(Error)>;
  3629. using OpenHandler = std::function<void()>;
  3630. SSEClient(Client &client, const std::string &path);
  3631. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3632. ~SSEClient();
  3633. SSEClient(const SSEClient &) = delete;
  3634. SSEClient &operator=(const SSEClient &) = delete;
  3635. // Event handlers
  3636. SSEClient &on_message(MessageHandler handler);
  3637. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3638. SSEClient &on_open(OpenHandler handler);
  3639. SSEClient &on_error(ErrorHandler handler);
  3640. SSEClient &set_reconnect_interval(int ms);
  3641. SSEClient &set_max_reconnect_attempts(int n);
  3642. // Update headers (thread-safe)
  3643. SSEClient &set_headers(const Headers &headers);
  3644. // State accessors
  3645. bool is_connected() const;
  3646. const std::string &last_event_id() const;
  3647. // Blocking start - runs event loop with auto-reconnect
  3648. void start();
  3649. // Non-blocking start - runs in background thread
  3650. void start_async();
  3651. // Stop the client (thread-safe)
  3652. void stop();
  3653. private:
  3654. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms,
  3655. bool &has_data, bool &has_id);
  3656. void run_event_loop();
  3657. void dispatch_event(const SSEMessage &msg);
  3658. bool should_reconnect(int count) const;
  3659. void wait_for_reconnect();
  3660. // Client and path
  3661. Client &client_;
  3662. std::string path_;
  3663. Headers headers_;
  3664. mutable std::mutex headers_mutex_;
  3665. // Callbacks
  3666. MessageHandler on_message_;
  3667. std::map<std::string, MessageHandler> event_handlers_;
  3668. OpenHandler on_open_;
  3669. ErrorHandler on_error_;
  3670. // Configuration
  3671. int reconnect_interval_ms_ = 3000;
  3672. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3673. // State
  3674. std::atomic<bool> running_{false};
  3675. std::atomic<bool> connected_{false};
  3676. std::string last_event_id_;
  3677. // Async support
  3678. std::thread async_thread_;
  3679. };
  3680. } // namespace sse
  3681. namespace ws {
  3682. class WebSocketClient;
  3683. enum class Opcode : uint8_t {
  3684. Continuation = 0x0,
  3685. Text = 0x1,
  3686. Binary = 0x2,
  3687. Close = 0x8,
  3688. Ping = 0x9,
  3689. Pong = 0xA,
  3690. };
  3691. enum class CloseStatus : uint16_t {
  3692. Normal = 1000,
  3693. GoingAway = 1001,
  3694. ProtocolError = 1002,
  3695. UnsupportedData = 1003,
  3696. NoStatus = 1005,
  3697. Abnormal = 1006,
  3698. InvalidPayload = 1007,
  3699. PolicyViolation = 1008,
  3700. MessageTooBig = 1009,
  3701. MandatoryExtension = 1010,
  3702. InternalError = 1011,
  3703. };
  3704. // Timeout is returned only when a read timeout was set and it elapsed before
  3705. // any byte of a frame arrived: nothing was consumed and the connection is
  3706. // still open, so the caller can send on it and read again. `msg` is left
  3707. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3708. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3709. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3710. // upgrade handshake fully succeeded. On failure error() identifies the
  3711. // failing layer; status()/headers() expose the server's upgrade response
  3712. // when one was received (status() is -1 otherwise).
  3713. class Result {
  3714. public:
  3715. Result() = default;
  3716. Result(Error err, int status, Headers &&headers)
  3717. : err_(err), status_(status), headers_(std::move(headers)) {}
  3718. explicit operator bool() const { return err_ == Error::Success; }
  3719. Error error() const { return err_; }
  3720. // Upgrade response info
  3721. int status() const { return status_; }
  3722. const Headers &headers() const { return headers_; }
  3723. std::string get_header_value(const std::string &key,
  3724. const char *def = "") const {
  3725. return detail::get_header_value(headers_, key, def, 0);
  3726. }
  3727. bool has_header(const std::string &key) const {
  3728. return headers_.find(key) != headers_.end();
  3729. }
  3730. #ifdef CPPHTTPLIB_SSL_ENABLED
  3731. Result(Error err, int status, Headers &&headers, int ssl_error,
  3732. uint64_t ssl_backend_error)
  3733. : err_(err), status_(status), headers_(std::move(headers)),
  3734. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3735. int ssl_error() const { return ssl_error_; }
  3736. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3737. #endif
  3738. private:
  3739. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3740. int status_ = -1;
  3741. Headers headers_;
  3742. #ifdef CPPHTTPLIB_SSL_ENABLED
  3743. int ssl_error_ = 0;
  3744. uint64_t ssl_backend_error_ = 0;
  3745. #endif
  3746. };
  3747. class WebSocket {
  3748. public:
  3749. WebSocket(const WebSocket &) = delete;
  3750. WebSocket &operator=(const WebSocket &) = delete;
  3751. ~WebSocket();
  3752. ReadResult read(std::string &msg);
  3753. bool send(const std::string &data);
  3754. bool send(const char *data, size_t len);
  3755. void close(CloseStatus status = CloseStatus::Normal,
  3756. const std::string &reason = "");
  3757. const Request &request() const;
  3758. bool is_open() const;
  3759. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3760. // A server handler owns its connection's timeout this way; a client sets it
  3761. // through WebSocketClient. Safe to call while another thread is in read().
  3762. //
  3763. // Only a timeout set here is reported as Timeout. The compile-time default
  3764. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3765. // than a request for control, so when it elapses read() returns Fail and
  3766. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3767. void set_read_timeout(time_t sec, time_t usec = 0);
  3768. template <class Rep, class Period>
  3769. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3770. private:
  3771. friend class httplib::Server;
  3772. friend class httplib::ws::WebSocketClient;
  3773. WebSocket(
  3774. Stream &strm, const Request &req, bool is_server,
  3775. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3776. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3777. : strm_(strm), req_(req), is_server_(is_server),
  3778. ping_interval_sec_(ping_interval_sec),
  3779. max_missed_pongs_(max_missed_pongs) {
  3780. start_heartbeat();
  3781. }
  3782. WebSocket(
  3783. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3784. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3785. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3786. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3787. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3788. max_missed_pongs_(max_missed_pongs) {
  3789. start_heartbeat();
  3790. }
  3791. void start_heartbeat();
  3792. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3793. Stream &strm_;
  3794. std::unique_ptr<Stream> owned_strm_;
  3795. Request req_;
  3796. bool is_server_;
  3797. time_t ping_interval_sec_;
  3798. int max_missed_pongs_;
  3799. int unacked_pings_ = 0;
  3800. std::atomic<bool> closed_{false};
  3801. // Set once the caller has bounded read() through set_read_timeout(). Until
  3802. // then the timeout in effect is the compile-time default, and elapsing it
  3803. // is a failure that closes the connection, not a Timeout.
  3804. std::atomic<bool> read_timeout_set_{false};
  3805. std::mutex write_mutex_;
  3806. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3807. // may do so: read_websocket_frame() reads a payload until it has the whole
  3808. // declared length, so a second parser stealing bytes silently corrupts the
  3809. // message the first one is assembling.
  3810. std::mutex read_mutex_;
  3811. std::thread ping_thread_;
  3812. std::mutex ping_mutex_;
  3813. std::condition_variable ping_cv_;
  3814. };
  3815. class WebSocketClient {
  3816. public:
  3817. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3818. const Headers &headers = {});
  3819. ~WebSocketClient();
  3820. WebSocketClient(const WebSocketClient &) = delete;
  3821. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3822. bool is_valid() const;
  3823. Result connect();
  3824. ReadResult read(std::string &msg);
  3825. bool send(const std::string &data);
  3826. bool send(const char *data, size_t len);
  3827. void close(CloseStatus status = CloseStatus::Normal,
  3828. const std::string &reason = "");
  3829. bool is_open() const;
  3830. const std::string &subprotocol() const;
  3831. void set_read_timeout(time_t sec, time_t usec = 0);
  3832. template <class Rep, class Period>
  3833. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3834. void set_write_timeout(time_t sec, time_t usec = 0);
  3835. template <class Rep, class Period>
  3836. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3837. void set_websocket_ping_interval(time_t sec);
  3838. void set_websocket_max_missed_pongs(int count);
  3839. void set_tcp_nodelay(bool on);
  3840. void set_address_family(int family);
  3841. void set_ipv6_v6only(bool on);
  3842. void set_socket_options(SocketOptions socket_options);
  3843. void set_connection_timeout(time_t sec, time_t usec = 0);
  3844. template <class Rep, class Period>
  3845. void
  3846. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3847. void set_interface(const std::string &intf);
  3848. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3849. #ifdef CPPHTTPLIB_SSL_ENABLED
  3850. struct PemMemory {
  3851. const char *cert_pem;
  3852. size_t cert_pem_len;
  3853. const char *key_pem;
  3854. size_t key_pem_len;
  3855. const char *private_key_password;
  3856. };
  3857. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3858. const PemMemory &pem, const Headers &headers = {});
  3859. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3860. const std::string &ca_cert_dir_path = std::string());
  3861. void set_ca_cert_store(tls::ca_store_t store);
  3862. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3863. void enable_server_certificate_verification(bool enabled);
  3864. void enable_server_hostname_verification(bool enabled);
  3865. void enable_system_ca(bool enabled);
  3866. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  3867. void set_session_verifier(
  3868. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  3869. #endif
  3870. private:
  3871. void shutdown_and_close();
  3872. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3873. int &ssl_error, uint64_t &ssl_backend_error);
  3874. void prepare_default_headers(Request &req);
  3875. std::string host_;
  3876. int port_;
  3877. std::string path_;
  3878. Headers headers_;
  3879. std::string subprotocol_;
  3880. bool is_valid_ = false;
  3881. socket_t sock_ = INVALID_SOCKET;
  3882. std::unique_ptr<WebSocket> ws_;
  3883. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3884. time_t read_timeout_usec_ = 0;
  3885. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3886. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3887. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3888. time_t websocket_ping_interval_sec_ =
  3889. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3890. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3891. int address_family_ = AF_UNSPEC;
  3892. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3893. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3894. SocketOptions socket_options_ = nullptr;
  3895. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3896. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3897. std::string interface_;
  3898. // Hostname to connection target map. The value is an IP literal or another
  3899. // hostname; only the connection target changes, never the identity.
  3900. std::map<std::string, std::string> addr_map_;
  3901. #ifdef CPPHTTPLIB_SSL_ENABLED
  3902. bool is_ssl_ = false;
  3903. tls::ctx_t tls_ctx_ = nullptr;
  3904. tls::session_t tls_session_ = nullptr;
  3905. std::string ca_cert_file_path_;
  3906. std::string ca_cert_dir_path_;
  3907. bool custom_ca_loaded_ = false;
  3908. bool certs_loaded_ = false;
  3909. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3910. bool server_certificate_verification_ = true;
  3911. bool server_hostname_verification_ = true;
  3912. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  3913. #endif
  3914. };
  3915. template <class Rep, class Period>
  3916. inline void WebSocket::set_read_timeout(
  3917. const std::chrono::duration<Rep, Period> &duration) {
  3918. detail::duration_to_sec_and_usec(
  3919. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3920. }
  3921. template <class Rep, class Period>
  3922. inline void WebSocketClient::set_read_timeout(
  3923. const std::chrono::duration<Rep, Period> &duration) {
  3924. detail::duration_to_sec_and_usec(
  3925. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3926. }
  3927. template <class Rep, class Period>
  3928. inline void WebSocketClient::set_write_timeout(
  3929. const std::chrono::duration<Rep, Period> &duration) {
  3930. detail::duration_to_sec_and_usec(
  3931. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3932. }
  3933. template <class Rep, class Period>
  3934. inline void WebSocketClient::set_connection_timeout(
  3935. const std::chrono::duration<Rep, Period> &duration) {
  3936. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3937. set_connection_timeout(sec, usec);
  3938. });
  3939. }
  3940. namespace impl {
  3941. bool is_valid_utf8(const std::string &s);
  3942. // Three states, because a failure that consumed bytes and one that consumed
  3943. // none are not the same thing: the first has left the stream in the middle of
  3944. // a frame and the connection cannot be reused, the second can just be retried.
  3945. enum class FrameRead { Ok, Fail, Timeout };
  3946. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3947. std::string &payload, bool &fin,
  3948. bool expect_masked, size_t max_len);
  3949. } // namespace impl
  3950. } // namespace ws
  3951. // ----------------------------------------------------------------------------
  3952. /*
  3953. * Implementation that will be part of the .cc file if split into .h + .cc.
  3954. */
  3955. namespace stream {
  3956. // stream::Result implementations
  3957. inline Result::Result() : chunk_size_(8192) {}
  3958. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3959. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3960. inline Result::Result(Result &&other) noexcept
  3961. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3962. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3963. finished_(other.finished_) {
  3964. other.current_size_ = 0;
  3965. other.finished_ = true;
  3966. }
  3967. inline Result &Result::operator=(Result &&other) noexcept {
  3968. if (this != &other) {
  3969. handle_ = std::move(other.handle_);
  3970. buffer_ = std::move(other.buffer_);
  3971. current_size_ = other.current_size_;
  3972. chunk_size_ = other.chunk_size_;
  3973. finished_ = other.finished_;
  3974. other.current_size_ = 0;
  3975. other.finished_ = true;
  3976. }
  3977. return *this;
  3978. }
  3979. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3980. inline Result::operator bool() const { return is_valid(); }
  3981. inline int Result::status() const {
  3982. return handle_.response ? handle_.response->status : -1;
  3983. }
  3984. inline const Headers &Result::headers() const {
  3985. static const Headers empty_headers;
  3986. return handle_.response ? handle_.response->headers : empty_headers;
  3987. }
  3988. inline std::string Result::get_header_value(const std::string &key,
  3989. const char *def) const {
  3990. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3991. }
  3992. inline bool Result::has_header(const std::string &key) const {
  3993. return handle_.response ? handle_.response->has_header(key) : false;
  3994. }
  3995. inline Error Result::error() const { return handle_.error; }
  3996. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3997. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3998. inline bool Result::next() {
  3999. if (!handle_.is_valid() || finished_) { return false; }
  4000. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  4001. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  4002. if (n > 0) {
  4003. current_size_ = static_cast<size_t>(n);
  4004. return true;
  4005. }
  4006. current_size_ = 0;
  4007. finished_ = true;
  4008. return false;
  4009. }
  4010. inline const char *Result::data() const { return buffer_.data(); }
  4011. inline size_t Result::size() const { return current_size_; }
  4012. inline std::string Result::read_all() {
  4013. std::string result;
  4014. while (next()) {
  4015. result.append(data(), size());
  4016. }
  4017. return result;
  4018. }
  4019. } // namespace stream
  4020. namespace sse {
  4021. // SSEMessage implementations
  4022. inline SSEMessage::SSEMessage() : event("message") {}
  4023. inline void SSEMessage::clear() {
  4024. event = "message";
  4025. data.clear();
  4026. id.clear();
  4027. }
  4028. // SSEClient implementations
  4029. inline SSEClient::SSEClient(Client &client, const std::string &path)
  4030. : client_(client), path_(path) {}
  4031. inline SSEClient::SSEClient(Client &client, const std::string &path,
  4032. const Headers &headers)
  4033. : client_(client), path_(path), headers_(headers) {}
  4034. inline SSEClient::~SSEClient() { stop(); }
  4035. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  4036. on_message_ = std::move(handler);
  4037. return *this;
  4038. }
  4039. inline SSEClient &SSEClient::on_event(const std::string &type,
  4040. MessageHandler handler) {
  4041. event_handlers_[type] = std::move(handler);
  4042. return *this;
  4043. }
  4044. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  4045. on_open_ = std::move(handler);
  4046. return *this;
  4047. }
  4048. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  4049. on_error_ = std::move(handler);
  4050. return *this;
  4051. }
  4052. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  4053. reconnect_interval_ms_ = ms;
  4054. return *this;
  4055. }
  4056. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  4057. max_reconnect_attempts_ = n;
  4058. return *this;
  4059. }
  4060. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  4061. std::lock_guard<std::mutex> lock(headers_mutex_);
  4062. headers_ = headers;
  4063. return *this;
  4064. }
  4065. inline bool SSEClient::is_connected() const { return connected_.load(); }
  4066. inline const std::string &SSEClient::last_event_id() const {
  4067. return last_event_id_;
  4068. }
  4069. inline void SSEClient::start() {
  4070. running_.store(true);
  4071. run_event_loop();
  4072. }
  4073. inline void SSEClient::start_async() {
  4074. running_.store(true);
  4075. async_thread_ = std::thread([this]() { run_event_loop(); });
  4076. }
  4077. inline void SSEClient::stop() {
  4078. running_.store(false);
  4079. client_.stop(); // Cancel any pending operations
  4080. if (async_thread_.joinable()) { async_thread_.join(); }
  4081. }
  4082. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4083. int &retry_ms, bool &has_data,
  4084. bool &has_id) {
  4085. // Blank line signals end of event
  4086. if (line.empty()) { return true; }
  4087. // Lines starting with ':' are comments (ignored)
  4088. if (line[0] == ':') { return false; }
  4089. // Find the colon separator
  4090. auto colon_pos = line.find(':');
  4091. auto field = line.substr(0, colon_pos);
  4092. std::string value;
  4093. // Value starts after colon, skip optional single space
  4094. if (colon_pos != std::string::npos && colon_pos + 1 < line.size()) {
  4095. auto value_start = colon_pos + 1;
  4096. if (line[value_start] == ' ') { value_start++; }
  4097. value = line.substr(value_start);
  4098. }
  4099. // Handle known fields
  4100. if (field == "event") {
  4101. msg.event = value;
  4102. } else if (field == "data") {
  4103. // Multiple data lines are concatenated with newlines
  4104. if (has_data) { msg.data += "\n"; }
  4105. msg.data += value;
  4106. has_data = true;
  4107. } else if (field == "id") {
  4108. // An id that cannot be sent back as Last-Event-ID is ignored. Empty id is
  4109. // valid (clears the last event ID)
  4110. if (detail::fields::is_field_value(value)) {
  4111. msg.id = value;
  4112. has_id = true;
  4113. }
  4114. } else if (field == "retry") {
  4115. // Parse retry interval in milliseconds
  4116. // Per the SSE spec, a value that is not all ASCII digits is ignored.
  4117. if (detail::is_numeric(value)) {
  4118. int v = 0;
  4119. auto res =
  4120. detail::from_chars(value.data(), value.data() + value.size(), v);
  4121. if (res.ec == std::errc{}) { retry_ms = v; }
  4122. }
  4123. }
  4124. // Unknown fields are ignored per SSE spec
  4125. return false;
  4126. }
  4127. inline void SSEClient::run_event_loop() {
  4128. auto reconnect_count = 0;
  4129. while (running_.load()) {
  4130. // Build headers, including Last-Event-ID if we have one
  4131. Headers request_headers;
  4132. {
  4133. std::lock_guard<std::mutex> lock(headers_mutex_);
  4134. request_headers = headers_;
  4135. }
  4136. if (!last_event_id_.empty()) {
  4137. request_headers.emplace("Last-Event-ID", last_event_id_);
  4138. }
  4139. // Open streaming connection
  4140. auto result = stream::Get(client_, path_, request_headers);
  4141. // Connection error handling
  4142. if (!result) {
  4143. connected_.store(false);
  4144. if (on_error_) { on_error_(result.error()); }
  4145. if (!should_reconnect(reconnect_count)) { break; }
  4146. wait_for_reconnect();
  4147. reconnect_count++;
  4148. continue;
  4149. }
  4150. if (result.status() != StatusCode::OK_200) {
  4151. connected_.store(false);
  4152. if (on_error_) { on_error_(Error::Connection); }
  4153. // For certain errors, don't reconnect.
  4154. // Note: 401 is intentionally absent so that handlers can refresh
  4155. // credentials via set_headers() and let the client reconnect.
  4156. if (result.status() == StatusCode::NoContent_204 ||
  4157. result.status() == StatusCode::NotFound_404 ||
  4158. result.status() == StatusCode::Forbidden_403) {
  4159. break;
  4160. }
  4161. if (!should_reconnect(reconnect_count)) { break; }
  4162. wait_for_reconnect();
  4163. reconnect_count++;
  4164. continue;
  4165. }
  4166. // Connection successful
  4167. connected_.store(true);
  4168. reconnect_count = 0;
  4169. if (on_open_) { on_open_(); }
  4170. // Event receiving loop
  4171. std::string buffer;
  4172. SSEMessage current_msg;
  4173. auto has_data = false;
  4174. auto has_id = false;
  4175. auto first_line = true;
  4176. auto after_cr = false;
  4177. auto event_too_long = false;
  4178. while (running_.load() && result.next()) {
  4179. // What is left in the buffer has no line ending
  4180. auto search_pos = buffer.size();
  4181. buffer.append(result.data(), result.size());
  4182. // Process complete lines in the buffer. A line ends with \r\n, \n or \r
  4183. // per the SSE spec
  4184. size_t line_start = 0;
  4185. size_t eol_pos;
  4186. while ((eol_pos = buffer.find_first_of("\r\n", search_pos)) !=
  4187. std::string::npos) {
  4188. auto line = buffer.substr(line_start, eol_pos - line_start);
  4189. line_start = eol_pos + 1;
  4190. search_pos = line_start;
  4191. // The \n of a \r\n may arrive in a later chunk than its \r
  4192. auto is_lf_of_crlf =
  4193. after_cr && line.empty() && buffer[eol_pos] == '\n';
  4194. after_cr = buffer[eol_pos] == '\r';
  4195. if (is_lf_of_crlf) { continue; }
  4196. // A UTF-8 BOM at the start of the stream is ignored per the SSE spec
  4197. if (first_line) {
  4198. first_line = false;
  4199. if (line.compare(0, 3, "\xEF\xBB\xBF") == 0) { line.erase(0, 3); }
  4200. }
  4201. // Parse the line and check if event is complete
  4202. auto event_complete = parse_sse_line(
  4203. line, current_msg, reconnect_interval_ms_, has_data, has_id);
  4204. if (event_complete) {
  4205. // Update last_event_id for reconnection, even for an event that
  4206. // has no data. An empty id clears it.
  4207. if (has_id) { last_event_id_ = current_msg.id; }
  4208. // An event without a data field is not dispatched
  4209. if (has_data) { dispatch_event(current_msg); }
  4210. // Reset the message for the next event either way
  4211. current_msg.clear();
  4212. has_data = false;
  4213. has_id = false;
  4214. }
  4215. }
  4216. // Keep unprocessed data in buffer
  4217. buffer.erase(0, line_start);
  4218. // Neither an event nor a line still waiting for its end may grow
  4219. // without bound. 0 means no limit.
  4220. if (CPPHTTPLIB_SSE_MAX_EVENT_LENGTH > 0 &&
  4221. buffer.size() + current_msg.data.size() >
  4222. CPPHTTPLIB_SSE_MAX_EVENT_LENGTH) {
  4223. if (on_error_) { on_error_(Error::ExceedMaxPayloadSize); }
  4224. event_too_long = true;
  4225. break;
  4226. }
  4227. }
  4228. // Connection ended
  4229. connected_.store(false);
  4230. // Reconnecting would only get the same event again
  4231. if (!running_.load() || event_too_long) { break; }
  4232. // Check for read errors
  4233. if (result.has_read_error()) {
  4234. if (on_error_) { on_error_(result.read_error()); }
  4235. }
  4236. if (!should_reconnect(reconnect_count)) { break; }
  4237. wait_for_reconnect();
  4238. reconnect_count++;
  4239. }
  4240. connected_.store(false);
  4241. }
  4242. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4243. // Check for specific event type handler first
  4244. auto it = event_handlers_.find(msg.event);
  4245. if (it != event_handlers_.end()) {
  4246. it->second(msg);
  4247. return;
  4248. }
  4249. // Fall back to generic message handler
  4250. if (on_message_) { on_message_(msg); }
  4251. }
  4252. inline bool SSEClient::should_reconnect(int count) const {
  4253. if (!running_.load()) { return false; }
  4254. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4255. return count < max_reconnect_attempts_;
  4256. }
  4257. inline void SSEClient::wait_for_reconnect() {
  4258. // Use small increments to check running_ flag frequently.
  4259. // Always wait at least one increment, so that a zero interval (e.g.
  4260. // "retry: 0" from the server) cannot cause a busy reconnect loop.
  4261. const auto step_ms = 100;
  4262. auto interval_ms = (std::max)(reconnect_interval_ms_, step_ms);
  4263. auto waited = 0;
  4264. while (running_.load() && waited < interval_ms) {
  4265. std::this_thread::sleep_for(std::chrono::milliseconds(step_ms));
  4266. waited += step_ms;
  4267. }
  4268. }
  4269. } // namespace sse
  4270. #ifdef CPPHTTPLIB_SSL_ENABLED
  4271. /*
  4272. * TLS abstraction layer - internal function declarations
  4273. * These are implementation details and not part of the public API.
  4274. */
  4275. namespace tls {
  4276. // Client context
  4277. ctx_t create_client_context();
  4278. void free_context(ctx_t ctx);
  4279. bool set_min_version(ctx_t ctx, Version version);
  4280. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4281. bool load_ca_file(ctx_t ctx, const char *file_path);
  4282. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4283. bool load_system_certs(ctx_t ctx);
  4284. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4285. const char *password);
  4286. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4287. const char *key_path, const char *password);
  4288. // Server context
  4289. ctx_t create_server_context();
  4290. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4291. const char *password);
  4292. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4293. const char *key_path, const char *password);
  4294. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4295. void set_verify_client(ctx_t ctx, bool require);
  4296. // Session management
  4297. session_t create_session(ctx_t ctx, socket_t sock);
  4298. void free_session(session_t session);
  4299. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4300. // Handshake (non-blocking capable)
  4301. TlsError connect(session_t session);
  4302. TlsError accept(session_t session);
  4303. // Handshake with timeout (blocking until timeout)
  4304. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4305. time_t timeout_usec, TlsError *err);
  4306. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4307. time_t timeout_usec, TlsError *err);
  4308. // I/O (non-blocking capable)
  4309. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4310. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4311. int pending(const_session_t session);
  4312. void shutdown(session_t session, bool graceful);
  4313. // Connection state
  4314. bool is_peer_closed(session_t session, socket_t sock);
  4315. // Certificate verification
  4316. cert_t get_peer_cert(const_session_t session);
  4317. // The certificates the peer sent, leaf first. Free each with free_cert(), and
  4318. // do not use them after free_session(), as with get_peer_cert().
  4319. size_t get_peer_certs(const_session_t session, std::vector<cert_t> &certs);
  4320. void free_cert(cert_t cert);
  4321. bool verify_hostname(cert_t cert, const char *hostname);
  4322. uint64_t hostname_mismatch_code();
  4323. long get_verify_result(const_session_t session);
  4324. // Certificate introspection
  4325. std::string get_cert_subject_cn(cert_t cert);
  4326. std::string get_cert_issuer_name(cert_t cert);
  4327. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4328. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4329. std::string get_cert_serial(cert_t cert);
  4330. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4331. const char *get_sni(const_session_t session);
  4332. // CA store management
  4333. ca_store_t create_ca_store(const char *pem, size_t len);
  4334. void free_ca_store(ca_store_t store);
  4335. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4336. // Free each with free_cert(), and do not use them once the context's CA
  4337. // certificates change.
  4338. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4339. std::vector<std::string> get_ca_names(ctx_t ctx);
  4340. // Dynamic certificate update (for servers)
  4341. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4342. const char *password);
  4343. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4344. // Certificate verification callback
  4345. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4346. long get_verify_error(const_session_t session);
  4347. std::string verify_error_string(long error_code);
  4348. // TlsError information
  4349. uint64_t peek_error();
  4350. uint64_t get_error();
  4351. std::string error_string(uint64_t code);
  4352. } // namespace tls
  4353. #endif // CPPHTTPLIB_SSL_ENABLED
  4354. /*
  4355. * Group 1: detail namespace - Non-SSL utilities
  4356. */
  4357. namespace detail {
  4358. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4359. const void *optval, socklen_t optlen) {
  4360. return setsockopt(sock, level, optname,
  4361. #ifdef _WIN32
  4362. reinterpret_cast<const char *>(optval),
  4363. #else
  4364. optval,
  4365. #endif
  4366. optlen) == 0;
  4367. }
  4368. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4369. time_t sec, time_t usec) {
  4370. #ifdef _WIN32
  4371. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4372. #else
  4373. timeval timeout;
  4374. timeout.tv_sec = static_cast<long>(sec);
  4375. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4376. #endif
  4377. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4378. }
  4379. inline bool is_hex(char c, int &v) {
  4380. if (is_ascii_digit(c)) {
  4381. v = c - '0';
  4382. return true;
  4383. } else if ('A' <= c && c <= 'F') {
  4384. v = c - 'A' + 10;
  4385. return true;
  4386. } else if ('a' <= c && c <= 'f') {
  4387. v = c - 'a' + 10;
  4388. return true;
  4389. }
  4390. return false;
  4391. }
  4392. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4393. int &val) {
  4394. if (i >= s.size()) { return false; }
  4395. val = 0;
  4396. for (; cnt; i++, cnt--) {
  4397. if (!s[i]) { return false; }
  4398. auto v = 0;
  4399. if (is_hex(s[i], v)) {
  4400. val = val * 16 + v;
  4401. } else {
  4402. return false;
  4403. }
  4404. }
  4405. return true;
  4406. }
  4407. inline std::string from_i_to_hex(size_t n) {
  4408. static const auto charset = "0123456789abcdef";
  4409. std::string ret;
  4410. do {
  4411. ret = charset[n & 15] + ret;
  4412. n >>= 4;
  4413. } while (n > 0);
  4414. return ret;
  4415. }
  4416. inline std::string compute_etag(const FileStat &fs,
  4417. const std::string &suffix = std::string()) {
  4418. if (!fs.is_file()) { return std::string(); }
  4419. // If mtime cannot be determined (negative value indicates an error
  4420. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4421. // value like 0 could collide with a real file that legitimately has
  4422. // mtime == 0 (epoch) and lead to misleading validators.
  4423. auto mtime_raw = fs.mtime();
  4424. if (mtime_raw < 0) { return std::string(); }
  4425. auto mtime = static_cast<size_t>(mtime_raw);
  4426. auto size = fs.size();
  4427. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4428. from_i_to_hex(size) + suffix + "\"";
  4429. }
  4430. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4431. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4432. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4433. inline std::string file_mtime_to_http_date(time_t mtime) {
  4434. if (mtime < 0) { return std::string(); }
  4435. struct tm tm_buf;
  4436. #ifdef _WIN32
  4437. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4438. #else
  4439. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4440. #endif
  4441. char buf[64];
  4442. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4443. return std::string();
  4444. }
  4445. return std::string(buf);
  4446. }
  4447. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4448. inline time_t parse_http_date(const std::string &date_str) {
  4449. struct tm tm_buf;
  4450. // Create a classic locale object once for all parsing attempts
  4451. const std::locale classic_locale = std::locale::classic();
  4452. // Try to parse using std::get_time (C++11, cross-platform)
  4453. auto try_parse = [&](const char *fmt) -> bool {
  4454. std::istringstream ss(date_str);
  4455. ss.imbue(classic_locale);
  4456. memset(&tm_buf, 0, sizeof(tm_buf));
  4457. ss >> std::get_time(&tm_buf, fmt);
  4458. return !ss.fail();
  4459. };
  4460. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4461. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4462. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4463. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4464. // asctime format: "Sun Nov 6 08:49:37 1994"
  4465. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4466. return static_cast<time_t>(-1);
  4467. }
  4468. }
  4469. }
  4470. #ifdef _WIN32
  4471. return _mkgmtime(&tm_buf);
  4472. #elif defined _AIX
  4473. return mktime(&tm_buf);
  4474. #else
  4475. return timegm(&tm_buf);
  4476. #endif
  4477. }
  4478. inline bool is_weak_etag(const std::string &s) {
  4479. // Check if the string is a weak ETag (starts with 'W/"')
  4480. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4481. }
  4482. inline bool is_strong_etag(const std::string &s) {
  4483. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4484. // chars)
  4485. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4486. }
  4487. inline size_t to_utf8(int code, char *buff) {
  4488. if (code < 0x0080) {
  4489. buff[0] = static_cast<char>(code & 0x7F);
  4490. return 1;
  4491. } else if (code < 0x0800) {
  4492. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4493. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4494. return 2;
  4495. } else if (code < 0xD800) {
  4496. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4497. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4498. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4499. return 3;
  4500. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4501. return 0;
  4502. } else if (code < 0x10000) {
  4503. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4504. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4505. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4506. return 3;
  4507. } else if (code < 0x110000) {
  4508. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4509. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4510. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4511. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4512. return 4;
  4513. }
  4514. // NOTREACHED
  4515. return 0;
  4516. }
  4517. } // namespace detail
  4518. namespace ws {
  4519. namespace impl {
  4520. inline bool is_valid_utf8(const std::string &s) {
  4521. size_t i = 0;
  4522. auto n = s.size();
  4523. while (i < n) {
  4524. auto c = static_cast<unsigned char>(s[i]);
  4525. size_t len;
  4526. uint32_t cp;
  4527. if (c < 0x80) {
  4528. i++;
  4529. continue;
  4530. } else if ((c & 0xE0) == 0xC0) {
  4531. len = 2;
  4532. cp = c & 0x1F;
  4533. } else if ((c & 0xF0) == 0xE0) {
  4534. len = 3;
  4535. cp = c & 0x0F;
  4536. } else if ((c & 0xF8) == 0xF0) {
  4537. len = 4;
  4538. cp = c & 0x07;
  4539. } else {
  4540. return false;
  4541. }
  4542. if (i + len > n) { return false; }
  4543. for (size_t j = 1; j < len; j++) {
  4544. auto b = static_cast<unsigned char>(s[i + j]);
  4545. if ((b & 0xC0) != 0x80) { return false; }
  4546. cp = (cp << 6) | (b & 0x3F);
  4547. }
  4548. // Overlong encoding check
  4549. if (len == 2 && cp < 0x80) { return false; }
  4550. if (len == 3 && cp < 0x800) { return false; }
  4551. if (len == 4 && cp < 0x10000) { return false; }
  4552. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4553. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4554. if (cp > 0x10FFFF) { return false; }
  4555. i += len;
  4556. }
  4557. return true;
  4558. }
  4559. } // namespace impl
  4560. } // namespace ws
  4561. namespace detail {
  4562. // NOTE: This code came up with the following stackoverflow post:
  4563. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4564. inline std::string base64_encode(const std::string &in) {
  4565. static const auto lookup =
  4566. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4567. std::string out;
  4568. out.reserve(in.size());
  4569. // Unsigned: the accumulator is never masked, so with a signed int the
  4570. // `val << 8` below overflows once enough bytes are folded in (undefined
  4571. // behaviour before C++20). Only the low bits are ever emitted, so the
  4572. // wrap-around of an unsigned accumulator does not affect the output.
  4573. uint32_t val = 0;
  4574. auto valb = -6;
  4575. for (auto c : in) {
  4576. val = (val << 8) + static_cast<uint8_t>(c);
  4577. valb += 8;
  4578. while (valb >= 0) {
  4579. out.push_back(lookup[(val >> valb) & 0x3F]);
  4580. valb -= 6;
  4581. }
  4582. }
  4583. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4584. while (out.size() % 4) {
  4585. out.push_back('=');
  4586. }
  4587. return out;
  4588. }
  4589. inline std::string sha1(const std::string &input) {
  4590. // RFC 3174 SHA-1 implementation
  4591. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4592. return (x << n) | (x >> (32 - n));
  4593. };
  4594. uint32_t h0 = 0x67452301;
  4595. uint32_t h1 = 0xEFCDAB89;
  4596. uint32_t h2 = 0x98BADCFE;
  4597. uint32_t h3 = 0x10325476;
  4598. uint32_t h4 = 0xC3D2E1F0;
  4599. // Pre-processing: adding padding bits
  4600. std::string msg = input;
  4601. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4602. msg.push_back(static_cast<char>(0x80u));
  4603. while (msg.size() % 64 != 56) {
  4604. msg.push_back(0);
  4605. }
  4606. // Append original length in bits as 64-bit big-endian
  4607. for (int i = 56; i >= 0; i -= 8) {
  4608. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4609. }
  4610. // Process each 512-bit chunk
  4611. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4612. uint32_t w[80];
  4613. for (size_t i = 0; i < 16; i++) {
  4614. w[i] =
  4615. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4616. << 24) |
  4617. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4618. << 16) |
  4619. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4620. << 8) |
  4621. (static_cast<uint32_t>(
  4622. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4623. }
  4624. for (int i = 16; i < 80; i++) {
  4625. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4626. }
  4627. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4628. for (int i = 0; i < 80; i++) {
  4629. uint32_t f, k;
  4630. if (i < 20) {
  4631. f = (b & c) | ((~b) & d);
  4632. k = 0x5A827999;
  4633. } else if (i < 40) {
  4634. f = b ^ c ^ d;
  4635. k = 0x6ED9EBA1;
  4636. } else if (i < 60) {
  4637. f = (b & c) | (b & d) | (c & d);
  4638. k = 0x8F1BBCDC;
  4639. } else {
  4640. f = b ^ c ^ d;
  4641. k = 0xCA62C1D6;
  4642. }
  4643. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4644. e = d;
  4645. d = c;
  4646. c = left_rotate(b, 30);
  4647. b = a;
  4648. a = temp;
  4649. }
  4650. h0 += a;
  4651. h1 += b;
  4652. h2 += c;
  4653. h3 += d;
  4654. h4 += e;
  4655. }
  4656. // Produce the final hash as a 20-byte binary string
  4657. std::string hash(20, '\0');
  4658. for (size_t i = 0; i < 4; i++) {
  4659. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4660. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4661. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4662. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4663. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4664. }
  4665. return hash;
  4666. }
  4667. inline std::string websocket_accept_key(const std::string &client_key) {
  4668. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4669. return base64_encode(sha1(client_key + magic));
  4670. }
  4671. inline bool is_websocket_upgrade(const Request &req) {
  4672. if (req.method != "GET") { return false; }
  4673. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4674. // list of protocols and asks recipients to match each name
  4675. // case-insensitively, so look for the token rather than compare the whole
  4676. // field value.
  4677. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4678. // Check Connection: Upgrade
  4679. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4680. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4681. // RFC 6455 Section 4.2.1
  4682. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4683. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4684. return false;
  4685. }
  4686. static const std::string b64chars =
  4687. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4688. for (size_t i = 0; i < 22; i++) {
  4689. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4690. }
  4691. // Check Sec-WebSocket-Version: 13
  4692. auto version = req.get_header_value("Sec-WebSocket-Version");
  4693. if (version != "13") { return false; }
  4694. return true;
  4695. }
  4696. // Unpredictable bytes for masking keys (RFC 6455 Section 5.3) and nonces
  4697. inline void fill_random_bytes(unsigned char *out, size_t n) {
  4698. thread_local std::random_device rd;
  4699. size_t filled = 0;
  4700. while (filled < n) {
  4701. auto v = rd();
  4702. for (size_t b = 0; b < sizeof(v) && filled < n; ++b, ++filled) {
  4703. out[filled] = static_cast<unsigned char>((v >> (b * 8)) & 0xFFu);
  4704. }
  4705. }
  4706. }
  4707. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4708. const char *data, size_t len, bool fin,
  4709. bool mask) {
  4710. // First byte: FIN + opcode
  4711. uint8_t header[2];
  4712. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4713. (static_cast<uint8_t>(opcode) & 0x0F));
  4714. // Second byte: MASK + payload length
  4715. if (len < 126) {
  4716. header[1] = static_cast<uint8_t>(len);
  4717. if (mask) { header[1] |= 0x80; }
  4718. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4719. } else if (len <= 0xFFFF) {
  4720. header[1] = 126;
  4721. if (mask) { header[1] |= 0x80; }
  4722. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4723. uint8_t ext[2];
  4724. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4725. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4726. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4727. } else {
  4728. header[1] = 127;
  4729. if (mask) { header[1] |= 0x80; }
  4730. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4731. uint8_t ext[8];
  4732. for (int i = 7; i >= 0; i--) {
  4733. ext[7 - i] =
  4734. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4735. }
  4736. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4737. }
  4738. if (mask) {
  4739. // Generate random mask key
  4740. uint8_t mask_key[4];
  4741. fill_random_bytes(mask_key, sizeof(mask_key));
  4742. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4743. // Write masked payload in chunks
  4744. const size_t chunk_size = 4096;
  4745. std::vector<char> buf((std::min)(len, chunk_size));
  4746. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4747. size_t n = (std::min)(chunk_size, len - offset);
  4748. for (size_t i = 0; i < n; i++) {
  4749. buf[i] =
  4750. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4751. }
  4752. if (strm.write(buf.data(), n) < 0) { return false; }
  4753. }
  4754. } else {
  4755. if (len > 0) {
  4756. if (strm.write(data, len) < 0) { return false; }
  4757. }
  4758. }
  4759. return true;
  4760. }
  4761. } // namespace detail
  4762. namespace ws {
  4763. namespace impl {
  4764. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4765. // hands back whatever its buffer already holds -- so every multi-byte field has
  4766. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4767. // header straddles the read buffer's boundary.
  4768. //
  4769. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4770. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4771. // there is a failure like any other. (When read() fails it always records why,
  4772. // so the error belongs to this call and not to an earlier one.)
  4773. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4774. auto p = static_cast<char *>(buf);
  4775. size_t total = 0;
  4776. while (total < size) {
  4777. auto n = strm.read(p + total, size - total);
  4778. if (n <= 0) {
  4779. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4780. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4781. }
  4782. total += static_cast<size_t>(n);
  4783. }
  4784. return FrameRead::Ok;
  4785. }
  4786. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4787. std::string &payload, bool &fin,
  4788. bool expect_masked, size_t max_len) {
  4789. // Read first 2 bytes. This is the only read that may report a timeout: it
  4790. // sits on a frame boundary, where nothing has been consumed yet.
  4791. uint8_t header[2];
  4792. FrameRead first = read_exact(strm, header, 2);
  4793. if (first != FrameRead::Ok) { return first; }
  4794. fin = (header[0] & 0x80) != 0;
  4795. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4796. if (header[0] & 0x70) { return FrameRead::Fail; }
  4797. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4798. bool masked = (header[1] & 0x80) != 0;
  4799. uint64_t payload_len = header[1] & 0x7F;
  4800. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4801. // MUST have a payload length of 125 bytes or less
  4802. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4803. if (is_control) {
  4804. if (!fin) { return FrameRead::Fail; }
  4805. if (payload_len > 125) { return FrameRead::Fail; }
  4806. }
  4807. if (masked != expect_masked) { return FrameRead::Fail; }
  4808. // Extended payload length
  4809. if (payload_len == 126) {
  4810. uint8_t ext[2];
  4811. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4812. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4813. } else if (payload_len == 127) {
  4814. uint8_t ext[8];
  4815. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4816. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4817. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4818. payload_len = 0;
  4819. for (int i = 0; i < 8; i++) {
  4820. payload_len = (payload_len << 8) | ext[i];
  4821. }
  4822. }
  4823. // A max_len of 0 means no limit, as payload_max_length does, and a length
  4824. // size_t cannot hold (32-bit builds) is refused either way.
  4825. if ((max_len > 0 && payload_len > max_len) ||
  4826. payload_len > (std::numeric_limits<size_t>::max)()) {
  4827. return FrameRead::Fail;
  4828. }
  4829. // Read mask key if present
  4830. uint8_t mask_key[4] = {0};
  4831. if (masked) {
  4832. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4833. return FrameRead::Fail;
  4834. }
  4835. }
  4836. // Grow the payload only as it arrives, since a header alone can announce
  4837. // max_len bytes that never come.
  4838. payload.clear();
  4839. auto len = static_cast<size_t>(payload_len);
  4840. while (payload.size() < len) {
  4841. auto offset = payload.size();
  4842. auto n = (std::min)(len - offset, CPPHTTPLIB_RECV_BUFSIZ);
  4843. payload.resize(offset + n);
  4844. if (read_exact(strm, &payload[offset], n) != FrameRead::Ok) {
  4845. return FrameRead::Fail;
  4846. }
  4847. }
  4848. // Unmask if needed
  4849. if (masked) {
  4850. for (size_t i = 0; i < payload.size(); i++) {
  4851. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4852. }
  4853. }
  4854. return FrameRead::Ok;
  4855. }
  4856. // RFC 6455 §5.5.1, §7.4: a Close payload is empty, or a status code that may
  4857. // be sent followed by a UTF-8 reason.
  4858. inline bool is_valid_close_payload(const std::string &payload) {
  4859. if (payload.empty()) { return true; }
  4860. if (payload.size() < 2) { return false; }
  4861. auto code = (static_cast<uint8_t>(payload[0]) << 8) |
  4862. static_cast<uint8_t>(payload[1]);
  4863. auto may_be_sent = (1000 <= code && code <= 1003) ||
  4864. (1007 <= code && code <= 1014) ||
  4865. (3000 <= code && code <= 4999);
  4866. return may_be_sent && is_valid_utf8(payload.substr(2));
  4867. }
  4868. } // namespace impl
  4869. } // namespace ws
  4870. namespace detail {
  4871. inline bool is_valid_path(const std::string &path) {
  4872. size_t level = 0;
  4873. size_t i = 0;
  4874. // Skip slash
  4875. while (i < path.size() && path[i] == '/') {
  4876. i++;
  4877. }
  4878. while (i < path.size()) {
  4879. // Read component
  4880. auto beg = i;
  4881. while (i < path.size() && path[i] != '/') {
  4882. if (path[i] == '\0') {
  4883. return false;
  4884. } else if (path[i] == '\\') {
  4885. return false;
  4886. }
  4887. i++;
  4888. }
  4889. auto len = i - beg;
  4890. assert(len > 0);
  4891. if (!path.compare(beg, len, ".")) {
  4892. ;
  4893. } else if (!path.compare(beg, len, "..")) {
  4894. if (level == 0) { return false; }
  4895. level--;
  4896. } else {
  4897. level++;
  4898. }
  4899. // Skip slash
  4900. while (i < path.size() && path[i] == '/') {
  4901. i++;
  4902. }
  4903. }
  4904. return true;
  4905. }
  4906. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4907. #if defined(_WIN32)
  4908. char buf[_MAX_PATH];
  4909. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4910. resolved = buf;
  4911. #elif defined(PATH_MAX)
  4912. char buf[PATH_MAX];
  4913. if (realpath(path, buf) == nullptr) { return false; }
  4914. resolved = buf;
  4915. #else
  4916. auto buf = realpath(path, nullptr);
  4917. auto guard = scope_exit([&]() { std::free(buf); });
  4918. if (buf == nullptr) { return false; }
  4919. resolved = buf;
  4920. #endif
  4921. return true;
  4922. }
  4923. inline bool is_path_within_base(const std::string &resolved_path,
  4924. const std::string &resolved_base) {
  4925. #if defined(_WIN32)
  4926. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4927. resolved_base.size()) == 0;
  4928. #else
  4929. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4930. resolved_base.size()) == 0;
  4931. #endif
  4932. }
  4933. inline FileStat::FileStat(const std::string &path) {
  4934. #if defined(_WIN32)
  4935. auto wpath = u8string_to_wstring(path.c_str());
  4936. ret_ = _wstat(wpath.c_str(), &st_);
  4937. #else
  4938. ret_ = stat(path.c_str(), &st_);
  4939. #endif
  4940. }
  4941. inline bool FileStat::is_file() const {
  4942. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4943. }
  4944. inline bool FileStat::is_dir() const {
  4945. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4946. }
  4947. inline time_t FileStat::mtime() const {
  4948. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4949. : static_cast<time_t>(-1);
  4950. }
  4951. inline size_t FileStat::size() const {
  4952. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4953. }
  4954. inline std::string encode_path(const std::string &s) {
  4955. std::string result;
  4956. result.reserve(s.size());
  4957. for (size_t i = 0; s[i]; i++) {
  4958. switch (s[i]) {
  4959. case ' ': result += "%20"; break;
  4960. case '+': result += "%2B"; break;
  4961. case '\'': result += "%27"; break;
  4962. case ',': result += "%2C"; break;
  4963. // case ':': result += "%3A"; break; // ok? probably...
  4964. case ';': result += "%3B"; break;
  4965. default:
  4966. auto c = static_cast<uint8_t>(s[i]);
  4967. // Control characters (incl. CR/LF) and non-ASCII bytes are not allowed
  4968. // in a request-target as-is.
  4969. if (c < 0x20 || c == 0x7f || c >= 0x80) {
  4970. result += '%';
  4971. char hex[4];
  4972. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4973. assert(len == 2);
  4974. result.append(hex, static_cast<size_t>(len));
  4975. } else {
  4976. result += s[i];
  4977. }
  4978. break;
  4979. }
  4980. }
  4981. return result;
  4982. }
  4983. inline std::string file_extension(const std::string &path) {
  4984. auto i = path.size();
  4985. while (i > 0 && is_ascii_alnum(path[i - 1])) {
  4986. i--;
  4987. }
  4988. if (i == path.size() || i == 0 || path[i - 1] != '.') {
  4989. return std::string();
  4990. }
  4991. return path.substr(i);
  4992. }
  4993. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4994. template <typename T>
  4995. inline bool parse_header(const char *beg, const char *end, T fn);
  4996. template <typename T>
  4997. inline bool parse_header(const char *beg, const char *end, T fn) {
  4998. // Skip trailing spaces and tabs.
  4999. while (beg < end && is_space_or_tab(end[-1])) {
  5000. end--;
  5001. }
  5002. auto p = beg;
  5003. while (p < end && *p != ':') {
  5004. p++;
  5005. }
  5006. auto name = std::string(beg, p);
  5007. if (!detail::fields::is_field_name(name)) { return false; }
  5008. if (p == end) { return false; }
  5009. auto key_end = p;
  5010. if (*p++ != ':') { return false; }
  5011. while (p < end && is_space_or_tab(*p)) {
  5012. p++;
  5013. }
  5014. if (p <= end) {
  5015. auto key_len = key_end - beg;
  5016. if (!key_len) { return false; }
  5017. auto key = std::string(beg, key_end);
  5018. auto val = std::string(p, end);
  5019. if (!detail::fields::is_field_value(val)) { return false; }
  5020. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  5021. // percent-decoded by the recipient. Applications that need to interpret a
  5022. // value as a URI component should call httplib::decode_uri_component()
  5023. // (or decode_path_component()) explicitly.
  5024. fn(key, val);
  5025. return true;
  5026. }
  5027. return false;
  5028. }
  5029. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  5030. const Headers &src_headers) {
  5031. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  5032. // transfer coding is complete when a chunk with a chunk-size of zero is
  5033. // received, possibly followed by a trailer section, and finally terminated by
  5034. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  5035. //
  5036. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  5037. // doesn't care for the existence of the final CRLF. In other words, it seems
  5038. // to be ok whether the final CRLF exists or not in the chunked data.
  5039. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  5040. //
  5041. // According to the reference code in RFC 9112, cpp-httplib now allows
  5042. // chunked transfer coding data without the final CRLF.
  5043. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  5044. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  5045. "transfer-encoding",
  5046. "content-length",
  5047. "host",
  5048. "authorization",
  5049. "www-authenticate",
  5050. "proxy-authenticate",
  5051. "proxy-authorization",
  5052. "cookie",
  5053. "set-cookie",
  5054. "cache-control",
  5055. "expect",
  5056. "max-forwards",
  5057. "pragma",
  5058. "range",
  5059. "te",
  5060. "age",
  5061. "expires",
  5062. "date",
  5063. "location",
  5064. "retry-after",
  5065. "vary",
  5066. "warning",
  5067. "content-encoding",
  5068. "content-type",
  5069. "content-range",
  5070. "trailer"};
  5071. case_ignore::unordered_set<std::string> declared_trailers;
  5072. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  5073. if (!trailer_header.empty()) {
  5074. // split() trims each token and skips empty ones, so the name arrives ready
  5075. // to look up.
  5076. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  5077. ',', [&](const char *b, const char *e) {
  5078. // A legitimate message declares only a handful of trailers. Cap the
  5079. // set so a peer cannot grow it without bound: an oversized set only
  5080. // arises from an attempt to force many colliding names into
  5081. // quadratic lookups (case_ignore::hash is unkeyed).
  5082. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  5083. return;
  5084. }
  5085. std::string key(b, e);
  5086. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  5087. declared_trailers.insert(key);
  5088. }
  5089. });
  5090. }
  5091. size_t trailer_header_count = 0;
  5092. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  5093. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  5094. // Count every received trailer field, not only the declared ones stored in
  5095. // dest, so undeclared fields cannot keep this loop running past the limit.
  5096. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  5097. constexpr auto line_terminator_len = 2;
  5098. auto line_beg = line_reader.ptr();
  5099. auto line_end =
  5100. line_reader.ptr() + line_reader.size() - line_terminator_len;
  5101. if (!parse_header(line_beg, line_end,
  5102. [&](const std::string &key, const std::string &val) {
  5103. if (declared_trailers.find(key) !=
  5104. declared_trailers.end()) {
  5105. dest.emplace(key, val);
  5106. }
  5107. })) {
  5108. return false;
  5109. }
  5110. trailer_header_count++;
  5111. if (!line_reader.getline()) { return false; }
  5112. }
  5113. return true;
  5114. }
  5115. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  5116. size_t right) {
  5117. while (b + left < e && is_space_or_tab(b[left])) {
  5118. left++;
  5119. }
  5120. while (right > 0 && is_space_or_tab(b[right - 1])) {
  5121. right--;
  5122. }
  5123. return std::make_pair(left, right);
  5124. }
  5125. inline std::string trim_copy(const std::string &s) {
  5126. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  5127. return s.substr(r.first, r.second - r.first);
  5128. }
  5129. inline std::string trim_double_quotes_copy(const std::string &s) {
  5130. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  5131. return s.substr(1, s.size() - 2);
  5132. }
  5133. return s;
  5134. }
  5135. // Takes the quotes off a parameter value. Only \" and \\ are quoted-pairs
  5136. // here, as browsers send any other backslash, such as one in a Windows path,
  5137. // as it is.
  5138. inline std::string unquote_param(const std::string &s) {
  5139. if (s.size() < 2 || s.front() != '"' || s.back() != '"') { return s; }
  5140. std::string out;
  5141. for (size_t i = 1; i + 1 < s.size(); i++) {
  5142. if (s[i] == '\\' && i + 2 < s.size() &&
  5143. (s[i + 1] == '"' || s[i + 1] == '\\')) {
  5144. i++;
  5145. }
  5146. out += s[i];
  5147. }
  5148. return out;
  5149. }
  5150. inline void
  5151. divide(const char *data, std::size_t size, char d,
  5152. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5153. fn) {
  5154. const auto it = std::find(data, data + size, d);
  5155. const auto found = static_cast<std::size_t>(it != data + size);
  5156. const auto lhs_data = data;
  5157. const auto lhs_size = static_cast<std::size_t>(it - data);
  5158. const auto rhs_data = it + found;
  5159. const auto rhs_size = size - lhs_size - found;
  5160. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  5161. }
  5162. inline void
  5163. divide(const std::string &str, char d,
  5164. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5165. fn) {
  5166. divide(str.data(), str.size(), d, std::move(fn));
  5167. }
  5168. inline void split(const char *b, const char *e, char d,
  5169. std::function<void(const char *, const char *)> fn) {
  5170. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5171. }
  5172. inline void split(const char *b, const char *e, char d, size_t m,
  5173. std::function<void(const char *, const char *)> fn) {
  5174. size_t i = 0;
  5175. size_t beg = 0;
  5176. size_t count = 1;
  5177. while (e ? (b + i < e) : (b[i] != '\0')) {
  5178. if (b[i] == d && count < m) {
  5179. auto r = trim(b, e, beg, i);
  5180. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5181. beg = i + 1;
  5182. count++;
  5183. }
  5184. i++;
  5185. }
  5186. if (i) {
  5187. auto r = trim(b, e, beg, i);
  5188. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5189. }
  5190. }
  5191. // Same contract as split(), except that a delimiter inside a quoted-string is
  5192. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5193. // quoted-string, and ';' and '=' are legal characters inside one.
  5194. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5195. std::function<void(const char *, const char *)> fn) {
  5196. size_t i = 0;
  5197. size_t beg = 0;
  5198. size_t count = 1;
  5199. auto in_quotes = false;
  5200. auto has = [&](size_t j) { return e ? (b + j < e) : (b[j] != '\0'); };
  5201. while (has(i)) {
  5202. if (in_quotes && b[i] == '\\' && has(i + 1)) {
  5203. // A quoted-pair, whose second character does not end the string.
  5204. i++;
  5205. } else if (b[i] == '"') {
  5206. in_quotes = !in_quotes;
  5207. } else if (b[i] == d && !in_quotes && count < m) {
  5208. auto r = trim(b, e, beg, i);
  5209. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5210. beg = i + 1;
  5211. count++;
  5212. }
  5213. i++;
  5214. }
  5215. if (i) {
  5216. auto r = trim(b, e, beg, i);
  5217. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5218. }
  5219. }
  5220. inline void split_unquoted(const char *b, const char *e, char d,
  5221. std::function<void(const char *, const char *)> fn) {
  5222. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5223. std::move(fn));
  5224. }
  5225. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5226. // key a token, so the first '=' is the separator even when the value is a
  5227. // quoted-string carrying more of them.
  5228. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5229. std::string &val) {
  5230. divide(
  5231. b, static_cast<std::size_t>(e - b), '=',
  5232. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5233. const auto kr = trim(kb, kb + klen, 0, klen);
  5234. key.assign(kb + kr.first, kb + kr.second);
  5235. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5236. val.assign(vb + vr.first, vb + vr.second);
  5237. });
  5238. }
  5239. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5240. std::function<bool(const char *, const char *)> fn) {
  5241. size_t i = 0;
  5242. size_t beg = 0;
  5243. size_t count = 1;
  5244. while (e ? (b + i < e) : (b[i] != '\0')) {
  5245. if (b[i] == d && count < m) {
  5246. auto r = trim(b, e, beg, i);
  5247. if (r.first < r.second) {
  5248. auto found = fn(&b[r.first], &b[r.second]);
  5249. if (found) { return true; }
  5250. }
  5251. beg = i + 1;
  5252. count++;
  5253. }
  5254. i++;
  5255. }
  5256. if (i) {
  5257. auto r = trim(b, e, beg, i);
  5258. if (r.first < r.second) {
  5259. auto found = fn(&b[r.first], &b[r.second]);
  5260. if (found) { return true; }
  5261. }
  5262. }
  5263. return false;
  5264. }
  5265. inline bool split_find(const char *b, const char *e, char d,
  5266. std::function<bool(const char *, const char *)> fn) {
  5267. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5268. std::move(fn));
  5269. }
  5270. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5271. size_t fixed_buffer_size)
  5272. : strm_(strm), fixed_buffer_(fixed_buffer),
  5273. fixed_buffer_size_(fixed_buffer_size) {}
  5274. inline const char *stream_line_reader::ptr() const {
  5275. if (growable_buffer_.empty()) {
  5276. return fixed_buffer_;
  5277. } else {
  5278. return growable_buffer_.data();
  5279. }
  5280. }
  5281. inline size_t stream_line_reader::size() const {
  5282. if (growable_buffer_.empty()) {
  5283. return fixed_buffer_used_size_;
  5284. } else {
  5285. return growable_buffer_.size();
  5286. }
  5287. }
  5288. inline bool stream_line_reader::end_with_crlf() const {
  5289. auto end = ptr() + size();
  5290. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5291. }
  5292. inline bool stream_line_reader::getline() {
  5293. fixed_buffer_used_size_ = 0;
  5294. growable_buffer_.clear();
  5295. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5296. char prev_byte = 0;
  5297. #endif
  5298. for (size_t i = 0;; i++) {
  5299. // Fast path: whatever the stream has already buffered can be scanned for
  5300. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5301. // call, a bounds check and a one-byte copy per character of the request.
  5302. size_t buffered_size = 0;
  5303. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5304. auto take = buffered_size;
  5305. auto terminated = false;
  5306. for (size_t at = 0; at < buffered_size;) {
  5307. auto nl = static_cast<const char *>(
  5308. memchr(buffered + at, '\n', buffered_size - at));
  5309. if (!nl) { break; }
  5310. auto pos = static_cast<size_t>(nl - buffered);
  5311. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5312. take = pos + 1;
  5313. terminated = true;
  5314. break;
  5315. #else
  5316. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5317. // be the last byte of an earlier chunk, hence prev_byte.
  5318. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5319. take = pos + 1;
  5320. terminated = true;
  5321. break;
  5322. }
  5323. at = pos + 1;
  5324. #endif
  5325. }
  5326. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5327. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5328. prev_byte = buffered[take - 1];
  5329. #endif
  5330. append(buffered, take);
  5331. strm_.consume_buffered(take);
  5332. i += take;
  5333. if (terminated) { return true; }
  5334. continue;
  5335. }
  5336. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5337. // Treat exceptionally long lines as an error to
  5338. // prevent infinite loops/memory exhaustion
  5339. return false;
  5340. }
  5341. char byte;
  5342. auto n = strm_.read(&byte, 1);
  5343. if (n < 0) {
  5344. return false;
  5345. } else if (n == 0) {
  5346. if (i == 0) {
  5347. return false;
  5348. } else {
  5349. break;
  5350. }
  5351. }
  5352. append(byte);
  5353. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5354. if (byte == '\n') { break; }
  5355. #else
  5356. if (prev_byte == '\r' && byte == '\n') { break; }
  5357. prev_byte = byte;
  5358. #endif
  5359. }
  5360. return true;
  5361. }
  5362. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5363. inline void stream_line_reader::append(const char *data, size_t size) {
  5364. // Once the line has outgrown the fixed buffer everything must keep going to
  5365. // the growable one, even if a later chunk would have fit. Without the
  5366. // emptiness check a short append after a long one would land in the fixed
  5367. // buffer, which ptr() and size() no longer look at, and be lost.
  5368. if (growable_buffer_.empty() &&
  5369. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5370. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5371. fixed_buffer_used_size_ += size;
  5372. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5373. } else {
  5374. // Unlike the per-character overload, this can be the very first append of
  5375. // the line, so the fixed buffer may hold nothing and carry no terminator
  5376. // yet. assign() takes an explicit length and does not need one.
  5377. if (growable_buffer_.empty()) {
  5378. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5379. }
  5380. growable_buffer_.append(data, size);
  5381. }
  5382. }
  5383. inline mmap::mmap(const char *path) { open(path); }
  5384. inline mmap::~mmap() { close(); }
  5385. inline bool mmap::open(const char *path) {
  5386. close();
  5387. #if defined(_WIN32)
  5388. auto wpath = u8string_to_wstring(path);
  5389. if (wpath.empty()) { return false; }
  5390. hFile_ =
  5391. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5392. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5393. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5394. LARGE_INTEGER size{};
  5395. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5396. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5397. // See:
  5398. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5399. if (static_cast<ULONGLONG>(size.QuadPart) >
  5400. (std::numeric_limits<decltype(size_)>::max)()) {
  5401. // `size_t` might be 32-bits, on 32-bits Windows.
  5402. return false;
  5403. }
  5404. size_ = static_cast<size_t>(size.QuadPart);
  5405. hMapping_ =
  5406. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5407. // Special treatment for an empty file...
  5408. if (hMapping_ == NULL && size_ == 0) {
  5409. close();
  5410. is_open_empty_file = true;
  5411. return true;
  5412. }
  5413. if (hMapping_ == NULL) {
  5414. close();
  5415. return false;
  5416. }
  5417. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5418. if (addr_ == nullptr) {
  5419. close();
  5420. return false;
  5421. }
  5422. #else
  5423. // O_NONBLOCK so that opening a FIFO does not wait for a writer.
  5424. fd_ = ::open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
  5425. if (fd_ == -1) { return false; }
  5426. // Only a regular file has a size to serve, unlike a directory or a device.
  5427. struct stat sb;
  5428. if (fstat(fd_, &sb) == -1 || !S_ISREG(sb.st_mode) ||
  5429. static_cast<uint64_t>(sb.st_size) >
  5430. (std::numeric_limits<size_t>::max)()) {
  5431. close();
  5432. return false;
  5433. }
  5434. size_ = static_cast<size_t>(sb.st_size);
  5435. #endif
  5436. return true;
  5437. }
  5438. inline bool mmap::is_open() const {
  5439. #if defined(_WIN32)
  5440. return is_open_empty_file ? true : addr_ != nullptr;
  5441. #else
  5442. return fd_ != -1;
  5443. #endif
  5444. }
  5445. inline size_t mmap::size() const { return size_; }
  5446. inline void mmap::close() {
  5447. #if defined(_WIN32)
  5448. if (addr_) {
  5449. ::UnmapViewOfFile(addr_);
  5450. addr_ = nullptr;
  5451. }
  5452. if (hMapping_) {
  5453. ::CloseHandle(hMapping_);
  5454. hMapping_ = NULL;
  5455. }
  5456. if (hFile_ != INVALID_HANDLE_VALUE) {
  5457. ::CloseHandle(hFile_);
  5458. hFile_ = INVALID_HANDLE_VALUE;
  5459. }
  5460. is_open_empty_file = false;
  5461. #else
  5462. if (fd_ != -1) {
  5463. ::close(fd_);
  5464. fd_ = -1;
  5465. }
  5466. #endif
  5467. size_ = 0;
  5468. }
  5469. inline int close_socket(socket_t sock) noexcept {
  5470. #ifdef _WIN32
  5471. return closesocket(sock);
  5472. #else
  5473. return close(sock);
  5474. #endif
  5475. }
  5476. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5477. ssize_t res = 0;
  5478. while (true) {
  5479. res = fn();
  5480. if (res < 0 && errno == EINTR) {
  5481. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5482. continue;
  5483. }
  5484. break;
  5485. }
  5486. return res;
  5487. }
  5488. inline size_t mmap::read(size_t offset, char *buf, size_t len) const {
  5489. if (offset >= size_) { return 0; }
  5490. len = (std::min)(len, size_ - offset);
  5491. #if defined(_WIN32)
  5492. // Windows does not let a mapped file be truncated.
  5493. std::memcpy(buf, static_cast<const char *>(addr_) + offset, len);
  5494. return len;
  5495. #else
  5496. auto n = handle_EINTR(
  5497. [&]() { return ::pread(fd_, buf, len, static_cast<off_t>(offset)); });
  5498. return n > 0 ? static_cast<size_t>(n) : 0;
  5499. #endif
  5500. }
  5501. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5502. return handle_EINTR([&]() {
  5503. return recv(sock,
  5504. #ifdef _WIN32
  5505. static_cast<char *>(ptr), static_cast<int>(size),
  5506. #else
  5507. ptr, size,
  5508. #endif
  5509. flags);
  5510. });
  5511. }
  5512. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5513. int flags) {
  5514. return handle_EINTR([&]() {
  5515. return send(sock,
  5516. #ifdef _WIN32
  5517. static_cast<const char *>(ptr), static_cast<int>(size),
  5518. #else
  5519. ptr, size,
  5520. #endif
  5521. flags);
  5522. });
  5523. }
  5524. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5525. #ifdef _WIN32
  5526. return ::WSAPoll(fds, nfds, timeout);
  5527. #else
  5528. return ::poll(fds, nfds, timeout);
  5529. #endif
  5530. }
  5531. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5532. time_t usec) {
  5533. struct pollfd pfd;
  5534. pfd.fd = sock;
  5535. pfd.events = events;
  5536. pfd.revents = 0;
  5537. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5538. // "return immediately", which callers here rely on to probe a socket.
  5539. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5540. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5541. }
  5542. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5543. return select_impl(sock, POLLIN, sec, usec);
  5544. }
  5545. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5546. return select_impl(sock, POLLOUT, sec, usec);
  5547. }
  5548. // The point sec and usec from now, for select_until(). A negative sec never
  5549. // comes, as a negative timeout waits forever in select_impl().
  5550. inline std::chrono::steady_clock::time_point deadline_after(time_t sec,
  5551. time_t usec) {
  5552. if (sec < 0) { return std::chrono::steady_clock::time_point::max(); }
  5553. return std::chrono::steady_clock::now() + std::chrono::seconds(sec) +
  5554. std::chrono::microseconds(usec);
  5555. }
  5556. // Waits only for the time left until deadline, so that all the waits of one
  5557. // TLS handshake come out of a single timeout.
  5558. inline ssize_t select_until(socket_t sock, short events,
  5559. std::chrono::steady_clock::time_point deadline) {
  5560. if (deadline == std::chrono::steady_clock::time_point::max()) {
  5561. return select_impl(sock, events, -1, 0);
  5562. }
  5563. auto left = std::chrono::duration_cast<std::chrono::microseconds>(
  5564. deadline - std::chrono::steady_clock::now())
  5565. .count();
  5566. if (left <= 0) { return 0; }
  5567. return select_impl(sock, events, static_cast<time_t>(left / 1000000),
  5568. static_cast<time_t>(left % 1000000));
  5569. }
  5570. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5571. time_t usec) {
  5572. struct pollfd pfd_read;
  5573. pfd_read.fd = sock;
  5574. pfd_read.events = POLLIN | POLLOUT;
  5575. pfd_read.revents = 0;
  5576. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5577. auto poll_res =
  5578. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5579. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5580. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5581. auto error = 0;
  5582. socklen_t len = sizeof(error);
  5583. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5584. reinterpret_cast<char *>(&error), &len);
  5585. auto successful = res >= 0 && !error;
  5586. return successful ? Error::Success : Error::Connection;
  5587. }
  5588. return Error::Connection;
  5589. }
  5590. inline bool is_socket_alive(socket_t sock) {
  5591. const auto val = detail::select_read(sock, 0, 0);
  5592. if (val == 0) {
  5593. return true;
  5594. } else if (val < 0 && errno == EBADF) {
  5595. return false;
  5596. }
  5597. char buf[1];
  5598. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5599. }
  5600. class SocketStream final : public Stream {
  5601. public:
  5602. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5603. time_t write_timeout_sec, time_t write_timeout_usec,
  5604. time_t max_timeout_msec = 0,
  5605. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5606. (std::chrono::steady_clock::time_point::min)());
  5607. ~SocketStream() override;
  5608. bool is_readable() const override;
  5609. bool wait_readable() const override;
  5610. bool wait_writable() const override;
  5611. bool is_peer_alive() const override;
  5612. ssize_t read(char *ptr, size_t size) override;
  5613. ssize_t write(const char *ptr, size_t size) override;
  5614. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5615. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5616. socket_t socket() const override;
  5617. time_t duration() const override;
  5618. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5619. void set_max_timeout(time_t msec) override;
  5620. const char *buffered_data(size_t &size) const override;
  5621. void consume_buffered(size_t size) override;
  5622. // The caller has just seen this socket become readable. Lets the next read
  5623. // skip its own readiness wait, which would otherwise ask the kernel a
  5624. // question that was answered a moment ago. Consumed by that read.
  5625. void set_readable_hint() { readable_hint_ = true; }
  5626. private:
  5627. bool ensure_readable();
  5628. socket_t sock_;
  5629. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5630. // thread while a read is in flight -- that is the point of it, for a caller
  5631. // holding one connection and wanting control back to send on it.
  5632. std::atomic<time_t> read_timeout_sec_;
  5633. std::atomic<time_t> read_timeout_usec_;
  5634. time_t write_timeout_sec_;
  5635. time_t write_timeout_usec_;
  5636. time_t max_timeout_msec_;
  5637. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5638. std::vector<char> read_buff_;
  5639. size_t read_buff_off_ = 0;
  5640. size_t read_buff_content_size_ = 0;
  5641. bool readable_hint_ = false;
  5642. static const size_t read_buff_size_ = 1024l * 4;
  5643. };
  5644. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5645. time_t keep_alive_timeout_sec) {
  5646. using namespace std::chrono;
  5647. const auto interval_usec =
  5648. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5649. // Avoid expensive `steady_clock::now()` call for the first time
  5650. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5651. const auto start = steady_clock::now() - microseconds{interval_usec};
  5652. const auto timeout = seconds{keep_alive_timeout_sec};
  5653. while (true) {
  5654. if (svr_sock == INVALID_SOCKET) {
  5655. break; // Server socket is closed
  5656. }
  5657. auto val = select_read(sock, 0, interval_usec);
  5658. if (val < 0) {
  5659. break; // Ssocket error
  5660. } else if (val == 0) {
  5661. if (steady_clock::now() - start > timeout) {
  5662. break; // Timeout
  5663. }
  5664. } else {
  5665. return true; // Ready for read
  5666. }
  5667. }
  5668. return false;
  5669. }
  5670. // `has_buffered_request` reports whether the connection's stream already holds
  5671. // bytes of the next request. A client may pipeline its requests (RFC 9112
  5672. // 9.3.2), so reading one request can pull the start of the next one into the
  5673. // stream's buffer; that request must be served without waiting for the socket
  5674. // to become readable again, since its bytes are no longer on the socket.
  5675. // `callback` is told whether keep_alive() has just seen the socket go readable.
  5676. template <typename P, typename T>
  5677. inline bool process_server_socket_core(const std::atomic<socket_t> &svr_sock,
  5678. socket_t sock,
  5679. size_t keep_alive_max_count,
  5680. time_t keep_alive_timeout_sec,
  5681. P has_buffered_request, T callback) {
  5682. assert(keep_alive_max_count > 0);
  5683. auto ret = false;
  5684. auto count = keep_alive_max_count;
  5685. while (count > 0) {
  5686. auto socket_readable = false;
  5687. if (!has_buffered_request()) {
  5688. if (!keep_alive(svr_sock, sock, keep_alive_timeout_sec)) { break; }
  5689. socket_readable = true;
  5690. }
  5691. auto close_connection = count == 1;
  5692. auto connection_closed = false;
  5693. ret = callback(socket_readable, close_connection, connection_closed);
  5694. if (!ret || connection_closed) { break; }
  5695. count--;
  5696. }
  5697. return ret;
  5698. }
  5699. template <typename T>
  5700. inline bool
  5701. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5702. size_t keep_alive_max_count,
  5703. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5704. time_t read_timeout_usec, time_t write_timeout_sec,
  5705. time_t write_timeout_usec, T callback) {
  5706. // One stream per connection: its read buffer can already hold the start of
  5707. // the next, pipelined request.
  5708. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5709. write_timeout_sec, write_timeout_usec);
  5710. return process_server_socket_core(
  5711. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5712. [&]() { return strm.is_readable(); },
  5713. [&](bool socket_readable, bool close_connection,
  5714. bool &connection_closed) {
  5715. if (socket_readable) { strm.set_readable_hint(); }
  5716. return callback(strm, close_connection, connection_closed);
  5717. });
  5718. }
  5719. inline bool process_client_socket(
  5720. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5721. time_t write_timeout_sec, time_t write_timeout_usec,
  5722. time_t max_timeout_msec,
  5723. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5724. std::function<bool(Stream &)> callback) {
  5725. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5726. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5727. start_time);
  5728. return callback(strm);
  5729. }
  5730. inline int shutdown_socket(socket_t sock) noexcept {
  5731. #ifdef _WIN32
  5732. return shutdown(sock, SD_BOTH);
  5733. #else
  5734. return shutdown(sock, SHUT_RDWR);
  5735. #endif
  5736. }
  5737. // Half-closes the write side and drains any in-flight/queued bytes before
  5738. // the final shutdown+close. Closing with unread data in the receive queue
  5739. // (or bytes arriving after the receive side is closed) makes the stack send
  5740. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5741. // response as a failed read even though it was fully written.
  5742. inline void drain_and_close_socket(socket_t sock) noexcept {
  5743. #ifdef _WIN32
  5744. shutdown(sock, SD_SEND);
  5745. #else
  5746. shutdown(sock, SHUT_WR);
  5747. #endif
  5748. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5749. size_t total = 0;
  5750. const auto deadline = std::chrono::steady_clock::now() +
  5751. std::chrono::milliseconds(100); // bound #1
  5752. while (total < size_t(1024u * 1024u)) { // bound #2
  5753. const auto remaining =
  5754. std::chrono::duration_cast<std::chrono::microseconds>(
  5755. deadline - std::chrono::steady_clock::now())
  5756. .count();
  5757. if (remaining <= 0) { break; }
  5758. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5759. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5760. if (n <= 0) { break; }
  5761. total += static_cast<size_t>(n);
  5762. }
  5763. shutdown_socket(sock);
  5764. close_socket(sock);
  5765. }
  5766. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5767. if (s.size() > 1 && s[0] == '\0') {
  5768. auto ret = s;
  5769. ret[0] = '@';
  5770. return ret;
  5771. }
  5772. return s;
  5773. }
  5774. inline std::string
  5775. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5776. if (s.size() > 1 && s[0] == '@') {
  5777. auto ret = s;
  5778. ret[0] = '\0';
  5779. return ret;
  5780. }
  5781. return s;
  5782. }
  5783. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5784. const struct addrinfo *hints,
  5785. struct addrinfo **res, time_t timeout_sec) {
  5786. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5787. if (timeout_sec <= 0) {
  5788. // No timeout specified, use standard getaddrinfo
  5789. return getaddrinfo(node, service, hints, res);
  5790. }
  5791. #ifdef _WIN32
  5792. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5793. OVERLAPPED overlapped = {};
  5794. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5795. if (!event) { return EAI_FAIL; }
  5796. overlapped.hEvent = event;
  5797. PADDRINFOEXW result_addrinfo = nullptr;
  5798. HANDLE cancel_handle = nullptr;
  5799. ADDRINFOEXW hints_ex = {};
  5800. if (hints) {
  5801. hints_ex.ai_flags = hints->ai_flags;
  5802. hints_ex.ai_family = hints->ai_family;
  5803. hints_ex.ai_socktype = hints->ai_socktype;
  5804. hints_ex.ai_protocol = hints->ai_protocol;
  5805. }
  5806. auto wnode = u8string_to_wstring(node);
  5807. auto wservice = u8string_to_wstring(service);
  5808. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5809. hints ? &hints_ex : nullptr, &result_addrinfo,
  5810. nullptr, &overlapped, nullptr, &cancel_handle);
  5811. if (ret == WSA_IO_PENDING) {
  5812. auto wait_result =
  5813. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5814. if (wait_result == WAIT_TIMEOUT) {
  5815. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5816. ::CloseHandle(event);
  5817. return EAI_AGAIN;
  5818. }
  5819. DWORD bytes_returned;
  5820. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5821. &bytes_returned, FALSE)) {
  5822. ::CloseHandle(event);
  5823. return ::WSAGetLastError();
  5824. }
  5825. }
  5826. ::CloseHandle(event);
  5827. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5828. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5829. return 0;
  5830. }
  5831. return ret;
  5832. #elif TARGET_OS_MAC && defined(__clang__)
  5833. if (!node) { return EAI_NONAME; }
  5834. // macOS implementation using CFHost API for asynchronous DNS resolution
  5835. CFStringRef hostname_ref = CFStringCreateWithCString(
  5836. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5837. if (!hostname_ref) { return EAI_MEMORY; }
  5838. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5839. CFRelease(hostname_ref);
  5840. if (!host_ref) { return EAI_MEMORY; }
  5841. // Set up context for callback
  5842. struct CFHostContext {
  5843. bool completed = false;
  5844. bool success = false;
  5845. CFArrayRef addresses = nullptr;
  5846. std::mutex mutex;
  5847. std::condition_variable cv;
  5848. } context;
  5849. CFHostClientContext client_context;
  5850. memset(&client_context, 0, sizeof(client_context));
  5851. client_context.info = &context;
  5852. // Set callback
  5853. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5854. const CFStreamError *error, void *info) {
  5855. auto ctx = static_cast<CFHostContext *>(info);
  5856. std::lock_guard<std::mutex> lock(ctx->mutex);
  5857. if (error && error->error != 0) {
  5858. ctx->success = false;
  5859. } else {
  5860. Boolean hasBeenResolved;
  5861. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5862. if (ctx->addresses && hasBeenResolved) {
  5863. CFRetain(ctx->addresses);
  5864. ctx->success = true;
  5865. } else {
  5866. ctx->success = false;
  5867. }
  5868. }
  5869. ctx->completed = true;
  5870. ctx->cv.notify_one();
  5871. };
  5872. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5873. CFRelease(host_ref);
  5874. return EAI_SYSTEM;
  5875. }
  5876. // Schedule on run loop
  5877. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5878. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5879. // Start resolution
  5880. CFStreamError stream_error;
  5881. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5882. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5883. CFRelease(host_ref);
  5884. return EAI_FAIL;
  5885. }
  5886. // Wait for completion with timeout
  5887. auto timeout_time =
  5888. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5889. bool timed_out = false;
  5890. {
  5891. std::unique_lock<std::mutex> lock(context.mutex);
  5892. while (!context.completed) {
  5893. auto now = std::chrono::steady_clock::now();
  5894. if (now >= timeout_time) {
  5895. timed_out = true;
  5896. break;
  5897. }
  5898. // Run the runloop for a short time
  5899. lock.unlock();
  5900. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5901. lock.lock();
  5902. }
  5903. }
  5904. // Clean up
  5905. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5906. CFHostSetClient(host_ref, nullptr, nullptr);
  5907. if (timed_out || !context.completed) {
  5908. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5909. CFRelease(host_ref);
  5910. return EAI_AGAIN;
  5911. }
  5912. if (!context.success || !context.addresses) {
  5913. CFRelease(host_ref);
  5914. return EAI_NODATA;
  5915. }
  5916. // Convert CFArray to addrinfo
  5917. CFIndex count = CFArrayGetCount(context.addresses);
  5918. if (count == 0) {
  5919. CFRelease(context.addresses);
  5920. CFRelease(host_ref);
  5921. return EAI_NODATA;
  5922. }
  5923. struct addrinfo *result_addrinfo = nullptr;
  5924. struct addrinfo **current = &result_addrinfo;
  5925. for (CFIndex i = 0; i < count; i++) {
  5926. CFDataRef addr_data =
  5927. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5928. if (!addr_data) continue;
  5929. const struct sockaddr *sockaddr_ptr =
  5930. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5931. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5932. // Allocate addrinfo structure
  5933. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5934. if (!*current) {
  5935. freeaddrinfo(result_addrinfo);
  5936. CFRelease(context.addresses);
  5937. CFRelease(host_ref);
  5938. return EAI_MEMORY;
  5939. }
  5940. memset(*current, 0, sizeof(struct addrinfo));
  5941. // Set up addrinfo fields
  5942. (*current)->ai_family = sockaddr_ptr->sa_family;
  5943. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5944. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5945. (*current)->ai_addrlen = sockaddr_len;
  5946. // Copy sockaddr
  5947. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5948. if (!(*current)->ai_addr) {
  5949. freeaddrinfo(result_addrinfo);
  5950. CFRelease(context.addresses);
  5951. CFRelease(host_ref);
  5952. return EAI_MEMORY;
  5953. }
  5954. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5955. // Set port if service is specified
  5956. if (service && *service) {
  5957. int port = 0;
  5958. if (parse_port(service, strlen(service), port)) {
  5959. if (sockaddr_ptr->sa_family == AF_INET) {
  5960. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5961. ->sin_port = htons(static_cast<uint16_t>(port));
  5962. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5963. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5964. ->sin6_port = htons(static_cast<uint16_t>(port));
  5965. }
  5966. }
  5967. }
  5968. current = &((*current)->ai_next);
  5969. }
  5970. CFRelease(context.addresses);
  5971. CFRelease(host_ref);
  5972. *res = result_addrinfo;
  5973. return 0;
  5974. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5975. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) && \
  5976. !defined(CPPHTTPLIB_THREAD_SANITIZER)
  5977. // Skipped under TSan: glibc's internal resolver thread is invisible to it.
  5978. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5979. // the resolver worker still references the stack-local gaicb. The cancel
  5980. // path therefore waits (gai_suspend with no timeout) for the worker to
  5981. // actually finish before letting the stack frame go. The trade-off is that
  5982. // a wedged DNS server can hold this thread for the system resolver timeout
  5983. // (~30s by default) past the caller's connection timeout.
  5984. struct gaicb request{};
  5985. struct gaicb *requests[1] = {&request};
  5986. struct sigevent sevp{};
  5987. struct timespec timeout{timeout_sec, 0};
  5988. request.ar_name = node;
  5989. request.ar_service = service;
  5990. request.ar_request = hints;
  5991. sevp.sigev_notify = SIGEV_NONE;
  5992. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5993. if (rc != 0) { return rc; }
  5994. auto cleanup = scope_exit([&] {
  5995. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5996. });
  5997. int wait_result = gai_suspend(requests, 1, &timeout);
  5998. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5999. int gai_result = gai_error(&request);
  6000. if (gai_result == 0) {
  6001. *res = request.ar_result;
  6002. request.ar_result = nullptr;
  6003. return 0;
  6004. }
  6005. return gai_result;
  6006. }
  6007. gai_cancel(&request);
  6008. while (gai_error(&request) == EAI_INPROGRESS) {
  6009. gai_suspend(requests, 1, nullptr);
  6010. }
  6011. return wait_result;
  6012. #else
  6013. // Fallback implementation using thread-based timeout for other Unix systems.
  6014. struct GetAddrInfoState {
  6015. ~GetAddrInfoState() {
  6016. if (info) { freeaddrinfo(info); }
  6017. }
  6018. std::mutex mutex;
  6019. std::condition_variable result_cv;
  6020. bool completed = false;
  6021. int result = EAI_SYSTEM;
  6022. std::string node;
  6023. std::string service;
  6024. struct addrinfo hints;
  6025. struct addrinfo *info = nullptr;
  6026. };
  6027. // Allocate on the heap, so the resolver thread can keep using the data.
  6028. auto state = std::make_shared<GetAddrInfoState>();
  6029. if (node) { state->node = node; }
  6030. state->service = service;
  6031. state->hints = *hints;
  6032. std::thread resolve_thread([state]() {
  6033. auto thread_result =
  6034. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  6035. &state->info);
  6036. std::lock_guard<std::mutex> lock(state->mutex);
  6037. state->result = thread_result;
  6038. state->completed = true;
  6039. state->result_cv.notify_one();
  6040. });
  6041. // Wait for completion or timeout
  6042. std::unique_lock<std::mutex> lock(state->mutex);
  6043. auto finished =
  6044. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  6045. [&] { return state->completed; });
  6046. if (finished) {
  6047. // Operation completed within timeout
  6048. resolve_thread.join();
  6049. *res = state->info;
  6050. state->info = nullptr; // Pass ownership to caller
  6051. return state->result;
  6052. } else {
  6053. // Timeout occurred
  6054. resolve_thread.detach(); // Let the thread finish in background
  6055. return EAI_AGAIN; // Return timeout error
  6056. }
  6057. #endif
  6058. #else
  6059. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  6060. return getaddrinfo(node, service, hints, res);
  6061. #endif
  6062. }
  6063. template <typename BindOrConnect>
  6064. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  6065. int address_family, int socket_flags, bool tcp_nodelay,
  6066. bool ipv6_v6only, SocketOptions socket_options,
  6067. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  6068. // Get address info
  6069. const char *node = nullptr;
  6070. struct addrinfo hints;
  6071. struct addrinfo *result;
  6072. memset(&hints, 0, sizeof(struct addrinfo));
  6073. hints.ai_socktype = SOCK_STREAM;
  6074. hints.ai_protocol = IPPROTO_IP;
  6075. if (!ip.empty()) {
  6076. node = ip.c_str();
  6077. // Ask getaddrinfo to convert IP in c-string to address
  6078. hints.ai_family = AF_UNSPEC;
  6079. hints.ai_flags = AI_NUMERICHOST;
  6080. } else {
  6081. if (!host.empty()) { node = host.c_str(); }
  6082. hints.ai_family = address_family;
  6083. hints.ai_flags = socket_flags;
  6084. }
  6085. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  6086. if (hints.ai_family == AF_UNIX) {
  6087. const auto addrlen = host.length();
  6088. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  6089. #ifdef SOCK_CLOEXEC
  6090. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  6091. hints.ai_protocol);
  6092. #else
  6093. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  6094. #endif
  6095. if (sock != INVALID_SOCKET) {
  6096. sockaddr_un addr{};
  6097. addr.sun_family = AF_UNIX;
  6098. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  6099. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  6100. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  6101. hints.ai_addrlen = static_cast<socklen_t>(
  6102. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  6103. #ifndef SOCK_CLOEXEC
  6104. #ifndef _WIN32
  6105. fcntl(sock, F_SETFD, FD_CLOEXEC);
  6106. #endif
  6107. #endif
  6108. if (socket_options) { socket_options(sock); }
  6109. #ifdef _WIN32
  6110. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  6111. // remove the option.
  6112. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  6113. #endif
  6114. bool dummy;
  6115. if (!bind_or_connect(sock, hints, dummy)) {
  6116. close_socket(sock);
  6117. sock = INVALID_SOCKET;
  6118. }
  6119. }
  6120. return sock;
  6121. }
  6122. #endif
  6123. auto service = std::to_string(port);
  6124. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  6125. timeout_sec)) {
  6126. #if defined __linux__ && !defined __ANDROID__
  6127. res_init();
  6128. #endif
  6129. return INVALID_SOCKET;
  6130. }
  6131. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6132. for (auto rp = result; rp; rp = rp->ai_next) {
  6133. // Create a socket
  6134. #ifdef _WIN32
  6135. auto sock =
  6136. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  6137. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  6138. /**
  6139. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  6140. * and above the socket creation fails on older Windows Systems.
  6141. *
  6142. * Let's try to create a socket the old way in this case.
  6143. *
  6144. * Reference:
  6145. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  6146. *
  6147. * WSA_FLAG_NO_HANDLE_INHERIT:
  6148. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  6149. * SP1, and later
  6150. *
  6151. */
  6152. if (sock == INVALID_SOCKET) {
  6153. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6154. }
  6155. #else
  6156. #ifdef SOCK_CLOEXEC
  6157. auto sock =
  6158. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  6159. #else
  6160. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  6161. #endif
  6162. #endif
  6163. if (sock == INVALID_SOCKET) { continue; }
  6164. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  6165. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  6166. close_socket(sock);
  6167. continue;
  6168. }
  6169. #endif
  6170. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  6171. if (rp->ai_family == AF_INET6) {
  6172. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  6173. }
  6174. if (socket_options) { socket_options(sock); }
  6175. // bind or connect
  6176. auto quit = false;
  6177. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  6178. close_socket(sock);
  6179. if (quit) { break; }
  6180. }
  6181. return INVALID_SOCKET;
  6182. }
  6183. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  6184. #ifdef _WIN32
  6185. auto flags = nonblocking ? 1UL : 0UL;
  6186. ioctlsocket(sock, FIONBIO, &flags);
  6187. #else
  6188. auto flags = fcntl(sock, F_GETFL, 0);
  6189. fcntl(sock, F_SETFL,
  6190. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  6191. #endif
  6192. }
  6193. inline bool is_connection_error() {
  6194. #ifdef _WIN32
  6195. return WSAGetLastError() != WSAEWOULDBLOCK;
  6196. #else
  6197. return errno != EINPROGRESS;
  6198. #endif
  6199. }
  6200. // accept() failed because the process or the network stack is temporarily out
  6201. // of resources. The listening socket is still usable, so back off briefly and
  6202. // try again.
  6203. inline bool is_accept_resource_error() {
  6204. #ifdef _WIN32
  6205. auto err = WSAGetLastError();
  6206. return err == WSAEMFILE || err == WSAENOBUFS;
  6207. #else
  6208. auto err = errno;
  6209. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6210. #endif
  6211. }
  6212. // accept() failed for a reason that says nothing about the listening socket:
  6213. // the pending connection went away before it could be accepted, or the call
  6214. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6215. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6216. // connection that way.
  6217. inline bool is_accept_transient_error() {
  6218. #ifdef _WIN32
  6219. auto err = WSAGetLastError();
  6220. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6221. err == WSAECONNABORTED;
  6222. #else
  6223. auto err = errno;
  6224. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6225. err == ECONNABORTED;
  6226. #endif
  6227. }
  6228. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6229. struct addrinfo hints;
  6230. struct addrinfo *result;
  6231. memset(&hints, 0, sizeof(struct addrinfo));
  6232. hints.ai_family = AF_UNSPEC;
  6233. hints.ai_socktype = SOCK_STREAM;
  6234. hints.ai_protocol = 0;
  6235. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6236. return false;
  6237. }
  6238. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6239. auto ret = false;
  6240. for (auto rp = result; rp; rp = rp->ai_next) {
  6241. const auto &ai = *rp;
  6242. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6243. ret = true;
  6244. break;
  6245. }
  6246. }
  6247. return ret;
  6248. }
  6249. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6250. #define USE_IF2IP
  6251. #endif
  6252. #ifdef USE_IF2IP
  6253. inline std::string if2ip(int address_family, const std::string &ifn) {
  6254. struct ifaddrs *ifap;
  6255. getifaddrs(&ifap);
  6256. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6257. std::string addr_candidate;
  6258. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6259. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6260. (AF_UNSPEC == address_family ||
  6261. ifa->ifa_addr->sa_family == address_family)) {
  6262. if (ifa->ifa_addr->sa_family == AF_INET) {
  6263. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6264. char buf[INET_ADDRSTRLEN];
  6265. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6266. return std::string(buf, INET_ADDRSTRLEN);
  6267. }
  6268. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6269. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6270. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6271. char buf[INET6_ADDRSTRLEN] = {};
  6272. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6273. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6274. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6275. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6276. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6277. } else {
  6278. return std::string(buf, INET6_ADDRSTRLEN);
  6279. }
  6280. }
  6281. }
  6282. }
  6283. }
  6284. }
  6285. return addr_candidate;
  6286. }
  6287. #endif
  6288. inline socket_t create_client_socket(
  6289. const std::string &host, const std::string &ip, int port,
  6290. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6291. SocketOptions socket_options, time_t connection_timeout_sec,
  6292. time_t connection_timeout_usec, time_t read_timeout_sec,
  6293. time_t read_timeout_usec, time_t write_timeout_sec,
  6294. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6295. auto sock = create_socket(
  6296. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6297. std::move(socket_options),
  6298. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6299. if (!intf.empty()) {
  6300. #ifdef USE_IF2IP
  6301. auto ip_from_if = if2ip(address_family, intf);
  6302. if (ip_from_if.empty()) { ip_from_if = intf; }
  6303. if (!bind_ip_address(sock2, ip_from_if)) {
  6304. error = Error::BindIPAddress;
  6305. return false;
  6306. }
  6307. #endif
  6308. }
  6309. set_nonblocking(sock2, true);
  6310. auto ret =
  6311. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6312. if (ret < 0) {
  6313. if (is_connection_error()) {
  6314. error = Error::Connection;
  6315. return false;
  6316. }
  6317. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6318. connection_timeout_usec);
  6319. if (error != Error::Success) {
  6320. if (error == Error::ConnectionTimeout) { quit = true; }
  6321. return false;
  6322. }
  6323. }
  6324. set_nonblocking(sock2, false);
  6325. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6326. read_timeout_usec);
  6327. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6328. write_timeout_usec);
  6329. error = Error::Success;
  6330. return true;
  6331. },
  6332. connection_timeout_sec); // Pass DNS timeout
  6333. if (sock != INVALID_SOCKET) {
  6334. error = Error::Success;
  6335. } else {
  6336. if (error == Error::Success) { error = Error::Connection; }
  6337. }
  6338. return sock;
  6339. }
  6340. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6341. socklen_t addr_len, std::string &ip, int &port) {
  6342. if (addr.ss_family == AF_INET) {
  6343. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6344. } else if (addr.ss_family == AF_INET6) {
  6345. port =
  6346. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6347. } else {
  6348. return false;
  6349. }
  6350. std::array<char, NI_MAXHOST> ipstr{};
  6351. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6352. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6353. 0, NI_NUMERICHOST)) {
  6354. return false;
  6355. }
  6356. ip = ipstr.data();
  6357. return true;
  6358. }
  6359. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6360. struct sockaddr_storage addr;
  6361. socklen_t addr_len = sizeof(addr);
  6362. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6363. &addr_len)) {
  6364. get_ip_and_port(addr, addr_len, ip, port);
  6365. }
  6366. }
  6367. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6368. struct sockaddr_storage addr;
  6369. socklen_t addr_len = sizeof(addr);
  6370. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6371. &addr_len)) {
  6372. #ifndef _WIN32
  6373. if (addr.ss_family == AF_UNIX) {
  6374. #if defined(__linux__)
  6375. struct ucred ucred;
  6376. socklen_t len = sizeof(ucred);
  6377. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6378. port = ucred.pid;
  6379. }
  6380. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6381. pid_t pid;
  6382. socklen_t len = sizeof(pid);
  6383. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6384. port = pid;
  6385. }
  6386. #endif
  6387. return;
  6388. }
  6389. #endif
  6390. get_ip_and_port(addr, addr_len, ip, port);
  6391. }
  6392. }
  6393. inline std::string
  6394. find_content_type(const std::string &path,
  6395. const std::map<std::string, std::string> &user_data,
  6396. const std::string &default_content_type) {
  6397. auto ext = file_extension(path);
  6398. // Extensions are matched regardless of case, as web servers do, with an
  6399. // exact match to a user mapping first
  6400. auto lower_ext = case_ignore::to_lower(ext);
  6401. auto it = user_data.find(ext);
  6402. if (it == user_data.end()) { it = user_data.find(lower_ext); }
  6403. if (it != user_data.end()) { return it->second; }
  6404. static const struct {
  6405. const char *ext;
  6406. const char *type;
  6407. } types[] = {
  6408. {"css", "text/css"},
  6409. {"csv", "text/csv"},
  6410. {"htm", "text/html"},
  6411. {"html", "text/html"},
  6412. {"js", "text/javascript"},
  6413. {"mjs", "text/javascript"},
  6414. {"txt", "text/plain"},
  6415. {"vtt", "text/vtt"},
  6416. {"apng", "image/apng"},
  6417. {"avif", "image/avif"},
  6418. {"bmp", "image/bmp"},
  6419. {"gif", "image/gif"},
  6420. {"png", "image/png"},
  6421. {"svg", "image/svg+xml"},
  6422. {"webp", "image/webp"},
  6423. {"ico", "image/x-icon"},
  6424. {"tif", "image/tiff"},
  6425. {"tiff", "image/tiff"},
  6426. {"jpg", "image/jpeg"},
  6427. {"jpeg", "image/jpeg"},
  6428. {"mp4", "video/mp4"},
  6429. {"mpeg", "video/mpeg"},
  6430. {"webm", "video/webm"},
  6431. {"mp3", "audio/mp3"},
  6432. {"mpga", "audio/mpeg"},
  6433. {"weba", "audio/webm"},
  6434. {"wav", "audio/wave"},
  6435. {"otf", "font/otf"},
  6436. {"ttf", "font/ttf"},
  6437. {"woff", "font/woff"},
  6438. {"woff2", "font/woff2"},
  6439. {"7z", "application/x-7z-compressed"},
  6440. {"atom", "application/atom+xml"},
  6441. {"pdf", "application/pdf"},
  6442. {"json", "application/json"},
  6443. {"rss", "application/rss+xml"},
  6444. {"tar", "application/x-tar"},
  6445. {"xht", "application/xhtml+xml"},
  6446. {"xhtml", "application/xhtml+xml"},
  6447. {"xslt", "application/xslt+xml"},
  6448. {"xml", "application/xml"},
  6449. {"gz", "application/gzip"},
  6450. {"zip", "application/zip"},
  6451. {"wasm", "application/wasm"},
  6452. };
  6453. for (const auto &t : types) {
  6454. if (lower_ext == t.ext) { return t.type; }
  6455. }
  6456. return default_content_type;
  6457. }
  6458. inline std::string
  6459. extract_media_type(const std::string &content_type,
  6460. std::map<std::string, std::string> *params = nullptr) {
  6461. // Extract type/subtype from Content-Type value (RFC 2045)
  6462. // e.g. "application/json; charset=utf-8" -> "application/json"
  6463. auto media_type = content_type;
  6464. auto semicolon_pos = media_type.find(';');
  6465. if (semicolon_pos != std::string::npos) {
  6466. auto param_str = media_type.substr(semicolon_pos + 1);
  6467. media_type = media_type.substr(0, semicolon_pos);
  6468. if (params) {
  6469. // Parse parameters: key=value pairs separated by ';'
  6470. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6471. [&](const char *b, const char *e) {
  6472. std::string key;
  6473. std::string val;
  6474. divide_param_pair(b, e, key, val);
  6475. // Parameter names are case-insensitive (RFC 9110
  6476. // §5.6.6)
  6477. if (!key.empty()) {
  6478. params->emplace(case_ignore::to_lower(trim_copy(key)),
  6479. unquote_param(val));
  6480. }
  6481. });
  6482. }
  6483. }
  6484. // Trim whitespace from media type
  6485. return trim_copy(media_type);
  6486. }
  6487. inline bool can_compress_content_type(const std::string &content_type) {
  6488. // Media types are case-insensitive (RFC 9110 §8.3.1)
  6489. auto mime_type = case_ignore::to_lower(extract_media_type(content_type));
  6490. static const char *const compressible[] = {
  6491. "image/svg+xml",
  6492. "application/javascript",
  6493. "application/x-javascript",
  6494. "application/json",
  6495. "application/ld+json",
  6496. "application/xml",
  6497. "application/xhtml+xml",
  6498. "application/rss+xml",
  6499. "application/atom+xml",
  6500. "application/xslt+xml",
  6501. "application/protobuf",
  6502. };
  6503. for (auto type : compressible) {
  6504. if (mime_type == type) { return true; }
  6505. }
  6506. return mime_type != "text/event-stream" && !mime_type.rfind("text/", 0);
  6507. }
  6508. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6509. double &quality) {
  6510. quality = 1.0;
  6511. token.clear();
  6512. // Split on first ';': left = token name, right = parameters
  6513. const char *params_b = nullptr;
  6514. std::size_t params_len = 0;
  6515. divide(
  6516. b, static_cast<std::size_t>(e - b), ';',
  6517. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6518. auto r = trim(lb, lb + llen, 0, llen);
  6519. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6520. params_b = rb;
  6521. params_len = rlen;
  6522. });
  6523. if (token.empty()) { return false; }
  6524. if (params_len == 0) { return true; }
  6525. // Scan parameters for q= (stops on first match)
  6526. bool invalid = false;
  6527. split_find(params_b, params_b + params_len, ';',
  6528. (std::numeric_limits<size_t>::max)(),
  6529. [&](const char *pb, const char *pe) -> bool {
  6530. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6531. auto len = static_cast<size_t>(pe - pb);
  6532. if (len < 2) { return false; }
  6533. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6534. return false;
  6535. }
  6536. // Trim the value portion
  6537. auto r = trim(pb, pe, 2, len);
  6538. if (r.first >= r.second) {
  6539. invalid = true;
  6540. return true;
  6541. }
  6542. double v = 0.0;
  6543. auto res = from_chars(pb + r.first, pb + r.second, v);
  6544. if (res.ec != std::errc{} || res.ptr != pb + r.second ||
  6545. v < 0.0 || v > 1.0) {
  6546. invalid = true;
  6547. return true;
  6548. }
  6549. quality = v;
  6550. return true;
  6551. });
  6552. return !invalid;
  6553. }
  6554. inline EncodingType encoding_type(const Request &req,
  6555. const std::string &content_type) {
  6556. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6557. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6558. if (s.empty()) { return EncodingType::None; }
  6559. // Single-pass: iterate tokens and track the best supported encoding.
  6560. // Server preference breaks ties (br > gzip > zstd).
  6561. EncodingType best = EncodingType::None;
  6562. double best_q = 0.0; // q=0 means "not acceptable"
  6563. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6564. auto priority = [](EncodingType t) -> int {
  6565. switch (t) {
  6566. case EncodingType::Brotli: return 0;
  6567. case EncodingType::Gzip: return 1;
  6568. case EncodingType::Zstd: return 2;
  6569. default: return 3;
  6570. }
  6571. };
  6572. std::string name;
  6573. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6574. double quality = 1.0;
  6575. if (!parse_quality(b, e, name, quality)) { return; }
  6576. if (quality <= 0.0) { return; }
  6577. EncodingType type = EncodingType::None;
  6578. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6579. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6580. #endif
  6581. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6582. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6583. type = EncodingType::Gzip;
  6584. }
  6585. #endif
  6586. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6587. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6588. type = EncodingType::Zstd;
  6589. }
  6590. #endif
  6591. if (type == EncodingType::None) { return; }
  6592. // Higher q-value wins; for equal q, server preference breaks ties
  6593. if (quality > best_q ||
  6594. (quality == best_q && priority(type) < priority(best))) {
  6595. best_q = quality;
  6596. best = type;
  6597. }
  6598. });
  6599. return best;
  6600. }
  6601. // `content_type` is taken separately because a file-backed response has not
  6602. // been given one yet when its coding has to be decided.
  6603. inline EncodingType encoding_type(const Request &req, const Response &res,
  6604. const std::string &content_type) {
  6605. // The response already names a content coding of its own: a handler serving
  6606. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6607. // point whose headers name the coding its files are stored in. Applying one
  6608. // on top of that would double-encode the body and append a second
  6609. // `Content-Encoding` field line.
  6610. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6611. return encoding_type(req, content_type);
  6612. }
  6613. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6614. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6615. }
  6616. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6617. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6618. if (type == EncodingType::Gzip) {
  6619. return detail::make_unique<gzip_compressor>();
  6620. }
  6621. #endif
  6622. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6623. if (type == EncodingType::Brotli) {
  6624. return detail::make_unique<brotli_compressor>();
  6625. }
  6626. #endif
  6627. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6628. if (type == EncodingType::Zstd) {
  6629. return detail::make_unique<zstd_compressor>();
  6630. }
  6631. #endif
  6632. (void)type;
  6633. return nullptr;
  6634. }
  6635. inline const char *encoding_name(EncodingType type) {
  6636. switch (type) {
  6637. case EncodingType::Gzip: return "gzip";
  6638. case EncodingType::Brotli: return "br";
  6639. case EncodingType::Zstd: return "zstd";
  6640. default: return "";
  6641. }
  6642. }
  6643. inline bool nocompressor::compress(const char *data, size_t data_length,
  6644. bool /*last*/, Callback callback) {
  6645. if (!data_length) { return true; }
  6646. return callback(data, data_length);
  6647. }
  6648. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6649. inline gzip_compressor::gzip_compressor() {
  6650. std::memset(&strm_, 0, sizeof(strm_));
  6651. strm_.zalloc = Z_NULL;
  6652. strm_.zfree = Z_NULL;
  6653. strm_.opaque = Z_NULL;
  6654. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6655. Z_DEFAULT_STRATEGY) == Z_OK;
  6656. }
  6657. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6658. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6659. bool last, Callback callback) {
  6660. assert(is_valid_);
  6661. do {
  6662. constexpr size_t max_avail_in =
  6663. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6664. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6665. (std::min)(data_length, max_avail_in));
  6666. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6667. data_length -= strm_.avail_in;
  6668. data += strm_.avail_in;
  6669. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6670. auto ret = Z_OK;
  6671. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6672. do {
  6673. strm_.avail_out = static_cast<uInt>(buff.size());
  6674. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6675. ret = deflate(&strm_, flush);
  6676. if (ret == Z_STREAM_ERROR) { return false; }
  6677. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6678. return false;
  6679. }
  6680. } while (strm_.avail_out == 0);
  6681. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6682. (flush == Z_NO_FLUSH && ret == Z_OK));
  6683. assert(strm_.avail_in == 0);
  6684. } while (data_length > 0);
  6685. return true;
  6686. }
  6687. inline gzip_decompressor::gzip_decompressor() {
  6688. std::memset(&strm_, 0, sizeof(strm_));
  6689. strm_.zalloc = Z_NULL;
  6690. strm_.zfree = Z_NULL;
  6691. strm_.opaque = Z_NULL;
  6692. // 15 is the value of wbits, which should be at the maximum possible value
  6693. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6694. // that the stream type should be automatically detected either gzip or
  6695. // deflate.
  6696. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6697. }
  6698. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6699. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6700. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6701. Callback callback) {
  6702. assert(is_valid_);
  6703. auto ret = Z_OK;
  6704. do {
  6705. constexpr size_t max_avail_in =
  6706. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6707. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6708. (std::min)(data_length, max_avail_in));
  6709. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6710. data_length -= strm_.avail_in;
  6711. data += strm_.avail_in;
  6712. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6713. while (strm_.avail_in > 0 && ret == Z_OK) {
  6714. strm_.avail_out = static_cast<uInt>(buff.size());
  6715. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6716. ret = inflate(&strm_, Z_NO_FLUSH);
  6717. assert(ret != Z_STREAM_ERROR);
  6718. switch (ret) {
  6719. case Z_NEED_DICT:
  6720. case Z_DATA_ERROR:
  6721. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6722. }
  6723. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6724. return false;
  6725. }
  6726. }
  6727. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6728. } while (data_length > 0);
  6729. return true;
  6730. }
  6731. #endif
  6732. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6733. inline brotli_compressor::brotli_compressor() {
  6734. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6735. }
  6736. inline brotli_compressor::~brotli_compressor() {
  6737. BrotliEncoderDestroyInstance(state_);
  6738. }
  6739. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6740. bool last, Callback callback) {
  6741. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6742. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6743. auto available_in = data_length;
  6744. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6745. for (;;) {
  6746. if (last) {
  6747. if (BrotliEncoderIsFinished(state_)) { break; }
  6748. } else {
  6749. if (!available_in) { break; }
  6750. }
  6751. auto available_out = buff.size();
  6752. auto next_out = buff.data();
  6753. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6754. &available_out, &next_out, nullptr)) {
  6755. return false;
  6756. }
  6757. auto output_bytes = buff.size() - available_out;
  6758. if (output_bytes) {
  6759. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6760. }
  6761. }
  6762. return true;
  6763. }
  6764. inline brotli_decompressor::brotli_decompressor() {
  6765. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6766. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6767. : BROTLI_DECODER_RESULT_ERROR;
  6768. }
  6769. inline brotli_decompressor::~brotli_decompressor() {
  6770. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6771. }
  6772. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6773. inline bool brotli_decompressor::decompress(const char *data,
  6774. size_t data_length,
  6775. Callback callback) {
  6776. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6777. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6778. return 0;
  6779. }
  6780. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6781. size_t avail_in = data_length;
  6782. size_t total_out;
  6783. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6784. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6785. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6786. char *next_out = buff.data();
  6787. size_t avail_out = buff.size();
  6788. decoder_r = BrotliDecoderDecompressStream(
  6789. decoder_s, &avail_in, &next_in, &avail_out,
  6790. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6791. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6792. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6793. }
  6794. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6795. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6796. }
  6797. #endif
  6798. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6799. inline zstd_compressor::zstd_compressor() {
  6800. ctx_ = ZSTD_createCCtx();
  6801. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6802. }
  6803. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6804. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6805. bool last, Callback callback) {
  6806. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6807. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6808. ZSTD_inBuffer input = {data, data_length, 0};
  6809. bool finished;
  6810. do {
  6811. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6812. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6813. if (ZSTD_isError(remaining)) { return false; }
  6814. if (!callback(buff.data(), output.pos)) { return false; }
  6815. finished = last ? (remaining == 0) : (input.pos == input.size);
  6816. } while (!finished);
  6817. return true;
  6818. }
  6819. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6820. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6821. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6822. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6823. Callback callback) {
  6824. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6825. ZSTD_inBuffer input = {data, data_length, 0};
  6826. while (input.pos < input.size) {
  6827. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6828. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6829. if (ZSTD_isError(remaining)) { return false; }
  6830. if (!callback(buff.data(), output.pos)) { return false; }
  6831. }
  6832. return true;
  6833. }
  6834. #endif
  6835. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6836. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6837. // unknown coding, and its payload would be handed back still compressed.
  6838. inline bool is_zlib_encoding(const std::string &encoding) {
  6839. return case_ignore::equal(encoding, "gzip") ||
  6840. case_ignore::equal(encoding, "deflate");
  6841. }
  6842. inline bool is_brotli_encoding(const std::string &encoding) {
  6843. return case_ignore::equal(encoding, "br");
  6844. }
  6845. inline bool is_zstd_encoding(const std::string &encoding) {
  6846. return case_ignore::equal(encoding, "zstd");
  6847. }
  6848. // Returns true if the content coding is one cpp-httplib is able to decompress
  6849. // when the corresponding support is compiled in.
  6850. inline bool is_known_content_encoding(const std::string &encoding) {
  6851. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6852. is_zstd_encoding(encoding);
  6853. }
  6854. inline std::unique_ptr<decompressor>
  6855. create_decompressor(const std::string &encoding) {
  6856. std::unique_ptr<decompressor> decompressor;
  6857. if (is_zlib_encoding(encoding)) {
  6858. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6859. decompressor = detail::make_unique<gzip_decompressor>();
  6860. #endif
  6861. } else if (is_brotli_encoding(encoding)) {
  6862. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6863. decompressor = detail::make_unique<brotli_decompressor>();
  6864. #endif
  6865. } else if (is_zstd_encoding(encoding)) {
  6866. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6867. decompressor = detail::make_unique<zstd_decompressor>();
  6868. #endif
  6869. }
  6870. return decompressor;
  6871. }
  6872. // Returns the best available compressor and its Content-Encoding name.
  6873. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6874. inline std::pair<std::unique_ptr<compressor>, const char *>
  6875. create_compressor() {
  6876. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6877. return {detail::make_unique<brotli_compressor>(), "br"};
  6878. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6879. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6880. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6881. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6882. #else
  6883. return {nullptr, nullptr};
  6884. #endif
  6885. }
  6886. inline bool is_prohibited_header_name(const std::string &name) {
  6887. // Field names are case-insensitive (RFC 9110 §5.1)
  6888. return case_ignore::equal(name, "REMOTE_ADDR") ||
  6889. case_ignore::equal(name, "REMOTE_PORT") ||
  6890. case_ignore::equal(name, "LOCAL_ADDR") ||
  6891. case_ignore::equal(name, "LOCAL_PORT");
  6892. }
  6893. inline bool has_header(const Headers &headers, const std::string &key) {
  6894. if (is_prohibited_header_name(key)) { return false; }
  6895. return headers.find(key) != headers.end();
  6896. }
  6897. inline const char *get_header_value(const Headers &headers,
  6898. const std::string &key, const char *def,
  6899. size_t id) {
  6900. if (is_prohibited_header_name(key)) {
  6901. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6902. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6903. throw std::invalid_argument(msg);
  6904. #else
  6905. return "";
  6906. #endif
  6907. }
  6908. auto rng = headers.equal_range(key);
  6909. auto it = bounded_next(rng.first, id, rng.second);
  6910. if (it != rng.second) { return it->second.c_str(); }
  6911. return def;
  6912. }
  6913. inline size_t get_header_value_count(const Headers &headers,
  6914. const std::string &key) {
  6915. return headers.count(key);
  6916. }
  6917. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6918. // list may be sent as several field lines, and the combined field value is
  6919. // those values joined by commas in the order they were received. Callers that
  6920. // parse such a list must work on the combined value; reading only the first
  6921. // occurrence silently drops whatever the later field lines carry.
  6922. inline std::string get_combined_header_value(const Headers &headers,
  6923. const std::string &key) {
  6924. std::string combined;
  6925. auto rng = headers.equal_range(key);
  6926. for (auto it = rng.first; it != rng.second; ++it) {
  6927. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6928. // elements, so an empty field line must not contribute a bare comma to the
  6929. // combined value.
  6930. if (it->second.empty()) { continue; }
  6931. if (!combined.empty()) { combined += ", "; }
  6932. combined += it->second;
  6933. }
  6934. return combined;
  6935. }
  6936. inline bool has_header_token(const Headers &headers, const std::string &key,
  6937. const std::string &token) {
  6938. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6939. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6940. // several lines. Match complete tokens rather than searching the raw value,
  6941. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6942. auto rng = headers.equal_range(key);
  6943. for (auto it = rng.first; it != rng.second; ++it) {
  6944. const auto &value = it->second;
  6945. if (split_find(value.data(), value.data() + value.size(), ',',
  6946. [&](const char *b, const char *e) {
  6947. return case_ignore::equal(std::string(b, e), token);
  6948. })) {
  6949. return true;
  6950. }
  6951. }
  6952. return false;
  6953. }
  6954. template <typename Map>
  6955. inline typename Map::mapped_type
  6956. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6957. auto rng = m.equal_range(key);
  6958. auto it = bounded_next(rng.first, id, rng.second);
  6959. if (it != rng.second) { return it->second; }
  6960. return typename Map::mapped_type();
  6961. }
  6962. inline void set_header(Headers &headers, const std::string &key,
  6963. const std::string &val) {
  6964. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6965. }
  6966. inline bool read_headers(Stream &strm, Headers &headers) {
  6967. const auto bufsiz = 2048;
  6968. char buf[bufsiz];
  6969. stream_line_reader line_reader(strm, buf, bufsiz);
  6970. size_t header_count = 0;
  6971. for (;;) {
  6972. if (!line_reader.getline()) { return false; }
  6973. // Check if the line ends with CRLF.
  6974. auto line_terminator_len = 2;
  6975. if (line_reader.end_with_crlf()) {
  6976. // Blank line indicates end of headers.
  6977. if (line_reader.size() == 2) { break; }
  6978. } else {
  6979. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6980. // Blank line indicates end of headers.
  6981. if (line_reader.size() == 1) { break; }
  6982. line_terminator_len = 1;
  6983. #else
  6984. continue; // Skip invalid line.
  6985. #endif
  6986. }
  6987. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6988. // Check header count limit
  6989. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6990. // Exclude line terminator
  6991. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6992. if (!parse_header(line_reader.ptr(), end,
  6993. [&](const std::string &key, const std::string &val) {
  6994. headers.emplace(key, val);
  6995. })) {
  6996. return false;
  6997. }
  6998. header_count++;
  6999. }
  7000. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  7001. // headers that have different values to prevent request smuggling.
  7002. auto cl_range = headers.equal_range("Content-Length");
  7003. if (cl_range.first != cl_range.second) {
  7004. const auto &first_val = cl_range.first->second;
  7005. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  7006. if (it->second != first_val) { return false; }
  7007. }
  7008. }
  7009. return true;
  7010. }
  7011. // Parsed by hand: std::regex_match recurses once per character of the reason
  7012. // phrase, which a server can make as long as a whole line.
  7013. inline bool parse_status_line(const char *line, std::string &version,
  7014. int &status, std::string &reason) {
  7015. if (std::strncmp(line, "HTTP/1.", 7) != 0 ||
  7016. (line[7] != '0' && line[7] != '1') || line[8] != ' ' ||
  7017. !is_ascii_digit(line[9]) || !is_ascii_digit(line[10]) ||
  7018. !is_ascii_digit(line[11])) {
  7019. return false;
  7020. }
  7021. auto p = line + 12;
  7022. auto reason_begin = p;
  7023. if (*p == ' ') {
  7024. reason_begin = ++p;
  7025. p += std::strcspn(p, "\r\n");
  7026. }
  7027. auto reason_end = p;
  7028. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  7029. if (*p == '\r') { p++; }
  7030. #else
  7031. if (*p++ != '\r') { return false; }
  7032. #endif
  7033. if (*p++ != '\n' || *p != '\0') { return false; }
  7034. version.assign(line, 8);
  7035. status = (line[9] - '0') * 100 + (line[10] - '0') * 10 + (line[11] - '0');
  7036. reason.assign(reason_begin, reason_end);
  7037. return true;
  7038. }
  7039. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  7040. // status stays -1 until a status line is parsed, mirroring stream::Result.
  7041. struct WebSocketUpgradeResponse {
  7042. Error error = Error::Success;
  7043. int status = -1;
  7044. Headers headers;
  7045. std::string selected_subprotocol;
  7046. };
  7047. inline bool
  7048. read_websocket_upgrade_response(Stream &strm,
  7049. const std::string &expected_accept,
  7050. const std::string &offered_subprotocols,
  7051. WebSocketUpgradeResponse &upgrade) {
  7052. // Read status line
  7053. const auto bufsiz = 2048;
  7054. char buf[bufsiz];
  7055. stream_line_reader line_reader(strm, buf, bufsiz);
  7056. if (!line_reader.getline()) {
  7057. upgrade.error = Error::Read;
  7058. return false;
  7059. }
  7060. std::string version;
  7061. std::string reason;
  7062. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  7063. upgrade.error = Error::WebSocketHandshake;
  7064. return false;
  7065. }
  7066. // Read the headers even for a rejection so the caller can see why the
  7067. // server refused the upgrade. A non-101 response may carry a body; it is
  7068. // deliberately left unread since the caller closes the socket right away.
  7069. if (!read_headers(strm, upgrade.headers)) {
  7070. upgrade.error = Error::Read;
  7071. return false;
  7072. }
  7073. const auto &headers = upgrade.headers;
  7074. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  7075. upgrade.error = Error::WebSocketHandshake;
  7076. return false;
  7077. }
  7078. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  7079. if (!has_header_token(headers, "Upgrade", "websocket")) {
  7080. upgrade.error = Error::WebSocketHandshake;
  7081. return false;
  7082. }
  7083. // Verify Connection: Upgrade
  7084. if (!has_header_token(headers, "Connection", "upgrade")) {
  7085. upgrade.error = Error::WebSocketHandshake;
  7086. return false;
  7087. }
  7088. // Verify Sec-WebSocket-Accept header value
  7089. auto it = headers.find("Sec-WebSocket-Accept");
  7090. if (it == headers.end() || it->second != expected_accept) {
  7091. upgrade.error = Error::WebSocketHandshake;
  7092. return false;
  7093. }
  7094. // Extract negotiated subprotocol
  7095. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  7096. if (proto_it != headers.end()) {
  7097. upgrade.selected_subprotocol = proto_it->second;
  7098. }
  7099. // Verify the subprotocol is one the client offered (RFC 6455 4.1)
  7100. if (!upgrade.selected_subprotocol.empty()) {
  7101. auto was_offered = false;
  7102. split(offered_subprotocols.data(),
  7103. offered_subprotocols.data() + offered_subprotocols.size(), ',',
  7104. [&](const char *b, const char *e) {
  7105. if (std::string(b, e) == upgrade.selected_subprotocol) {
  7106. was_offered = true;
  7107. }
  7108. });
  7109. if (!was_offered) {
  7110. upgrade.error = Error::WebSocketHandshake;
  7111. return false;
  7112. }
  7113. }
  7114. return true;
  7115. }
  7116. enum class ReadContentResult {
  7117. Success, // Successfully read the content
  7118. PayloadTooLarge, // The content exceeds the specified payload limit
  7119. Error // An error occurred while reading the content
  7120. };
  7121. inline ReadContentResult read_content_with_length(
  7122. Stream &strm, size_t len, DownloadProgress progress,
  7123. ContentReceiverWithProgress out,
  7124. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  7125. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7126. detail::BodyReader br;
  7127. br.stream = &strm;
  7128. br.has_content_length = true;
  7129. br.content_length = len;
  7130. br.payload_max_length = payload_max_length;
  7131. br.chunked = false;
  7132. br.bytes_read = 0;
  7133. br.last_error = Error::Success;
  7134. size_t r = 0;
  7135. while (r < len) {
  7136. auto read_len = static_cast<size_t>(len - r);
  7137. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  7138. auto n = detail::read_body_content(&strm, br, buf, to_read);
  7139. if (n <= 0) {
  7140. // Check if it was a payload size error
  7141. if (br.last_error == Error::ExceedMaxPayloadSize) {
  7142. return ReadContentResult::PayloadTooLarge;
  7143. }
  7144. return ReadContentResult::Error;
  7145. }
  7146. if (!out(buf, static_cast<size_t>(n), r, len)) {
  7147. return ReadContentResult::Error;
  7148. }
  7149. r += static_cast<size_t>(n);
  7150. if (progress) {
  7151. if (!progress(r, len)) { return ReadContentResult::Error; }
  7152. }
  7153. }
  7154. return ReadContentResult::Success;
  7155. }
  7156. inline ReadContentResult
  7157. read_content_without_length(Stream &strm, size_t payload_max_length,
  7158. ContentReceiverWithProgress out) {
  7159. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7160. size_t r = 0;
  7161. for (;;) {
  7162. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  7163. if (n == 0) { return ReadContentResult::Success; }
  7164. if (n < 0) { return ReadContentResult::Error; }
  7165. // Check if adding this data would exceed the payload limit
  7166. if (payload_max_length > 0 &&
  7167. (r > payload_max_length ||
  7168. payload_max_length - r < static_cast<size_t>(n))) {
  7169. return ReadContentResult::PayloadTooLarge;
  7170. }
  7171. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  7172. return ReadContentResult::Error;
  7173. }
  7174. r += static_cast<size_t>(n);
  7175. }
  7176. return ReadContentResult::Success;
  7177. }
  7178. template <typename T>
  7179. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  7180. size_t payload_max_length,
  7181. ContentReceiverWithProgress out) {
  7182. detail::ChunkedDecoder dec(strm);
  7183. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  7184. size_t total_len = 0;
  7185. for (;;) {
  7186. size_t chunk_offset = 0;
  7187. size_t chunk_total = 0;
  7188. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  7189. if (n < 0) { return ReadContentResult::Error; }
  7190. if (n == 0) {
  7191. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  7192. return ReadContentResult::Error;
  7193. }
  7194. return ReadContentResult::Success;
  7195. }
  7196. if (payload_max_length > 0 &&
  7197. (total_len > payload_max_length ||
  7198. payload_max_length - total_len < static_cast<size_t>(n))) {
  7199. return ReadContentResult::PayloadTooLarge;
  7200. }
  7201. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  7202. return ReadContentResult::Error;
  7203. }
  7204. total_len += static_cast<size_t>(n);
  7205. }
  7206. }
  7207. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  7208. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  7209. // is the final transfer coding. A single field value may list several
  7210. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  7211. // several Transfer-Encoding lines, which combine into one comma-separated
  7212. // list in the order the lines were received. Headers preserves that order,
  7213. // so the final coding is the last token of the last line. Match it
  7214. // case-insensitively rather than comparing the whole value against
  7215. // "chunked".
  7216. //
  7217. // Security: reading a chunked message as unframed leaves its body in the
  7218. // socket, where a keep-alive connection parses it as a smuggled request.
  7219. // Server::process_request() answers 400 and closes when the final coding is
  7220. // not chunked, so a request whose framing cannot be determined never
  7221. // reaches the "no body" path.
  7222. auto rng = headers.equal_range("Transfer-Encoding");
  7223. if (rng.first == rng.second) { return false; }
  7224. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7225. // combined list ending in nothing rather than inheriting the line before it.
  7226. std::string last_coding;
  7227. for (auto it = rng.first; it != rng.second; ++it) {
  7228. const auto &value = it->second;
  7229. last_coding.clear();
  7230. split(value.data(), value.data() + value.size(), ',',
  7231. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7232. }
  7233. return case_ignore::equal(last_coding, "chunked");
  7234. }
  7235. // RFC 9112 6.1: a message framed by Transfer-Encoding next to a Content-Length,
  7236. // or in HTTP/1.0, leaves the connection unfit to carry another one.
  7237. template <typename T> inline bool has_faulty_transfer_encoding(const T &msg) {
  7238. return msg.has_header("Transfer-Encoding") &&
  7239. (msg.has_header("Content-Length") || msg.version == "HTTP/1.0");
  7240. }
  7241. inline bool has_conflicting_content_length(const Headers &headers) {
  7242. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7243. // Content-Length is framed ambiguously. The body readers here delimit it by
  7244. // the transfer coding and drop Content-Length, while an intermediary may do
  7245. // the reverse, so the two disagree on where the body ends and a reused
  7246. // connection is desynchronised (request/response smuggling). Content-Length:
  7247. // 0 is tolerated for compatibility with existing peers.
  7248. return has_header(headers, "Transfer-Encoding") &&
  7249. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7250. }
  7251. template <typename T, typename U>
  7252. bool prepare_content_receiver(T &x, int &status,
  7253. ContentReceiverWithProgress receiver,
  7254. bool decompress, size_t payload_max_length,
  7255. bool &exceed_payload_max_length, U callback) {
  7256. if (decompress) {
  7257. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7258. std::unique_ptr<decompressor> decompressor;
  7259. if (!encoding.empty()) {
  7260. // A coding we know about but were not built with is an error. An
  7261. // unrecognized coding (including "identity") is left alone and the
  7262. // payload is passed through as-is, since some servers misuse the header,
  7263. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7264. decompressor = detail::create_decompressor(encoding);
  7265. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7266. status = StatusCode::UnsupportedMediaType_415;
  7267. return false;
  7268. }
  7269. }
  7270. if (decompressor) {
  7271. if (decompressor->is_valid()) {
  7272. size_t decompressed_size = 0;
  7273. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7274. size_t off, size_t len) {
  7275. return decompressor->decompress(
  7276. buf, n, [&](const char *buf2, size_t n2) {
  7277. // Guard against zip-bomb: check
  7278. // decompressed size against limit.
  7279. if (payload_max_length > 0 &&
  7280. (decompressed_size >= payload_max_length ||
  7281. n2 > payload_max_length - decompressed_size)) {
  7282. exceed_payload_max_length = true;
  7283. return false;
  7284. }
  7285. decompressed_size += n2;
  7286. return receiver(buf2, n2, off, len);
  7287. });
  7288. };
  7289. return callback(std::move(out));
  7290. } else {
  7291. status = StatusCode::InternalServerError_500;
  7292. return false;
  7293. }
  7294. }
  7295. }
  7296. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7297. size_t len) {
  7298. return receiver(buf, n, off, len);
  7299. };
  7300. return callback(std::move(out));
  7301. }
  7302. template <typename T>
  7303. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7304. DownloadProgress progress,
  7305. ContentReceiverWithProgress receiver, bool decompress) {
  7306. bool exceed_payload_max_length = false;
  7307. return prepare_content_receiver(
  7308. x, status, std::move(receiver), decompress, payload_max_length,
  7309. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7310. auto ret = true;
  7311. // Note: exceed_payload_max_length may also be set by the decompressor
  7312. // wrapper in prepare_content_receiver when the decompressed payload
  7313. // size exceeds the limit.
  7314. if (is_chunked_transfer_encoding(x.headers)) {
  7315. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7316. if (result == ReadContentResult::Success) {
  7317. ret = true;
  7318. } else if (result == ReadContentResult::PayloadTooLarge) {
  7319. exceed_payload_max_length = true;
  7320. ret = false;
  7321. } else {
  7322. ret = false;
  7323. }
  7324. } else if (!has_header(x.headers, "Content-Length")) {
  7325. auto result =
  7326. read_content_without_length(strm, payload_max_length, out);
  7327. if (result == ReadContentResult::Success) {
  7328. ret = true;
  7329. } else if (result == ReadContentResult::PayloadTooLarge) {
  7330. exceed_payload_max_length = true;
  7331. ret = false;
  7332. } else {
  7333. ret = false;
  7334. }
  7335. } else {
  7336. auto is_invalid_value = false;
  7337. auto len = get_header_value_u64(x.headers, "Content-Length",
  7338. (std::numeric_limits<size_t>::max)(),
  7339. 0, is_invalid_value);
  7340. if (is_invalid_value) {
  7341. ret = false;
  7342. } else if (len > 0) {
  7343. auto result = read_content_with_length(
  7344. strm, len, std::move(progress), out, payload_max_length);
  7345. ret = (result == ReadContentResult::Success);
  7346. if (result == ReadContentResult::PayloadTooLarge) {
  7347. exceed_payload_max_length = true;
  7348. }
  7349. }
  7350. }
  7351. if (!ret) {
  7352. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7353. : StatusCode::BadRequest_400;
  7354. }
  7355. return ret;
  7356. });
  7357. }
  7358. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7359. const std::string &path) {
  7360. // Neither the method nor the request target may carry CR/LF, SP or other
  7361. // control octets; otherwise a value smuggled into either splits the request
  7362. // line and injects headers or a whole request.
  7363. if (!fields::is_token(method)) { return -1; }
  7364. if (!fields::is_request_target(path)) { return -1; }
  7365. std::string s = method;
  7366. s += ' ';
  7367. s += path;
  7368. s += " HTTP/1.1\r\n";
  7369. return strm.write(s.data(), s.size());
  7370. }
  7371. inline ssize_t write_response_line(Stream &strm, int status) {
  7372. std::string s = "HTTP/1.1 ";
  7373. s += std::to_string(status);
  7374. s += ' ';
  7375. s += httplib::status_message(status);
  7376. s += "\r\n";
  7377. return strm.write(s.data(), s.size());
  7378. }
  7379. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7380. ssize_t write_len = 0;
  7381. for (const auto &x : headers) {
  7382. // Skip fields with invalid names or values to prevent response splitting
  7383. // via CR/LF injection, matching set_header(). The client validates request
  7384. // headers up front in check_and_write_headers, but the server passes
  7385. // res.headers straight to this writer, and res.headers is a public field
  7386. // an application can populate directly with request-derived values.
  7387. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7388. std::string s;
  7389. s = x.first;
  7390. s += ": ";
  7391. s += x.second;
  7392. s += "\r\n";
  7393. auto len = strm.write(s.data(), s.size());
  7394. if (len < 0) { return len; }
  7395. write_len += len;
  7396. }
  7397. auto len = strm.write("\r\n");
  7398. if (len < 0) { return len; }
  7399. write_len += len;
  7400. return write_len;
  7401. }
  7402. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7403. size_t offset = 0;
  7404. while (offset < l) {
  7405. auto length = strm.write(d + offset, l - offset);
  7406. if (length < 0) { return false; }
  7407. offset += static_cast<size_t>(length);
  7408. }
  7409. return true;
  7410. }
  7411. template <typename T>
  7412. inline bool write_content_with_progress(Stream &strm,
  7413. const ContentProvider &content_provider,
  7414. size_t offset, size_t length,
  7415. T is_shutting_down,
  7416. const UploadProgress &upload_progress,
  7417. Error &error) {
  7418. size_t end_offset = offset + length;
  7419. size_t start_offset = offset;
  7420. auto ok = true;
  7421. auto finished = false;
  7422. DataSink data_sink;
  7423. data_sink.write = [&](const char *d, size_t l) -> bool {
  7424. if (ok) {
  7425. // Bytes past `length` would follow the framed body, where the peer reads
  7426. // them as the next message. Write only what fits and fail the rest.
  7427. if (l > end_offset - offset) {
  7428. l = end_offset - offset;
  7429. ok = false;
  7430. }
  7431. if (write_data(strm, d, l)) {
  7432. offset += l;
  7433. if (upload_progress && length > 0) {
  7434. size_t current_written = offset - start_offset;
  7435. if (!upload_progress(current_written, length)) {
  7436. ok = false;
  7437. return false;
  7438. }
  7439. }
  7440. } else {
  7441. ok = false;
  7442. }
  7443. }
  7444. return ok;
  7445. };
  7446. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7447. // The body is framed by `length`, so a provider that reports itself done
  7448. // early has truncated it. Record that and let the short-body check below
  7449. // fail the write, rather than calling the provider again forever.
  7450. data_sink.done = [&]() { finished = true; };
  7451. while (offset < end_offset && !finished && !is_shutting_down()) {
  7452. auto last_offset = offset;
  7453. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7454. error = Error::Write;
  7455. return false;
  7456. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7457. error = Error::Canceled;
  7458. return false;
  7459. } else if (!ok) {
  7460. error = Error::Write;
  7461. return false;
  7462. }
  7463. // A provider that reports success without writing anything and without
  7464. // reporting itself done gets handed the same offset and length again on
  7465. // the next pass, so it would spin here for as long as the peer stays
  7466. // connected. Treat making no progress as a short body, like done() early.
  7467. if (!finished && offset == last_offset) {
  7468. error = Error::Write;
  7469. return false;
  7470. }
  7471. }
  7472. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7473. error = Error::Write;
  7474. return false;
  7475. }
  7476. error = Error::Success;
  7477. return true;
  7478. }
  7479. template <typename T>
  7480. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7481. size_t offset, size_t length, T is_shutting_down,
  7482. Error &error) {
  7483. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7484. is_shutting_down, nullptr, error);
  7485. }
  7486. template <typename T>
  7487. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7488. size_t offset, size_t length,
  7489. const T &is_shutting_down) {
  7490. auto error = Error::Success;
  7491. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7492. error);
  7493. }
  7494. template <typename T>
  7495. inline bool
  7496. write_content_without_length(Stream &strm,
  7497. const ContentProvider &content_provider,
  7498. const T &is_shutting_down) {
  7499. size_t offset = 0;
  7500. auto data_available = true;
  7501. auto ok = true;
  7502. DataSink data_sink;
  7503. data_sink.write = [&](const char *d, size_t l) -> bool {
  7504. if (ok) {
  7505. offset += l;
  7506. if (!write_data(strm, d, l)) { ok = false; }
  7507. }
  7508. return ok;
  7509. };
  7510. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7511. data_sink.done = [&](void) { data_available = false; };
  7512. while (data_available && !is_shutting_down()) {
  7513. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7514. return false;
  7515. } else if (!content_provider(offset, 0, data_sink)) {
  7516. return false;
  7517. } else if (!ok) {
  7518. return false;
  7519. }
  7520. }
  7521. return !data_available; // true only if done() was called, false if shutting
  7522. // down
  7523. }
  7524. // Runs a known-length content provider to completion and compresses what it
  7525. // writes into `out`, chunk by chunk, without holding the identity form.
  7526. inline bool compress_content_provider(const ContentProvider &content_provider,
  7527. size_t length, compressor &cmp,
  7528. std::string &out) {
  7529. size_t offset = 0;
  7530. auto ok = true;
  7531. auto finished = false;
  7532. DataSink data_sink;
  7533. auto append = [&](const char *data, size_t data_len) {
  7534. out.append(data, data_len);
  7535. return true;
  7536. };
  7537. data_sink.write = [&](const char *d, size_t l) -> bool {
  7538. if (!ok) { return false; }
  7539. offset += l;
  7540. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7541. return ok;
  7542. };
  7543. // The body is framed by `length`, so a provider that reports itself done
  7544. // early has truncated it; the short-body check below turns that into a
  7545. // failure rather than calling the provider again forever.
  7546. data_sink.done = [&]() { finished = true; };
  7547. while (offset < length && !finished) {
  7548. auto prev_offset = offset;
  7549. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7550. return false;
  7551. }
  7552. // No Stream to block on here, so a provider that keeps returning true
  7553. // without writing would spin. Treat a pass that made no progress as a
  7554. // failure.
  7555. if (offset == prev_offset) { return false; }
  7556. }
  7557. if (offset != length) { return false; }
  7558. return cmp.compress(nullptr, 0, true, append);
  7559. }
  7560. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7561. // and the file flag, so recording them has to come after; keeping all of it
  7562. // here means a third file-serving path cannot get that order wrong.
  7563. inline void set_file_content_provider(Response &res,
  7564. const std::shared_ptr<mmap> &m,
  7565. const std::string &content_type,
  7566. EncodingType encoding) {
  7567. // One read and one write move up to this much of the file at a time.
  7568. auto buf = std::make_shared<std::vector<char>>(
  7569. (std::min)(m->size(), size_t(256 * 1024)));
  7570. res.set_content_provider(
  7571. m->size(), content_type,
  7572. [m, buf](size_t offset, size_t length, DataSink &sink) -> bool {
  7573. // Never read past the file, which ends the response early if it has
  7574. // shrunk since it was opened.
  7575. auto n = m->read(offset, buf->data(), (std::min)(length, buf->size()));
  7576. if (n == 0) { return false; }
  7577. sink.write(buf->data(), n);
  7578. return true;
  7579. });
  7580. res.is_file_content_provider_ = true;
  7581. res.content_coding_ = encoding;
  7582. }
  7583. template <typename T, typename U>
  7584. inline bool
  7585. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7586. const T &is_shutting_down, U &compressor, Error &error) {
  7587. size_t offset = 0;
  7588. auto data_available = true;
  7589. auto ok = true;
  7590. DataSink data_sink;
  7591. data_sink.write = [&](const char *d, size_t l) -> bool {
  7592. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7593. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7594. // zero-length chunk is the terminator, so it must not be emitted here.
  7595. if (ok && l > 0) {
  7596. offset += l;
  7597. std::string payload;
  7598. if (compressor.compress(d, l, false,
  7599. [&](const char *data, size_t data_len) {
  7600. payload.append(data, data_len);
  7601. return true;
  7602. })) {
  7603. if (!payload.empty()) {
  7604. // Emit chunked response header and footer for each chunk
  7605. auto chunk =
  7606. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7607. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7608. }
  7609. } else {
  7610. ok = false;
  7611. }
  7612. }
  7613. return ok;
  7614. };
  7615. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7616. auto done_with_trailer = [&](const Headers *trailer) {
  7617. if (!ok) { return; }
  7618. data_available = false;
  7619. std::string payload;
  7620. if (!compressor.compress(nullptr, 0, true,
  7621. [&](const char *data, size_t data_len) {
  7622. payload.append(data, data_len);
  7623. return true;
  7624. })) {
  7625. ok = false;
  7626. return;
  7627. }
  7628. if (!payload.empty()) {
  7629. // Emit chunked response header and footer for each chunk
  7630. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7631. if (!write_data(strm, chunk.data(), chunk.size())) {
  7632. ok = false;
  7633. return;
  7634. }
  7635. }
  7636. constexpr const char done_marker[] = "0\r\n";
  7637. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7638. // Trailer
  7639. if (trailer) {
  7640. for (const auto &kv : *trailer) {
  7641. // Skip fields with invalid names or values to prevent response
  7642. // splitting via CR/LF injection, matching set_header().
  7643. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7644. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7645. if (!write_data(strm, field_line.data(), field_line.size())) {
  7646. ok = false;
  7647. }
  7648. }
  7649. }
  7650. constexpr const char crlf[] = "\r\n";
  7651. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7652. };
  7653. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7654. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7655. done_with_trailer(&trailer);
  7656. };
  7657. while (data_available && !is_shutting_down()) {
  7658. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7659. error = Error::Write;
  7660. return false;
  7661. } else if (!content_provider(offset, 0, data_sink)) {
  7662. error = Error::Canceled;
  7663. return false;
  7664. } else if (!ok) {
  7665. error = Error::Write;
  7666. return false;
  7667. }
  7668. }
  7669. if (data_available) { // exited due to is_shutting_down(), not done()
  7670. error = Error::Write;
  7671. return false;
  7672. }
  7673. error = Error::Success;
  7674. return true;
  7675. }
  7676. template <typename T, typename U>
  7677. inline bool write_content_chunked(Stream &strm,
  7678. const ContentProvider &content_provider,
  7679. const T &is_shutting_down, U &compressor) {
  7680. auto error = Error::Success;
  7681. return write_content_chunked(strm, content_provider, is_shutting_down,
  7682. compressor, error);
  7683. }
  7684. template <typename T>
  7685. inline bool redirect(T &cli, Request &req, Response &res,
  7686. const std::string &path, const std::string &location,
  7687. Error &error) {
  7688. Request new_req = req;
  7689. new_req.path = path;
  7690. new_req.redirect_count_ -= 1;
  7691. if (res.status == StatusCode::SeeOther_303 &&
  7692. (req.method != "GET" && req.method != "HEAD")) {
  7693. new_req.method = "GET";
  7694. new_req.body.clear();
  7695. new_req.headers.clear();
  7696. new_req.content_length_ = 0;
  7697. new_req.content_provider_ = nullptr;
  7698. new_req.is_chunked_content_provider_ = false;
  7699. }
  7700. Response new_res;
  7701. auto ret = cli.send(new_req, new_res, error);
  7702. if (ret) {
  7703. req = std::move(new_req);
  7704. res = std::move(new_res);
  7705. if (res.location.empty()) { res.location = location; }
  7706. }
  7707. return ret;
  7708. }
  7709. inline std::string params_to_query_str(const Params &params) {
  7710. std::string query;
  7711. for (auto it = params.begin(); it != params.end(); ++it) {
  7712. if (it != params.begin()) { query += '&'; }
  7713. query += encode_query_component(it->first);
  7714. query += '=';
  7715. query += encode_query_component(it->second);
  7716. }
  7717. return query;
  7718. }
  7719. // Splits one "key=value" span of a query string at its first '='. A span with
  7720. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7721. // "?flag" keeps its name.
  7722. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7723. std::string &val) {
  7724. divide(b, static_cast<std::size_t>(e - b), '=',
  7725. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7726. std::size_t rhs_size) {
  7727. key.assign(lhs_data, lhs_size);
  7728. val.assign(rhs_data, rhs_size);
  7729. });
  7730. }
  7731. inline void parse_query_text(const char *data, std::size_t size,
  7732. Params &params) {
  7733. std::set<std::string> cache;
  7734. split(data, data + size, '&', [&](const char *b, const char *e) {
  7735. std::string kv(b, e);
  7736. if (cache.find(kv) != cache.end()) { return; }
  7737. cache.insert(std::move(kv));
  7738. std::string key;
  7739. std::string val;
  7740. divide_query_pair(b, e, key, val);
  7741. if (!key.empty()) {
  7742. params.emplace(decode_query_component(key), decode_query_component(val));
  7743. }
  7744. });
  7745. }
  7746. inline void parse_query_text(const std::string &s, Params &params) {
  7747. parse_query_text(s.data(), s.size(), params);
  7748. }
  7749. // Normalize a query string by decoding and re-encoding each key/value pair
  7750. // while preserving the original parameter order. This avoids double-encoding
  7751. // and ensures consistent encoding. It works on the raw string rather than
  7752. // parsing into Params and re-serializing, because that round trip cannot
  7753. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7754. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7755. // duplicated pairs.
  7756. inline std::string normalize_query_string(const std::string &query) {
  7757. std::string result;
  7758. split(query.data(), query.data() + query.size(), '&',
  7759. [&](const char *b, const char *e) {
  7760. std::string key;
  7761. std::string val;
  7762. divide_query_pair(b, e, key, val);
  7763. if (!key.empty()) {
  7764. auto dec_key = decode_query_component(key);
  7765. auto dec_val = decode_query_component(val);
  7766. if (!result.empty()) { result += '&'; }
  7767. result += encode_query_component(dec_key);
  7768. if (!val.empty() || std::find(b, e, '=') != e) {
  7769. result += '=';
  7770. result += encode_query_component(dec_val);
  7771. }
  7772. }
  7773. });
  7774. return result;
  7775. }
  7776. // Build the request target that goes on the wire from a caller-supplied path.
  7777. // Shared by the buffered send path and the streaming API so that both put the
  7778. // same bytes in the request line for the same input.
  7779. inline std::string encode_request_target(const std::string &uri,
  7780. bool path_encode) {
  7781. // The fragment stays with the client (RFC 9110 §7.1).
  7782. auto target = uri.substr(0, uri.find('#'));
  7783. // `substr(0, npos)` yields the whole string, which is what the no-query
  7784. // case needs.
  7785. auto query_pos = target.find('?');
  7786. auto path_part = target.substr(0, query_pos);
  7787. std::string query_part;
  7788. if (query_pos != std::string::npos) {
  7789. query_part = target.substr(query_pos + 1);
  7790. }
  7791. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7792. if (!query_part.empty()) {
  7793. // When path encoding is disabled the caller has supplied an already-encoded
  7794. // target and expects the exact bytes to be sent on the wire, so skip
  7795. // normalization for the query too. Normalizing would decode-then-re-encode
  7796. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7797. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7798. if (path_encode) {
  7799. auto normalized = normalize_query_string(query_part);
  7800. if (!normalized.empty()) {
  7801. result += '?';
  7802. result += normalized;
  7803. }
  7804. } else {
  7805. result += '?';
  7806. result += query_part;
  7807. }
  7808. }
  7809. return result;
  7810. }
  7811. inline bool parse_multipart_boundary(const std::string &content_type,
  7812. std::string &boundary) {
  7813. std::map<std::string, std::string> params;
  7814. extract_media_type(content_type, &params);
  7815. auto it = params.find("boundary");
  7816. if (it == params.end()) { return false; }
  7817. boundary = it->second;
  7818. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7819. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7820. // bytes costs a nearly full comparison at nearly every position: the
  7821. // boundary's length multiplies the worst-case cost of scanning a body.
  7822. return !boundary.empty() && boundary.size() <= 70;
  7823. }
  7824. inline void parse_disposition_params(const std::string &s, Params &params) {
  7825. std::set<std::string> cache;
  7826. split_unquoted(
  7827. s.data(), s.data() + s.size(), ';', [&](const char *b, const char *e) {
  7828. std::string kv(b, e);
  7829. if (cache.find(kv) != cache.end()) { return; }
  7830. cache.insert(kv);
  7831. std::string key;
  7832. std::string val;
  7833. divide_param_pair(b, e, key, val);
  7834. if (!key.empty()) {
  7835. params.emplace(trim_double_quotes_copy(key), unquote_param(val));
  7836. }
  7837. });
  7838. }
  7839. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7840. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7841. #else
  7842. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7843. #endif
  7844. auto is_valid = [](const std::string &str) {
  7845. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7846. };
  7847. if (s.size() > 7 && case_ignore::equal(s.substr(0, 6), "bytes=")) {
  7848. const auto pos = static_cast<size_t>(6);
  7849. const auto len = static_cast<size_t>(s.size() - 6);
  7850. auto all_valid_ranges = true;
  7851. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7852. if (!all_valid_ranges) { return; }
  7853. const auto it = std::find(b, e, '-');
  7854. if (it == e) {
  7855. all_valid_ranges = false;
  7856. return;
  7857. }
  7858. const auto lhs = std::string(b, it);
  7859. const auto rhs = std::string(it + 1, e);
  7860. if (!is_valid(lhs) || !is_valid(rhs)) {
  7861. all_valid_ranges = false;
  7862. return;
  7863. }
  7864. ssize_t first = -1;
  7865. if (!lhs.empty()) {
  7866. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7867. // would turn the range into a suffix range.
  7868. auto res =
  7869. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7870. if (res.ec != std::errc{}) {
  7871. all_valid_ranges = false;
  7872. return;
  7873. }
  7874. }
  7875. ssize_t last = -1;
  7876. if (!rhs.empty()) {
  7877. // An overflowing last-byte-pos is past any content length, so keeping
  7878. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7879. ssize_t v;
  7880. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7881. if (res.ec == std::errc{}) { last = v; }
  7882. }
  7883. if ((first == -1 && last == -1) ||
  7884. (first != -1 && last != -1 && first > last)) {
  7885. all_valid_ranges = false;
  7886. return;
  7887. }
  7888. ranges.emplace_back(first, last);
  7889. });
  7890. return all_valid_ranges && !ranges.empty();
  7891. }
  7892. return false;
  7893. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7894. }
  7895. #else
  7896. } catch (...) { return false; }
  7897. #endif
  7898. // Removes each quoted-string, honoring a quoted-pair (RFC 9110 Section 5.6.4)
  7899. inline std::string remove_quoted_strings(const std::string &s) {
  7900. std::string out;
  7901. auto in_quotes = false;
  7902. for (size_t i = 0; i < s.size(); i++) {
  7903. if (s[i] == '"') {
  7904. in_quotes = !in_quotes;
  7905. } else if (!in_quotes) {
  7906. out += s[i];
  7907. } else if (s[i] == '\\') {
  7908. i++;
  7909. }
  7910. }
  7911. return out;
  7912. }
  7913. inline bool parse_accept_header(const std::string &s,
  7914. std::vector<std::string> &content_types) {
  7915. // Parameter values are not used here, so a quoted-string is dropped rather
  7916. // than parsed: a ',' or ';' inside one must not be read as a delimiter.
  7917. if (s.find('"') != std::string::npos) {
  7918. return parse_accept_header(remove_quoted_strings(s), content_types);
  7919. }
  7920. content_types.clear();
  7921. // Empty string is considered valid (no preference)
  7922. if (s.empty()) { return true; }
  7923. struct AcceptEntry {
  7924. std::string media_type;
  7925. double quality;
  7926. int order;
  7927. };
  7928. std::vector<AcceptEntry> entries;
  7929. int order = 0;
  7930. bool has_invalid_entry = false;
  7931. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7932. // has to parse and ignore empty list elements, so a leading, trailing or
  7933. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7934. // split() skips them, and the header length limit bounds how many a sender
  7935. // can send, so ignoring all of them cannot be used as a denial-of-service
  7936. // vector.
  7937. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7938. std::string entry(b, e);
  7939. entry = trim_copy(entry);
  7940. AcceptEntry accept_entry;
  7941. accept_entry.order = order++;
  7942. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7943. accept_entry.media_type, accept_entry.quality)) {
  7944. has_invalid_entry = true;
  7945. return;
  7946. }
  7947. // Remove additional parameters from media type
  7948. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7949. // Basic validation of media type format
  7950. if (accept_entry.media_type.empty()) {
  7951. has_invalid_entry = true;
  7952. return;
  7953. }
  7954. // Check for basic media type format (should contain '/' or be '*')
  7955. if (accept_entry.media_type != "*" &&
  7956. accept_entry.media_type.find('/') == std::string::npos) {
  7957. has_invalid_entry = true;
  7958. return;
  7959. }
  7960. entries.push_back(std::move(accept_entry));
  7961. });
  7962. // Return false if any invalid entry was found
  7963. if (has_invalid_entry) { return false; }
  7964. // Sort by quality (descending), then by original order (ascending)
  7965. std::sort(entries.begin(), entries.end(),
  7966. [](const AcceptEntry &a, const AcceptEntry &b) {
  7967. if (a.quality != b.quality) {
  7968. return a.quality > b.quality; // Higher quality first
  7969. }
  7970. return a.order < b.order; // Earlier order first for same quality
  7971. });
  7972. // Extract sorted media types
  7973. content_types.reserve(entries.size());
  7974. for (auto &entry : entries) {
  7975. content_types.push_back(std::move(entry.media_type));
  7976. }
  7977. return true;
  7978. }
  7979. class FormDataParser {
  7980. public:
  7981. FormDataParser() = default;
  7982. void set_boundary(std::string &&boundary) {
  7983. boundary_ = std::move(boundary);
  7984. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7985. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7986. }
  7987. bool is_valid() const { return is_valid_; }
  7988. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7989. const ContentReceiver &content_callback) {
  7990. // Once the close delimiter has been seen the rest of the body is epilogue
  7991. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7992. // spread across reads is not copied in only to be erased right away.
  7993. if (state_ == 5) { return true; }
  7994. buf_append(buf, n);
  7995. while (buf_size() > 0) {
  7996. switch (state_) {
  7997. case 0: { // Initial boundary
  7998. auto pos = buf_find(dash_boundary_crlf_);
  7999. if (pos == buf_size()) {
  8000. // Not found yet: keep only a possible partial boundary at the tail so
  8001. // that a body which never contains the boundary cannot grow the
  8002. // buffer (and get rescanned from the start) without bound.
  8003. auto keep = dash_boundary_crlf_.size() - 1;
  8004. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  8005. return true;
  8006. }
  8007. buf_erase(pos + dash_boundary_crlf_.size());
  8008. state_ = 1;
  8009. break;
  8010. }
  8011. case 1: { // New entry
  8012. clear_file_info();
  8013. header_searched_ = 0;
  8014. state_ = 2;
  8015. break;
  8016. }
  8017. case 2: { // Headers
  8018. // Resume where the last call stopped looking, so that a line arriving
  8019. // a few bytes at a time is not searched from its start each time.
  8020. auto pos = buf_find(crlf_, header_searched_);
  8021. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  8022. while (pos < buf_size()) {
  8023. // Empty line
  8024. if (pos == 0) {
  8025. if (!header_callback(file_)) {
  8026. is_valid_ = false;
  8027. return false;
  8028. }
  8029. buf_erase(crlf_.size());
  8030. state_ = 3;
  8031. break;
  8032. }
  8033. // Check header count limit
  8034. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  8035. is_valid_ = false;
  8036. return false;
  8037. }
  8038. header_count_++;
  8039. const auto header = buf_head(pos);
  8040. if (!parse_header(header.data(), header.data() + header.size(),
  8041. [&](const std::string &, const std::string &) {})) {
  8042. is_valid_ = false;
  8043. return false;
  8044. }
  8045. // Parse and emplace space trimmed headers into a map
  8046. if (!parse_header(
  8047. header.data(), header.data() + header.size(),
  8048. [&](const std::string &key, const std::string &val) {
  8049. file_.headers.emplace(key, val);
  8050. })) {
  8051. is_valid_ = false;
  8052. return false;
  8053. }
  8054. constexpr const char header_content_type[] = "Content-Type:";
  8055. if (start_with_case_ignore(header, header_content_type)) {
  8056. file_.content_type =
  8057. trim_copy(header.substr(str_len(header_content_type)));
  8058. } else {
  8059. std::string disposition_params;
  8060. if (parse_content_disposition(header, disposition_params)) {
  8061. Params params;
  8062. parse_disposition_params(disposition_params, params);
  8063. auto it = params.find("name");
  8064. if (it != params.end()) {
  8065. file_.name = it->second;
  8066. } else {
  8067. is_valid_ = false;
  8068. return false;
  8069. }
  8070. it = params.find("filename");
  8071. if (it != params.end()) { file_.filename = it->second; }
  8072. it = params.find("filename*");
  8073. if (it != params.end()) {
  8074. // RFC 5987: only UTF-8 encoding is allowed
  8075. const auto &val = it->second;
  8076. constexpr const char utf8_prefix[] = "UTF-8''";
  8077. constexpr size_t prefix_len = str_len(utf8_prefix);
  8078. if (val.size() > prefix_len &&
  8079. start_with_case_ignore(val, utf8_prefix)) {
  8080. file_.filename = decode_path_component(
  8081. val.substr(prefix_len)); // override...
  8082. } else {
  8083. is_valid_ = false;
  8084. return false;
  8085. }
  8086. }
  8087. }
  8088. }
  8089. buf_erase(pos + crlf_.size());
  8090. pos = buf_find(crlf_);
  8091. }
  8092. if (state_ != 3) {
  8093. // The CR of the CRLF may be the last byte so far.
  8094. header_searched_ = buf_size() > 0 ? buf_size() - 1 : 0;
  8095. return true;
  8096. }
  8097. break;
  8098. }
  8099. case 3: { // Body
  8100. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  8101. auto pos = buf_find(crlf_dash_boundary_);
  8102. if (pos < buf_size()) {
  8103. if (!content_callback(buf_data(), pos)) {
  8104. is_valid_ = false;
  8105. return false;
  8106. }
  8107. buf_erase(pos + crlf_dash_boundary_.size());
  8108. state_ = 4;
  8109. } else {
  8110. auto len = buf_size() - crlf_dash_boundary_.size();
  8111. if (len > 0) {
  8112. if (!content_callback(buf_data(), len)) {
  8113. is_valid_ = false;
  8114. return false;
  8115. }
  8116. buf_erase(len);
  8117. }
  8118. return true;
  8119. }
  8120. break;
  8121. }
  8122. case 4: { // Boundary
  8123. if (crlf_.size() > buf_size()) { return true; }
  8124. if (buf_start_with(crlf_)) {
  8125. buf_erase(crlf_.size());
  8126. state_ = 1;
  8127. } else if (buf_start_with(dash_)) {
  8128. buf_erase(dash_.size());
  8129. is_valid_ = true;
  8130. state_ = 5;
  8131. } else {
  8132. // Only CRLF (another part follows) and "--" (close-delimiter) are
  8133. // accepted after a boundary; RFC 2046 allows transport-padding in
  8134. // between, but this parser has never supported it. Either way the
  8135. // body is already destined to be rejected, so fail now instead of
  8136. // buffering the rest of it. Both are two bytes, so the check above
  8137. // already guarantees enough buffered data to decide.
  8138. is_valid_ = false;
  8139. return false;
  8140. }
  8141. break;
  8142. }
  8143. case 5: { // Epilogue
  8144. buf_erase(buf_size());
  8145. break;
  8146. }
  8147. }
  8148. }
  8149. return true;
  8150. }
  8151. private:
  8152. void clear_file_info() {
  8153. file_.name.clear();
  8154. file_.filename.clear();
  8155. file_.content_type.clear();
  8156. file_.headers.clear();
  8157. header_count_ = 0;
  8158. }
  8159. bool start_with_case_ignore(const std::string &a, const char *b,
  8160. size_t offset = 0) const {
  8161. const auto b_len = strlen(b);
  8162. if (a.size() < offset + b_len) { return false; }
  8163. for (size_t i = 0; i < b_len; i++) {
  8164. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  8165. return false;
  8166. }
  8167. }
  8168. return true;
  8169. }
  8170. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  8171. // Returns true if header matches, with the params portion in `params_out`.
  8172. bool parse_content_disposition(const std::string &header,
  8173. std::string &params_out) const {
  8174. constexpr const char prefix[] = "Content-Disposition:";
  8175. constexpr size_t prefix_len = str_len(prefix);
  8176. if (!start_with_case_ignore(header, prefix)) { return false; }
  8177. // Skip whitespace after "Content-Disposition:"
  8178. auto pos = prefix_len;
  8179. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8180. pos++;
  8181. }
  8182. // Match "form-data;" (case-insensitive)
  8183. constexpr const char form_data[] = "form-data;";
  8184. constexpr size_t form_data_len = str_len(form_data);
  8185. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  8186. pos += form_data_len;
  8187. // Skip whitespace after "form-data;"
  8188. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  8189. pos++;
  8190. }
  8191. params_out = header.substr(pos);
  8192. return true;
  8193. }
  8194. const std::string dash_ = "--";
  8195. const std::string crlf_ = "\r\n";
  8196. std::string boundary_;
  8197. std::string dash_boundary_crlf_;
  8198. std::string crlf_dash_boundary_;
  8199. size_t state_ = 0;
  8200. bool is_valid_ = false;
  8201. FormData file_;
  8202. size_t header_count_ = 0;
  8203. size_t header_searched_ = 0;
  8204. // Buffer
  8205. bool start_with(const std::string &a, size_t spos, size_t epos,
  8206. const std::string &b) const {
  8207. if (epos - spos < b.size()) { return false; }
  8208. for (size_t i = 0; i < b.size(); i++) {
  8209. if (a[i + spos] != b[i]) { return false; }
  8210. }
  8211. return true;
  8212. }
  8213. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  8214. const char *buf_data() const { return &buf_[buf_spos_]; }
  8215. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  8216. bool buf_start_with(const std::string &s) const {
  8217. return start_with(buf_, buf_spos_, buf_epos_, s);
  8218. }
  8219. size_t buf_find(const std::string &s, size_t from = 0) const {
  8220. auto c = s.front();
  8221. size_t off = buf_spos_ + from;
  8222. while (off < buf_epos_) {
  8223. auto pos = off;
  8224. while (true) {
  8225. if (pos == buf_epos_) { return buf_size(); }
  8226. if (buf_[pos] == c) { break; }
  8227. pos++;
  8228. }
  8229. auto remaining_size = buf_epos_ - pos;
  8230. if (s.size() > remaining_size) { return buf_size(); }
  8231. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  8232. off = pos + 1;
  8233. }
  8234. return buf_size();
  8235. }
  8236. void buf_append(const char *data, size_t n) {
  8237. auto remaining_size = buf_size();
  8238. if (remaining_size > 0 && buf_spos_ > 0) {
  8239. for (size_t i = 0; i < remaining_size; i++) {
  8240. buf_[i] = buf_[buf_spos_ + i];
  8241. }
  8242. }
  8243. buf_spos_ = 0;
  8244. buf_epos_ = remaining_size;
  8245. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  8246. for (size_t i = 0; i < n; i++) {
  8247. buf_[buf_epos_ + i] = data[i];
  8248. }
  8249. buf_epos_ += n;
  8250. }
  8251. void buf_erase(size_t size) { buf_spos_ += size; }
  8252. std::string buf_;
  8253. size_t buf_spos_ = 0;
  8254. size_t buf_epos_ = 0;
  8255. };
  8256. inline std::string random_string(size_t length) {
  8257. constexpr const char data[] =
  8258. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  8259. std::string result(length, '\0');
  8260. fill_random_bytes(reinterpret_cast<unsigned char *>(&result[0]), length);
  8261. for (auto &c : result) {
  8262. c = data[static_cast<unsigned char>(c) % (sizeof(data) - 1)];
  8263. }
  8264. return result;
  8265. }
  8266. inline std::string make_multipart_data_boundary() {
  8267. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8268. }
  8269. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8270. auto valid = true;
  8271. for (size_t i = 0; i < boundary.size(); i++) {
  8272. auto c = boundary[i];
  8273. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8274. valid = false;
  8275. break;
  8276. }
  8277. }
  8278. return valid;
  8279. }
  8280. // Escape a multipart field name/filename following the WHATWG HTML standard
  8281. // ("escape a multipart form-data name"): '"' -> %22, CR -> %0D, LF -> %0A.
  8282. // As the value is a quoted-string, '\' -> '\\' too, which browsers leave out.
  8283. // With quoted = false, only CR and LF are escaped; this is for header values
  8284. // outside a quoted-string (e.g. Content-Type), where '"' and '\' are legal.
  8285. inline std::string escape_multipart_field(const std::string &s,
  8286. bool quoted = true) {
  8287. std::string result;
  8288. result.reserve(s.size());
  8289. for (auto c : s) {
  8290. switch (c) {
  8291. case '"':
  8292. if (quoted) {
  8293. result += "%22";
  8294. } else {
  8295. result += c;
  8296. }
  8297. break;
  8298. case '\\':
  8299. // A lone backslash would escape the character after it (RFC 9110
  8300. // 5.6.4).
  8301. if (quoted) { result += '\\'; }
  8302. result += c;
  8303. break;
  8304. case '\r': result += "%0D"; break;
  8305. case '\n': result += "%0A"; break;
  8306. default: result += c; break;
  8307. }
  8308. }
  8309. return result;
  8310. }
  8311. template <typename T>
  8312. inline std::string
  8313. serialize_multipart_formdata_item_begin(const T &item,
  8314. const std::string &boundary) {
  8315. std::string body = "--" + boundary + "\r\n";
  8316. body += "Content-Disposition: form-data; name=\"" +
  8317. escape_multipart_field(item.name) + "\"";
  8318. if (!item.filename.empty()) {
  8319. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8320. }
  8321. body += "\r\n";
  8322. if (!item.content_type.empty()) {
  8323. body +=
  8324. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8325. "\r\n";
  8326. }
  8327. body += "\r\n";
  8328. return body;
  8329. }
  8330. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8331. inline std::string
  8332. serialize_multipart_formdata_finish(const std::string &boundary) {
  8333. return "--" + boundary + "--\r\n";
  8334. }
  8335. inline std::string
  8336. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8337. return "multipart/form-data; boundary=" + boundary;
  8338. }
  8339. inline std::string
  8340. serialize_multipart_formdata(const UploadFormDataItems &items,
  8341. const std::string &boundary, bool finish = true) {
  8342. std::string body;
  8343. for (const auto &item : items) {
  8344. body += serialize_multipart_formdata_item_begin(item, boundary);
  8345. body += item.content + serialize_multipart_formdata_item_end();
  8346. }
  8347. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8348. return body;
  8349. }
  8350. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8351. const std::string &boundary) {
  8352. size_t total = 0;
  8353. for (const auto &item : items) {
  8354. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8355. total += item.content.size();
  8356. total += serialize_multipart_formdata_item_end().size();
  8357. }
  8358. total += serialize_multipart_formdata_finish(boundary).size();
  8359. return total;
  8360. }
  8361. struct MultipartSegment {
  8362. const char *data;
  8363. size_t size;
  8364. };
  8365. // NOTE: items must outlive the returned ContentProvider
  8366. // (safe for synchronous use inside Post/Put/Patch)
  8367. inline ContentProvider
  8368. make_multipart_content_provider(const UploadFormDataItems &items,
  8369. const std::string &boundary) {
  8370. // Own the per-item header strings and the finish string
  8371. std::vector<std::string> owned;
  8372. owned.reserve(items.size() + 1);
  8373. for (const auto &item : items)
  8374. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8375. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8376. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8377. std::vector<MultipartSegment> segs;
  8378. segs.reserve(items.size() * 3 + 1);
  8379. static const char crlf[] = "\r\n";
  8380. for (size_t i = 0; i < items.size(); i++) {
  8381. segs.push_back({owned[i].data(), owned[i].size()});
  8382. segs.push_back({items[i].content.data(), items[i].content.size()});
  8383. segs.push_back({crlf, 2});
  8384. }
  8385. segs.push_back({owned.back().data(), owned.back().size()});
  8386. struct MultipartState {
  8387. std::vector<std::string> owned;
  8388. std::vector<MultipartSegment> segs;
  8389. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8390. };
  8391. auto state = std::make_shared<MultipartState>();
  8392. state->owned = std::move(owned);
  8393. // `segs` holds raw pointers into owned strings; std::string move preserves
  8394. // the data pointer, so these pointers remain valid after the move above.
  8395. state->segs = std::move(segs);
  8396. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8397. // Buffer multiple small segments into fewer, larger writes to avoid
  8398. // excessive TCP packets when there are many form data items (#2410)
  8399. auto &buf = state->buf;
  8400. auto buf_size = buf.size();
  8401. size_t buf_len = 0;
  8402. size_t remaining = length;
  8403. // Find the first segment containing 'offset'
  8404. size_t pos = 0;
  8405. size_t seg_idx = 0;
  8406. for (; seg_idx < state->segs.size(); seg_idx++) {
  8407. const auto &seg = state->segs[seg_idx];
  8408. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8409. pos += seg.size;
  8410. }
  8411. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8412. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8413. const auto &seg = state->segs[seg_idx];
  8414. size_t available = seg.size - seg_offset;
  8415. size_t to_copy = (std::min)(available, remaining);
  8416. const char *src = seg.data + seg_offset;
  8417. seg_offset = 0; // only the first segment has a non-zero offset
  8418. while (to_copy > 0) {
  8419. size_t space = buf_size - buf_len;
  8420. size_t chunk = (std::min)(to_copy, space);
  8421. std::memcpy(buf.data() + buf_len, src, chunk);
  8422. buf_len += chunk;
  8423. src += chunk;
  8424. to_copy -= chunk;
  8425. remaining -= chunk;
  8426. if (buf_len == buf_size) {
  8427. if (!sink.write(buf.data(), buf_len)) { return false; }
  8428. buf_len = 0;
  8429. }
  8430. }
  8431. }
  8432. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8433. return true;
  8434. };
  8435. }
  8436. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8437. if (ranges.size() <= 1) return;
  8438. // Sort ranges by start position
  8439. std::sort(ranges.begin(), ranges.end(),
  8440. [](const Range &a, const Range &b) { return a.first < b.first; });
  8441. Ranges coalesced;
  8442. coalesced.reserve(ranges.size());
  8443. for (auto &r : ranges) {
  8444. auto first_pos = r.first;
  8445. auto last_pos = r.second;
  8446. // Handle special cases like in range_error
  8447. if (first_pos == -1 && last_pos == -1) {
  8448. first_pos = 0;
  8449. last_pos = static_cast<ssize_t>(content_length);
  8450. }
  8451. if (first_pos == -1) {
  8452. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8453. last_pos = static_cast<ssize_t>(content_length) - 1;
  8454. }
  8455. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8456. last_pos = static_cast<ssize_t>(content_length) - 1;
  8457. }
  8458. // Skip invalid ranges
  8459. if (!(0 <= first_pos && first_pos <= last_pos &&
  8460. last_pos < static_cast<ssize_t>(content_length))) {
  8461. continue;
  8462. }
  8463. // Coalesce with previous range if overlapping or adjacent (but not
  8464. // identical)
  8465. if (!coalesced.empty()) {
  8466. auto &prev = coalesced.back();
  8467. // Check if current range overlaps or is adjacent to previous range
  8468. // but don't coalesce identical ranges (allow duplicates)
  8469. if (first_pos <= prev.second + 1 &&
  8470. !(first_pos == prev.first && last_pos == prev.second)) {
  8471. // Extend the previous range
  8472. prev.second = (std::max)(prev.second, last_pos);
  8473. continue;
  8474. }
  8475. }
  8476. // Add new range
  8477. coalesced.emplace_back(first_pos, last_pos);
  8478. }
  8479. ranges = std::move(coalesced);
  8480. }
  8481. inline bool range_error(Request &req, Response &res) {
  8482. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8483. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8484. req.ranges.clear();
  8485. if (res.status == StatusCode::PartialContent_206) {
  8486. res.status = StatusCode::OK_200;
  8487. }
  8488. return false;
  8489. }
  8490. ssize_t content_len = static_cast<ssize_t>(
  8491. res.content_length_ ? res.content_length_ : res.body.size());
  8492. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8493. size_t overwrapping_count = 0;
  8494. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8495. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8496. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8497. // Too many ranges
  8498. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8499. for (auto &r : req.ranges) {
  8500. auto &first_pos = r.first;
  8501. auto &last_pos = r.second;
  8502. if (first_pos == -1 && last_pos == -1) {
  8503. first_pos = 0;
  8504. last_pos = content_len;
  8505. }
  8506. // RFC 9110 14.1.2: a suffix-length longer than the representation
  8507. // selects the entire representation.
  8508. if (first_pos == -1) {
  8509. first_pos = (std::max)(static_cast<ssize_t>(0), content_len - last_pos);
  8510. last_pos = content_len - 1;
  8511. }
  8512. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8513. // A client can limit the number of bytes requested without knowing the
  8514. // size of the selected representation. If the last-pos value is absent,
  8515. // or if the value is greater than or equal to the current length of the
  8516. // representation data, the byte range is interpreted as the remainder of
  8517. // the representation (i.e., the server replaces the value of last-pos
  8518. // with a value that is one less than the current length of the selected
  8519. // representation).
  8520. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8521. if (last_pos == -1 || last_pos >= content_len) {
  8522. last_pos = content_len - 1;
  8523. }
  8524. // Range must be within content length
  8525. if (!(0 <= first_pos && first_pos <= last_pos &&
  8526. last_pos <= content_len - 1)) {
  8527. return true;
  8528. }
  8529. // Request must not have more than two overlapping ranges
  8530. for (const auto &processed_range : processed_ranges) {
  8531. if (!(last_pos < processed_range.first ||
  8532. first_pos > processed_range.second)) {
  8533. overwrapping_count++;
  8534. if (overwrapping_count > 2) { return true; }
  8535. break; // Only count once per range
  8536. }
  8537. }
  8538. processed_ranges.emplace_back(first_pos, last_pos);
  8539. }
  8540. // After validation, coalesce overlapping ranges as per RFC 9110
  8541. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8542. }
  8543. return false;
  8544. }
  8545. inline std::pair<size_t, size_t>
  8546. get_range_offset_and_length(Range r, size_t content_length) {
  8547. assert(r.first != -1 && r.second != -1);
  8548. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8549. assert(r.first <= r.second &&
  8550. r.second < static_cast<ssize_t>(content_length));
  8551. (void)(content_length);
  8552. return std::make_pair(static_cast<size_t>(r.first),
  8553. static_cast<size_t>(r.second - r.first) + 1);
  8554. }
  8555. inline std::string make_content_range_header_field(
  8556. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8557. auto st = offset_and_length.first;
  8558. auto ed = st + offset_and_length.second - 1;
  8559. std::string field = "bytes ";
  8560. field += std::to_string(st);
  8561. field += '-';
  8562. field += std::to_string(ed);
  8563. field += '/';
  8564. field += std::to_string(content_length);
  8565. return field;
  8566. }
  8567. template <typename SToken, typename CToken, typename Content>
  8568. bool process_multipart_ranges_data(const Request &req,
  8569. const std::string &boundary,
  8570. const std::string &content_type,
  8571. size_t content_length, SToken stoken,
  8572. CToken ctoken, Content content) {
  8573. for (size_t i = 0; i < req.ranges.size(); i++) {
  8574. ctoken("--");
  8575. stoken(boundary);
  8576. ctoken("\r\n");
  8577. if (!content_type.empty()) {
  8578. ctoken("Content-Type: ");
  8579. stoken(content_type);
  8580. ctoken("\r\n");
  8581. }
  8582. auto offset_and_length =
  8583. get_range_offset_and_length(req.ranges[i], content_length);
  8584. ctoken("Content-Range: ");
  8585. stoken(make_content_range_header_field(offset_and_length, content_length));
  8586. ctoken("\r\n");
  8587. ctoken("\r\n");
  8588. if (!content(offset_and_length.first, offset_and_length.second)) {
  8589. return false;
  8590. }
  8591. ctoken("\r\n");
  8592. }
  8593. ctoken("--");
  8594. stoken(boundary);
  8595. ctoken("--");
  8596. return true;
  8597. }
  8598. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8599. const std::string &boundary,
  8600. const std::string &content_type,
  8601. size_t content_length,
  8602. std::string &data) {
  8603. process_multipart_ranges_data(
  8604. req, boundary, content_type, content_length,
  8605. [&](const std::string &token) { data += token; },
  8606. [&](const std::string &token) { data += token; },
  8607. [&](size_t offset, size_t length) {
  8608. assert(offset + length <= content_length);
  8609. data += res.body.substr(offset, length);
  8610. return true;
  8611. });
  8612. }
  8613. inline size_t get_multipart_ranges_data_length(const Request &req,
  8614. const std::string &boundary,
  8615. const std::string &content_type,
  8616. size_t content_length) {
  8617. size_t data_length = 0;
  8618. process_multipart_ranges_data(
  8619. req, boundary, content_type, content_length,
  8620. [&](const std::string &token) { data_length += token.size(); },
  8621. [&](const std::string &token) { data_length += token.size(); },
  8622. [&](size_t /*offset*/, size_t length) {
  8623. data_length += length;
  8624. return true;
  8625. });
  8626. return data_length;
  8627. }
  8628. template <typename T>
  8629. inline bool
  8630. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8631. const std::string &boundary,
  8632. const std::string &content_type,
  8633. size_t content_length, const T &is_shutting_down) {
  8634. return process_multipart_ranges_data(
  8635. req, boundary, content_type, content_length,
  8636. [&](const std::string &token) { strm.write(token); },
  8637. [&](const std::string &token) { strm.write(token); },
  8638. [&](size_t offset, size_t length) {
  8639. return write_content(strm, res.content_provider_, offset, length,
  8640. is_shutting_down);
  8641. });
  8642. }
  8643. inline bool has_framed_body(const Request &req) {
  8644. return is_chunked_transfer_encoding(req.headers) ||
  8645. req.get_header_value_u64("Content-Length") > 0;
  8646. }
  8647. inline bool is_connection_persistent(const Request &req) {
  8648. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8649. if (req.version == "HTTP/1.0" &&
  8650. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8651. return false;
  8652. }
  8653. return true;
  8654. }
  8655. inline bool expect_content(const Request &req) {
  8656. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8657. req.method == "DELETE") {
  8658. return true;
  8659. }
  8660. return has_framed_body(req);
  8661. }
  8662. #ifdef _WIN32
  8663. class WSInit {
  8664. public:
  8665. WSInit() {
  8666. WSADATA wsaData;
  8667. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8668. }
  8669. ~WSInit() {
  8670. if (is_valid_) WSACleanup();
  8671. }
  8672. bool is_valid_ = false;
  8673. };
  8674. static WSInit wsinit_;
  8675. #endif
  8676. inline std::string unescape_quoted_pairs(const std::string &s) {
  8677. std::string out;
  8678. out.reserve(s.size());
  8679. for (size_t i = 0; i < s.size(); i++) {
  8680. if (s[i] == '\\' && i + 1 < s.size()) {
  8681. out += s[++i];
  8682. } else {
  8683. out += s[i];
  8684. }
  8685. }
  8686. return out;
  8687. }
  8688. // Inverse of unescape_quoted_pairs: prepares a value to sit inside a
  8689. // quoted-string. RFC 9110 §5.6.4 requires a literal '\' or '"' to be sent as a
  8690. // quoted-pair, so the recipient recovers the original value.
  8691. inline std::string escape_quoted_pairs(const std::string &s) {
  8692. std::string out;
  8693. out.reserve(s.size());
  8694. for (auto c : s) {
  8695. if (c == '\\' || c == '"') { out += '\\'; }
  8696. out += c;
  8697. }
  8698. return out;
  8699. }
  8700. // RFC 9110 Section 11.6.1 defines a challenge list as
  8701. // WWW-Authenticate = #challenge
  8702. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8703. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8704. // so a server may offer several schemes, each with its own comma-separated
  8705. // auth-param list, in either order and either as separate field lines or
  8706. // packed into one. Splitting on every comma would break apart a challenge's
  8707. // own param list; splitting only on the first space would miss a Digest
  8708. // challenge that isn't first. Split on commas that aren't inside a
  8709. // quoted-string instead (split_unquoted), then track which scheme each
  8710. // resulting segment belongs to: a segment whose text before "=" contains
  8711. // whitespace (or that has no "=" at all) starts a new challenge named by its
  8712. // leading token.
  8713. inline bool parse_www_authenticate(const Response &res,
  8714. std::map<std::string, std::string> &auth,
  8715. bool is_proxy) {
  8716. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8717. auto combined = get_combined_header_value(res.headers, auth_key);
  8718. if (combined.empty()) { return false; }
  8719. auto found_digest = false;
  8720. auto in_digest_challenge = false;
  8721. split_unquoted(
  8722. combined.data(), combined.data() + combined.size(), ',',
  8723. [&](const char *b, const char *e) {
  8724. std::string segment(b, e);
  8725. auto eq_pos = segment.find('=');
  8726. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8727. // for the first segment of a challenge, "<scheme> <key>") must be
  8728. // trimmed before its boundaries are inspected.
  8729. auto key_part = trim_copy(
  8730. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8731. auto space_pos = key_part.find_last_of(" \t");
  8732. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8733. // "<scheme>[ <key>]" starts a new challenge.
  8734. auto scheme_end =
  8735. space_pos == std::string::npos ? key_part.size() : space_pos;
  8736. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8737. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8738. // from one challenge is never paired with another's algorithm.
  8739. in_digest_challenge =
  8740. !found_digest &&
  8741. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8742. if (in_digest_challenge) { found_digest = true; }
  8743. if (space_pos == std::string::npos) {
  8744. // Bare scheme (or a token68), no auth-param on this segment.
  8745. return;
  8746. }
  8747. key_part = key_part.substr(space_pos + 1);
  8748. }
  8749. if (!in_digest_challenge) { return; }
  8750. auto val = trim_copy(segment.substr(eq_pos + 1));
  8751. auto unquoted = trim_double_quotes_copy(val);
  8752. if (unquoted.size() != val.size()) {
  8753. unquoted = unescape_quoted_pairs(unquoted);
  8754. }
  8755. auth[std::move(key_part)] = std::move(unquoted);
  8756. });
  8757. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8758. // make_digest_authentication_header() dereferences both unconditionally, so
  8759. // a challenge missing either can't produce a usable Authorization header.
  8760. // Treat it the same as no Digest challenge at all.
  8761. return found_digest && auth.find("realm") != auth.end() &&
  8762. auth.find("nonce") != auth.end();
  8763. }
  8764. class ContentProviderAdapter {
  8765. public:
  8766. explicit ContentProviderAdapter(
  8767. ContentProviderWithoutLength &&content_provider)
  8768. : content_provider_(std::move(content_provider)) {}
  8769. bool operator()(size_t offset, size_t, DataSink &sink) {
  8770. return content_provider_(offset, sink);
  8771. }
  8772. private:
  8773. ContentProviderWithoutLength content_provider_;
  8774. };
  8775. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8776. namespace fields {
  8777. inline bool is_token_char(char c) {
  8778. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8779. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8780. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8781. }
  8782. inline bool is_token(const std::string &s) {
  8783. if (s.empty()) { return false; }
  8784. for (auto c : s) {
  8785. if (!is_token_char(c)) { return false; }
  8786. }
  8787. return true;
  8788. }
  8789. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8790. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8791. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8792. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8793. inline bool is_field_content(const std::string &s) {
  8794. if (s.empty()) { return true; }
  8795. if (s.size() == 1) {
  8796. return is_field_vchar(s[0]);
  8797. } else if (s.size() == 2) {
  8798. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8799. } else {
  8800. size_t i = 0;
  8801. if (!is_field_vchar(s[i])) { return false; }
  8802. i++;
  8803. while (i < s.size() - 1) {
  8804. auto c = s[i++];
  8805. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8806. } else {
  8807. return false;
  8808. }
  8809. }
  8810. return is_field_vchar(s[i]);
  8811. }
  8812. }
  8813. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8814. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8815. return is_field_name(name) && is_field_value(value);
  8816. }
  8817. // RFC 9112 §2.2/§3.2: the request-target has no SP, HTAB or other control
  8818. // characters (incl. bare CR). obs-text (raw UTF-8) is allowed.
  8819. inline bool is_request_target(const std::string &s) {
  8820. return std::all_of(s.begin(), s.end(), is_field_vchar);
  8821. }
  8822. // RFC 9110 §7.2: the bytes of uri-host [ ":" port ], i.e. unreserved,
  8823. // sub-delims, "%", ":" and the IP-literal brackets. An empty value is valid.
  8824. inline bool is_host(const std::string &s) {
  8825. return std::all_of(s.begin(), s.end(), [](char c) {
  8826. return is_ascii_alnum(c) || c == '-' || c == '.' || c == '_' || c == '~' ||
  8827. c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  8828. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  8829. c == '=' || c == '%' || c == ':' || c == '[' || c == ']';
  8830. });
  8831. }
  8832. } // namespace fields
  8833. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8834. WebSocketUpgradeResponse &upgrade) {
  8835. // Generate a random 16-byte Sec-WebSocket-Key (RFC 6455 Section 4.1)
  8836. std::string key_bytes(16, '\0');
  8837. fill_random_bytes(reinterpret_cast<unsigned char *>(&key_bytes[0]),
  8838. key_bytes.size());
  8839. auto client_key = base64_encode(key_bytes);
  8840. req.headers.erase("Upgrade");
  8841. req.headers.erase("Connection");
  8842. req.headers.erase("Sec-WebSocket-Key");
  8843. req.headers.erase("Sec-WebSocket-Version");
  8844. req.headers.emplace("Upgrade", "websocket");
  8845. req.headers.emplace("Connection", "Upgrade");
  8846. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8847. req.headers.emplace("Sec-WebSocket-Version", "13");
  8848. // Build the request in memory first, like ClientImpl::write_request does.
  8849. // Writing straight to the socket would leak a request line onto the wire
  8850. // before check_and_write_headers gets a chance to reject an invalid header,
  8851. // and would emit one small write per header.
  8852. BufferStream bstrm;
  8853. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8854. upgrade.error = Error::Write;
  8855. return false;
  8856. }
  8857. auto error = Error::Success;
  8858. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8859. upgrade.error = error;
  8860. return false;
  8861. }
  8862. const auto &data = bstrm.get_buffer();
  8863. if (!write_data(strm, data.data(), data.size())) {
  8864. upgrade.error = Error::Write;
  8865. return false;
  8866. }
  8867. // Verify 101 response and Sec-WebSocket-Accept header
  8868. auto expected_accept = websocket_accept_key(client_key);
  8869. auto offered_subprotocols =
  8870. get_combined_header_value(req.headers, "Sec-WebSocket-Protocol");
  8871. return read_websocket_upgrade_response(strm, expected_accept,
  8872. offered_subprotocols, upgrade);
  8873. }
  8874. inline bool is_ip_address(const std::string &host) {
  8875. struct in_addr addr4;
  8876. struct in6_addr addr6;
  8877. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8878. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8879. }
  8880. // Resolve where a client should connect for `host`, honoring a user-supplied
  8881. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8882. // supplying the Host header and SNI; only the connection target changes.
  8883. //
  8884. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8885. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8886. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8887. // absent or empty mapping leaves `host` as the connection target; without the
  8888. // empty check the value would reach getaddrinfo as a null node and silently
  8889. // resolve to loopback.
  8890. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8891. const std::string &host, std::string &connect_host,
  8892. std::string &ip) {
  8893. connect_host = host;
  8894. ip.clear();
  8895. auto it = addr_map.find(host);
  8896. if (it == addr_map.end() || it->second.empty()) { return; }
  8897. if (is_ip_address(it->second)) {
  8898. ip = it->second;
  8899. } else {
  8900. connect_host = it->second;
  8901. }
  8902. }
  8903. } // namespace detail
  8904. /*
  8905. * Group 2: detail namespace - SSL common utilities
  8906. */
  8907. #ifdef CPPHTTPLIB_SSL_ENABLED
  8908. namespace detail {
  8909. class SSLSocketStream final : public Stream {
  8910. public:
  8911. SSLSocketStream(
  8912. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8913. time_t read_timeout_usec, time_t write_timeout_sec,
  8914. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8915. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8916. (std::chrono::steady_clock::time_point::min)());
  8917. ~SSLSocketStream() override;
  8918. bool is_readable() const override;
  8919. bool wait_readable() const override;
  8920. bool wait_writable() const override;
  8921. bool is_peer_alive() const override;
  8922. ssize_t read(char *ptr, size_t size) override;
  8923. ssize_t write(const char *ptr, size_t size) override;
  8924. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8925. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8926. socket_t socket() const override;
  8927. time_t duration() const override;
  8928. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8929. void set_max_timeout(time_t msec) override;
  8930. // See SocketStream::set_readable_hint().
  8931. void set_readable_hint() { readable_hint_ = true; }
  8932. private:
  8933. bool ensure_readable();
  8934. socket_t sock_;
  8935. tls::session_t session_;
  8936. time_t read_timeout_sec_;
  8937. time_t read_timeout_usec_;
  8938. time_t write_timeout_sec_;
  8939. time_t write_timeout_usec_;
  8940. time_t max_timeout_msec_;
  8941. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8942. bool readable_hint_ = false;
  8943. };
  8944. // A TLS stream for WebSocket connections, where the receive path and the
  8945. // send path (application send() plus the heartbeat ping thread) run on
  8946. // different threads. A single TLS session must never be entered
  8947. // concurrently, so every call into the session is serialized by one mutex.
  8948. //
  8949. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8950. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8951. // call under the lock, then waits for readiness with select() outside the
  8952. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8953. // blocked waiting for data never stalls a concurrent sender.
  8954. //
  8955. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8956. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8957. class WebSocketSSLStream final : public Stream {
  8958. public:
  8959. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8960. time_t read_timeout_sec, time_t read_timeout_usec,
  8961. time_t write_timeout_sec, time_t write_timeout_usec);
  8962. ~WebSocketSSLStream() override;
  8963. bool is_readable() const override;
  8964. bool wait_readable() const override;
  8965. bool wait_writable() const override;
  8966. ssize_t read(char *ptr, size_t size) override;
  8967. ssize_t write(const char *ptr, size_t size) override;
  8968. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8969. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8970. socket_t socket() const override;
  8971. time_t duration() const override;
  8972. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8973. private:
  8974. mutable std::mutex session_mutex_;
  8975. socket_t sock_;
  8976. tls::session_t session_;
  8977. // WebSocket::close() shortens the read timeout from the closing thread
  8978. // while the receive thread is inside wait_readable(), so these two are read
  8979. // and written concurrently. The write timeouts are never mutated.
  8980. std::atomic<time_t> read_timeout_sec_;
  8981. std::atomic<time_t> read_timeout_usec_;
  8982. time_t write_timeout_sec_;
  8983. time_t write_timeout_usec_;
  8984. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8985. };
  8986. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8987. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8988. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8989. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8990. unsigned int hash_length = 0;
  8991. unsigned char hash[EVP_MAX_MD_SIZE];
  8992. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8993. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8994. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8995. std::stringstream ss;
  8996. for (auto i = 0u; i < hash_length; ++i) {
  8997. ss << std::hex << std::setw(2) << std::setfill('0')
  8998. << static_cast<unsigned int>(hash[i]);
  8999. }
  9000. return ss.str();
  9001. }
  9002. inline std::string MD5(const std::string &s) {
  9003. return message_digest(s, EVP_md5());
  9004. }
  9005. inline std::string SHA_256(const std::string &s) {
  9006. return message_digest(s, EVP_sha256());
  9007. }
  9008. inline std::string SHA_512(const std::string &s) {
  9009. return message_digest(s, EVP_sha512());
  9010. }
  9011. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  9012. namespace {
  9013. template <size_t N>
  9014. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9015. std::stringstream ss;
  9016. for (size_t i = 0; i < N; ++i) {
  9017. ss << std::hex << std::setw(2) << std::setfill('0')
  9018. << static_cast<unsigned int>(hash[i]);
  9019. }
  9020. return ss.str();
  9021. }
  9022. } // namespace
  9023. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9024. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  9025. // initialized once. PSA state is process-global; do not free it.
  9026. inline bool ensure_mbedtls_psa_crypto() {
  9027. static std::once_flag once;
  9028. static bool ok = false;
  9029. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  9030. return ok;
  9031. }
  9032. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  9033. unsigned char *out, size_t out_size) {
  9034. if (!ensure_mbedtls_psa_crypto()) { return false; }
  9035. size_t olen = 0;
  9036. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  9037. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  9038. olen == out_size;
  9039. }
  9040. #endif
  9041. inline std::string MD5(const std::string &s) {
  9042. unsigned char hash[16];
  9043. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9044. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  9045. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9046. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9047. hash);
  9048. #else
  9049. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9050. hash);
  9051. #endif
  9052. return hash_to_hex(hash);
  9053. }
  9054. inline std::string SHA_256(const std::string &s) {
  9055. unsigned char hash[32];
  9056. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9057. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  9058. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9059. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9060. hash, 0);
  9061. #else
  9062. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9063. s.size(), hash, 0);
  9064. #endif
  9065. return hash_to_hex(hash);
  9066. }
  9067. inline std::string SHA_512(const std::string &s) {
  9068. unsigned char hash[64];
  9069. #ifdef CPPHTTPLIB_MBEDTLS_V4
  9070. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  9071. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  9072. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  9073. hash, 0);
  9074. #else
  9075. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  9076. s.size(), hash, 0);
  9077. #endif
  9078. return hash_to_hex(hash);
  9079. }
  9080. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9081. namespace {
  9082. template <size_t N>
  9083. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  9084. std::stringstream ss;
  9085. for (size_t i = 0; i < N; ++i) {
  9086. ss << std::hex << std::setw(2) << std::setfill('0')
  9087. << static_cast<unsigned int>(hash[i]);
  9088. }
  9089. return ss.str();
  9090. }
  9091. } // namespace
  9092. inline std::string MD5(const std::string &s) {
  9093. unsigned char hash[WC_MD5_DIGEST_SIZE];
  9094. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9095. static_cast<word32>(s.size()), hash);
  9096. return hash_to_hex(hash);
  9097. }
  9098. inline std::string SHA_256(const std::string &s) {
  9099. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  9100. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9101. static_cast<word32>(s.size()), hash);
  9102. return hash_to_hex(hash);
  9103. }
  9104. inline std::string SHA_512(const std::string &s) {
  9105. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  9106. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  9107. static_cast<word32>(s.size()), hash);
  9108. return hash_to_hex(hash);
  9109. }
  9110. #endif
  9111. template <typename T>
  9112. inline bool process_server_socket_ssl(
  9113. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  9114. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  9115. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  9116. time_t write_timeout_usec, T callback) {
  9117. // See process_server_socket(). The TLS library keeps already decrypted bytes
  9118. // of a pipelined request, which keep_alive() cannot see on the socket.
  9119. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9120. write_timeout_sec, write_timeout_usec);
  9121. return process_server_socket_core(
  9122. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  9123. [&]() { return strm.is_readable(); },
  9124. [&](bool socket_readable, bool close_connection,
  9125. bool &connection_closed) {
  9126. if (socket_readable) { strm.set_readable_hint(); }
  9127. return callback(strm, close_connection, connection_closed);
  9128. });
  9129. }
  9130. template <typename T>
  9131. inline bool process_client_socket_ssl(
  9132. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  9133. time_t read_timeout_usec, time_t write_timeout_sec,
  9134. time_t write_timeout_usec, time_t max_timeout_msec,
  9135. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  9136. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  9137. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  9138. start_time);
  9139. return callback(strm);
  9140. }
  9141. inline std::pair<std::string, std::string> make_digest_authentication_header(
  9142. const Request &req, const std::map<std::string, std::string> &auth,
  9143. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  9144. const std::string &password, bool is_proxy = false) {
  9145. std::string nc;
  9146. {
  9147. std::stringstream ss;
  9148. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  9149. nc = ss.str();
  9150. }
  9151. std::string qop;
  9152. if (auth.find("qop") != auth.end()) {
  9153. qop = auth.at("qop");
  9154. if (qop.find("auth-int") != std::string::npos) {
  9155. qop = "auth-int";
  9156. } else if (qop.find("auth") != std::string::npos) {
  9157. qop = "auth";
  9158. } else {
  9159. qop.clear();
  9160. }
  9161. }
  9162. std::string algo = "MD5";
  9163. if (auth.find("algorithm") != auth.end()) {
  9164. // algorithm is an unquoted token (RFC 7616 §3.4). A server value that is
  9165. // not a token would otherwise be emitted verbatim and could carry commas
  9166. // or quotes that inject further auth-params into the header below.
  9167. const auto &a = auth.at("algorithm");
  9168. if (fields::is_token(a)) { algo = a; }
  9169. }
  9170. std::string response;
  9171. {
  9172. auto H = algo == "SHA-256" ? detail::SHA_256
  9173. : algo == "SHA-512" ? detail::SHA_512
  9174. : detail::MD5;
  9175. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  9176. auto A2 = req.method + ":" + req.path;
  9177. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  9178. if (qop.empty()) {
  9179. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  9180. } else {
  9181. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  9182. ":" + qop + ":" + H(A2));
  9183. }
  9184. }
  9185. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  9186. // Every value placed inside a quoted-string is escaped so a '"' in it cannot
  9187. // close the string early. realm, nonce and opaque come straight from the
  9188. // server's challenge (parse_www_authenticate() already de-escaped them), so
  9189. // without this a crafted challenge injects extra auth-params into the header.
  9190. auto field =
  9191. "Digest username=\"" + detail::escape_quoted_pairs(username) +
  9192. "\", realm=\"" + detail::escape_quoted_pairs(auth.at("realm")) +
  9193. "\", nonce=\"" + detail::escape_quoted_pairs(auth.at("nonce")) +
  9194. "\", uri=\"" + detail::escape_quoted_pairs(req.path) +
  9195. "\", algorithm=" + algo +
  9196. (qop.empty() ? ", response=\""
  9197. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" + cnonce +
  9198. "\", response=\"") +
  9199. response + "\"" +
  9200. (opaque.empty()
  9201. ? ""
  9202. : ", opaque=\"" + detail::escape_quoted_pairs(opaque) + "\"");
  9203. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9204. return std::make_pair(key, field);
  9205. }
  9206. // Follows X509_check_host, which the OpenSSL backend uses, so that every
  9207. // backend accepts the same names.
  9208. inline bool match_hostname(const std::string &pattern,
  9209. const std::string &hostname) {
  9210. // A trailing dot on the host is ignored
  9211. auto host = hostname;
  9212. if (host.size() > 1 && host.back() == '.') { host.pop_back(); }
  9213. // Exact match (case-insensitive)
  9214. if (detail::case_ignore::equal(host, pattern)) { return true; }
  9215. // Split both pattern and hostname into components by '.', keeping any empty
  9216. // one, which no name may have
  9217. auto labels = [](const std::string &s) {
  9218. std::vector<std::string> v;
  9219. size_t b = 0;
  9220. while (true) {
  9221. auto e = s.find('.', b);
  9222. v.push_back(s.substr(b, e - b));
  9223. if (e == std::string::npos) { return v; }
  9224. b = e + 1;
  9225. }
  9226. };
  9227. auto pattern_components = labels(pattern);
  9228. auto host_components = labels(host);
  9229. auto has_empty_label = [](const std::vector<std::string> &v) {
  9230. return std::any_of(v.begin(), v.end(),
  9231. [](const std::string &l) { return l.empty(); });
  9232. };
  9233. if (has_empty_label(pattern_components) || has_empty_label(host_components)) {
  9234. return false;
  9235. }
  9236. // Component count must match
  9237. if (host_components.size() != pattern_components.size()) { return false; }
  9238. // A wildcard needs two labels after it, so that "*.com" matches nothing,
  9239. // and an IDNA label may not have one
  9240. const auto &leftmost = pattern_components.front();
  9241. if (leftmost.find('*') != std::string::npos &&
  9242. (pattern_components.size() < 3 ||
  9243. case_ignore::equal(leftmost.substr(0, 4), "xn--"))) {
  9244. return false;
  9245. }
  9246. // Compare each component with wildcard support
  9247. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  9248. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  9249. // Only the leftmost label may carry a wildcard (RFC 6125 6.4.3)
  9250. auto itr = pattern_components.begin();
  9251. for (const auto &h : host_components) {
  9252. auto &p = *itr;
  9253. auto is_leftmost = itr == pattern_components.begin();
  9254. if (!detail::case_ignore::equal(p, h) && !(is_leftmost && p == "*")) {
  9255. bool partial_match = false;
  9256. if (is_leftmost && !p.empty() && p[p.size() - 1] == '*') {
  9257. const auto prefix_length = p.size() - 1;
  9258. if (prefix_length == 0) {
  9259. partial_match = true;
  9260. } else if (h.size() >= prefix_length) {
  9261. partial_match =
  9262. std::equal(p.begin(),
  9263. p.begin() + static_cast<std::string::difference_type>(
  9264. prefix_length),
  9265. h.begin(), [](const char ca, const char cb) {
  9266. return detail::case_ignore::to_lower(ca) ==
  9267. detail::case_ignore::to_lower(cb);
  9268. });
  9269. }
  9270. }
  9271. if (!partial_match) { return false; }
  9272. }
  9273. ++itr;
  9274. }
  9275. return true;
  9276. }
  9277. #ifdef _WIN32
  9278. // Verify certificate using Windows CertGetCertificateChain API.
  9279. // This provides real-time certificate validation with Windows Update
  9280. // integration, independent of the TLS backend.
  9281. inline bool verify_cert_with_windows_schannel(
  9282. const std::vector<unsigned char> &der_cert, const std::string &hostname,
  9283. bool verify_hostname, uint64_t &out_error, tls::const_session_t session) {
  9284. if (der_cert.empty()) { return false; }
  9285. out_error = 0;
  9286. // Create Windows certificate context from DER data
  9287. auto cert_context = CertCreateCertificateContext(
  9288. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  9289. static_cast<DWORD>(der_cert.size()));
  9290. if (!cert_context) {
  9291. out_error = GetLastError();
  9292. return false;
  9293. }
  9294. auto cert_guard =
  9295. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  9296. // Give CryptoAPI the certificates the server sent. Without them it follows
  9297. // the leaf's AIA URL, which may lead to an issuer under an untrusted root.
  9298. std::vector<tls::cert_t> peer_certs;
  9299. tls::get_peer_certs(session, peer_certs);
  9300. auto store = CertOpenStore(CERT_STORE_PROV_MEMORY, 0, 0, 0, nullptr);
  9301. auto store_guard = scope_exit([&] {
  9302. for (auto cert : peer_certs) {
  9303. tls::free_cert(cert);
  9304. }
  9305. if (store) { CertCloseStore(store, 0); }
  9306. });
  9307. for (auto cert : peer_certs) {
  9308. std::vector<unsigned char> der;
  9309. if (store && tls::get_cert_der(cert, der)) {
  9310. CertAddEncodedCertificateToStore(store, X509_ASN_ENCODING, der.data(),
  9311. static_cast<DWORD>(der.size()),
  9312. CERT_STORE_ADD_USE_EXISTING, nullptr);
  9313. }
  9314. }
  9315. // Setup chain parameters
  9316. CERT_CHAIN_PARA chain_para = {};
  9317. chain_para.cbSize = sizeof(chain_para);
  9318. // Require the server authentication usage along the chain, which also
  9319. // rejects roots that Windows trusts only for other purposes.
  9320. LPSTR server_auth = const_cast<LPSTR>(szOID_PKIX_KP_SERVER_AUTH);
  9321. chain_para.RequestedUsage.dwType = USAGE_MATCH_TYPE_AND;
  9322. chain_para.RequestedUsage.Usage.cUsageIdentifier = 1;
  9323. chain_para.RequestedUsage.Usage.rgpszUsageIdentifier = &server_auth;
  9324. // Build certificate chain with revocation checking
  9325. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  9326. auto chain_result = CertGetCertificateChain(
  9327. nullptr, cert_context, nullptr, store, &chain_para,
  9328. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  9329. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  9330. nullptr, &chain_context);
  9331. if (!chain_result || !chain_context) {
  9332. out_error = GetLastError();
  9333. return false;
  9334. }
  9335. auto chain_guard =
  9336. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9337. // Verify SSL policy
  9338. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9339. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9340. #ifdef AUTHTYPE_SERVER
  9341. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9342. #endif
  9343. std::wstring whost;
  9344. if (verify_hostname) {
  9345. whost = u8string_to_wstring(hostname.c_str());
  9346. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9347. }
  9348. CERT_CHAIN_POLICY_PARA policy_para = {};
  9349. policy_para.cbSize = sizeof(policy_para);
  9350. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9351. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9352. #else
  9353. policy_para.dwFlags = 0;
  9354. #endif
  9355. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9356. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9357. policy_status.cbSize = sizeof(policy_status);
  9358. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9359. &policy_para, &policy_status)) {
  9360. out_error = GetLastError();
  9361. return false;
  9362. }
  9363. if (policy_status.dwError != 0) {
  9364. out_error = policy_status.dwError;
  9365. return false;
  9366. }
  9367. return true;
  9368. }
  9369. #endif // _WIN32
  9370. // Loads CA file/dir configuration and applies the system CA policy to a
  9371. // client TLS context. PEM data and native stores are applied to the context
  9372. // directly at set time; has_custom_store reflects them for the Auto policy
  9373. // decision.
  9374. inline bool load_client_ca_config(tls::ctx_t ctx,
  9375. const std::string &ca_cert_file_path,
  9376. const std::string &ca_cert_dir_path,
  9377. bool has_custom_store, SystemCAMode mode,
  9378. uint64_t &backend_error) {
  9379. auto ret = true;
  9380. if (!ca_cert_file_path.empty()) {
  9381. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9382. backend_error = tls::get_error();
  9383. ret = false;
  9384. }
  9385. } else if (!ca_cert_dir_path.empty()) {
  9386. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9387. backend_error = tls::get_error();
  9388. ret = false;
  9389. }
  9390. }
  9391. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9392. !ca_cert_dir_path.empty() || has_custom_store;
  9393. if (mode == SystemCAMode::Enabled ||
  9394. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9395. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9396. }
  9397. return ret;
  9398. }
  9399. inline std::string ca_certs_to_pem(tls::ctx_t ctx) {
  9400. std::vector<tls::cert_t> certs;
  9401. tls::get_ca_certs(ctx, certs);
  9402. std::string pem;
  9403. for (auto cert : certs) {
  9404. std::vector<unsigned char> der;
  9405. if (tls::get_cert_der(cert, der)) {
  9406. auto b64 = base64_encode(std::string(der.begin(), der.end()));
  9407. pem += "-----BEGIN CERTIFICATE-----\n";
  9408. for (size_t i = 0; i < b64.size(); i += 64) {
  9409. pem += b64.substr(i, 64) + "\n";
  9410. }
  9411. pem += "-----END CERTIFICATE-----\n";
  9412. }
  9413. tls::free_cert(cert);
  9414. }
  9415. return pem;
  9416. }
  9417. // The parts of session setup that only SSLClient needs, plus the handful
  9418. // WebSocketClient also exposes; everything else takes the defaults, which is
  9419. // what keeps the two clients on one implementation.
  9420. struct ClientTlsSessionOptions {
  9421. // Both SSLClient and WebSocketClient expose this independently of
  9422. // certificate verification.
  9423. bool server_hostname_verification = true;
  9424. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9425. // When non-null, guards session creation against concurrent use of the
  9426. // context. A WebSocketClient is not safe to use from several threads to
  9427. // begin with, so it passes nothing.
  9428. std::mutex *ctx_mutex = nullptr;
  9429. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9430. // The caller decides whether Schannel has anything to say about this
  9431. // connection; see SSLClient::initialize_ssl().
  9432. bool windows_cert_verification = false;
  9433. // A server certificate verifier works on the backend's chain verification,
  9434. // so the backend keeps deciding and Schannel only adds its own check.
  9435. bool server_certificate_verifier_set = false;
  9436. #endif
  9437. };
  9438. // Filled in on failure for callers that report error details.
  9439. struct ClientTlsSessionError {
  9440. Error error = Error::Success;
  9441. int ssl_error = 0;
  9442. uint64_t backend_error = 0;
  9443. };
  9444. // Establishes a client TLS session on an already connected socket. On failure
  9445. // the session is left for the caller to free: SSLClient frees it right away,
  9446. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9447. inline bool setup_client_tls_session(
  9448. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9449. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9450. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9451. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9452. using namespace tls;
  9453. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9454. if (out_error) {
  9455. out_error->error = error;
  9456. out_error->ssl_error = ssl_error;
  9457. out_error->backend_error = backend_error;
  9458. }
  9459. return false;
  9460. };
  9461. if (!ctx) {
  9462. session = nullptr;
  9463. return fail(Error::SSLConnection, 0, 0);
  9464. }
  9465. // With Windows verification on and no server certificate verifier set,
  9466. // Schannel is the only chain verifier. The backend's trust store is a
  9467. // snapshot of the Windows stores that lacks the roots Windows fetches on
  9468. // demand, so the backend's verdict is not used.
  9469. auto windows_verifies_chain = false;
  9470. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9471. windows_verifies_chain = options.windows_cert_verification &&
  9472. !options.server_certificate_verifier_set;
  9473. #endif
  9474. {
  9475. std::unique_lock<std::mutex> guard;
  9476. if (options.ctx_mutex) {
  9477. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9478. }
  9479. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9480. // Mbed TLS and wolfSSL need the verification mode set explicitly, on the
  9481. // context, so under the same lock; OpenSSL uses SSL_VERIFY_NONE and does
  9482. // all verification post-handshake. Unless Schannel verifies the chain
  9483. // instead, chain verification happens during the handshake even for IP
  9484. // hosts; the certificate identity is verified post-handshake via
  9485. // verify_hostname().
  9486. set_verify_client(ctx, server_certificate_verification &&
  9487. !windows_verifies_chain);
  9488. #endif
  9489. session = create_session(ctx, sock);
  9490. }
  9491. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9492. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9493. // their identity is checked post-handshake below instead. On Mbed TLS and
  9494. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9495. // options.server_hostname_verification is threaded through here.
  9496. if (!is_ip_address(host)) {
  9497. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9498. return fail(Error::SSLConnection, 0, get_error());
  9499. }
  9500. }
  9501. TlsError tls_err;
  9502. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9503. &tls_err)) {
  9504. auto error = Error::SSLConnection;
  9505. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9506. error = Error::SSLServerVerification;
  9507. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9508. error = Error::SSLServerHostnameVerification;
  9509. }
  9510. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9511. }
  9512. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9513. if (options.session_verifier) {
  9514. verification_status = options.session_verifier(session);
  9515. }
  9516. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9517. return fail(Error::SSLServerVerification, 0, get_error());
  9518. }
  9519. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9520. server_certificate_verification) {
  9521. if (!windows_verifies_chain) {
  9522. auto verify_result = get_verify_result(session);
  9523. if (verify_result != 0) {
  9524. return fail(Error::SSLServerVerification, 0,
  9525. static_cast<uint64_t>(verify_result));
  9526. }
  9527. }
  9528. auto server_cert = get_peer_cert(session);
  9529. if (!server_cert) {
  9530. return fail(Error::SSLServerVerification, 0, get_error());
  9531. }
  9532. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9533. // Identity check against the peer certificate, post-handshake for all
  9534. // backends. For IP hosts this is the only identity verification, since no
  9535. // hostname is bound during the handshake.
  9536. if (options.server_hostname_verification) {
  9537. if (!verify_hostname(server_cert, host.c_str())) {
  9538. return fail(Error::SSLServerHostnameVerification, 0,
  9539. hostname_mismatch_code());
  9540. }
  9541. }
  9542. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9543. // Windows Schannel verification, which lets Windows fetch missing roots
  9544. // and intermediates on demand. It must not be skipped: unless a server
  9545. // certificate verifier is set, it is the only chain check.
  9546. if (options.windows_cert_verification) {
  9547. std::vector<unsigned char> der;
  9548. uint64_t wincrypt_error = 0;
  9549. if (!get_cert_der(server_cert, der) ||
  9550. !verify_cert_with_windows_schannel(
  9551. der, host, options.server_hostname_verification, wincrypt_error,
  9552. session)) {
  9553. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9554. }
  9555. }
  9556. #endif
  9557. }
  9558. return true;
  9559. }
  9560. } // namespace detail
  9561. #endif // CPPHTTPLIB_SSL_ENABLED
  9562. /*
  9563. * Group 3: httplib namespace - Non-SSL public API implementations
  9564. */
  9565. inline void default_socket_options(socket_t sock) {
  9566. set_socket_opt(sock, SOL_SOCKET,
  9567. #ifdef SO_REUSEPORT
  9568. SO_REUSEPORT,
  9569. #else
  9570. SO_REUSEADDR,
  9571. #endif
  9572. 1);
  9573. }
  9574. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9575. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9576. sizeof(optval));
  9577. }
  9578. inline std::string get_bearer_token_auth(const Request &req) {
  9579. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9580. // than the prefix carries no token.
  9581. constexpr const char bearer_prefix[] = "Bearer ";
  9582. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9583. auto value = req.get_header_value("Authorization");
  9584. if (value.size() >= bearer_prefix_len &&
  9585. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9586. bearer_prefix)) {
  9587. return value.substr(bearer_prefix_len);
  9588. }
  9589. return "";
  9590. }
  9591. inline const char *status_message(int status) {
  9592. switch (status) {
  9593. case StatusCode::Continue_100: return "Continue";
  9594. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9595. case StatusCode::Processing_102: return "Processing";
  9596. case StatusCode::EarlyHints_103: return "Early Hints";
  9597. case StatusCode::OK_200: return "OK";
  9598. case StatusCode::Created_201: return "Created";
  9599. case StatusCode::Accepted_202: return "Accepted";
  9600. case StatusCode::NonAuthoritativeInformation_203:
  9601. return "Non-Authoritative Information";
  9602. case StatusCode::NoContent_204: return "No Content";
  9603. case StatusCode::ResetContent_205: return "Reset Content";
  9604. case StatusCode::PartialContent_206: return "Partial Content";
  9605. case StatusCode::MultiStatus_207: return "Multi-Status";
  9606. case StatusCode::AlreadyReported_208: return "Already Reported";
  9607. case StatusCode::IMUsed_226: return "IM Used";
  9608. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9609. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9610. case StatusCode::Found_302: return "Found";
  9611. case StatusCode::SeeOther_303: return "See Other";
  9612. case StatusCode::NotModified_304: return "Not Modified";
  9613. case StatusCode::UseProxy_305: return "Use Proxy";
  9614. case StatusCode::unused_306: return "unused";
  9615. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9616. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9617. case StatusCode::BadRequest_400: return "Bad Request";
  9618. case StatusCode::Unauthorized_401: return "Unauthorized";
  9619. case StatusCode::PaymentRequired_402: return "Payment Required";
  9620. case StatusCode::Forbidden_403: return "Forbidden";
  9621. case StatusCode::NotFound_404: return "Not Found";
  9622. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9623. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9624. case StatusCode::ProxyAuthenticationRequired_407:
  9625. return "Proxy Authentication Required";
  9626. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9627. case StatusCode::Conflict_409: return "Conflict";
  9628. case StatusCode::Gone_410: return "Gone";
  9629. case StatusCode::LengthRequired_411: return "Length Required";
  9630. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9631. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9632. case StatusCode::UriTooLong_414: return "URI Too Long";
  9633. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9634. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9635. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9636. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9637. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9638. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9639. case StatusCode::Locked_423: return "Locked";
  9640. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9641. case StatusCode::TooEarly_425: return "Too Early";
  9642. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9643. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9644. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9645. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9646. return "Request Header Fields Too Large";
  9647. case StatusCode::UnavailableForLegalReasons_451:
  9648. return "Unavailable For Legal Reasons";
  9649. case StatusCode::NotImplemented_501: return "Not Implemented";
  9650. case StatusCode::BadGateway_502: return "Bad Gateway";
  9651. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9652. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9653. case StatusCode::HttpVersionNotSupported_505:
  9654. return "HTTP Version Not Supported";
  9655. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9656. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9657. case StatusCode::LoopDetected_508: return "Loop Detected";
  9658. case StatusCode::NotExtended_510: return "Not Extended";
  9659. case StatusCode::NetworkAuthenticationRequired_511:
  9660. return "Network Authentication Required";
  9661. default:
  9662. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9663. }
  9664. }
  9665. inline std::string to_string(const Error error) {
  9666. switch (error) {
  9667. case Error::Success: return "Success (no error)";
  9668. case Error::Unknown: return "Unknown";
  9669. case Error::Connection: return "Could not establish connection";
  9670. case Error::BindIPAddress: return "Failed to bind IP address";
  9671. case Error::Read: return "Failed to read connection";
  9672. case Error::Write: return "Failed to write connection";
  9673. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9674. case Error::Canceled: return "Connection handling canceled";
  9675. case Error::SSLConnection: return "SSL connection failed";
  9676. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9677. case Error::SSLServerVerification: return "SSL server verification failed";
  9678. case Error::SSLServerHostnameVerification:
  9679. return "SSL server hostname verification failed";
  9680. case Error::UnsupportedMultipartBoundaryChars:
  9681. return "Unsupported HTTP multipart boundary characters";
  9682. case Error::Compression: return "Compression failed";
  9683. case Error::ConnectionTimeout: return "Connection timed out";
  9684. case Error::ProxyConnection: return "Proxy connection failed";
  9685. case Error::ConnectionClosed: return "Connection closed by server";
  9686. case Error::Timeout: return "Read timeout";
  9687. case Error::ResourceExhaustion: return "Resource exhaustion";
  9688. case Error::TooManyFormDataFiles: return "Too many form data files";
  9689. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9690. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9691. case Error::ExceedMaxSocketDescriptorCount:
  9692. return "Exceeded maximum socket descriptor count";
  9693. case Error::InvalidRequestLine: return "Invalid request line";
  9694. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9695. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9696. case Error::InvalidHeaders: return "Invalid headers";
  9697. case Error::MultipartParsing: return "Multipart parsing failed";
  9698. case Error::OpenFile: return "Failed to open file";
  9699. case Error::Listen: return "Failed to listen on socket";
  9700. case Error::GetSockName: return "Failed to get socket name";
  9701. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9702. case Error::HTTPParsing: return "HTTP parsing failed";
  9703. case Error::InvalidRangeHeader: return "Invalid Range header";
  9704. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9705. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9706. case Error::UserCallbackException: return "User callback threw an exception";
  9707. default: break;
  9708. }
  9709. return "Invalid";
  9710. }
  9711. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9712. os << to_string(obj);
  9713. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9714. return os;
  9715. }
  9716. inline std::string hosted_at(const std::string &hostname) {
  9717. std::vector<std::string> addrs;
  9718. hosted_at(hostname, addrs);
  9719. if (addrs.empty()) { return std::string(); }
  9720. return addrs[0];
  9721. }
  9722. inline void hosted_at(const std::string &hostname,
  9723. std::vector<std::string> &addrs) {
  9724. struct addrinfo hints;
  9725. struct addrinfo *result;
  9726. memset(&hints, 0, sizeof(struct addrinfo));
  9727. hints.ai_family = AF_UNSPEC;
  9728. hints.ai_socktype = SOCK_STREAM;
  9729. hints.ai_protocol = 0;
  9730. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9731. &result, 0)) {
  9732. #if defined __linux__ && !defined __ANDROID__
  9733. res_init();
  9734. #endif
  9735. return;
  9736. }
  9737. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9738. for (auto rp = result; rp; rp = rp->ai_next) {
  9739. const auto &addr =
  9740. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9741. std::string ip;
  9742. auto dummy = -1;
  9743. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9744. dummy)) {
  9745. addrs.emplace_back(std::move(ip));
  9746. }
  9747. }
  9748. }
  9749. inline std::string encode_uri_component(const std::string &value) {
  9750. std::ostringstream escaped;
  9751. escaped.fill('0');
  9752. escaped << std::hex;
  9753. for (auto c : value) {
  9754. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9755. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9756. escaped << c;
  9757. } else {
  9758. escaped << std::uppercase;
  9759. escaped << '%' << std::setw(2)
  9760. << static_cast<int>(static_cast<unsigned char>(c));
  9761. escaped << std::nouppercase;
  9762. }
  9763. }
  9764. return escaped.str();
  9765. }
  9766. inline std::string encode_uri(const std::string &value) {
  9767. std::ostringstream escaped;
  9768. escaped.fill('0');
  9769. escaped << std::hex;
  9770. for (auto c : value) {
  9771. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9772. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9773. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9774. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9775. escaped << c;
  9776. } else {
  9777. escaped << std::uppercase;
  9778. escaped << '%' << std::setw(2)
  9779. << static_cast<int>(static_cast<unsigned char>(c));
  9780. escaped << std::nouppercase;
  9781. }
  9782. }
  9783. return escaped.str();
  9784. }
  9785. inline std::string decode_uri_component(const std::string &value) {
  9786. std::string result;
  9787. for (size_t i = 0; i < value.size(); i++) {
  9788. if (value[i] == '%' && i + 2 < value.size()) {
  9789. auto val = 0;
  9790. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9791. result += static_cast<char>(val);
  9792. i += 2;
  9793. } else {
  9794. result += value[i];
  9795. }
  9796. } else {
  9797. result += value[i];
  9798. }
  9799. }
  9800. return result;
  9801. }
  9802. inline std::string decode_uri(const std::string &value) {
  9803. std::string result;
  9804. for (size_t i = 0; i < value.size(); i++) {
  9805. if (value[i] == '%' && i + 2 < value.size()) {
  9806. auto val = 0;
  9807. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9808. auto c = static_cast<char>(val);
  9809. // Keep escapes of the reserved characters that encode_uri leaves
  9810. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9811. // delimiter is not promoted into a real one (as with JS decodeURI).
  9812. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9813. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9814. c == '#') {
  9815. result += value[i];
  9816. result += value[i + 1];
  9817. result += value[i + 2];
  9818. } else {
  9819. result += c;
  9820. }
  9821. i += 2;
  9822. } else {
  9823. result += value[i];
  9824. }
  9825. } else {
  9826. result += value[i];
  9827. }
  9828. }
  9829. return result;
  9830. }
  9831. inline std::string encode_path_component(const std::string &component) {
  9832. std::string result;
  9833. result.reserve(component.size() * 3);
  9834. for (size_t i = 0; i < component.size(); i++) {
  9835. auto c = static_cast<unsigned char>(component[i]);
  9836. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9837. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9838. c == '_' || c == '~') {
  9839. result += static_cast<char>(c);
  9840. }
  9841. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9842. // "," / ";" / "="
  9843. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9844. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9845. c == '=') {
  9846. result += static_cast<char>(c);
  9847. }
  9848. // Colon is allowed in path segments except first segment
  9849. else if (c == ':') {
  9850. result += static_cast<char>(c);
  9851. }
  9852. // @ is allowed in path
  9853. else if (c == '@') {
  9854. result += static_cast<char>(c);
  9855. } else {
  9856. result += '%';
  9857. char hex[3];
  9858. snprintf(hex, sizeof(hex), "%02X", c);
  9859. result.append(hex, 2);
  9860. }
  9861. }
  9862. return result;
  9863. }
  9864. inline std::string decode_path_component(const std::string &component) {
  9865. std::string result;
  9866. result.reserve(component.size());
  9867. for (size_t i = 0; i < component.size(); i++) {
  9868. if (component[i] == '%' && i + 1 < component.size()) {
  9869. if (component[i + 1] == 'u') {
  9870. // Unicode %uXXXX encoding
  9871. auto val = 0;
  9872. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9873. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9874. char buff[4];
  9875. size_t len = 0;
  9876. if (detail::from_hex_to_i(component, i + 2, 4, val) &&
  9877. (len = detail::to_utf8(val, buff)) > 0) {
  9878. result.append(buff, len);
  9879. i += 5; // 'u0000'
  9880. } else {
  9881. // Not 4 hex digits, or a surrogate, which is no character: the
  9882. // escape is kept as it is rather than joining its neighbours
  9883. result += component[i];
  9884. }
  9885. } else {
  9886. // Standard %XX encoding
  9887. auto val = 0;
  9888. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9889. // 2 digits hex codes
  9890. result += static_cast<char>(val);
  9891. i += 2; // 'XX'
  9892. } else {
  9893. result += component[i];
  9894. }
  9895. }
  9896. } else {
  9897. result += component[i];
  9898. }
  9899. }
  9900. return result;
  9901. }
  9902. inline std::string encode_query_component(const std::string &component,
  9903. bool space_as_plus) {
  9904. std::string result;
  9905. result.reserve(component.size() * 3);
  9906. for (size_t i = 0; i < component.size(); i++) {
  9907. auto c = static_cast<unsigned char>(component[i]);
  9908. // Unreserved characters per RFC 3986
  9909. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9910. c == '_' || c == '~') {
  9911. result += static_cast<char>(c);
  9912. }
  9913. // Space handling
  9914. else if (c == ' ') {
  9915. if (space_as_plus) {
  9916. result += '+';
  9917. } else {
  9918. result += "%20";
  9919. }
  9920. }
  9921. // Plus sign handling
  9922. else if (c == '+') {
  9923. if (space_as_plus) {
  9924. result += "%2B";
  9925. } else {
  9926. result += static_cast<char>(c);
  9927. }
  9928. }
  9929. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9930. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9931. c == '*' || c == ',' || c == ';') {
  9932. result += static_cast<char>(c);
  9933. }
  9934. // Colon and @ are allowed in query
  9935. else if (c == ':' || c == '@') {
  9936. result += static_cast<char>(c);
  9937. }
  9938. // Forward slash is allowed in query values
  9939. else if (c == '/') {
  9940. result += static_cast<char>(c);
  9941. }
  9942. // Question mark is allowed in query values (after first ?)
  9943. else if (c == '?') {
  9944. result += static_cast<char>(c);
  9945. } else {
  9946. result += '%';
  9947. char hex[3];
  9948. snprintf(hex, sizeof(hex), "%02X", c);
  9949. result.append(hex, 2);
  9950. }
  9951. }
  9952. return result;
  9953. }
  9954. inline std::string decode_query_component(const std::string &component,
  9955. bool plus_as_space) {
  9956. std::string result;
  9957. result.reserve(component.size());
  9958. for (size_t i = 0; i < component.size(); i++) {
  9959. if (component[i] == '%' && i + 2 < component.size()) {
  9960. auto val = 0;
  9961. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9962. result += static_cast<char>(val);
  9963. i += 2;
  9964. } else {
  9965. result += component[i];
  9966. }
  9967. } else if (component[i] == '+' && plus_as_space) {
  9968. result += ' '; // + becomes space in form-urlencoded
  9969. } else {
  9970. result += component[i];
  9971. }
  9972. }
  9973. return result;
  9974. }
  9975. inline std::string sanitize_filename(const std::string &filename) {
  9976. // Extract basename: find the last path separator (/ or \)
  9977. auto pos = filename.find_last_of("/\\");
  9978. auto result =
  9979. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9980. // Strip null bytes
  9981. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9982. // Trim whitespace
  9983. {
  9984. auto start = result.find_first_not_of(" \t");
  9985. auto end = result.find_last_not_of(" \t");
  9986. result = (start == std::string::npos)
  9987. ? ""
  9988. : result.substr(start, end - start + 1);
  9989. }
  9990. // Reject . and ..
  9991. if (result == "." || result == "..") { return ""; }
  9992. return result;
  9993. }
  9994. inline std::string append_query_params(const std::string &path,
  9995. const Params &params) {
  9996. // The query ends at the fragment (RFC 3986 3.5), so the params go before it.
  9997. auto fragment_pos = path.find('#');
  9998. auto path_with_query = path.substr(0, fragment_pos);
  9999. path_with_query += path_with_query.find('?') == std::string::npos ? '?' : '&';
  10000. path_with_query += detail::params_to_query_str(params);
  10001. if (fragment_pos != std::string::npos) {
  10002. path_with_query.append(path, fragment_pos, std::string::npos);
  10003. }
  10004. return path_with_query;
  10005. }
  10006. // Header utilities
  10007. inline std::pair<std::string, std::string>
  10008. make_range_header(const Ranges &ranges) {
  10009. std::string field = "bytes=";
  10010. auto i = 0;
  10011. for (const auto &r : ranges) {
  10012. if (i != 0) { field += ", "; }
  10013. if (r.first != -1) { field += std::to_string(r.first); }
  10014. field += '-';
  10015. if (r.second != -1) { field += std::to_string(r.second); }
  10016. i++;
  10017. }
  10018. return std::make_pair("Range", std::move(field));
  10019. }
  10020. inline std::pair<std::string, std::string>
  10021. make_basic_authentication_header(const std::string &username,
  10022. const std::string &password, bool is_proxy) {
  10023. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  10024. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10025. return std::make_pair(key, std::move(field));
  10026. }
  10027. inline std::pair<std::string, std::string>
  10028. make_bearer_token_authentication_header(const std::string &token,
  10029. bool is_proxy = false) {
  10030. auto field = "Bearer " + token;
  10031. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  10032. return std::make_pair(key, std::move(field));
  10033. }
  10034. // Request implementation
  10035. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  10036. size_t id) const {
  10037. return detail::get_header_value_u64(headers, key, def, id);
  10038. }
  10039. inline bool Request::has_header(const std::string &key) const {
  10040. return detail::has_header(headers, key);
  10041. }
  10042. inline std::string Request::get_header_value(const std::string &key,
  10043. const char *def, size_t id) const {
  10044. return detail::get_header_value(headers, key, def, id);
  10045. }
  10046. inline size_t Request::get_header_value_count(const std::string &key) const {
  10047. return detail::get_header_value_count(headers, key);
  10048. }
  10049. inline void Request::set_header(const std::string &key,
  10050. const std::string &val) {
  10051. detail::set_header(headers, key, val);
  10052. }
  10053. inline bool Request::has_trailer(const std::string &key) const {
  10054. return trailers.find(key) != trailers.end();
  10055. }
  10056. inline std::string Request::get_trailer_value(const std::string &key,
  10057. size_t id) const {
  10058. return detail::get_multimap_value(trailers, key, id);
  10059. }
  10060. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  10061. return trailers.count(key);
  10062. }
  10063. inline bool Request::has_param(const std::string &key) const {
  10064. return params.find(key) != params.end();
  10065. }
  10066. inline std::string Request::get_param_value(const std::string &key,
  10067. size_t id) const {
  10068. return detail::get_multimap_value(params, key, id);
  10069. }
  10070. inline std::vector<std::string>
  10071. Request::get_param_values(const std::string &key) const {
  10072. auto rng = params.equal_range(key);
  10073. std::vector<std::string> values;
  10074. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  10075. for (auto it = rng.first; it != rng.second; ++it) {
  10076. values.push_back(it->second);
  10077. }
  10078. return values;
  10079. }
  10080. inline size_t Request::get_param_value_count(const std::string &key) const {
  10081. return params.count(key);
  10082. }
  10083. inline bool Request::is_multipart_form_data() const {
  10084. const auto &content_type = get_header_value("Content-Type");
  10085. return detail::case_ignore::equal(detail::extract_media_type(content_type),
  10086. "multipart/form-data");
  10087. }
  10088. // Multipart FormData implementation
  10089. inline std::string MultipartFormData::get_field(const std::string &key,
  10090. size_t id) const {
  10091. auto rng = fields.equal_range(key);
  10092. auto it = detail::bounded_next(rng.first, id, rng.second);
  10093. if (it != rng.second) { return it->second.content; }
  10094. return std::string();
  10095. }
  10096. inline std::vector<std::string>
  10097. MultipartFormData::get_fields(const std::string &key) const {
  10098. std::vector<std::string> values;
  10099. auto rng = fields.equal_range(key);
  10100. for (auto it = rng.first; it != rng.second; it++) {
  10101. values.push_back(it->second.content);
  10102. }
  10103. return values;
  10104. }
  10105. inline bool MultipartFormData::has_field(const std::string &key) const {
  10106. return fields.find(key) != fields.end();
  10107. }
  10108. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  10109. return fields.count(key);
  10110. }
  10111. inline FormData MultipartFormData::get_file(const std::string &key,
  10112. size_t id) const {
  10113. return detail::get_multimap_value(files, key, id);
  10114. }
  10115. inline std::vector<FormData>
  10116. MultipartFormData::get_files(const std::string &key) const {
  10117. std::vector<FormData> values;
  10118. auto rng = files.equal_range(key);
  10119. for (auto it = rng.first; it != rng.second; it++) {
  10120. values.push_back(it->second);
  10121. }
  10122. return values;
  10123. }
  10124. inline bool MultipartFormData::has_file(const std::string &key) const {
  10125. return files.find(key) != files.end();
  10126. }
  10127. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  10128. return files.count(key);
  10129. }
  10130. // Multipart FormData writer implementation
  10131. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  10132. return detail::is_multipart_boundary_chars_valid(boundary);
  10133. }
  10134. inline MultipartFormDataWriter::MultipartFormDataWriter()
  10135. : boundary_(detail::make_multipart_data_boundary()) {}
  10136. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  10137. : boundary_(std::move(boundary)) {}
  10138. inline const std::string &MultipartFormDataWriter::boundary() const {
  10139. return boundary_;
  10140. }
  10141. inline std::string MultipartFormDataWriter::content_type() const {
  10142. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  10143. }
  10144. inline std::string
  10145. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  10146. return detail::serialize_multipart_formdata(items, boundary_);
  10147. }
  10148. inline size_t MultipartFormDataWriter::content_length(
  10149. const UploadFormDataItems &items) const {
  10150. return detail::get_multipart_content_length(items, boundary_);
  10151. }
  10152. inline std::string
  10153. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  10154. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  10155. }
  10156. inline std::string MultipartFormDataWriter::item_end() {
  10157. return detail::serialize_multipart_formdata_item_end();
  10158. }
  10159. inline std::string MultipartFormDataWriter::finish() const {
  10160. return detail::serialize_multipart_formdata_finish(boundary_);
  10161. }
  10162. // Response implementation
  10163. namespace detail {
  10164. // A response has one content source: `body`, a content provider, or a file.
  10165. // Each content setter calls this so that the one called last wins.
  10166. inline void clear_content_provider(Response &res) {
  10167. auto releaser = std::move(res.content_provider_resource_releaser_);
  10168. auto success = res.content_provider_success_;
  10169. res.content_length_ = 0;
  10170. res.content_provider_ = nullptr;
  10171. res.content_provider_resource_releaser_ = nullptr;
  10172. res.is_chunked_content_provider_ = false;
  10173. res.is_file_content_provider_ = false;
  10174. res.content_provider_success_ = false;
  10175. res.content_coding_ = EncodingType::None;
  10176. res.file_content_path_.clear();
  10177. res.file_content_content_type_.clear();
  10178. if (releaser) { releaser(success); }
  10179. }
  10180. inline void clear_content(Response &res) {
  10181. res.body.clear();
  10182. clear_content_provider(res);
  10183. }
  10184. // `body` is public, so it can be assigned directly after a provider or a file
  10185. // was set. It came last, so it wins.
  10186. inline void prefer_assigned_body(Response &res) {
  10187. if (!res.body.empty() &&
  10188. (res.content_provider_ || !res.file_content_path_.empty())) {
  10189. clear_content_provider(res);
  10190. }
  10191. }
  10192. // RFC 9112 6.3: a 1xx, 204 or 304 response ends with its header section.
  10193. inline bool body_allowed_for_status(int status) {
  10194. return status >= 200 && status != StatusCode::NoContent_204 &&
  10195. status != StatusCode::NotModified_304;
  10196. }
  10197. // Only a 206 response is served as a partial representation. range_error()
  10198. // validates `req.ranges` only for a 2xx status, so slicing under any other
  10199. // status would start from an unchecked offset.
  10200. inline bool is_partial_content(const Request &req, const Response &res) {
  10201. return !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  10202. }
  10203. // Sets the Content-Length or Transfer-Encoding framing the body that
  10204. // Server::write_response_core() writes. Only the library sets them: one from a
  10205. // handler would go out next to it, or describe some other body.
  10206. inline void set_framing_headers(const Request &req, Response &res,
  10207. const std::string &boundary,
  10208. const std::string &content_type) {
  10209. // A HEAD response may give the length a GET would have had (RFC 9110 9.3.2).
  10210. auto head_length = req.method == "HEAD"
  10211. ? res.get_header_value("Content-Length")
  10212. : std::string();
  10213. res.headers.erase("Content-Length");
  10214. res.headers.erase("Transfer-Encoding");
  10215. if (!body_allowed_for_status(res.status)) { return; }
  10216. if (res.content_provider_) {
  10217. if (res.content_length_ == 0) {
  10218. if (res.is_chunked_content_provider_) {
  10219. res.set_header("Transfer-Encoding", "chunked");
  10220. }
  10221. return;
  10222. }
  10223. // The part Server::write_content_with_provider() writes.
  10224. auto length = res.content_length_;
  10225. if (is_partial_content(req, res)) {
  10226. length = req.ranges.size() == 1
  10227. ? get_range_offset_and_length(req.ranges[0], length).second
  10228. : get_multipart_ranges_data_length(req, boundary,
  10229. content_type, length);
  10230. }
  10231. res.set_header("Content-Length", std::to_string(length));
  10232. } else if (!res.body.empty()) {
  10233. res.set_header("Content-Length", std::to_string(res.body.size()));
  10234. } else {
  10235. res.set_header("Content-Length", head_length.empty() ? "0" : head_length);
  10236. }
  10237. }
  10238. } // namespace detail
  10239. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  10240. size_t id) const {
  10241. return detail::get_header_value_u64(headers, key, def, id);
  10242. }
  10243. inline bool Response::has_header(const std::string &key) const {
  10244. return headers.find(key) != headers.end();
  10245. }
  10246. inline std::string Response::get_header_value(const std::string &key,
  10247. const char *def,
  10248. size_t id) const {
  10249. return detail::get_header_value(headers, key, def, id);
  10250. }
  10251. inline size_t Response::get_header_value_count(const std::string &key) const {
  10252. return detail::get_header_value_count(headers, key);
  10253. }
  10254. inline void Response::set_header(const std::string &key,
  10255. const std::string &val) {
  10256. detail::set_header(headers, key, val);
  10257. }
  10258. inline bool Response::has_trailer(const std::string &key) const {
  10259. return trailers.find(key) != trailers.end();
  10260. }
  10261. inline std::string Response::get_trailer_value(const std::string &key,
  10262. size_t id) const {
  10263. return detail::get_multimap_value(trailers, key, id);
  10264. }
  10265. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  10266. return trailers.count(key);
  10267. }
  10268. inline void Response::set_redirect(const std::string &url, int stat) {
  10269. if (detail::fields::is_field_value(url)) {
  10270. set_header("Location", url);
  10271. if (300 <= stat && stat < 400) {
  10272. this->status = stat;
  10273. } else {
  10274. this->status = StatusCode::Found_302;
  10275. }
  10276. }
  10277. }
  10278. inline void Response::set_content(const char *s, size_t n,
  10279. const std::string &content_type) {
  10280. body.assign(s, n); // Before the releaser runs; it may own `s`.
  10281. detail::clear_content_provider(*this);
  10282. auto rng = headers.equal_range("Content-Type");
  10283. headers.erase(rng.first, rng.second);
  10284. set_header("Content-Type", content_type);
  10285. }
  10286. inline void Response::set_content(const std::string &s,
  10287. const std::string &content_type) {
  10288. set_content(s.data(), s.size(), content_type);
  10289. }
  10290. inline void Response::set_content(std::string &&s,
  10291. const std::string &content_type) {
  10292. body = std::move(s);
  10293. detail::clear_content_provider(*this);
  10294. auto rng = headers.equal_range("Content-Type");
  10295. headers.erase(rng.first, rng.second);
  10296. set_header("Content-Type", content_type);
  10297. }
  10298. inline void Response::set_content_provider(
  10299. size_t in_length, const std::string &content_type, ContentProvider provider,
  10300. ContentProviderResourceReleaser resource_releaser) {
  10301. detail::clear_content(*this);
  10302. set_header("Content-Type", content_type);
  10303. content_length_ = in_length;
  10304. if (in_length > 0) { content_provider_ = std::move(provider); }
  10305. content_provider_resource_releaser_ = std::move(resource_releaser);
  10306. }
  10307. inline void Response::set_content_provider(
  10308. const std::string &content_type, ContentProviderWithoutLength provider,
  10309. ContentProviderResourceReleaser resource_releaser) {
  10310. detail::clear_content(*this);
  10311. set_header("Content-Type", content_type);
  10312. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  10313. content_provider_resource_releaser_ = std::move(resource_releaser);
  10314. }
  10315. inline void Response::set_chunked_content_provider(
  10316. const std::string &content_type, ContentProviderWithoutLength provider,
  10317. ContentProviderResourceReleaser resource_releaser) {
  10318. set_content_provider(content_type, std::move(provider),
  10319. std::move(resource_releaser));
  10320. is_chunked_content_provider_ = true;
  10321. }
  10322. inline void Response::set_file_content(const std::string &path,
  10323. const std::string &content_type) {
  10324. detail::clear_content(*this);
  10325. file_content_path_ = path;
  10326. file_content_content_type_ = content_type;
  10327. }
  10328. inline void Response::set_file_content(const std::string &path) {
  10329. set_file_content(path, std::string());
  10330. }
  10331. // Result implementation
  10332. inline size_t Result::get_request_header_value_u64(const std::string &key,
  10333. size_t def,
  10334. size_t id) const {
  10335. return detail::get_header_value_u64(request_headers_, key, def, id);
  10336. }
  10337. inline bool Result::has_request_header(const std::string &key) const {
  10338. return request_headers_.find(key) != request_headers_.end();
  10339. }
  10340. inline std::string Result::get_request_header_value(const std::string &key,
  10341. const char *def,
  10342. size_t id) const {
  10343. return detail::get_header_value(request_headers_, key, def, id);
  10344. }
  10345. inline size_t
  10346. Result::get_request_header_value_count(const std::string &key) const {
  10347. return request_headers_.count(key);
  10348. }
  10349. // Stream implementation
  10350. inline ssize_t Stream::write(const char *ptr) {
  10351. return write(ptr, strlen(ptr));
  10352. }
  10353. inline ssize_t Stream::write(const std::string &s) {
  10354. return write(s.data(), s.size());
  10355. }
  10356. // BodyReader implementation
  10357. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  10358. if (!stream) {
  10359. last_error = Error::Connection;
  10360. return -1;
  10361. }
  10362. if (eof) { return 0; }
  10363. if (!chunked) {
  10364. // Content-Length based reading
  10365. if (has_content_length && bytes_read >= content_length) {
  10366. eof = true;
  10367. return 0;
  10368. }
  10369. auto to_read = len;
  10370. if (has_content_length) {
  10371. auto remaining = content_length - bytes_read;
  10372. to_read = (std::min)(len, remaining);
  10373. }
  10374. auto n = stream->read(buf, to_read);
  10375. if (n < 0) {
  10376. last_error = stream->get_error();
  10377. if (last_error == Error::Success) { last_error = Error::Read; }
  10378. eof = true;
  10379. return n;
  10380. }
  10381. if (n == 0) {
  10382. // Unexpected EOF before content_length
  10383. last_error = stream->get_error();
  10384. if (last_error == Error::Success) { last_error = Error::Read; }
  10385. eof = true;
  10386. return 0;
  10387. }
  10388. bytes_read += static_cast<size_t>(n);
  10389. if (has_content_length && bytes_read >= content_length) { eof = true; }
  10390. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10391. last_error = Error::ExceedMaxPayloadSize;
  10392. eof = true;
  10393. return -1;
  10394. }
  10395. return n;
  10396. }
  10397. // Chunked transfer encoding: delegate to shared decoder instance.
  10398. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  10399. size_t chunk_offset = 0;
  10400. size_t chunk_total = 0;
  10401. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  10402. if (n < 0) {
  10403. last_error = stream->get_error();
  10404. if (last_error == Error::Success) { last_error = Error::Read; }
  10405. eof = true;
  10406. return n;
  10407. }
  10408. if (n == 0) {
  10409. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  10410. eof = true;
  10411. return 0;
  10412. }
  10413. bytes_read += static_cast<size_t>(n);
  10414. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  10415. last_error = Error::ExceedMaxPayloadSize;
  10416. eof = true;
  10417. return -1;
  10418. }
  10419. return n;
  10420. }
  10421. // ThreadPool implementation
  10422. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  10423. time_t idle_timeout_sec)
  10424. : base_thread_count_(n), max_queued_requests_(mqr),
  10425. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  10426. shutdown_(false) {
  10427. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10428. if (max_n != 0 && max_n < n) {
  10429. std::string msg = "max_threads must be >= base_threads";
  10430. throw std::invalid_argument(msg);
  10431. }
  10432. #endif
  10433. max_thread_count_ = max_n == 0 ? n : max_n;
  10434. threads_.reserve(base_thread_count_);
  10435. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10436. try {
  10437. #endif
  10438. for (size_t i = 0; i < base_thread_count_; i++) {
  10439. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10440. }
  10441. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10442. } catch (...) {
  10443. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10444. // signal the workers we already spawned to exit and join them so the
  10445. // vector destructor does not see joinable threads (which would call
  10446. // std::terminate). Then rethrow so the caller learns of the failure.
  10447. {
  10448. std::unique_lock<std::mutex> lock(mutex_);
  10449. shutdown_ = true;
  10450. }
  10451. cond_.notify_all();
  10452. for (auto &t : threads_) {
  10453. if (t.joinable()) { t.join(); }
  10454. }
  10455. throw;
  10456. }
  10457. #endif
  10458. }
  10459. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10460. {
  10461. std::unique_lock<std::mutex> lock(mutex_);
  10462. if (shutdown_) { return false; }
  10463. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10464. return false;
  10465. }
  10466. jobs_.push_back(std::move(fn));
  10467. // Spawn a dynamic thread if no idle threads and under max
  10468. if (idle_thread_count_ == 0 &&
  10469. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10470. cleanup_finished_threads();
  10471. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10472. }
  10473. }
  10474. cond_.notify_one();
  10475. return true;
  10476. }
  10477. inline void ThreadPool::shutdown() {
  10478. {
  10479. std::unique_lock<std::mutex> lock(mutex_);
  10480. shutdown_ = true;
  10481. }
  10482. cond_.notify_all();
  10483. for (auto &t : threads_) {
  10484. if (t.joinable()) { t.join(); }
  10485. }
  10486. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10487. // with worker threads that call move_to_finished() concurrently.
  10488. std::list<std::thread> remaining_dynamic;
  10489. {
  10490. std::unique_lock<std::mutex> lock(mutex_);
  10491. remaining_dynamic = std::move(dynamic_threads_);
  10492. }
  10493. for (auto &t : remaining_dynamic) {
  10494. if (t.joinable()) { t.join(); }
  10495. }
  10496. std::unique_lock<std::mutex> lock(mutex_);
  10497. cleanup_finished_threads();
  10498. }
  10499. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10500. // Must be called with mutex_ held
  10501. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10502. if (it->get_id() == id) {
  10503. finished_threads_.push_back(std::move(*it));
  10504. dynamic_threads_.erase(it);
  10505. return;
  10506. }
  10507. }
  10508. }
  10509. inline void ThreadPool::cleanup_finished_threads() {
  10510. // Must be called with mutex_ held
  10511. for (auto &t : finished_threads_) {
  10512. if (t.joinable()) { t.join(); }
  10513. }
  10514. finished_threads_.clear();
  10515. }
  10516. inline void ThreadPool::worker(bool is_dynamic) {
  10517. for (;;) {
  10518. std::function<void()> fn;
  10519. {
  10520. std::unique_lock<std::mutex> lock(mutex_);
  10521. idle_thread_count_++;
  10522. if (is_dynamic) {
  10523. auto has_work =
  10524. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10525. [&] { return !jobs_.empty() || shutdown_; });
  10526. if (!has_work) {
  10527. // Timed out with no work - exit this dynamic thread
  10528. idle_thread_count_--;
  10529. move_to_finished(std::this_thread::get_id());
  10530. break;
  10531. }
  10532. } else {
  10533. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10534. }
  10535. idle_thread_count_--;
  10536. if (shutdown_ && jobs_.empty()) { break; }
  10537. fn = std::move(jobs_.front());
  10538. jobs_.pop_front();
  10539. }
  10540. assert(true == static_cast<bool>(fn));
  10541. fn();
  10542. }
  10543. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10544. !defined(LIBRESSL_VERSION_NUMBER)
  10545. OPENSSL_thread_stop();
  10546. #endif
  10547. }
  10548. /*
  10549. * Group 1 (continued): detail namespace - Stream implementations
  10550. */
  10551. namespace detail {
  10552. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10553. time_t timeout_sec, time_t timeout_usec,
  10554. time_t &actual_timeout_sec,
  10555. time_t &actual_timeout_usec) {
  10556. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10557. auto actual_timeout_msec =
  10558. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10559. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10560. actual_timeout_sec = actual_timeout_msec / 1000;
  10561. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10562. }
  10563. // Socket stream implementation
  10564. inline SocketStream::SocketStream(
  10565. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10566. time_t write_timeout_sec, time_t write_timeout_usec,
  10567. time_t max_timeout_msec,
  10568. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10569. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10570. read_timeout_usec_(read_timeout_usec),
  10571. write_timeout_sec_(write_timeout_sec),
  10572. write_timeout_usec_(write_timeout_usec),
  10573. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10574. read_buff_(read_buff_size_, 0) {}
  10575. inline SocketStream::~SocketStream() = default;
  10576. inline bool SocketStream::is_readable() const {
  10577. return read_buff_off_ < read_buff_content_size_;
  10578. }
  10579. inline bool SocketStream::wait_readable() const {
  10580. if (max_timeout_msec_ <= 0) {
  10581. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10582. }
  10583. time_t read_timeout_sec;
  10584. time_t read_timeout_usec;
  10585. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10586. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10587. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10588. }
  10589. inline bool SocketStream::wait_writable() const {
  10590. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10591. }
  10592. inline bool SocketStream::ensure_readable() {
  10593. if (readable_hint_) {
  10594. readable_hint_ = false;
  10595. return true;
  10596. }
  10597. return wait_readable();
  10598. }
  10599. inline const char *SocketStream::buffered_data(size_t &size) const {
  10600. size = read_buff_content_size_ - read_buff_off_;
  10601. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10602. }
  10603. inline void SocketStream::consume_buffered(size_t size) {
  10604. assert(size <= read_buff_content_size_ - read_buff_off_);
  10605. read_buff_off_ += size;
  10606. }
  10607. inline bool SocketStream::is_peer_alive() const {
  10608. return detail::is_socket_alive(sock_);
  10609. }
  10610. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10611. #ifdef _WIN32
  10612. size =
  10613. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10614. #else
  10615. size = (std::min)(size,
  10616. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10617. #endif
  10618. if (read_buff_off_ < read_buff_content_size_) {
  10619. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10620. if (size <= remaining_size) {
  10621. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10622. read_buff_off_ += size;
  10623. return static_cast<ssize_t>(size);
  10624. } else {
  10625. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10626. read_buff_off_ += remaining_size;
  10627. return static_cast<ssize_t>(remaining_size);
  10628. }
  10629. }
  10630. if (!ensure_readable()) {
  10631. error_ = Error::Timeout;
  10632. return -1;
  10633. }
  10634. read_buff_off_ = 0;
  10635. read_buff_content_size_ = 0;
  10636. if (size < read_buff_size_) {
  10637. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10638. CPPHTTPLIB_RECV_FLAGS);
  10639. if (n <= 0) {
  10640. if (n == 0) {
  10641. error_ = Error::ConnectionClosed;
  10642. } else {
  10643. error_ = Error::Read;
  10644. }
  10645. return n;
  10646. } else if (n <= static_cast<ssize_t>(size)) {
  10647. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10648. return n;
  10649. } else {
  10650. memcpy(ptr, read_buff_.data(), size);
  10651. read_buff_off_ = size;
  10652. read_buff_content_size_ = static_cast<size_t>(n);
  10653. return static_cast<ssize_t>(size);
  10654. }
  10655. } else {
  10656. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10657. if (n <= 0) {
  10658. if (n == 0) {
  10659. error_ = Error::ConnectionClosed;
  10660. } else {
  10661. error_ = Error::Read;
  10662. }
  10663. }
  10664. return n;
  10665. }
  10666. }
  10667. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10668. if (!wait_writable()) { return -1; }
  10669. #if defined(_WIN32) && !defined(_WIN64)
  10670. size =
  10671. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10672. #endif
  10673. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10674. }
  10675. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10676. int &port) const {
  10677. return detail::get_remote_ip_and_port(sock_, ip, port);
  10678. }
  10679. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10680. int &port) const {
  10681. return detail::get_local_ip_and_port(sock_, ip, port);
  10682. }
  10683. inline socket_t SocketStream::socket() const { return sock_; }
  10684. inline time_t SocketStream::duration() const {
  10685. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10686. std::chrono::steady_clock::now() - start_time_)
  10687. .count();
  10688. }
  10689. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10690. read_timeout_sec_ = sec;
  10691. read_timeout_usec_ = usec;
  10692. }
  10693. inline void SocketStream::set_max_timeout(time_t msec) {
  10694. max_timeout_msec_ = msec;
  10695. start_time_ = std::chrono::steady_clock::now();
  10696. }
  10697. // Buffer stream implementation
  10698. inline bool BufferStream::is_readable() const { return true; }
  10699. inline bool BufferStream::wait_readable() const { return true; }
  10700. inline bool BufferStream::wait_writable() const { return true; }
  10701. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10702. #if defined(_MSC_VER) && _MSC_VER < 1910
  10703. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10704. #else
  10705. auto len_read = buffer.copy(ptr, size, position);
  10706. #endif
  10707. position += static_cast<size_t>(len_read);
  10708. return static_cast<ssize_t>(len_read);
  10709. }
  10710. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10711. buffer.append(ptr, size);
  10712. return static_cast<ssize_t>(size);
  10713. }
  10714. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10715. int & /*port*/) const {}
  10716. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10717. int & /*port*/) const {}
  10718. inline socket_t BufferStream::socket() const { return 0; }
  10719. inline time_t BufferStream::duration() const { return 0; }
  10720. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10721. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10722. : MatcherBase(pattern) {
  10723. constexpr const char marker[] = "/:";
  10724. // One past the last ending position of a path param substring
  10725. std::size_t last_param_end = 0;
  10726. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10727. // Needed to ensure that parameter names are unique during matcher
  10728. // construction
  10729. // If exceptions are disabled, only last duplicate path
  10730. // parameter will be set
  10731. std::unordered_set<std::string> param_name_set;
  10732. #endif
  10733. while (true) {
  10734. const auto marker_pos = pattern.find(
  10735. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10736. if (marker_pos == std::string::npos) { break; }
  10737. static_fragments_.push_back(
  10738. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10739. const auto param_name_start = marker_pos + str_len(marker);
  10740. auto sep_pos = pattern.find(separator, param_name_start);
  10741. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10742. auto param_name =
  10743. pattern.substr(param_name_start, sep_pos - param_name_start);
  10744. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10745. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10746. std::string msg = "Encountered path parameter '" + param_name +
  10747. "' multiple times in route pattern '" + pattern + "'.";
  10748. throw std::invalid_argument(msg);
  10749. }
  10750. #endif
  10751. param_names_.push_back(std::move(param_name));
  10752. last_param_end = sep_pos + 1;
  10753. }
  10754. if (last_param_end < pattern.length()) {
  10755. static_fragments_.push_back(pattern.substr(last_param_end));
  10756. }
  10757. }
  10758. inline bool PathParamsMatcher::match(Request &request) const {
  10759. request.matches = std::smatch();
  10760. request.path_params.clear();
  10761. // A pattern without parameters is just a literal path to compare against
  10762. if (param_names_.empty()) { return request.path == pattern(); }
  10763. request.path_params.reserve(param_names_.size());
  10764. // One past the position at which the path matched the pattern last time
  10765. std::size_t starting_pos = 0;
  10766. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10767. const auto &fragment = static_fragments_[i];
  10768. if (starting_pos + fragment.length() > request.path.length()) {
  10769. return false;
  10770. }
  10771. // Avoid unnecessary allocation by using strncmp instead of substr +
  10772. // comparison
  10773. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10774. fragment.length()) != 0) {
  10775. return false;
  10776. }
  10777. starting_pos += fragment.length();
  10778. // Should only happen when we have a static fragment after a param
  10779. // Example: '/users/:id/subscriptions'
  10780. // The 'subscriptions' fragment here does not have a corresponding param
  10781. if (i >= param_names_.size()) { continue; }
  10782. auto sep_pos = request.path.find(separator, starting_pos);
  10783. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10784. const auto &param_name = param_names_[i];
  10785. request.path_params.emplace(
  10786. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10787. // Mark everything up to '/' as matched
  10788. starting_pos = sep_pos + 1;
  10789. }
  10790. // Returns false if the path is longer than the pattern
  10791. return starting_pos >= request.path.length();
  10792. }
  10793. inline bool RegexMatcher::match(Request &request) const {
  10794. request.path_params.clear();
  10795. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10796. // a non-match rather than risking a stack overflow in std::regex_match.
  10797. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10798. return false;
  10799. }
  10800. return std::regex_match(request.path, request.matches, regex_);
  10801. }
  10802. // Enclose IPv6 address in brackets if needed
  10803. inline std::string prepare_host_string(const std::string &host) {
  10804. // Enclose IPv6 address in brackets (but not if already enclosed)
  10805. if (host.find(':') == std::string::npos ||
  10806. (!host.empty() && host[0] == '[')) {
  10807. // IPv4, hostname, or already bracketed IPv6
  10808. return host;
  10809. } else {
  10810. // IPv6 address without brackets
  10811. return "[" + host + "]";
  10812. }
  10813. }
  10814. inline std::string make_host_and_port_string(const std::string &host, int port,
  10815. bool is_ssl) {
  10816. auto result = prepare_host_string(host);
  10817. // Append port if not default
  10818. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10819. ; // do nothing
  10820. } else {
  10821. result += ":" + std::to_string(port);
  10822. }
  10823. return result;
  10824. }
  10825. // Create "host:port" string always including port number (for CONNECT method)
  10826. inline std::string
  10827. make_host_and_port_string_always_port(const std::string &host, int port) {
  10828. return prepare_host_string(host) + ":" + std::to_string(port);
  10829. }
  10830. // Value for the Host header a client sends when the caller supplied none.
  10831. // Only the value: callers decide where in their header list it goes.
  10832. inline std::string make_default_host_header_value(const std::string &host,
  10833. int port, bool is_ssl,
  10834. int address_family) {
  10835. if (address_family == AF_UNIX) { return "localhost"; }
  10836. return make_host_and_port_string(host, port, is_ssl);
  10837. }
  10838. inline void add_default_user_agent_header(Request &req) {
  10839. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10840. if (!req.has_header("User-Agent")) {
  10841. req.set_header("User-Agent",
  10842. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10843. }
  10844. #else
  10845. (void)req;
  10846. #endif
  10847. }
  10848. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10849. NormalizedTarget normalize_target(const std::string &host);
  10850. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10851. bool host_matches_no_proxy(const NormalizedTarget &target,
  10852. const std::vector<NoProxyEntry> &entries);
  10853. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10854. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10855. if (prefix_bits == 0) { return true; }
  10856. int full_bytes = prefix_bits / 8;
  10857. int rem_bits = prefix_bits % 8;
  10858. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10859. static_cast<size_t>(full_bytes)) != 0) {
  10860. return false;
  10861. }
  10862. if (rem_bits == 0) { return true; }
  10863. auto i = static_cast<size_t>(full_bytes);
  10864. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10865. return (ip[i] & mask) == (net[i] & mask);
  10866. }
  10867. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10868. if (token.empty()) { return false; }
  10869. if (token == "*") {
  10870. out.kind = NoProxyKind::Wildcard;
  10871. return true;
  10872. }
  10873. auto slash = token.find('/');
  10874. std::string addr_part =
  10875. (slash == std::string::npos) ? token : token.substr(0, slash);
  10876. std::string prefix_part =
  10877. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10878. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10879. // don't silently treat it as a /32 (or /128).
  10880. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10881. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10882. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10883. // when brackets are present.
  10884. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10885. addr_part.back() == ']';
  10886. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10887. if (!bracketed) {
  10888. struct in_addr v4;
  10889. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10890. int prefix = 32;
  10891. if (!prefix_part.empty() &&
  10892. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 32,
  10893. prefix)) {
  10894. return false;
  10895. }
  10896. out.kind = NoProxyKind::IPv4Cidr;
  10897. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10898. out.prefix_bits = prefix;
  10899. return true;
  10900. }
  10901. }
  10902. struct in6_addr v6;
  10903. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10904. int prefix = 128;
  10905. if (!prefix_part.empty() &&
  10906. !parse_int_in_range(prefix_part.data(), prefix_part.size(), 0, 128,
  10907. prefix)) {
  10908. return false;
  10909. }
  10910. out.kind = NoProxyKind::IPv6Cidr;
  10911. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10912. out.prefix_bits = prefix;
  10913. return true;
  10914. }
  10915. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10916. // the entry is malformed — don't fall through to the hostname branch.
  10917. if (bracketed) { return false; }
  10918. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10919. if (slash != std::string::npos) { return false; }
  10920. // Port-specific entries (host:port) are not supported.
  10921. if (token.find(':') != std::string::npos) { return false; }
  10922. std::string hostname = case_ignore::to_lower(token);
  10923. while (!hostname.empty() && hostname.front() == '.') {
  10924. hostname.erase(hostname.begin());
  10925. }
  10926. while (!hostname.empty() && hostname.back() == '.') {
  10927. hostname.pop_back();
  10928. }
  10929. if (hostname.empty()) { return false; }
  10930. out.kind = NoProxyKind::HostnameSuffix;
  10931. out.hostname_pattern = std::move(hostname);
  10932. return true;
  10933. }
  10934. inline NormalizedTarget normalize_target(const std::string &host) {
  10935. NormalizedTarget t;
  10936. std::string h = host;
  10937. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10938. h = h.substr(1, h.size() - 2);
  10939. }
  10940. // Strip a single trailing dot so "example.com." canonicalizes to
  10941. // "example.com".
  10942. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10943. t.hostname = case_ignore::to_lower(h);
  10944. if (!t.hostname.empty()) {
  10945. struct in_addr v4;
  10946. struct in6_addr v6;
  10947. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10948. t.is_ipv4 = true;
  10949. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10950. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10951. t.is_ipv6 = true;
  10952. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10953. }
  10954. }
  10955. return t;
  10956. }
  10957. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10958. const std::vector<NoProxyEntry> &entries) {
  10959. if (target.hostname.empty()) { return false; }
  10960. for (const auto &e : entries) {
  10961. switch (e.kind) {
  10962. case NoProxyKind::Wildcard: return true;
  10963. case NoProxyKind::IPv4Cidr:
  10964. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10965. return true;
  10966. }
  10967. break;
  10968. case NoProxyKind::IPv6Cidr:
  10969. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10970. return true;
  10971. }
  10972. break;
  10973. case NoProxyKind::HostnameSuffix:
  10974. if (target.is_ipv4 || target.is_ipv6) { break; }
  10975. if (target.hostname == e.hostname_pattern) { return true; }
  10976. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10977. // an entry of "example.com".
  10978. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10979. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10980. if (target.hostname[offset - 1] == '.' &&
  10981. target.hostname.compare(offset, e.hostname_pattern.size(),
  10982. e.hostname_pattern) == 0) {
  10983. return true;
  10984. }
  10985. }
  10986. break;
  10987. }
  10988. }
  10989. return false;
  10990. }
  10991. template <typename T>
  10992. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10993. T header_writer, Error &error) {
  10994. for (const auto &h : headers) {
  10995. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10996. error = Error::InvalidHeaders;
  10997. return false;
  10998. }
  10999. }
  11000. if (header_writer(strm, headers) <= 0) {
  11001. error = Error::Write;
  11002. return false;
  11003. }
  11004. return true;
  11005. }
  11006. } // namespace detail
  11007. /*
  11008. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  11009. */
  11010. #ifdef CPPHTTPLIB_SSL_ENABLED
  11011. namespace detail {
  11012. // SSL socket stream implementation
  11013. inline SSLSocketStream::SSLSocketStream(
  11014. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  11015. time_t read_timeout_usec, time_t write_timeout_sec,
  11016. time_t write_timeout_usec, time_t max_timeout_msec,
  11017. std::chrono::time_point<std::chrono::steady_clock> start_time)
  11018. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11019. read_timeout_usec_(read_timeout_usec),
  11020. write_timeout_sec_(write_timeout_sec),
  11021. write_timeout_usec_(write_timeout_usec),
  11022. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  11023. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11024. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  11025. // Note: create_session() also clears this, but SSLClient currently
  11026. // uses ssl_new() which does not. Until full TLS API migration is complete,
  11027. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  11028. // SSL session was created.
  11029. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  11030. #endif
  11031. }
  11032. inline SSLSocketStream::~SSLSocketStream() = default;
  11033. inline bool SSLSocketStream::is_readable() const {
  11034. return tls::pending(session_) > 0;
  11035. }
  11036. inline bool SSLSocketStream::wait_readable() const {
  11037. if (max_timeout_msec_ <= 0) {
  11038. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11039. }
  11040. time_t read_timeout_sec;
  11041. time_t read_timeout_usec;
  11042. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  11043. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  11044. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  11045. }
  11046. inline bool SSLSocketStream::wait_writable() const {
  11047. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  11048. !tls::is_peer_closed(session_, sock_);
  11049. }
  11050. inline bool SSLSocketStream::ensure_readable() {
  11051. if (readable_hint_) {
  11052. readable_hint_ = false;
  11053. return true;
  11054. }
  11055. return wait_readable();
  11056. }
  11057. inline bool SSLSocketStream::is_peer_alive() const {
  11058. return !tls::is_peer_closed(session_, sock_);
  11059. }
  11060. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  11061. if (tls::pending(session_) > 0) {
  11062. tls::TlsError err;
  11063. auto ret = tls::read(session_, ptr, size, err);
  11064. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11065. error_ = Error::ConnectionClosed;
  11066. }
  11067. return ret;
  11068. } else if (ensure_readable()) {
  11069. tls::TlsError err;
  11070. auto ret = tls::read(session_, ptr, size, err);
  11071. if (ret < 0) {
  11072. auto n = 1000;
  11073. #ifdef _WIN32
  11074. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  11075. (err.code == tls::ErrorCode::SyscallError &&
  11076. WSAGetLastError() == WSAETIMEDOUT))) {
  11077. #else
  11078. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  11079. #endif
  11080. if (tls::pending(session_) > 0) {
  11081. return tls::read(session_, ptr, size, err);
  11082. } else if (wait_readable()) {
  11083. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11084. ret = tls::read(session_, ptr, size, err);
  11085. if (ret >= 0) { return ret; }
  11086. } else {
  11087. break;
  11088. }
  11089. }
  11090. assert(ret < 0);
  11091. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11092. error_ = Error::ConnectionClosed;
  11093. }
  11094. return ret;
  11095. } else {
  11096. error_ = Error::Timeout;
  11097. return -1;
  11098. }
  11099. }
  11100. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  11101. if (wait_writable()) {
  11102. auto handle_size =
  11103. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11104. tls::TlsError err;
  11105. auto ret = tls::write(session_, ptr, handle_size, err);
  11106. if (ret < 0) {
  11107. auto n = 1000;
  11108. #ifdef _WIN32
  11109. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  11110. (err.code == tls::ErrorCode::SyscallError &&
  11111. WSAGetLastError() == WSAETIMEDOUT))) {
  11112. #else
  11113. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  11114. #endif
  11115. if (wait_writable()) {
  11116. std::this_thread::sleep_for(std::chrono::microseconds{10});
  11117. ret = tls::write(session_, ptr, handle_size, err);
  11118. if (ret >= 0) { return ret; }
  11119. } else {
  11120. break;
  11121. }
  11122. }
  11123. assert(ret < 0);
  11124. }
  11125. return ret;
  11126. }
  11127. return -1;
  11128. }
  11129. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  11130. int &port) const {
  11131. detail::get_remote_ip_and_port(sock_, ip, port);
  11132. }
  11133. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  11134. int &port) const {
  11135. detail::get_local_ip_and_port(sock_, ip, port);
  11136. }
  11137. inline socket_t SSLSocketStream::socket() const { return sock_; }
  11138. inline time_t SSLSocketStream::duration() const {
  11139. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11140. std::chrono::steady_clock::now() - start_time_)
  11141. .count();
  11142. }
  11143. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  11144. read_timeout_sec_ = sec;
  11145. read_timeout_usec_ = usec;
  11146. }
  11147. inline void SSLSocketStream::set_max_timeout(time_t msec) {
  11148. max_timeout_msec_ = msec;
  11149. start_time_ = std::chrono::steady_clock::now();
  11150. }
  11151. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  11152. tls::session_t session,
  11153. time_t read_timeout_sec,
  11154. time_t read_timeout_usec,
  11155. time_t write_timeout_sec,
  11156. time_t write_timeout_usec)
  11157. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  11158. read_timeout_usec_(read_timeout_usec),
  11159. write_timeout_sec_(write_timeout_sec),
  11160. write_timeout_usec_(write_timeout_usec),
  11161. start_time_(std::chrono::steady_clock::now()) {
  11162. // The receive and send paths run on different threads, so each TLS call is
  11163. // driven in non-blocking mode and readiness is awaited with select()
  11164. // outside the session lock. Set the socket non-blocking once here; it is
  11165. // never flipped back, so no thread races on the flag.
  11166. detail::set_nonblocking(sock_, true);
  11167. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  11168. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  11169. #endif
  11170. }
  11171. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  11172. inline bool WebSocketSSLStream::is_readable() const {
  11173. std::lock_guard<std::mutex> guard(session_mutex_);
  11174. return tls::pending(session_) > 0;
  11175. }
  11176. inline bool WebSocketSSLStream::wait_readable() const {
  11177. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  11178. }
  11179. inline bool WebSocketSSLStream::wait_writable() const {
  11180. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  11181. // that probe toggles the socket's blocking flag, which would race with the
  11182. // concurrent reader on a permanently non-blocking socket.
  11183. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  11184. }
  11185. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  11186. tls::TlsError err;
  11187. auto n = 1000;
  11188. while (--n >= 0) {
  11189. {
  11190. std::lock_guard<std::mutex> guard(session_mutex_);
  11191. auto ret = tls::read(session_, ptr, size, err);
  11192. if (ret > 0) { return ret; }
  11193. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  11194. error_ = Error::ConnectionClosed;
  11195. return ret;
  11196. }
  11197. }
  11198. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  11199. // direction: the send path shares this session, so output it left pending
  11200. // has to be flushed before more input can be decrypted. Anything else is
  11201. // a hard error.
  11202. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  11203. #ifdef _WIN32
  11204. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  11205. needs_readable =
  11206. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  11207. WSAGetLastError() == WSAETIMEDOUT);
  11208. #endif
  11209. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  11210. error_ = Error::Read;
  11211. return -1;
  11212. }
  11213. if (!(needs_readable ? wait_readable() : wait_writable())) {
  11214. error_ = Error::Timeout;
  11215. return -1;
  11216. }
  11217. }
  11218. // Out of retries. Recording a reason matters: a caller that reads get_error()
  11219. // to tell a timeout from a close would otherwise see whatever the previous
  11220. // failure left behind (error_ is never cleared on success).
  11221. error_ = Error::Read;
  11222. return -1;
  11223. }
  11224. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  11225. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  11226. tls::TlsError err;
  11227. auto n = 1000;
  11228. while (--n >= 0) {
  11229. {
  11230. std::lock_guard<std::mutex> guard(session_mutex_);
  11231. auto ret = tls::write(session_, ptr, handle_size, err);
  11232. if (ret >= 0) { return ret; }
  11233. }
  11234. // ret < 0. As in read(), either direction can be needed: a renegotiation
  11235. // or a post-handshake message must be consumed before the record goes
  11236. // out. Anything else is a hard error.
  11237. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  11238. #ifdef _WIN32
  11239. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  11240. needs_writable =
  11241. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  11242. WSAGetLastError() == WSAETIMEDOUT);
  11243. #endif
  11244. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  11245. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  11246. }
  11247. return -1;
  11248. }
  11249. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  11250. int &port) const {
  11251. detail::get_remote_ip_and_port(sock_, ip, port);
  11252. }
  11253. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  11254. int &port) const {
  11255. detail::get_local_ip_and_port(sock_, ip, port);
  11256. }
  11257. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  11258. inline time_t WebSocketSSLStream::duration() const {
  11259. return std::chrono::duration_cast<std::chrono::milliseconds>(
  11260. std::chrono::steady_clock::now() - start_time_)
  11261. .count();
  11262. }
  11263. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  11264. read_timeout_sec_ = sec;
  11265. read_timeout_usec_ = usec;
  11266. }
  11267. } // namespace detail
  11268. #endif // CPPHTTPLIB_SSL_ENABLED
  11269. /*
  11270. * Group 4: Server implementation
  11271. */
  11272. // HTTP server implementation
  11273. inline Server::Server()
  11274. : new_task_queue([] {
  11275. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  11276. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  11277. }) {
  11278. #ifndef _WIN32
  11279. signal(SIGPIPE, SIG_IGN);
  11280. #endif
  11281. }
  11282. inline Server::~Server() = default;
  11283. inline std::unique_ptr<detail::MatcherBase>
  11284. Server::make_matcher(const std::string &pattern) {
  11285. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  11286. // a path params pattern
  11287. if (pattern.find("/:") != std::string::npos) {
  11288. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11289. }
  11290. // A pattern with no regex metacharacter only has to be compared literally,
  11291. // which is what PathParamsMatcher already does when it captures no
  11292. // parameter, so std::regex is only worth building for the patterns that
  11293. // actually need it
  11294. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  11295. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  11296. }
  11297. return detail::make_unique<detail::RegexMatcher>(pattern);
  11298. }
  11299. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  11300. return add_handler(get_handlers_, pattern, std::move(handler));
  11301. }
  11302. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  11303. return add_handler(post_handlers_, pattern, std::move(handler));
  11304. }
  11305. inline Server &Server::Post(const std::string &pattern,
  11306. HandlerWithContentReader handler) {
  11307. return add_handler(post_handlers_for_content_reader_, pattern,
  11308. std::move(handler));
  11309. }
  11310. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  11311. return add_handler(put_handlers_, pattern, std::move(handler));
  11312. }
  11313. inline Server &Server::Put(const std::string &pattern,
  11314. HandlerWithContentReader handler) {
  11315. return add_handler(put_handlers_for_content_reader_, pattern,
  11316. std::move(handler));
  11317. }
  11318. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  11319. return add_handler(patch_handlers_, pattern, std::move(handler));
  11320. }
  11321. inline Server &Server::Patch(const std::string &pattern,
  11322. HandlerWithContentReader handler) {
  11323. return add_handler(patch_handlers_for_content_reader_, pattern,
  11324. std::move(handler));
  11325. }
  11326. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  11327. return add_handler(delete_handlers_, pattern, std::move(handler));
  11328. }
  11329. inline Server &Server::Delete(const std::string &pattern,
  11330. HandlerWithContentReader handler) {
  11331. return add_handler(delete_handlers_for_content_reader_, pattern,
  11332. std::move(handler));
  11333. }
  11334. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  11335. return add_handler(options_handlers_, pattern, std::move(handler));
  11336. }
  11337. inline const std::set<std::string> &Server::builtin_methods() {
  11338. thread_local const std::set<std::string> methods{
  11339. "GET", "HEAD", "POST", "PUT", "DELETE",
  11340. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  11341. return methods;
  11342. }
  11343. inline Server::CustomHandlerEntry *
  11344. Server::custom_entry_for_registration(const std::string &method) {
  11345. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  11346. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  11347. // routing() before the custom tables are consulted, so a route registered
  11348. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  11349. // there and would be reachable, but they carry protocol-level meaning
  11350. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  11351. // library does not route.
  11352. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  11353. output_error_log(Error::InvalidHTTPMethod, nullptr);
  11354. has_invalid_registration_ = true;
  11355. return nullptr;
  11356. }
  11357. return &custom_handlers_[method];
  11358. }
  11359. inline Server &Server::CustomRoute(const std::string &method,
  11360. const std::string &pattern,
  11361. Handler handler) {
  11362. auto *entry = custom_entry_for_registration(method);
  11363. if (!entry) { return *this; }
  11364. return add_handler(entry->handlers, pattern, std::move(handler));
  11365. }
  11366. inline Server &Server::CustomRoute(const std::string &method,
  11367. const std::string &pattern,
  11368. HandlerWithContentReader handler) {
  11369. auto *entry = custom_entry_for_registration(method);
  11370. if (!entry) { return *this; }
  11371. return add_handler(entry->handlers_for_content_reader, pattern,
  11372. std::move(handler));
  11373. }
  11374. inline const Server::CustomHandlerEntry *
  11375. Server::find_custom_entry(const std::string &method) const {
  11376. // find() alone would be correct here. The empty() check is what keeps the
  11377. // per-request cost off servers that never call CustomRoute(), which is the
  11378. // overwhelmingly common case; keep it rather than walking into the tree.
  11379. if (custom_handlers_.empty()) { return nullptr; }
  11380. auto it = custom_handlers_.find(method);
  11381. return it == custom_handlers_.end() ? nullptr : &it->second;
  11382. }
  11383. inline Server &Server::WebSocket(const std::string &pattern,
  11384. WebSocketHandler handler) {
  11385. websocket_handlers_.push_back(
  11386. {make_matcher(pattern), std::move(handler), nullptr});
  11387. return *this;
  11388. }
  11389. inline Server &Server::WebSocket(const std::string &pattern,
  11390. WebSocketHandler handler,
  11391. SubProtocolSelector sub_protocol_selector) {
  11392. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  11393. std::move(sub_protocol_selector)});
  11394. return *this;
  11395. }
  11396. inline bool Server::set_base_dir(const std::string &dir,
  11397. const std::string &mount_point) {
  11398. return set_mount_point(mount_point, dir);
  11399. }
  11400. inline bool Server::set_mount_point(const std::string &mount_point,
  11401. const std::string &dir, Headers headers) {
  11402. detail::FileStat stat(dir);
  11403. if (stat.is_dir()) {
  11404. std::string mnt = !mount_point.empty() ? mount_point : "/";
  11405. if (!mnt.empty() && mnt[0] == '/') {
  11406. // Without the resolved directory, a file could not be checked to be
  11407. // inside it.
  11408. std::string resolved_base;
  11409. if (!detail::canonicalize_path(dir.c_str(), resolved_base)) {
  11410. return false;
  11411. }
  11412. #if defined(_WIN32)
  11413. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  11414. resolved_base += '\\';
  11415. }
  11416. #else
  11417. if (resolved_base.back() != '/') { resolved_base += '/'; }
  11418. #endif
  11419. base_dirs_.push_back(
  11420. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  11421. return true;
  11422. }
  11423. }
  11424. return false;
  11425. }
  11426. inline bool Server::remove_mount_point(const std::string &mount_point) {
  11427. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  11428. if (it->mount_point == mount_point) {
  11429. base_dirs_.erase(it);
  11430. return true;
  11431. }
  11432. }
  11433. return false;
  11434. }
  11435. inline Server &
  11436. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  11437. const std::string &mime) {
  11438. file_extension_and_mimetype_map_[ext] = mime;
  11439. return *this;
  11440. }
  11441. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11442. default_file_mimetype_ = mime;
  11443. return *this;
  11444. }
  11445. inline Server &Server::set_file_request_handler(Handler handler) {
  11446. file_request_handler_ = std::move(handler);
  11447. return *this;
  11448. }
  11449. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11450. std::true_type) {
  11451. error_handler_ = std::move(handler);
  11452. return *this;
  11453. }
  11454. inline Server &Server::set_error_handler_core(Handler handler,
  11455. std::false_type) {
  11456. error_handler_ = [handler](const Request &req, Response &res) {
  11457. handler(req, res);
  11458. return HandlerResponse::Handled;
  11459. };
  11460. return *this;
  11461. }
  11462. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11463. exception_handler_ = std::move(handler);
  11464. return *this;
  11465. }
  11466. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11467. pre_routing_handler_ = std::move(handler);
  11468. return *this;
  11469. }
  11470. inline Server &Server::set_post_routing_handler(Handler handler) {
  11471. post_routing_handler_ = std::move(handler);
  11472. return *this;
  11473. }
  11474. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11475. pre_request_handler_ = std::move(handler);
  11476. return *this;
  11477. }
  11478. inline Server &Server::set_logger(Logger logger) {
  11479. logger_ = std::move(logger);
  11480. return *this;
  11481. }
  11482. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11483. error_logger_ = std::move(error_logger);
  11484. return *this;
  11485. }
  11486. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11487. pre_compression_logger_ = std::move(logger);
  11488. return *this;
  11489. }
  11490. inline Server &
  11491. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11492. expect_100_continue_handler_ = std::move(handler);
  11493. return *this;
  11494. }
  11495. inline Server &Server::set_start_handler(StartHandler handler) {
  11496. start_handler_ = std::move(handler);
  11497. return *this;
  11498. }
  11499. inline Server &Server::set_address_family(int family) {
  11500. address_family_ = family;
  11501. return *this;
  11502. }
  11503. inline Server &Server::set_tcp_nodelay(bool on) {
  11504. tcp_nodelay_ = on;
  11505. return *this;
  11506. }
  11507. inline Server &Server::set_ipv6_v6only(bool on) {
  11508. ipv6_v6only_ = on;
  11509. return *this;
  11510. }
  11511. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11512. socket_options_ = std::move(socket_options);
  11513. return *this;
  11514. }
  11515. inline Server &Server::set_default_headers(Headers headers) {
  11516. default_headers_ = std::move(headers);
  11517. return *this;
  11518. }
  11519. inline Server &Server::set_header_writer(
  11520. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11521. header_writer_ = writer;
  11522. return *this;
  11523. }
  11524. inline Server &
  11525. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11526. trusted_proxies_ = proxies;
  11527. return *this;
  11528. }
  11529. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11530. keep_alive_max_count_ = count;
  11531. return *this;
  11532. }
  11533. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11534. keep_alive_timeout_sec_ = sec;
  11535. return *this;
  11536. }
  11537. template <class Rep, class Period>
  11538. inline Server &Server::set_keep_alive_timeout(
  11539. const std::chrono::duration<Rep, Period> &duration) {
  11540. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11541. set_keep_alive_timeout(sec);
  11542. });
  11543. return *this;
  11544. }
  11545. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11546. read_timeout_sec_ = sec;
  11547. read_timeout_usec_ = usec;
  11548. return *this;
  11549. }
  11550. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11551. write_timeout_sec_ = sec;
  11552. write_timeout_usec_ = usec;
  11553. return *this;
  11554. }
  11555. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11556. idle_interval_sec_ = sec;
  11557. idle_interval_usec_ = usec;
  11558. return *this;
  11559. }
  11560. inline Server &Server::set_payload_max_length(size_t length) {
  11561. payload_max_length_ = length;
  11562. return *this;
  11563. }
  11564. inline Server &Server::set_static_file_compression(bool on) {
  11565. static_file_compression_ = on;
  11566. return *this;
  11567. }
  11568. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11569. static_file_compression_min_length_ = length;
  11570. return *this;
  11571. }
  11572. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11573. static_file_compression_max_length_ = length;
  11574. return *this;
  11575. }
  11576. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11577. websocket_max_missed_pongs_ = count;
  11578. return *this;
  11579. }
  11580. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11581. websocket_ping_interval_sec_ = sec;
  11582. return *this;
  11583. }
  11584. template <class Rep, class Period>
  11585. inline Server &Server::set_websocket_ping_interval(
  11586. const std::chrono::duration<Rep, Period> &duration) {
  11587. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11588. set_websocket_ping_interval(sec);
  11589. });
  11590. return *this;
  11591. }
  11592. inline bool Server::bind_to_port(const std::string &host, int port,
  11593. int socket_flags) {
  11594. auto ret = bind_internal(host, port, socket_flags);
  11595. if (ret == -1) { is_decommissioned = true; }
  11596. return ret >= 0;
  11597. }
  11598. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11599. auto ret = bind_internal(host, 0, socket_flags);
  11600. if (ret == -1) { is_decommissioned = true; }
  11601. return ret;
  11602. }
  11603. inline bool Server::listen_after_bind() { return listen_internal(); }
  11604. inline bool Server::listen(const std::string &host, int port,
  11605. int socket_flags) {
  11606. return bind_to_port(host, port, socket_flags) && listen_internal();
  11607. }
  11608. inline bool Server::is_running() const { return is_running_; }
  11609. inline void Server::wait_until_ready() const {
  11610. while (!is_running_ && !is_decommissioned) {
  11611. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11612. }
  11613. }
  11614. inline void Server::stop() noexcept {
  11615. // Release the listening socket whether or not the accept loop is running:
  11616. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11617. // exchange is what makes this safe to call concurrently with the accept loop.
  11618. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11619. if (sock != INVALID_SOCKET) {
  11620. detail::shutdown_socket(sock);
  11621. detail::close_socket(sock);
  11622. }
  11623. is_decommissioned = false;
  11624. }
  11625. inline void Server::decommission() { is_decommissioned = true; }
  11626. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11627. auto len = strlen(s);
  11628. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11629. len -= 2;
  11630. {
  11631. // RFC 9112 §3: exactly one SP between the method, the target and the
  11632. // version. Taking other whitespace as a separator too lets recipients
  11633. // that parse more strictly see a different request.
  11634. auto end = s + len;
  11635. if (std::count(s, end, ' ') != 2) { return false; }
  11636. auto sp1 = std::find(s, end, ' ');
  11637. auto sp2 = std::find(sp1 + 1, end, ' ');
  11638. if (sp1 == s || sp2 == sp1 + 1 || sp2 + 1 == end) { return false; }
  11639. req.method.assign(s, sp1);
  11640. req.target.assign(sp1 + 1, sp2);
  11641. req.version.assign(sp2 + 1, end);
  11642. }
  11643. // A method outside the built-in set is accepted only when a handler has been
  11644. // registered for it with CustomRoute().
  11645. const auto &methods = builtin_methods();
  11646. if (methods.find(req.method) == methods.end() &&
  11647. !find_custom_entry(req.method)) {
  11648. output_error_log(Error::InvalidHTTPMethod, &req);
  11649. return false;
  11650. }
  11651. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11652. output_error_log(Error::InvalidHTTPVersion, &req);
  11653. return false;
  11654. }
  11655. // A request-target has no fragment (RFC 9112 §3.2), and one stripped here
  11656. // would leave this server routing a different path than a cache or a
  11657. // filter in front of it sees.
  11658. if (!detail::fields::is_request_target(req.target) ||
  11659. req.target.find('#') != std::string::npos) {
  11660. return false;
  11661. }
  11662. {
  11663. detail::divide(req.target, '?',
  11664. [&](const char *lhs_data, std::size_t lhs_size,
  11665. const char *rhs_data, std::size_t rhs_size) {
  11666. req.path =
  11667. decode_path_component(std::string(lhs_data, lhs_size));
  11668. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11669. });
  11670. }
  11671. return true;
  11672. }
  11673. inline bool Server::write_response(Stream &strm, bool close_connection,
  11674. Request &req, Response &res) {
  11675. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11676. // incorrectly to the error content.
  11677. req.ranges.clear();
  11678. return write_response_core(strm, close_connection, req, res, false);
  11679. }
  11680. inline bool Server::write_response_with_content(Stream &strm,
  11681. bool close_connection,
  11682. const Request &req,
  11683. Response &res) {
  11684. return write_response_core(strm, close_connection, req, res, true);
  11685. }
  11686. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11687. const Request &req, Response &res,
  11688. bool need_apply_ranges) {
  11689. assert(res.status != -1);
  11690. if (400 <= res.status && error_handler_ &&
  11691. error_handler_(req, res) == HandlerResponse::Handled) {
  11692. need_apply_ranges = true;
  11693. }
  11694. if (!detail::body_allowed_for_status(res.status)) {
  11695. detail::clear_content(res);
  11696. }
  11697. detail::prefer_assigned_body(res);
  11698. std::string content_type;
  11699. std::string boundary;
  11700. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11701. // Prepare additional headers
  11702. if (close_connection ||
  11703. detail::has_header_token(req.headers, "Connection", "close") ||
  11704. 400 <= res.status || // Don't leave connections open after errors
  11705. // The client withholds the body until `100 Continue`, which was never
  11706. // sent, so whether and when the body follows is unknown.
  11707. (req.expect_100_continue_pending_ && detail::has_framed_body(req)) ||
  11708. // The body was left partway, e.g. by a content receiver that returned
  11709. // false, so the rest of it cannot be told from the next request.
  11710. (req.body_read_started_ && !req.body_consumed_)) {
  11711. res.set_header("Connection", "close");
  11712. } else {
  11713. std::string s = "timeout=";
  11714. s += std::to_string(keep_alive_timeout_sec_);
  11715. s += ", max=";
  11716. s += std::to_string(keep_alive_max_count_);
  11717. res.set_header("Keep-Alive", s);
  11718. }
  11719. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11720. !res.has_header("Content-Type")) {
  11721. res.set_header("Content-Type", "text/plain");
  11722. }
  11723. detail::set_framing_headers(req, res, boundary, content_type);
  11724. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11725. res.set_header("Accept-Ranges", "bytes");
  11726. }
  11727. if (post_routing_handler_) {
  11728. post_routing_handler_(req, res);
  11729. // Again, for a body or framing headers the handler changed.
  11730. detail::set_framing_headers(req, res, boundary, content_type);
  11731. }
  11732. // Response line and headers
  11733. detail::BufferStream bstrm;
  11734. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11735. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11736. // Combine a small body with the headers so the whole response leaves in a
  11737. // single write. A large body is written on its own instead: a copy of it
  11738. // costs more than the extra write saves.
  11739. auto send_body =
  11740. req.method != "HEAD" && detail::body_allowed_for_status(res.status);
  11741. auto body_is_separate = false;
  11742. auto provider_done = false;
  11743. if (send_body && !res.body.empty() && !res.content_provider_) {
  11744. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11745. bstrm.write(res.body.data(), res.body.size());
  11746. } else {
  11747. body_is_separate = true;
  11748. }
  11749. } else if (send_body && res.content_provider_ &&
  11750. res.is_file_content_provider_ &&
  11751. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11752. // A small file is read into the same buffer. Other providers may produce
  11753. // their data over time, so they are never held back.
  11754. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11755. return false;
  11756. }
  11757. provider_done = true;
  11758. }
  11759. // Log before writing to avoid race condition with client-side code that
  11760. // accesses logger-captured data immediately after receiving the response.
  11761. output_log(req, res);
  11762. // Flush buffer
  11763. auto &data = bstrm.get_buffer();
  11764. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11765. if (body_is_separate) {
  11766. return detail::write_data(strm, res.body.data(), res.body.size());
  11767. }
  11768. // Streaming body
  11769. if (send_body && res.content_provider_) {
  11770. if (!provider_done &&
  11771. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11772. return false;
  11773. }
  11774. res.content_provider_success_ = true;
  11775. }
  11776. return true;
  11777. }
  11778. inline bool
  11779. Server::write_content_with_provider(Stream &strm, const Request &req,
  11780. Response &res, const std::string &boundary,
  11781. const std::string &content_type) {
  11782. auto is_shutting_down = [this]() {
  11783. return this->svr_sock_ == INVALID_SOCKET;
  11784. };
  11785. if (res.content_length_ > 0) {
  11786. if (!detail::is_partial_content(req, res)) {
  11787. return detail::write_content(strm, res.content_provider_, 0,
  11788. res.content_length_, is_shutting_down);
  11789. } else if (req.ranges.size() == 1) {
  11790. auto offset_and_length = detail::get_range_offset_and_length(
  11791. req.ranges[0], res.content_length_);
  11792. return detail::write_content(strm, res.content_provider_,
  11793. offset_and_length.first,
  11794. offset_and_length.second, is_shutting_down);
  11795. } else {
  11796. return detail::write_multipart_ranges_data(
  11797. strm, req, res, boundary, content_type, res.content_length_,
  11798. is_shutting_down);
  11799. }
  11800. } else {
  11801. if (res.is_chunked_content_provider_) {
  11802. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11803. // re-negotiating here would disagree with them, e.g. once a handler's
  11804. // own Content-Encoding header suppresses the negotiation.
  11805. auto compressor = detail::make_compressor(res.content_coding_);
  11806. if (!compressor) {
  11807. compressor = detail::make_unique<detail::nocompressor>();
  11808. }
  11809. return detail::write_content_chunked(strm, res.content_provider_,
  11810. is_shutting_down, *compressor);
  11811. } else {
  11812. return detail::write_content_without_length(strm, res.content_provider_,
  11813. is_shutting_down);
  11814. }
  11815. }
  11816. }
  11817. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11818. FormFields::iterator cur_field;
  11819. FormFiles::iterator cur_file;
  11820. auto is_text_field = false;
  11821. size_t count = 0;
  11822. if (read_content_core(
  11823. strm, req, res,
  11824. // Regular
  11825. [&](const char *buf, size_t n) {
  11826. // Prevent arithmetic overflow when checking sizes.
  11827. // Avoid computing (req.body.size() + n) directly because
  11828. // adding two unsigned `size_t` values can wrap around and
  11829. // produce a small result instead of indicating overflow.
  11830. // Instead, check using subtraction: ensure `n` does not
  11831. // exceed the remaining capacity `max_size() - size()`.
  11832. if (req.body.size() >= req.body.max_size() ||
  11833. n > req.body.max_size() - req.body.size()) {
  11834. return false;
  11835. }
  11836. // Limit decompressed body size to payload_max_length_ to protect
  11837. // against "zip bomb" attacks where a small compressed payload
  11838. // decompresses to a massive size.
  11839. if (payload_max_length_ > 0 &&
  11840. (req.body.size() >= payload_max_length_ ||
  11841. n > payload_max_length_ - req.body.size())) {
  11842. return false;
  11843. }
  11844. req.body.append(buf, n);
  11845. return true;
  11846. },
  11847. // Multipart FormData
  11848. [&](const FormData &file) {
  11849. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11850. output_error_log(Error::TooManyFormDataFiles, &req);
  11851. return false;
  11852. }
  11853. if (file.filename.empty()) {
  11854. cur_field = req.form.fields.emplace(
  11855. file.name, FormField{file.name, file.content, file.headers});
  11856. is_text_field = true;
  11857. } else {
  11858. cur_file = req.form.files.emplace(file.name, file);
  11859. is_text_field = false;
  11860. }
  11861. return true;
  11862. },
  11863. [&](const char *buf, size_t n) {
  11864. if (is_text_field) {
  11865. auto &content = cur_field->second.content;
  11866. if (content.size() + n > content.max_size()) { return false; }
  11867. content.append(buf, n);
  11868. } else {
  11869. auto &content = cur_file->second.content;
  11870. if (content.size() + n > content.max_size()) { return false; }
  11871. content.append(buf, n);
  11872. }
  11873. return true;
  11874. })) {
  11875. const auto &content_type = req.get_header_value("Content-Type");
  11876. if (detail::case_ignore::equal(detail::extract_media_type(content_type),
  11877. "application/x-www-form-urlencoded")) {
  11878. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11879. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11880. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11881. return false;
  11882. }
  11883. detail::parse_query_text(req.body, req.params);
  11884. }
  11885. return true;
  11886. }
  11887. return false;
  11888. }
  11889. inline bool Server::read_content_with_content_receiver(
  11890. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11891. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11892. return read_content_core(strm, req, res, std::move(receiver),
  11893. std::move(multipart_header),
  11894. std::move(multipart_receiver));
  11895. }
  11896. inline bool Server::read_content_core(
  11897. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11898. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11899. detail::FormDataParser multipart_form_data_parser;
  11900. ContentReceiverWithProgress out;
  11901. if (req.is_multipart_form_data()) {
  11902. const auto &content_type = req.get_header_value("Content-Type");
  11903. std::string boundary;
  11904. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11905. res.status = StatusCode::BadRequest_400;
  11906. output_error_log(Error::MultipartParsing, &req);
  11907. return false;
  11908. }
  11909. multipart_form_data_parser.set_boundary(std::move(boundary));
  11910. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11911. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11912. multipart_receiver);
  11913. };
  11914. } else {
  11915. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11916. size_t /*len*/) { return receiver(buf, n); };
  11917. }
  11918. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11919. // For non-SSL builds we still scan non-persistent connections for stray
  11920. // body bytes so the payload limit is enforced (413). On keep-alive,
  11921. // pending bytes may be the next request (issue #2450), so skip.
  11922. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11923. if (!req.has_header("Content-Length") &&
  11924. !detail::is_chunked_transfer_encoding(req.headers)) {
  11925. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11926. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11927. auto has_data = strm.is_readable();
  11928. if (!has_data) {
  11929. auto s = strm.socket();
  11930. if (s != INVALID_SOCKET) {
  11931. has_data = detail::select_read(s, 0, 0) > 0;
  11932. }
  11933. }
  11934. if (has_data) {
  11935. // Route through the same decompressing reader used by the
  11936. // length-framed and chunked paths below, so payload_max_length_ is
  11937. // enforced on the decompressed size here too instead of only on the
  11938. // compressed wire bytes.
  11939. return detail::read_content(strm, req, payload_max_length_, res.status,
  11940. nullptr, out, true);
  11941. }
  11942. }
  11943. return true;
  11944. }
  11945. #else
  11946. if (!req.has_header("Content-Length") &&
  11947. !detail::is_chunked_transfer_encoding(req.headers)) {
  11948. return true;
  11949. }
  11950. #endif
  11951. // A second read would start where the first one stopped, or in the next
  11952. // request.
  11953. if (req.body_read_started_) { return false; }
  11954. // The client is waiting for this before it sends the body.
  11955. if (req.expect_100_continue_pending_) {
  11956. req.expect_100_continue_pending_ = false;
  11957. detail::write_response_line(strm, StatusCode::Continue_100);
  11958. strm.write("\r\n");
  11959. }
  11960. // Set before reading, since a receiver may also stop by throwing.
  11961. req.body_read_started_ = true;
  11962. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11963. out, true)) {
  11964. return false;
  11965. }
  11966. req.body_consumed_ = true;
  11967. if (req.is_multipart_form_data()) {
  11968. if (!multipart_form_data_parser.is_valid()) {
  11969. res.status = StatusCode::BadRequest_400;
  11970. output_error_log(Error::MultipartParsing, &req);
  11971. return false;
  11972. }
  11973. }
  11974. return true;
  11975. }
  11976. inline bool Server::handle_file_request(Request &req, Response &res) {
  11977. for (const auto &entry : base_dirs_) {
  11978. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11979. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11980. // One that already ends in '/' (the root mount among them) carries its own
  11981. // boundary; set_mount_point() guarantees the mount point is not empty.
  11982. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11983. (entry.mount_point.back() == '/' ||
  11984. req.path.size() == entry.mount_point.size() ||
  11985. req.path[entry.mount_point.size()] == '/')) {
  11986. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11987. if (detail::is_valid_path(sub_path)) {
  11988. auto path = entry.base_dir + sub_path;
  11989. if (path.back() == '/') { path += "index.html"; }
  11990. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11991. // but symlinks/junctions can still escape the base directory. A path
  11992. // that cannot be resolved, which includes one that does not exist, is
  11993. // not served from here.
  11994. std::string resolved_path;
  11995. if (!detail::canonicalize_path(path.c_str(), resolved_path)) {
  11996. continue;
  11997. }
  11998. if (!detail::is_path_within_base(resolved_path,
  11999. entry.resolved_base_dir)) {
  12000. res.status = StatusCode::Forbidden_403;
  12001. return true;
  12002. }
  12003. detail::FileStat stat(path);
  12004. if (stat.is_dir()) {
  12005. // Relative, so "//dir" cannot name another host; "./" keeps a ':'
  12006. // in the name from reading as a scheme.
  12007. auto name = req.path.substr(req.path.rfind('/') + 1);
  12008. res.set_redirect("./" + encode_path_component(name) + "/",
  12009. StatusCode::MovedPermanently_301);
  12010. return true;
  12011. }
  12012. if (stat.is_file()) {
  12013. for (const auto &kv : entry.headers) {
  12014. res.set_header(kv.first, kv.second);
  12015. }
  12016. auto content_type = detail::find_content_type(
  12017. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12018. auto encoding = detail::EncodingType::None;
  12019. if (static_file_compression_) {
  12020. encoding =
  12021. static_file_encoding(req, res, content_type, stat.size());
  12022. }
  12023. // The ETag names the representation actually sent, so a client that
  12024. // cached the compressed form revalidates against the compressed ETag
  12025. // and still gets a 304, while one that took identity keeps the plain
  12026. // ETag.
  12027. auto etag = detail::compute_etag(
  12028. stat, encoding == detail::EncodingType::None
  12029. ? std::string()
  12030. : std::string("-") + detail::encoding_name(encoding));
  12031. if (!etag.empty()) { res.set_header("ETag", etag); }
  12032. auto mtime = stat.mtime();
  12033. auto last_modified = detail::file_mtime_to_http_date(mtime);
  12034. if (!last_modified.empty()) {
  12035. res.set_header("Last-Modified", last_modified);
  12036. }
  12037. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  12038. check_if_range(req, etag, mtime);
  12039. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12040. if (!mm->is_open()) {
  12041. output_error_log(Error::OpenFile, &req);
  12042. return false;
  12043. }
  12044. detail::set_file_content_provider(res, mm, content_type, encoding);
  12045. if (req.method != "HEAD" && file_request_handler_) {
  12046. file_request_handler_(req, res);
  12047. }
  12048. return true;
  12049. } else {
  12050. output_error_log(Error::OpenFile, &req);
  12051. }
  12052. }
  12053. }
  12054. }
  12055. return false;
  12056. }
  12057. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  12058. const std::string &etag,
  12059. time_t mtime) const {
  12060. // Handle conditional GET:
  12061. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  12062. // 2. If-Modified-Since is checked only when If-None-Match is absent
  12063. if (req.has_header("If-None-Match")) {
  12064. if (!etag.empty()) {
  12065. auto val =
  12066. detail::get_combined_header_value(req.headers, "If-None-Match");
  12067. // NOTE: We use exact string matching here. This works correctly
  12068. // because our server always generates weak ETags (W/"..."), and
  12069. // clients typically send back the same ETag they received.
  12070. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  12071. // If-None-Match, where W/"x" and "x" would match, but this
  12072. // simplified implementation requires exact matches.
  12073. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  12074. [&](const char *b, const char *e) {
  12075. auto seg_len = static_cast<size_t>(e - b);
  12076. return (seg_len == 1 && *b == '*') ||
  12077. (seg_len == etag.size() &&
  12078. std::equal(b, e, etag.begin()));
  12079. });
  12080. if (ret) {
  12081. res.status = StatusCode::NotModified_304;
  12082. return true;
  12083. }
  12084. }
  12085. } else if (req.has_header("If-Modified-Since")) {
  12086. auto val = req.get_header_value("If-Modified-Since");
  12087. auto t = detail::parse_http_date(val);
  12088. if (t != static_cast<time_t>(-1) && mtime <= t) {
  12089. res.status = StatusCode::NotModified_304;
  12090. return true;
  12091. }
  12092. }
  12093. return false;
  12094. }
  12095. inline bool Server::check_if_range(Request &req, const std::string &etag,
  12096. time_t mtime) const {
  12097. // Handle If-Range for partial content requests (RFC 9110
  12098. // Section 13.1.5). If-Range is only evaluated when Range header is
  12099. // present. If the validator matches, serve partial content; otherwise
  12100. // serve full content.
  12101. if (!req.ranges.empty() && req.has_header("If-Range")) {
  12102. auto val = req.get_header_value("If-Range");
  12103. auto is_valid_range = [&]() {
  12104. if (detail::is_strong_etag(val)) {
  12105. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  12106. // comparison.
  12107. return (!etag.empty() && val == etag);
  12108. } else if (detail::is_weak_etag(val)) {
  12109. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  12110. return false;
  12111. } else {
  12112. // HTTP-date comparison
  12113. auto t = detail::parse_http_date(val);
  12114. return (t != static_cast<time_t>(-1) && mtime <= t);
  12115. }
  12116. };
  12117. if (!is_valid_range()) {
  12118. // Validator doesn't match: ignore Range and serve full content
  12119. req.ranges.clear();
  12120. return false;
  12121. }
  12122. }
  12123. return true;
  12124. }
  12125. inline socket_t
  12126. Server::create_server_socket(const std::string &host, int port,
  12127. int socket_flags,
  12128. SocketOptions socket_options) const {
  12129. return detail::create_socket(
  12130. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  12131. ipv6_v6only_, std::move(socket_options),
  12132. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  12133. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  12134. output_error_log(Error::BindIPAddress, nullptr);
  12135. return false;
  12136. }
  12137. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  12138. output_error_log(Error::Listen, nullptr);
  12139. return false;
  12140. }
  12141. return true;
  12142. });
  12143. }
  12144. inline int Server::bind_internal(const std::string &host, int port,
  12145. int socket_flags) {
  12146. if (is_decommissioned) { return -1; }
  12147. if (!is_valid()) { return -1; }
  12148. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  12149. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  12150. if (port == 0) {
  12151. struct sockaddr_storage addr;
  12152. socklen_t addr_len = sizeof(addr);
  12153. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  12154. &addr_len) == -1) {
  12155. output_error_log(Error::GetSockName, nullptr);
  12156. return -1;
  12157. }
  12158. if (addr.ss_family == AF_INET) {
  12159. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  12160. } else if (addr.ss_family == AF_INET6) {
  12161. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  12162. } else {
  12163. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  12164. return -1;
  12165. }
  12166. } else {
  12167. return port;
  12168. }
  12169. }
  12170. inline bool Server::listen_internal() {
  12171. // A stop() between bind and listen leaves nothing to accept on. Report
  12172. // failure instead of returning success without ever serving, and mark the
  12173. // server decommissioned the way any failed listen does so that a concurrent
  12174. // wait_until_ready() wakes up instead of spinning forever.
  12175. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  12176. is_decommissioned = true;
  12177. return false;
  12178. }
  12179. auto ret = true;
  12180. is_running_ = true;
  12181. auto se = detail::scope_exit([&]() { is_running_ = false; });
  12182. if (start_handler_) { start_handler_(); }
  12183. {
  12184. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  12185. while (svr_sock_ != INVALID_SOCKET) {
  12186. #ifndef _WIN32
  12187. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  12188. #endif
  12189. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  12190. idle_interval_usec_);
  12191. if (val == 0) { // Timeout
  12192. task_queue->on_idle();
  12193. continue;
  12194. }
  12195. #ifndef _WIN32
  12196. }
  12197. #endif
  12198. #if defined _WIN32
  12199. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  12200. // OVERLAPPED
  12201. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  12202. #elif defined SOCK_CLOEXEC
  12203. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  12204. #else
  12205. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  12206. #endif
  12207. if (sock == INVALID_SOCKET) {
  12208. // NOTE: Winsock reports failures through WSAGetLastError() and never
  12209. // touches the CRT errno, so the two have to be asked platform by
  12210. // platform rather than by testing errno here.
  12211. if (detail::is_accept_resource_error()) {
  12212. // The per-process descriptor limit or the network stack's buffer
  12213. // space has been reached. Try to accept new connections after a
  12214. // short sleep.
  12215. std::this_thread::sleep_for(std::chrono::microseconds{1});
  12216. continue;
  12217. } else if (detail::is_accept_transient_error()) {
  12218. continue;
  12219. }
  12220. // Take the descriptor out of svr_sock_ before closing it: a later
  12221. // stop() would otherwise shutdown()/close() a value the OS may have
  12222. // reused, and keep_alive() watches svr_sock_ to notice the server is
  12223. // gone. The exchange also settles the race with a concurrent stop(),
  12224. // since whichever side takes the descriptor closes it exactly once.
  12225. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  12226. if (listen_sock != INVALID_SOCKET) {
  12227. detail::close_socket(listen_sock);
  12228. ret = false;
  12229. output_error_log(Error::Connection, nullptr);
  12230. } else {
  12231. ; // The server socket was closed by user.
  12232. }
  12233. break;
  12234. }
  12235. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  12236. read_timeout_sec_, read_timeout_usec_);
  12237. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  12238. write_timeout_sec_, write_timeout_usec_);
  12239. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  12240. if (!task_queue->enqueue(
  12241. [this, sock]() { process_and_close_socket(sock); })) {
  12242. output_error_log(Error::ResourceExhaustion, nullptr);
  12243. detail::shutdown_socket(sock);
  12244. detail::close_socket(sock);
  12245. }
  12246. }
  12247. task_queue->shutdown();
  12248. }
  12249. is_decommissioned = !ret;
  12250. return ret;
  12251. }
  12252. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  12253. if (pre_routing_handler_ &&
  12254. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12255. return true;
  12256. }
  12257. // File handler
  12258. if ((req.method == "GET" || req.method == "HEAD") &&
  12259. handle_file_request(req, res)) {
  12260. return true;
  12261. }
  12262. const auto *custom = find_custom_entry(req.method);
  12263. // The second clause mirrors what expect_content() does unconditionally for
  12264. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  12265. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  12266. // `allprop`) would skip its handler and fall through to 404.
  12267. if (detail::expect_content(req) ||
  12268. (custom && !custom->handlers_for_content_reader.empty())) {
  12269. // Content reader handler
  12270. {
  12271. // Track whether the ContentReader was aborted due to the decompressed
  12272. // payload exceeding `payload_max_length_`.
  12273. // The user handler runs after the lambda returns, so we must restore the
  12274. // 413 status if the handler overwrites it.
  12275. bool content_reader_payload_too_large = false;
  12276. ContentReader reader(
  12277. [&](ContentReceiver receiver) {
  12278. auto result = read_content_with_content_receiver(
  12279. strm, req, res, std::move(receiver), nullptr, nullptr);
  12280. if (!result) {
  12281. output_error_log(Error::Read, &req);
  12282. if (res.status == StatusCode::PayloadTooLarge_413) {
  12283. content_reader_payload_too_large = true;
  12284. }
  12285. }
  12286. return result;
  12287. },
  12288. [&](FormDataHeader header, ContentReceiver receiver) {
  12289. auto result = read_content_with_content_receiver(
  12290. strm, req, res, nullptr, std::move(header),
  12291. std::move(receiver));
  12292. if (!result) {
  12293. output_error_log(Error::Read, &req);
  12294. if (res.status == StatusCode::PayloadTooLarge_413) {
  12295. content_reader_payload_too_large = true;
  12296. }
  12297. }
  12298. return result;
  12299. });
  12300. bool dispatched = false;
  12301. if (req.method == "POST") {
  12302. dispatched = dispatch_request_for_content_reader(
  12303. req, res, std::move(reader), post_handlers_for_content_reader_);
  12304. } else if (req.method == "PUT") {
  12305. dispatched = dispatch_request_for_content_reader(
  12306. req, res, std::move(reader), put_handlers_for_content_reader_);
  12307. } else if (req.method == "PATCH") {
  12308. dispatched = dispatch_request_for_content_reader(
  12309. req, res, std::move(reader), patch_handlers_for_content_reader_);
  12310. } else if (req.method == "DELETE") {
  12311. dispatched = dispatch_request_for_content_reader(
  12312. req, res, std::move(reader), delete_handlers_for_content_reader_);
  12313. } else if (custom) {
  12314. dispatched = dispatch_request_for_content_reader(
  12315. req, res, std::move(reader), custom->handlers_for_content_reader);
  12316. }
  12317. if (dispatched) {
  12318. if (content_reader_payload_too_large) {
  12319. // Enforce the limit: override any status the handler may have set
  12320. // and return false so the error path sends a plain 413 response.
  12321. res.status = StatusCode::PayloadTooLarge_413;
  12322. detail::clear_content(res);
  12323. return false;
  12324. }
  12325. return true;
  12326. }
  12327. }
  12328. // NOTE: `req.body` is not read here. For a regular handler the body is
  12329. // read inside dispatch_request(), after the route has matched and the
  12330. // pre-request handler has approved the request, so that a rejected
  12331. // request (e.g. failed authentication) never forces us to buffer a
  12332. // potentially large body.
  12333. }
  12334. // Regular handler
  12335. if (req.method == "GET" || req.method == "HEAD") {
  12336. return dispatch_request(req, res, get_handlers_, strm);
  12337. } else if (req.method == "POST") {
  12338. return dispatch_request(req, res, post_handlers_, strm);
  12339. } else if (req.method == "PUT") {
  12340. return dispatch_request(req, res, put_handlers_, strm);
  12341. } else if (req.method == "DELETE") {
  12342. return dispatch_request(req, res, delete_handlers_, strm);
  12343. } else if (req.method == "OPTIONS") {
  12344. return dispatch_request(req, res, options_handlers_, strm);
  12345. } else if (req.method == "PATCH") {
  12346. return dispatch_request(req, res, patch_handlers_, strm);
  12347. } else if (custom) {
  12348. return dispatch_request(req, res, custom->handlers, strm);
  12349. }
  12350. res.status = StatusCode::BadRequest_400;
  12351. return false;
  12352. }
  12353. inline bool Server::dispatch_request(Request &req, Response &res,
  12354. const Handlers &handlers, Stream &strm) {
  12355. for (const auto &x : handlers) {
  12356. const auto &matcher = x.first;
  12357. const auto &handler = x.second;
  12358. if (matcher->match(req)) {
  12359. req.matched_route = matcher->pattern();
  12360. // Run the pre-request handler before reading the body so a rejected
  12361. // request (e.g. failed authentication) never forces us to buffer a
  12362. // potentially large body. `req.matched_route` is available here.
  12363. if (pre_request_handler_ &&
  12364. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12365. return true;
  12366. }
  12367. // The route matched and the request was approved; read the body now.
  12368. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  12369. output_error_log(Error::Read, &req);
  12370. return false;
  12371. }
  12372. handler(req, res);
  12373. return true;
  12374. }
  12375. }
  12376. return false;
  12377. }
  12378. // Decides the content coding for a response served straight from a file. Both
  12379. // the ETag, which has to name the representation actually sent, and
  12380. // `apply_static_file_compression()` go through this, so the two cannot drift
  12381. // apart.
  12382. inline detail::EncodingType
  12383. Server::static_file_encoding(const Request &req, const Response &res,
  12384. const std::string &content_type,
  12385. size_t length) const {
  12386. if (!static_file_compression_) { return detail::EncodingType::None; }
  12387. // Nothing to compress, and an empty file already answers with
  12388. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  12389. // turn an empty body into a 20-byte gzip stream.
  12390. if (length == 0) { return detail::EncodingType::None; }
  12391. // A file that already fits in a single packet gains nothing from being made
  12392. // smaller, since it still travels in that one segment, and a file of a few
  12393. // bytes comes out larger than it went in.
  12394. if (length < static_file_compression_min_length_) {
  12395. return detail::EncodingType::None;
  12396. }
  12397. // RFC 9110 applies Range to the representation after content coding, so a
  12398. // compressed 206 would mean compressing the whole file and then slicing it.
  12399. // Serve ranges from the identity representation instead.
  12400. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  12401. if (static_file_compression_max_length_ > 0 &&
  12402. length > static_file_compression_max_length_) {
  12403. return detail::EncodingType::None;
  12404. }
  12405. return detail::encoding_type(req, res, content_type);
  12406. }
  12407. // Compresses a file-backed content provider into `res.body`. Returns false when
  12408. // the response is left untouched.
  12409. inline bool Server::apply_static_file_compression(const Request &req,
  12410. Response &res) const {
  12411. auto type = res.content_coding_;
  12412. if (type == detail::EncodingType::None || !res.content_provider_) {
  12413. return false;
  12414. }
  12415. auto compressor = detail::make_compressor(type);
  12416. if (!compressor) { return false; }
  12417. output_pre_compression_log(req, res);
  12418. std::string compressed;
  12419. if (!detail::compress_content_provider(res.content_provider_,
  12420. res.content_length_, *compressor,
  12421. compressed)) {
  12422. return false;
  12423. }
  12424. res.body.swap(compressed);
  12425. // The provider was consumed in full, so its releaser hears about a success.
  12426. res.content_provider_success_ = true;
  12427. detail::clear_content_provider(res);
  12428. res.set_header("Content-Encoding", detail::encoding_name(type));
  12429. res.set_header("Vary", "Accept-Encoding");
  12430. return true;
  12431. }
  12432. inline void Server::apply_ranges(const Request &req, Response &res,
  12433. std::string &content_type,
  12434. std::string &boundary) const {
  12435. // A known-length content provider leaves `res.body` empty, so the compressor
  12436. // at the end of this function never runs for one (issue #2545). A file-backed
  12437. // provider is fully readable right here, so compress it and answer with an
  12438. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12439. // takes the same path as `set_content()` from here on. Range requests never
  12440. // get a content coding, so `Content-Range` still names identity bytes and
  12441. // none of the range handling below applies.
  12442. if (apply_static_file_compression(req, res)) { return; }
  12443. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12444. auto it = res.headers.find("Content-Type");
  12445. if (it != res.headers.end()) {
  12446. content_type = it->second;
  12447. res.headers.erase(it);
  12448. }
  12449. boundary = detail::make_multipart_data_boundary();
  12450. res.set_header("Content-Type",
  12451. "multipart/byteranges; boundary=" + boundary);
  12452. }
  12453. auto type = detail::encoding_type(req, res);
  12454. if (res.body.empty()) {
  12455. if (res.content_length_ > 0 && req.ranges.size() == 1 &&
  12456. res.status == StatusCode::PartialContent_206) {
  12457. auto offset_and_length = detail::get_range_offset_and_length(
  12458. req.ranges[0], res.content_length_);
  12459. auto content_range = detail::make_content_range_header_field(
  12460. offset_and_length, res.content_length_);
  12461. res.set_header("Content-Range", content_range);
  12462. } else if (res.is_chunked_content_provider_) {
  12463. res.content_coding_ = type;
  12464. if (type != detail::EncodingType::None) {
  12465. res.set_header("Content-Encoding", detail::encoding_name(type));
  12466. res.set_header("Vary", "Accept-Encoding");
  12467. }
  12468. }
  12469. } else {
  12470. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12471. ;
  12472. } else if (req.ranges.size() == 1) {
  12473. auto offset_and_length =
  12474. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12475. auto offset = offset_and_length.first;
  12476. auto length = offset_and_length.second;
  12477. auto content_range = detail::make_content_range_header_field(
  12478. offset_and_length, res.body.size());
  12479. res.set_header("Content-Range", content_range);
  12480. assert(offset + length <= res.body.size());
  12481. res.body = res.body.substr(offset, length);
  12482. } else {
  12483. std::string data;
  12484. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12485. res.body.size(), data);
  12486. res.body.swap(data);
  12487. }
  12488. if (type != detail::EncodingType::None) {
  12489. output_pre_compression_log(req, res);
  12490. if (auto compressor = detail::make_compressor(type)) {
  12491. std::string compressed;
  12492. if (compressor->compress(res.body.data(), res.body.size(), true,
  12493. [&](const char *data, size_t data_len) {
  12494. compressed.append(data, data_len);
  12495. return true;
  12496. })) {
  12497. res.body.swap(compressed);
  12498. res.set_header("Content-Encoding", detail::encoding_name(type));
  12499. res.set_header("Vary", "Accept-Encoding");
  12500. }
  12501. }
  12502. }
  12503. res.content_length_ = res.body.size();
  12504. }
  12505. }
  12506. inline bool Server::dispatch_request_for_content_reader(
  12507. Request &req, Response &res, ContentReader content_reader,
  12508. const HandlersForContentReader &handlers) const {
  12509. for (const auto &x : handlers) {
  12510. const auto &matcher = x.first;
  12511. const auto &handler = x.second;
  12512. if (matcher->match(req)) {
  12513. req.matched_route = matcher->pattern();
  12514. if (!pre_request_handler_ ||
  12515. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12516. handler(req, res, content_reader);
  12517. }
  12518. return true;
  12519. }
  12520. }
  12521. return false;
  12522. }
  12523. inline std::string
  12524. get_client_ip(const std::string &x_forwarded_for,
  12525. const std::vector<std::string> &trusted_proxies) {
  12526. // X-Forwarded-For is a comma-separated list per RFC 7239
  12527. std::vector<std::string> ip_list;
  12528. detail::split(x_forwarded_for.data(),
  12529. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12530. [&](const char *b, const char *e) {
  12531. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12532. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12533. });
  12534. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12535. // no segments. Signal "no client IP derived" with an empty string so the
  12536. // caller can fall back to the connection-level remote address.
  12537. if (ip_list.empty()) { return std::string(); }
  12538. // Each hop appends the address it received the request from, so the rightmost
  12539. // entries are the ones written by our own infrastructure while the leftmost
  12540. // are whatever the original client chose to send. Walk from the right and
  12541. // skip trusted proxies; the first address that is not a trusted proxy is the
  12542. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12543. // from the left instead lets a client forge an arbitrary address by following
  12544. // it with a trusted proxy's address, which the left-to-right scan then
  12545. // returned as the client.
  12546. for (size_t i = ip_list.size(); i-- > 0;) {
  12547. const auto &ip = ip_list[i];
  12548. auto is_trusted_proxy =
  12549. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12550. [&](const std::string &proxy) { return ip == proxy; });
  12551. if (!is_trusted_proxy) { return ip; }
  12552. }
  12553. // Every hop was a trusted proxy; fall back to the first entry.
  12554. return ip_list.front();
  12555. }
  12556. inline bool
  12557. Server::process_request(Stream &strm, const std::string &remote_addr,
  12558. int remote_port, const std::string &local_addr,
  12559. int local_port, bool close_connection,
  12560. bool &connection_closed,
  12561. const std::function<void(Request &)> &setup_request,
  12562. bool *websocket_upgraded) {
  12563. std::array<char, 2048> buf{};
  12564. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12565. // The read timeout bounds the request line and headers as a whole, so a
  12566. // client sending them a byte at a time cannot hold the worker any longer.
  12567. strm.set_max_timeout(read_timeout_sec_ * 1000 + read_timeout_usec_ / 1000);
  12568. // Connection has been closed on client
  12569. if (!line_reader.getline()) { return false; }
  12570. // RFC 9112 2.2: ignore an empty line received before the request-line. Some
  12571. // clients send an extra CRLF after a request body, which would otherwise be
  12572. // parsed as the next request on a persistent connection.
  12573. if (strcmp(line_reader.ptr(), "\r\n") == 0 && !line_reader.getline()) {
  12574. return false;
  12575. }
  12576. Request req;
  12577. req.start_time_ = std::chrono::steady_clock::now();
  12578. req.remote_addr = remote_addr;
  12579. req.remote_port = remote_port;
  12580. req.local_addr = local_addr;
  12581. req.local_port = local_port;
  12582. Response res;
  12583. res.version = "HTTP/1.1";
  12584. res.headers = default_headers_;
  12585. // RFC 9112 §9.6: a server that sends the "close" connection option must
  12586. // close the connection after that response, whichever path wrote it (an
  12587. // error status, a handler, or a rejected request). Reading on would also
  12588. // parse whatever the client sent next on a connection it considers done.
  12589. auto honor_connection_close = detail::scope_exit([&] {
  12590. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12591. connection_closed = true;
  12592. }
  12593. });
  12594. // Request line and headers. A rejected message leaves the rest of it (and
  12595. // any body) unread, so the connection cannot be reused: the leftover bytes
  12596. // would be parsed as the next request.
  12597. if (!parse_request_line(line_reader.ptr(), req)) {
  12598. connection_closed = true;
  12599. res.status = StatusCode::BadRequest_400;
  12600. output_error_log(Error::InvalidRequestLine, &req);
  12601. return write_response(strm, close_connection, req, res);
  12602. }
  12603. // Request headers
  12604. if (!detail::read_headers(strm, req.headers)) {
  12605. connection_closed = true;
  12606. res.status = StatusCode::BadRequest_400;
  12607. output_error_log(Error::InvalidHeaders, &req);
  12608. return write_response(strm, close_connection, req, res);
  12609. }
  12610. strm.set_max_timeout(0);
  12611. // RFC 9112 §6.3: Reject requests whose framing is invalid or ambiguous,
  12612. // which would otherwise let an intermediary and this parser disagree on
  12613. // where the body ends and enable request smuggling. Three cases: a
  12614. // Content-Length that is not a valid decimal length (e.g. "42, 42", "+42"
  12615. // or empty), which would otherwise be read as "no body"; a non-zero
  12616. // Content-Length alongside any Transfer-Encoding (Content-Length: 0 is
  12617. // tolerated for compatibility with existing clients); and a
  12618. // Transfer-Encoding whose final coding is not chunked, which leaves the body
  12619. // length undeterminable. None of them may fall through to the "no body"
  12620. // path, or the body bytes are parsed as the next request on a persistent
  12621. // connection.
  12622. auto is_invalid_content_length = false;
  12623. detail::get_header_value_u64(req.headers, "Content-Length", 0, 0,
  12624. is_invalid_content_length);
  12625. if (is_invalid_content_length ||
  12626. detail::has_conflicting_content_length(req.headers) ||
  12627. (req.has_header("Transfer-Encoding") &&
  12628. !detail::is_chunked_transfer_encoding(req.headers))) {
  12629. connection_closed = true;
  12630. res.status = StatusCode::BadRequest_400;
  12631. return write_response(strm, close_connection, req, res);
  12632. }
  12633. // RFC 9112 §6.1: a Transfer-Encoding alongside a Content-Length, or in an
  12634. // HTTP/1.0 request, is honoured, but the connection closes after the
  12635. // response.
  12636. if (detail::has_faulty_transfer_encoding(req)) { connection_closed = true; }
  12637. // RFC 9112 §3.2: Reject more than one Host field line, an invalid Host
  12638. // value, or none in HTTP/1.1, so that every recipient of the request sees
  12639. // the same authority.
  12640. auto host_count = req.get_header_value_count("Host");
  12641. if (host_count > 1 || (host_count == 0 && req.version == "HTTP/1.1") ||
  12642. !detail::fields::is_host(req.get_header_value("Host"))) {
  12643. connection_closed = true;
  12644. res.status = StatusCode::BadRequest_400;
  12645. output_error_log(Error::InvalidHeaders, &req);
  12646. return write_response(strm, close_connection, req, res);
  12647. }
  12648. // Check if the request URI doesn't exceed the limit
  12649. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12650. connection_closed = true;
  12651. res.status = StatusCode::UriTooLong_414;
  12652. output_error_log(Error::ExceedUriMaxLength, &req);
  12653. return write_response(strm, close_connection, req, res);
  12654. }
  12655. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12656. connection_closed = true;
  12657. }
  12658. if (req.version == "HTTP/1.0" &&
  12659. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12660. connection_closed = true;
  12661. }
  12662. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12663. // itself a trusted proxy. Otherwise any direct client could spoof
  12664. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12665. auto is_trusted_peer = std::any_of(
  12666. trusted_proxies_.begin(), trusted_proxies_.end(),
  12667. [&](const std::string &proxy) { return proxy == remote_addr; });
  12668. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12669. // Some proxies append the address they observed as a separate
  12670. // X-Forwarded-For field line instead of extending the one the client sent
  12671. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12672. // be scanned. Reading only the first occurrence would hand back the
  12673. // client-supplied, and therefore forgeable, value.
  12674. auto x_forwarded_for =
  12675. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12676. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12677. req.remote_addr = derived.empty() ? remote_addr : derived;
  12678. } else {
  12679. req.remote_addr = remote_addr;
  12680. }
  12681. req.remote_port = remote_port;
  12682. req.local_addr = local_addr;
  12683. req.local_port = local_port;
  12684. if (req.has_header("Accept")) {
  12685. auto accept_header =
  12686. detail::get_combined_header_value(req.headers, "Accept");
  12687. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12688. connection_closed = true;
  12689. res.status = StatusCode::BadRequest_400;
  12690. output_error_log(Error::HTTPParsing, &req);
  12691. return write_response(strm, close_connection, req, res);
  12692. }
  12693. }
  12694. if (req.has_header("Range")) {
  12695. const auto &range_header_value = req.get_header_value("Range");
  12696. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12697. connection_closed = true;
  12698. res.status = StatusCode::RangeNotSatisfiable_416;
  12699. output_error_log(Error::InvalidRangeHeader, &req);
  12700. return write_response(strm, close_connection, req, res);
  12701. }
  12702. }
  12703. if (setup_request) { setup_request(req); }
  12704. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12705. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12706. // must be ignored. An expectation we do not recognize is left alone; the
  12707. // 417 the section allows for one is a MAY, not a requirement.
  12708. //
  12709. // `100 Continue` itself is deferred until the body is actually read (see
  12710. // read_content_core), so a request rejected by a later handler never
  12711. // invites the client to send a body nobody will read.
  12712. if (req.version != "HTTP/1.0" &&
  12713. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12714. int status = StatusCode::Continue_100;
  12715. if (expect_100_continue_handler_) {
  12716. status = expect_100_continue_handler_(req, res);
  12717. }
  12718. if (status == StatusCode::Continue_100) {
  12719. req.expect_100_continue_pending_ = true;
  12720. } else {
  12721. if (res.status == -1) { res.status = status; }
  12722. connection_closed = true;
  12723. return write_response(strm, true, req, res);
  12724. }
  12725. }
  12726. // Setup `is_connection_closed` method
  12727. auto sock = strm.socket();
  12728. req.is_connection_closed = [sock]() {
  12729. return !detail::is_socket_alive(sock);
  12730. };
  12731. // WebSocket upgrade
  12732. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12733. // that authentication and other middleware can reject the request with an
  12734. // HTTP response (e.g., 401) before the protocol switches.
  12735. // The response says so when this connection closes after it.
  12736. auto close_after_response = close_connection || connection_closed;
  12737. if (detail::is_websocket_upgrade(req)) {
  12738. if (pre_routing_handler_ &&
  12739. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12740. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12741. return write_response_with_content(strm, close_after_response, req, res);
  12742. }
  12743. // Find matching WebSocket handler
  12744. for (const auto &entry : websocket_handlers_) {
  12745. if (entry.matcher->match(req)) {
  12746. req.matched_route = entry.matcher->pattern();
  12747. if (pre_request_handler_ &&
  12748. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12749. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12750. return write_response_with_content(strm, close_after_response, req,
  12751. res);
  12752. }
  12753. // Compute accept key
  12754. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12755. auto accept_key = detail::websocket_accept_key(client_key);
  12756. // Negotiate subprotocol
  12757. std::string selected_subprotocol;
  12758. if (entry.sub_protocol_selector) {
  12759. auto protocol_header = detail::get_combined_header_value(
  12760. req.headers, "Sec-WebSocket-Protocol");
  12761. if (!protocol_header.empty()) {
  12762. std::vector<std::string> protocols;
  12763. detail::split(protocol_header.data(),
  12764. protocol_header.data() + protocol_header.size(), ',',
  12765. [&](const char *b, const char *e) {
  12766. protocols.emplace_back(b, e);
  12767. });
  12768. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12769. // Ignore a selection the client did not offer (RFC 6455 4.2.2)
  12770. if (std::find(protocols.begin(), protocols.end(),
  12771. selected_subprotocol) == protocols.end()) {
  12772. selected_subprotocol.clear();
  12773. }
  12774. }
  12775. }
  12776. // Send 101 Switching Protocols
  12777. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12778. "Upgrade: websocket\r\n"
  12779. "Connection: Upgrade\r\n"
  12780. "Sec-WebSocket-Accept: " +
  12781. accept_key + "\r\n";
  12782. if (!selected_subprotocol.empty()) {
  12783. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12784. return false;
  12785. }
  12786. handshake_response +=
  12787. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12788. }
  12789. handshake_response += "\r\n";
  12790. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12791. 0) {
  12792. return false;
  12793. }
  12794. connection_closed = true;
  12795. if (websocket_upgraded) { *websocket_upgraded = true; }
  12796. {
  12797. #ifdef CPPHTTPLIB_SSL_ENABLED
  12798. if (req.ssl) {
  12799. // wss: the heartbeat ping thread and the read path enter the same
  12800. // TLS session from different threads. Hand the WebSocket a stream
  12801. // that serializes every TLS call, so the shared SSLSocketStream on
  12802. // the plain HTTP/HTTPS paths stays untouched.
  12803. auto ws_strm =
  12804. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12805. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12806. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12807. write_timeout_sec_, write_timeout_usec_));
  12808. ws::WebSocket ws(std::move(ws_strm), req, true,
  12809. websocket_ping_interval_sec_,
  12810. websocket_max_missed_pongs_);
  12811. entry.handler(req, ws);
  12812. return true;
  12813. }
  12814. #endif
  12815. // Use WebSocket-specific read timeout instead of HTTP timeout
  12816. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12817. 0);
  12818. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12819. websocket_max_missed_pongs_);
  12820. entry.handler(req, ws);
  12821. }
  12822. return true;
  12823. }
  12824. }
  12825. // No matching handler - fall through to 404
  12826. }
  12827. // Routing
  12828. auto routed = false;
  12829. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12830. routed = routing(req, res, strm);
  12831. #else
  12832. try {
  12833. routed = routing(req, res, strm);
  12834. } catch (std::exception &) {
  12835. if (exception_handler_) {
  12836. auto ep = std::current_exception();
  12837. exception_handler_(req, res, ep);
  12838. routed = true;
  12839. } else {
  12840. res.status = StatusCode::InternalServerError_500;
  12841. }
  12842. } catch (...) {
  12843. if (exception_handler_) {
  12844. auto ep = std::current_exception();
  12845. exception_handler_(req, res, ep);
  12846. routed = true;
  12847. } else {
  12848. res.status = StatusCode::InternalServerError_500;
  12849. }
  12850. }
  12851. #endif
  12852. auto ret = false;
  12853. if (routed) {
  12854. if (res.status == -1) {
  12855. res.status = req.ranges.empty() ? StatusCode::OK_200
  12856. : StatusCode::PartialContent_206;
  12857. }
  12858. // Before the Range checks below, so they see the body's own length.
  12859. detail::prefer_assigned_body(res);
  12860. // Serve file content by using a content provider
  12861. auto file_open_error = false;
  12862. if (!res.file_content_path_.empty()) {
  12863. const auto &path = res.file_content_path_;
  12864. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12865. if (!mm->is_open()) {
  12866. res.status = StatusCode::NotFound_404;
  12867. output_error_log(Error::OpenFile, &req);
  12868. file_open_error = true;
  12869. } else {
  12870. auto content_type = res.file_content_content_type_;
  12871. if (content_type.empty()) {
  12872. content_type = detail::find_content_type(
  12873. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12874. }
  12875. detail::set_file_content_provider(
  12876. res, mm, content_type,
  12877. static_file_encoding(req, res, content_type, mm->size()));
  12878. }
  12879. }
  12880. if (file_open_error) {
  12881. ret = write_response(strm, close_after_response, req, res);
  12882. } else if (detail::range_error(req, res)) {
  12883. detail::clear_content(res);
  12884. res.status = StatusCode::RangeNotSatisfiable_416;
  12885. ret = write_response(strm, close_after_response, req, res);
  12886. } else {
  12887. ret = write_response_with_content(strm, close_after_response, req, res);
  12888. }
  12889. } else {
  12890. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12891. ret = write_response(strm, close_after_response, req, res);
  12892. }
  12893. // Drain any unconsumed framed body to prevent request smuggling on
  12894. // keep-alive. Without framing there is no body to drain — reading would
  12895. // consume the next request (issue #2450). If the response has committed the
  12896. // connection to close, there is no next request to protect. A body read in
  12897. // part cannot be drained from where it stopped, so the connection closes.
  12898. if (!req.body_consumed_ && detail::has_framed_body(req) &&
  12899. !detail::has_header_token(res.headers, "Connection", "close")) {
  12900. int dummy_status;
  12901. if (req.body_read_started_ ||
  12902. !detail::read_content(
  12903. strm, req, payload_max_length_, dummy_status, nullptr,
  12904. [](const char *, size_t, size_t, size_t) { return true; }, false)) {
  12905. connection_closed = true;
  12906. }
  12907. }
  12908. return ret;
  12909. }
  12910. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12911. inline bool Server::process_and_close_socket(socket_t sock) {
  12912. std::string remote_addr;
  12913. int remote_port = 0;
  12914. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12915. std::string local_addr;
  12916. int local_port = 0;
  12917. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12918. bool websocket_upgraded = false;
  12919. auto ret = serve_guarded([&]() {
  12920. return detail::process_server_socket(
  12921. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12922. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12923. write_timeout_usec_,
  12924. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12925. return process_request(strm, remote_addr, remote_port, local_addr,
  12926. local_port, close_connection,
  12927. connection_closed, nullptr,
  12928. &websocket_upgraded);
  12929. });
  12930. });
  12931. detail::drain_and_close_socket(sock);
  12932. return ret;
  12933. }
  12934. inline void Server::output_log(const Request &req, const Response &res) const {
  12935. if (logger_) {
  12936. std::lock_guard<std::mutex> guard(logger_mutex_);
  12937. logger_(req, res);
  12938. }
  12939. }
  12940. inline void Server::output_pre_compression_log(const Request &req,
  12941. const Response &res) const {
  12942. if (pre_compression_logger_) {
  12943. std::lock_guard<std::mutex> guard(logger_mutex_);
  12944. pre_compression_logger_(req, res);
  12945. }
  12946. }
  12947. inline void Server::output_error_log(const Error &err,
  12948. const Request *req) const {
  12949. if (error_logger_) {
  12950. std::lock_guard<std::mutex> guard(logger_mutex_);
  12951. error_logger_(err, req);
  12952. }
  12953. }
  12954. /*
  12955. * Group 5: ClientImpl and Client (Universal) implementation
  12956. */
  12957. // HTTP client implementation
  12958. inline ClientImpl::ClientImpl(const std::string &host)
  12959. : ClientImpl(host, 80, std::string(), std::string()) {}
  12960. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12961. : ClientImpl(host, port, std::string(), std::string()) {}
  12962. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12963. const std::string &client_cert_path,
  12964. const std::string &client_key_path)
  12965. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12966. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12967. inline ClientImpl::~ClientImpl() {
  12968. // Wait until all the requests in flight are handled.
  12969. size_t retry_count = 10;
  12970. while (retry_count-- > 0) {
  12971. {
  12972. std::lock_guard<std::mutex> guard(socket_mutex_);
  12973. if (socket_requests_in_flight_ == 0) { break; }
  12974. }
  12975. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12976. }
  12977. std::lock_guard<std::mutex> guard(socket_mutex_);
  12978. shutdown_socket(socket_);
  12979. close_socket(socket_);
  12980. }
  12981. inline bool ClientImpl::is_valid() const { return true; }
  12982. inline bool
  12983. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12984. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12985. if (no_proxy_entries_.empty()) { return true; }
  12986. // host_ is const so its normalized form is invariant; cache it. The
  12987. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12988. if (host == host_) {
  12989. if (!host_normalized_valid_) {
  12990. host_normalized_ = detail::normalize_target(host_);
  12991. host_normalized_valid_ = true;
  12992. }
  12993. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12994. }
  12995. auto target = detail::normalize_target(host);
  12996. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12997. }
  12998. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12999. if (is_proxy_enabled_for_host(host_)) {
  13000. return detail::create_client_socket(
  13001. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  13002. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  13003. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  13004. write_timeout_sec_, write_timeout_usec_, interface_, error);
  13005. }
  13006. // Check is custom IP or hostname specified for host_
  13007. std::string connect_host;
  13008. std::string ip;
  13009. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  13010. return detail::create_client_socket(
  13011. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  13012. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  13013. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13014. write_timeout_usec_, interface_, error);
  13015. }
  13016. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  13017. Error &error) {
  13018. auto sock = create_client_socket(error);
  13019. if (sock == INVALID_SOCKET) { return false; }
  13020. socket.sock = sock;
  13021. return true;
  13022. }
  13023. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  13024. return create_and_connect_socket(socket, error);
  13025. }
  13026. inline bool ClientImpl::setup_proxy_connection(
  13027. Socket & /*socket*/,
  13028. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  13029. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  13030. return true;
  13031. }
  13032. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  13033. bool /*shutdown_gracefully*/) {
  13034. // If there are any requests in flight from threads other than us, then it's
  13035. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  13036. assert(socket_requests_in_flight_ == 0 ||
  13037. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13038. }
  13039. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  13040. if (socket.sock == INVALID_SOCKET) { return; }
  13041. detail::shutdown_socket(socket.sock);
  13042. }
  13043. inline void ClientImpl::close_socket(Socket &socket) {
  13044. // If there are requests in flight in another thread, usually closing
  13045. // the socket will be fine and they will simply receive an error when
  13046. // using the closed socket, but it is still a bug since rarely the OS
  13047. // may reassign the socket id to be used for a new socket, and then
  13048. // suddenly they will be operating on a live socket that is different
  13049. // than the one they intended!
  13050. assert(socket_requests_in_flight_ == 0 ||
  13051. socket_requests_are_from_thread_ == std::this_thread::get_id());
  13052. // It is also a bug if this happens while SSL is still active
  13053. #ifdef CPPHTTPLIB_SSL_ENABLED
  13054. assert(socket.ssl == nullptr);
  13055. #endif
  13056. if (socket.sock == INVALID_SOCKET) { return; }
  13057. detail::close_socket(socket.sock);
  13058. socket.sock = INVALID_SOCKET;
  13059. }
  13060. inline void ClientImpl::disconnect(bool gracefully) {
  13061. shutdown_ssl(socket_, gracefully);
  13062. shutdown_socket(socket_);
  13063. close_socket(socket_);
  13064. }
  13065. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  13066. Response &res,
  13067. bool skip_100_continue) const {
  13068. std::array<char, 2048> buf{};
  13069. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  13070. if (!line_reader.getline()) { return false; }
  13071. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13072. res.reason)) {
  13073. return req.method == "CONNECT";
  13074. }
  13075. // Skip interim (1xx) responses along with their header fields, except a 100
  13076. // Continue the caller handles itself for Expect: 100-continue. 101 ends
  13077. // HTTP on the connection, so it is final.
  13078. while (100 <= res.status && res.status < 200 &&
  13079. res.status != StatusCode::SwitchingProtocol_101 &&
  13080. (skip_100_continue || res.status != StatusCode::Continue_100)) {
  13081. Headers interim_headers;
  13082. if (!detail::read_headers(strm, interim_headers)) { return false; }
  13083. if (!line_reader.getline()) { return false; } // next response line
  13084. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  13085. res.reason)) {
  13086. return false;
  13087. }
  13088. }
  13089. return true;
  13090. }
  13091. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  13092. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  13093. auto ret = send_(req, res, error);
  13094. if (error == Error::SSLPeerCouldBeClosed_) {
  13095. assert(!ret);
  13096. ret = send_(req, res, error);
  13097. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  13098. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  13099. }
  13100. return ret;
  13101. }
  13102. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  13103. {
  13104. std::lock_guard<std::mutex> guard(socket_mutex_);
  13105. // Set this to false immediately - if it ever gets set to true by the end
  13106. // of the request, we know another thread instructed us to close the
  13107. // socket.
  13108. socket_should_be_closed_when_request_is_done_ = false;
  13109. auto is_alive = false;
  13110. if (socket_.is_open()) {
  13111. is_alive = detail::is_socket_alive(socket_.sock);
  13112. #ifdef CPPHTTPLIB_SSL_ENABLED
  13113. if (is_alive && is_ssl()) {
  13114. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13115. is_alive = false;
  13116. }
  13117. }
  13118. #endif
  13119. if (!is_alive) {
  13120. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  13121. disconnect(/*gracefully=*/false);
  13122. }
  13123. }
  13124. if (!is_alive) {
  13125. if (!ensure_socket_connection(socket_, error)) {
  13126. output_error_log(error, &req);
  13127. return false;
  13128. }
  13129. {
  13130. auto success = true;
  13131. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  13132. error)) {
  13133. if (!success) { output_error_log(error, &req); }
  13134. return success;
  13135. }
  13136. }
  13137. }
  13138. // Mark the current socket as being in use so that it cannot be closed by
  13139. // anyone else while this request is ongoing, even though we will be
  13140. // releasing the mutex.
  13141. if (socket_requests_in_flight_ > 1) {
  13142. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  13143. }
  13144. socket_requests_in_flight_ += 1;
  13145. socket_requests_are_from_thread_ = std::this_thread::get_id();
  13146. }
  13147. for (const auto &header : default_headers_) {
  13148. if (req.headers.find(header.first) == req.headers.end()) {
  13149. req.headers.insert(header);
  13150. }
  13151. }
  13152. auto ret = false;
  13153. auto close_connection = !keep_alive_;
  13154. auto se = detail::scope_exit([&]() {
  13155. // Briefly lock mutex in order to mark that a request is no longer ongoing
  13156. std::lock_guard<std::mutex> guard(socket_mutex_);
  13157. socket_requests_in_flight_ -= 1;
  13158. if (socket_requests_in_flight_ <= 0) {
  13159. assert(socket_requests_in_flight_ == 0);
  13160. socket_requests_are_from_thread_ = std::thread::id();
  13161. }
  13162. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  13163. !ret) {
  13164. disconnect(/*gracefully=*/true);
  13165. }
  13166. });
  13167. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  13168. return handle_request(strm, req, res, close_connection, error);
  13169. });
  13170. if (!ret) {
  13171. if (error == Error::Success) {
  13172. error = Error::Unknown;
  13173. output_error_log(error, &req);
  13174. }
  13175. }
  13176. return ret;
  13177. }
  13178. inline Result ClientImpl::send(const Request &req) {
  13179. auto req2 = req;
  13180. return send_(std::move(req2));
  13181. }
  13182. inline Result ClientImpl::send_(Request &&req) {
  13183. auto res = detail::make_unique<Response>();
  13184. auto error = Error::Success;
  13185. auto ret = send(req, *res, error);
  13186. #ifdef CPPHTTPLIB_SSL_ENABLED
  13187. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  13188. last_ssl_error_, last_backend_error_};
  13189. #else
  13190. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  13191. #endif
  13192. }
  13193. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  13194. const std::string &ct) {
  13195. (void)for_stream;
  13196. // Default headers are meant for the origin and may carry its credentials, so
  13197. // keep them off the CONNECT request the proxy reads.
  13198. if (r.method != "CONNECT") {
  13199. for (const auto &header : default_headers_) {
  13200. if (!r.has_header(header.first)) { r.headers.insert(header); }
  13201. }
  13202. }
  13203. // RFC 9110 5.3 recommends sending control data such as Host first, so
  13204. // prepend it rather than appending it after the caller's own fields.
  13205. if (!r.has_header("Host")) {
  13206. r.headers.emplace_front(
  13207. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  13208. address_family_));
  13209. }
  13210. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  13211. if (!r.content_receiver) {
  13212. if (!r.has_header("Accept-Encoding")) {
  13213. std::string accept_encoding;
  13214. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  13215. accept_encoding = "br";
  13216. #endif
  13217. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  13218. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13219. accept_encoding += "gzip, deflate";
  13220. #endif
  13221. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  13222. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  13223. accept_encoding += "zstd";
  13224. #endif
  13225. r.set_header("Accept-Encoding", accept_encoding);
  13226. }
  13227. detail::add_default_user_agent_header(r);
  13228. }
  13229. if (!r.body.empty()) {
  13230. if (!ct.empty() && !r.has_header("Content-Type")) {
  13231. r.headers.emplace("Content-Type", ct);
  13232. }
  13233. if (!r.has_header("Content-Length")) {
  13234. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  13235. }
  13236. }
  13237. }
  13238. inline ClientImpl::StreamHandle
  13239. ClientImpl::open_stream(const std::string &method, const std::string &path,
  13240. const Params &params, const Headers &headers,
  13241. const std::string &body,
  13242. const std::string &content_type) {
  13243. StreamHandle handle;
  13244. handle.response = detail::make_unique<Response>();
  13245. handle.error = Error::Success;
  13246. // Encode the target exactly like the buffered send path does, so that the
  13247. // same `path` produces the same request line through either API.
  13248. auto raw_query_path =
  13249. params.empty() ? path : append_query_params(path, params);
  13250. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  13251. handle.connection_ = detail::make_unique<ClientConnection>();
  13252. {
  13253. std::lock_guard<std::mutex> guard(socket_mutex_);
  13254. auto is_alive = false;
  13255. if (socket_.is_open()) {
  13256. is_alive = detail::is_socket_alive(socket_.sock);
  13257. #ifdef CPPHTTPLIB_SSL_ENABLED
  13258. if (is_alive && is_ssl()) {
  13259. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13260. is_alive = false;
  13261. }
  13262. }
  13263. #endif
  13264. if (!is_alive) { disconnect(/*gracefully=*/false); }
  13265. }
  13266. if (!is_alive) {
  13267. if (!ensure_socket_connection(socket_, handle.error)) {
  13268. handle.response.reset();
  13269. return handle;
  13270. }
  13271. {
  13272. auto success = true;
  13273. auto start_time = std::chrono::steady_clock::now();
  13274. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  13275. success, handle.error)) {
  13276. if (!success) { handle.response.reset(); }
  13277. return handle;
  13278. }
  13279. }
  13280. }
  13281. transfer_socket_ownership_to_handle(handle);
  13282. }
  13283. #ifdef CPPHTTPLIB_SSL_ENABLED
  13284. if (is_ssl() && handle.connection_->session) {
  13285. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  13286. handle.connection_->sock, handle.connection_->session,
  13287. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13288. write_timeout_usec_);
  13289. } else {
  13290. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13291. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13292. write_timeout_sec_, write_timeout_usec_);
  13293. }
  13294. #else
  13295. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  13296. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  13297. write_timeout_sec_, write_timeout_usec_);
  13298. #endif
  13299. handle.stream_ = handle.socket_stream_.get();
  13300. Request req;
  13301. req.method = method;
  13302. req.path = query_path;
  13303. req.headers = headers;
  13304. req.body = body;
  13305. prepare_default_headers(req, true, content_type);
  13306. auto &strm = *handle.stream_;
  13307. // Build the request line and headers in memory first, like write_request()
  13308. // does, so that a rejected header leaves nothing on the wire.
  13309. {
  13310. detail::BufferStream bstrm;
  13311. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  13312. handle.error = Error::Write;
  13313. handle.response.reset();
  13314. return handle;
  13315. }
  13316. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13317. handle.error)) {
  13318. handle.response.reset();
  13319. return handle;
  13320. }
  13321. const auto &data = bstrm.get_buffer();
  13322. if (!detail::write_data(strm, data.data(), data.size())) {
  13323. handle.error = Error::Write;
  13324. handle.response.reset();
  13325. return handle;
  13326. }
  13327. }
  13328. if (!body.empty()) {
  13329. if (strm.write(body.data(), body.size()) < 0) {
  13330. handle.error = Error::Write;
  13331. handle.response.reset();
  13332. return handle;
  13333. }
  13334. }
  13335. if (!read_response_line(strm, req, *handle.response) ||
  13336. !detail::read_headers(strm, handle.response->headers)) {
  13337. handle.error = Error::Read;
  13338. handle.response.reset();
  13339. return handle;
  13340. }
  13341. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  13342. // (204/304) response legitimately carries framing headers with no body.
  13343. if (method != "HEAD" &&
  13344. handle.response->status != StatusCode::NoContent_204 &&
  13345. handle.response->status != StatusCode::NotModified_304 &&
  13346. detail::has_conflicting_content_length(handle.response->headers)) {
  13347. handle.error = Error::Read;
  13348. handle.response.reset();
  13349. return handle;
  13350. }
  13351. handle.body_reader_.stream = handle.stream_;
  13352. handle.body_reader_.payload_max_length = payload_max_length_;
  13353. if (handle.response->has_header("Content-Length")) {
  13354. bool is_invalid = false;
  13355. auto content_length = detail::get_header_value_u64(
  13356. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  13357. if (is_invalid) {
  13358. handle.error = Error::Read;
  13359. handle.response.reset();
  13360. return handle;
  13361. }
  13362. handle.body_reader_.has_content_length = true;
  13363. handle.body_reader_.content_length = content_length;
  13364. }
  13365. handle.body_reader_.chunked =
  13366. detail::is_chunked_transfer_encoding(handle.response->headers);
  13367. auto content_encoding = detail::get_combined_header_value(
  13368. handle.response->headers, "Content-Encoding");
  13369. if (!content_encoding.empty()) {
  13370. // Same policy as prepare_content_receiver(): reject a coding we know about
  13371. // but were not built with, pass an unrecognized one through as-is.
  13372. handle.decompressor_ = detail::create_decompressor(content_encoding);
  13373. if (!handle.decompressor_) {
  13374. if (detail::is_known_content_encoding(content_encoding)) {
  13375. handle.error = Error::UnsupportedContentEncoding;
  13376. handle.response.reset();
  13377. return handle;
  13378. }
  13379. } else if (!handle.decompressor_->is_valid()) {
  13380. handle.error = Error::Compression;
  13381. handle.response.reset();
  13382. return handle;
  13383. }
  13384. }
  13385. return handle;
  13386. }
  13387. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  13388. if (!is_valid() || !response) { return -1; }
  13389. if (decompressor_) { return read_with_decompression(buf, len); }
  13390. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  13391. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  13392. trailers_parsed_ = true;
  13393. if (body_reader_.chunked_decoder) {
  13394. if (!body_reader_.chunked_decoder->parse_trailers_into(
  13395. response->trailers, response->headers)) {
  13396. return n;
  13397. }
  13398. } else {
  13399. detail::ChunkedDecoder dec(*stream_);
  13400. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  13401. return n;
  13402. }
  13403. }
  13404. }
  13405. return n;
  13406. }
  13407. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  13408. size_t len) {
  13409. if (decompress_offset_ < decompress_buffer_.size()) {
  13410. auto available = decompress_buffer_.size() - decompress_offset_;
  13411. auto to_copy = (std::min)(len, available);
  13412. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  13413. decompress_offset_ += to_copy;
  13414. decompressed_bytes_read_ += to_copy;
  13415. return static_cast<ssize_t>(to_copy);
  13416. }
  13417. decompress_buffer_.clear();
  13418. decompress_offset_ = 0;
  13419. constexpr size_t kDecompressionBufferSize = 8192;
  13420. char compressed_buf[kDecompressionBufferSize];
  13421. while (true) {
  13422. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  13423. sizeof(compressed_buf));
  13424. if (n <= 0) { return n; }
  13425. auto exceeded = false;
  13426. bool decompress_ok = decompressor_->decompress(
  13427. compressed_buf, static_cast<size_t>(n),
  13428. [&](const char *data, size_t data_len) {
  13429. decompress_buffer_.append(data, data_len);
  13430. auto limit = body_reader_.payload_max_length;
  13431. exceeded =
  13432. limit > 0 &&
  13433. decompressed_bytes_read_ + decompress_buffer_.size() > limit;
  13434. return !exceeded;
  13435. });
  13436. if (!decompress_ok) {
  13437. body_reader_.last_error =
  13438. exceeded ? Error::ExceedMaxPayloadSize : Error::Read;
  13439. return -1;
  13440. }
  13441. if (!decompress_buffer_.empty()) { break; }
  13442. }
  13443. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13444. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13445. decompress_offset_ = to_copy;
  13446. decompressed_bytes_read_ += to_copy;
  13447. return static_cast<ssize_t>(to_copy);
  13448. }
  13449. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13450. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13451. return;
  13452. }
  13453. trailers_parsed_ = true;
  13454. const auto bufsiz = 128;
  13455. char line_buf[bufsiz];
  13456. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13457. if (!line_reader.getline()) { return; }
  13458. if (!detail::parse_trailers(line_reader, response->trailers,
  13459. response->headers)) {
  13460. return;
  13461. }
  13462. }
  13463. namespace detail {
  13464. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13465. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13466. size_t &out_chunk_offset,
  13467. size_t &out_chunk_total) {
  13468. if (finished) { return 0; }
  13469. if (chunk_remaining == 0) {
  13470. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13471. if (!lr.getline()) { return -1; }
  13472. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13473. // the line terminator is never mistaken for line content.
  13474. const char *eol = lr.ptr() + lr.size();
  13475. if (lr.end_with_crlf()) {
  13476. eol -= 2;
  13477. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13478. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13479. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13480. // has to come off here or the check below would reject the line.
  13481. eol -= 1;
  13482. }
  13483. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13484. const char *p = lr.ptr();
  13485. int v = 0;
  13486. if (p == eol || !is_hex(*p, v)) { return -1; }
  13487. size_t chunk_len = 0;
  13488. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13489. for (; p < eol && is_hex(*p, v); ++p) {
  13490. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13491. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13492. }
  13493. while (p < eol && is_space_or_tab(*p)) {
  13494. ++p;
  13495. }
  13496. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13497. // terminator, and it is built from tokens and quoted-strings, so it never
  13498. // holds a CR, LF or any other control character. getline() reads up to the
  13499. // CRLF, so a bare LF left in here would be swallowed as extension text
  13500. // while an intermediary that ends the line on it delimits the chunks
  13501. // differently, and the two disagree on where the body ends (request
  13502. // smuggling).
  13503. if (p < eol && *p != ';') { return -1; }
  13504. for (; p < eol; ++p) {
  13505. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13506. }
  13507. if (chunk_len == 0) {
  13508. chunk_remaining = 0;
  13509. finished = true;
  13510. out_chunk_offset = 0;
  13511. out_chunk_total = 0;
  13512. return 0;
  13513. }
  13514. chunk_remaining = chunk_len;
  13515. last_chunk_total = chunk_remaining;
  13516. last_chunk_offset = 0;
  13517. }
  13518. auto to_read = (std::min)(chunk_remaining, len);
  13519. auto n = strm.read(buf, to_read);
  13520. if (n <= 0) { return -1; }
  13521. auto offset_before = last_chunk_offset;
  13522. last_chunk_offset += static_cast<size_t>(n);
  13523. chunk_remaining -= static_cast<size_t>(n);
  13524. out_chunk_offset = offset_before;
  13525. out_chunk_total = last_chunk_total;
  13526. if (chunk_remaining == 0) {
  13527. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13528. if (!lr.getline()) { return -1; }
  13529. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13530. }
  13531. return n;
  13532. }
  13533. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13534. const Headers &src_headers) {
  13535. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13536. if (!lr.getline()) { return false; }
  13537. return parse_trailers(lr, dest, src_headers);
  13538. }
  13539. } // namespace detail
  13540. inline void
  13541. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13542. handle.connection_->sock = socket_.sock;
  13543. #ifdef CPPHTTPLIB_SSL_ENABLED
  13544. handle.connection_->session = socket_.ssl;
  13545. socket_.ssl = nullptr;
  13546. #endif
  13547. socket_.sock = INVALID_SOCKET;
  13548. }
  13549. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13550. Response &res, bool close_connection,
  13551. Error &error) {
  13552. if (req.path.empty()) {
  13553. error = Error::Connection;
  13554. output_error_log(error, &req);
  13555. return false;
  13556. }
  13557. auto req_save = req;
  13558. bool ret;
  13559. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13560. auto req2 = req;
  13561. req2.path = "http://" +
  13562. detail::make_host_and_port_string(host_, port_, false) +
  13563. req.path;
  13564. ret = process_request(strm, req2, res, close_connection, error);
  13565. req = std::move(req2);
  13566. req.path = req_save.path;
  13567. } else {
  13568. ret = process_request(strm, req, res, close_connection, error);
  13569. }
  13570. if (!ret) { return false; }
  13571. {
  13572. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13573. // for this to be safe.
  13574. // This is safe to call because handle_request is only called by send_
  13575. // which locks the request mutex during the process. It would be a bug
  13576. // to call it from a different thread since it's a thread-safety issue
  13577. // to do these things to the socket if another thread is using the socket.
  13578. std::lock_guard<std::mutex> guard(socket_mutex_);
  13579. // Also when the request asked for it (e.g. a body that was never sent),
  13580. // so that a redirect or an auth retry below does not reuse the socket.
  13581. if (socket_should_be_closed_when_request_is_done_ ||
  13582. detail::has_header_token(res.headers, "Connection", "close") ||
  13583. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13584. disconnect(/*gracefully=*/true);
  13585. }
  13586. }
  13587. if (300 < res.status && res.status < 400 && follow_location_) {
  13588. req = std::move(req_save);
  13589. // The client that followed the redirect has answered any challenge it
  13590. // could. Retrying below would sign another host's challenge and send it
  13591. // here.
  13592. return redirect(req, res, error);
  13593. }
  13594. #ifdef CPPHTTPLIB_SSL_ENABLED
  13595. if ((res.status == StatusCode::Unauthorized_401 ||
  13596. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13597. req.authorization_count_ < 5) {
  13598. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13599. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13600. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13601. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13602. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13603. return ret;
  13604. }
  13605. const auto &username =
  13606. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13607. const auto &password =
  13608. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13609. if (!username.empty() && !password.empty()) {
  13610. std::map<std::string, std::string> auth;
  13611. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13612. Request new_req = req;
  13613. new_req.authorization_count_ += 1;
  13614. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13615. : "Authorization");
  13616. new_req.headers.insert(detail::make_digest_authentication_header(
  13617. req, auth, new_req.authorization_count_, detail::random_string(10),
  13618. username, password, is_proxy));
  13619. Response new_res;
  13620. ret = send(new_req, new_res, error);
  13621. if (ret) { res = std::move(new_res); }
  13622. }
  13623. }
  13624. }
  13625. #endif
  13626. return ret;
  13627. }
  13628. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13629. if (req.redirect_count_ == 0) {
  13630. error = Error::ExceedRedirectCount;
  13631. output_error_log(error, &req);
  13632. return false;
  13633. }
  13634. auto location = res.get_header_value("location");
  13635. if (location.empty()) { return false; }
  13636. detail::UrlComponents uc;
  13637. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13638. uc)) {
  13639. return false;
  13640. }
  13641. // Only follow http/https redirects
  13642. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13643. return false;
  13644. }
  13645. auto scheme = is_ssl() ? "https" : "http";
  13646. auto next_scheme = std::move(uc.scheme);
  13647. auto next_host = std::move(uc.host);
  13648. auto port_str = std::move(uc.port);
  13649. auto next_path = std::move(uc.path);
  13650. auto next_query = std::move(uc.query);
  13651. auto next_port = port_;
  13652. if (!port_str.empty()) {
  13653. if (!detail::parse_port(port_str, next_port)) { return false; }
  13654. } else if (!next_scheme.empty()) {
  13655. next_port = next_scheme == "https" ? 443 : 80;
  13656. }
  13657. if (next_scheme.empty()) { next_scheme = scheme; }
  13658. if (next_host.empty()) { next_host = host_; }
  13659. if (next_path.empty()) { next_path = "/"; }
  13660. auto path = std::move(next_path) + next_query;
  13661. // Same host redirect - use current client
  13662. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13663. return detail::redirect(*this, req, res, path, location, error);
  13664. }
  13665. // Cross-host/scheme redirect - create new client with robust setup
  13666. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13667. path, location, error);
  13668. }
  13669. // New method for robust redirect client creation
  13670. inline bool ClientImpl::create_redirect_client(
  13671. const std::string &scheme, const std::string &host, int port, Request &req,
  13672. Response &res, const std::string &path, const std::string &location,
  13673. Error &error) {
  13674. // Determine if we need SSL
  13675. auto need_ssl = (scheme == "https");
  13676. // Clean up request headers that are host/client specific
  13677. // Remove headers that should not be carried over to new host
  13678. auto headers_to_remove = std::vector<std::string>{
  13679. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13680. for (const auto &header_name : headers_to_remove) {
  13681. auto it = req.headers.find(header_name);
  13682. while (it != req.headers.end()) {
  13683. it = req.headers.erase(it);
  13684. it = req.headers.find(header_name);
  13685. }
  13686. }
  13687. // Create appropriate client type and handle redirect
  13688. if (need_ssl) {
  13689. #ifdef CPPHTTPLIB_SSL_ENABLED
  13690. // Create SSL client for HTTPS redirect
  13691. SSLClient redirect_client(host, port);
  13692. // Setup basic client configuration first
  13693. setup_redirect_client(redirect_client);
  13694. redirect_client.enable_server_certificate_verification(
  13695. server_certificate_verification_);
  13696. redirect_client.enable_server_hostname_verification(
  13697. server_hostname_verification_);
  13698. redirect_client.system_ca_mode_ = system_ca_mode_;
  13699. // Transfer CA certificate to redirect client
  13700. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13701. ca_cert_pem_.size());
  13702. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13703. if (is_ssl()) {
  13704. auto &self = static_cast<SSLClient &>(*this);
  13705. // A store given to set_ca_cert_store() lives only in this client's
  13706. // context, so pass on the CA certificates the context holds.
  13707. if (self.ca_cert_store_set_) {
  13708. auto pem = detail::ca_certs_to_pem(self.ctx_);
  13709. redirect_client.load_ca_cert_store(pem.data(), pem.size());
  13710. }
  13711. redirect_client.set_session_verifier(self.session_verifier_);
  13712. if (self.server_certificate_verifier_) {
  13713. redirect_client.set_server_certificate_verifier(
  13714. self.server_certificate_verifier_);
  13715. }
  13716. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  13717. redirect_client.enable_windows_cert_verification_ =
  13718. self.enable_windows_cert_verification_;
  13719. #endif
  13720. }
  13721. // Client certificates are set through constructor for SSLClient
  13722. // NOTE: SSLClient constructor already takes client_cert_path and
  13723. // client_key_path so we need to create it properly if client certs are
  13724. // needed
  13725. // Execute the redirect
  13726. return detail::redirect(redirect_client, req, res, path, location, error);
  13727. #else
  13728. // SSL not supported - set appropriate error
  13729. error = Error::SSLConnection;
  13730. output_error_log(error, &req);
  13731. return false;
  13732. #endif
  13733. } else {
  13734. // HTTP redirect
  13735. ClientImpl redirect_client(host, port);
  13736. // Setup client with robust configuration
  13737. setup_redirect_client(redirect_client);
  13738. // Execute the redirect
  13739. return detail::redirect(redirect_client, req, res, path, location, error);
  13740. }
  13741. }
  13742. // New method for robust client setup (based on basic_manual_redirect.cpp
  13743. // logic)
  13744. template <typename ClientType>
  13745. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13746. // Copy basic settings first
  13747. client.set_connection_timeout(connection_timeout_sec_,
  13748. connection_timeout_usec_);
  13749. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13750. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13751. client.set_max_timeout(max_timeout_msec_);
  13752. if (has_payload_max_length_) {
  13753. client.set_payload_max_length(payload_max_length_);
  13754. }
  13755. client.set_keep_alive(keep_alive_);
  13756. client.set_follow_location(
  13757. true); // Enable redirects to handle multi-step redirects
  13758. client.set_path_encode(path_encode_);
  13759. client.set_compress(compress_);
  13760. client.set_decompress(decompress_);
  13761. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13762. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13763. // 15.4, credentials must not be forwarded when redirecting to a different
  13764. // host. This function is only called for cross-host redirects; same-host
  13765. // redirects are handled directly in ClientImpl::redirect().
  13766. // Copy the proxy configuration unconditionally; the per-target bypass is
  13767. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13768. // still use the proxy.
  13769. client.no_proxy_entries_ = no_proxy_entries_;
  13770. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13771. client.set_proxy(proxy_host_, proxy_port_);
  13772. if (!proxy_basic_auth_username_.empty() ||
  13773. !proxy_basic_auth_password_.empty()) {
  13774. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13775. proxy_basic_auth_password_);
  13776. }
  13777. if (!proxy_bearer_token_auth_token_.empty()) {
  13778. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13779. }
  13780. #ifdef CPPHTTPLIB_SSL_ENABLED
  13781. if (!proxy_digest_auth_username_.empty()) {
  13782. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13783. proxy_digest_auth_password_);
  13784. }
  13785. #endif
  13786. }
  13787. // Copy network and socket settings
  13788. client.addr_map_ = addr_map_;
  13789. client.set_address_family(address_family_);
  13790. client.set_tcp_nodelay(tcp_nodelay_);
  13791. client.set_ipv6_v6only(ipv6_v6only_);
  13792. if (socket_options_) { client.set_socket_options(socket_options_); }
  13793. if (!interface_.empty()) { client.set_interface(interface_); }
  13794. // Copy logging and headers
  13795. if (logger_) { client.set_logger(logger_); }
  13796. if (error_logger_) { client.set_error_logger(error_logger_); }
  13797. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13798. // Each new client should generate its own headers based on its target host
  13799. }
  13800. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13801. const Request &req,
  13802. Error &error) const {
  13803. auto is_shutting_down = []() { return false; };
  13804. if (req.is_chunked_content_provider_) {
  13805. auto compressor = compress_ ? detail::create_compressor().first
  13806. : std::unique_ptr<detail::compressor>();
  13807. if (!compressor) {
  13808. compressor = detail::make_unique<detail::nocompressor>();
  13809. }
  13810. return detail::write_content_chunked(strm, req.content_provider_,
  13811. is_shutting_down, *compressor, error);
  13812. } else {
  13813. return detail::write_content_with_progress(
  13814. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13815. req.upload_progress, error);
  13816. }
  13817. }
  13818. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13819. bool close_connection, Error &error,
  13820. bool skip_body, bool &rejected_locally) {
  13821. rejected_locally = false;
  13822. // Prepare additional headers
  13823. if (close_connection) {
  13824. if (!req.has_header("Connection")) {
  13825. req.set_header("Connection", "close");
  13826. }
  13827. }
  13828. std::string ct_for_defaults;
  13829. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13830. ct_for_defaults = "text/plain";
  13831. }
  13832. prepare_default_headers(req, false, ct_for_defaults);
  13833. if (req.body.empty()) {
  13834. if (req.content_provider_) {
  13835. if (!req.is_chunked_content_provider_) {
  13836. if (!req.has_header("Content-Length")) {
  13837. auto length = std::to_string(req.content_length_);
  13838. req.set_header("Content-Length", length);
  13839. }
  13840. }
  13841. } else {
  13842. if (req.method == "POST" || req.method == "PUT" ||
  13843. req.method == "PATCH") {
  13844. req.set_header("Content-Length", "0");
  13845. }
  13846. }
  13847. }
  13848. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13849. // it opens is read by the origin. Each credential goes only to its own hop.
  13850. auto is_connect = req.method == "CONNECT";
  13851. if (!is_connect && !req.has_header("Authorization")) {
  13852. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13853. req.headers.insert(make_basic_authentication_header(
  13854. basic_auth_username_, basic_auth_password_, false));
  13855. } else if (!bearer_token_auth_token_.empty()) {
  13856. req.headers.insert(make_bearer_token_authentication_header(
  13857. bearer_token_auth_token_, false));
  13858. }
  13859. }
  13860. // Proxy-Authorization is only sent when the proxy reads this message —
  13861. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13862. // would leak proxy credentials to the destination server.
  13863. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13864. if ((!proxy_basic_auth_username_.empty() ||
  13865. !proxy_basic_auth_password_.empty()) &&
  13866. !req.has_header("Proxy-Authorization")) {
  13867. req.headers.insert(make_basic_authentication_header(
  13868. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13869. }
  13870. if (!proxy_bearer_token_auth_token_.empty() &&
  13871. !req.has_header("Proxy-Authorization")) {
  13872. req.headers.insert(make_bearer_token_authentication_header(
  13873. proxy_bearer_token_auth_token_, true));
  13874. }
  13875. }
  13876. // Request line and headers
  13877. {
  13878. detail::BufferStream bstrm;
  13879. // Extract the query from req.path. The encoding itself is delegated to
  13880. // `encode_request_target`; the raw query is still needed here to decide
  13881. // between populating `req.params` from it and falling back to building a
  13882. // query out of caller-supplied `req.params`.
  13883. // The fragment, which is not sent, is not part of the query.
  13884. auto target = req.path.substr(0, req.path.find('#'));
  13885. auto query_pos = target.find('?');
  13886. auto query_part = query_pos == std::string::npos
  13887. ? std::string()
  13888. : target.substr(query_pos + 1);
  13889. auto path_with_query =
  13890. detail::encode_request_target(req.path, path_encode_);
  13891. if (!query_part.empty()) {
  13892. // The query already came in through `req.path`; still populate
  13893. // `req.params` for handlers/users who read them.
  13894. detail::parse_query_text(query_part, req.params);
  13895. } else if (!req.params.empty()) {
  13896. // No query in `req.path`; build one from `req.params` so existing
  13897. // callers that pass `Params` separately continue to work.
  13898. path_with_query = append_query_params(path_with_query, req.params);
  13899. }
  13900. // Write request line and headers
  13901. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13902. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13903. // CR/LF in a caller-supplied path under set_path_encode(false)) must
  13904. // fail the request cleanly instead of emitting a request-line-less,
  13905. // header-injecting request.
  13906. error = Error::Write;
  13907. rejected_locally = true;
  13908. output_error_log(error, &req);
  13909. return false;
  13910. }
  13911. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13912. error)) {
  13913. rejected_locally = true;
  13914. output_error_log(error, &req);
  13915. return false;
  13916. }
  13917. // Flush buffer
  13918. auto &data = bstrm.get_buffer();
  13919. if (!detail::write_data(strm, data.data(), data.size())) {
  13920. error = Error::Write;
  13921. output_error_log(error, &req);
  13922. return false;
  13923. }
  13924. }
  13925. // After sending request line and headers, wait briefly for an early server
  13926. // response (e.g. 4xx) and avoid sending a potentially large request body
  13927. // unnecessarily. This workaround is only enabled on Windows because Unix
  13928. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13929. // buffering can accept large writes even when the peer already responded.
  13930. // Check the stream first (which covers SSL via `is_readable()`), then
  13931. // fall back to select on the socket. Only perform the wait for very large
  13932. // request bodies to avoid interfering with normal small requests and
  13933. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13934. // response. Skip this check when using Expect: 100-continue, as the protocol
  13935. // handles early responses properly.
  13936. #if defined(_WIN32)
  13937. if (!skip_body &&
  13938. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13939. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13940. auto start = std::chrono::high_resolution_clock::now();
  13941. for (;;) {
  13942. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13943. // from SSL internals. If the underlying socket is readable, assume an
  13944. // early response may be present.
  13945. auto sock = strm.socket();
  13946. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13947. return false;
  13948. }
  13949. // Fallback to stream-level check for non-socket streams or when the
  13950. // socket isn't reporting readable. Avoid using `is_readable()` for
  13951. // SSL, since `SSL_pending()` may report buffered records that do not
  13952. // indicate a complete application-level response yet.
  13953. if (!is_ssl() && strm.is_readable()) { return false; }
  13954. auto now = std::chrono::high_resolution_clock::now();
  13955. auto elapsed =
  13956. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13957. .count();
  13958. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13959. break;
  13960. }
  13961. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13962. }
  13963. }
  13964. #endif
  13965. // Body
  13966. if (skip_body) { return true; }
  13967. return write_request_body(strm, req, error);
  13968. }
  13969. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13970. Error &error) {
  13971. if (req.body.empty()) {
  13972. return write_content_with_provider(strm, req, error);
  13973. }
  13974. if (req.upload_progress) {
  13975. auto body_size = req.body.size();
  13976. size_t written = 0;
  13977. auto data = req.body.data();
  13978. while (written < body_size) {
  13979. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13980. if (!detail::write_data(strm, data + written, to_write)) {
  13981. error = Error::Write;
  13982. output_error_log(error, &req);
  13983. return false;
  13984. }
  13985. written += to_write;
  13986. if (!req.upload_progress(written, body_size)) {
  13987. error = Error::Canceled;
  13988. output_error_log(error, &req);
  13989. return false;
  13990. }
  13991. }
  13992. } else {
  13993. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13994. error = Error::Write;
  13995. output_error_log(error, &req);
  13996. return false;
  13997. }
  13998. }
  13999. return true;
  14000. }
  14001. inline std::unique_ptr<Response>
  14002. ClientImpl::send_with_content_provider_and_receiver(
  14003. Request &req, const char *body, size_t content_length,
  14004. ContentProvider content_provider,
  14005. ContentProviderWithoutLength content_provider_without_length,
  14006. const std::string &content_type, ContentReceiver content_receiver,
  14007. Error &error) {
  14008. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14009. auto enc = compress_
  14010. ? detail::create_compressor()
  14011. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  14012. nullptr, nullptr);
  14013. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  14014. if (enc.first && !content_provider_without_length) {
  14015. auto &compressor = enc.first;
  14016. if (content_provider) {
  14017. auto ok = true;
  14018. auto finished = false;
  14019. size_t offset = 0;
  14020. DataSink data_sink;
  14021. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  14022. if (ok) {
  14023. auto last = offset + data_len == content_length;
  14024. auto ret = compressor->compress(
  14025. data, data_len, last,
  14026. [&](const char *compressed_data, size_t compressed_data_len) {
  14027. req.body.append(compressed_data, compressed_data_len);
  14028. return true;
  14029. });
  14030. if (ret) {
  14031. offset += data_len;
  14032. } else {
  14033. ok = false;
  14034. }
  14035. }
  14036. return ok;
  14037. };
  14038. // As in detail::write_content_with_progress(): the body is framed by
  14039. // content_length, so a provider that finishes early has truncated it.
  14040. // Stop and report that instead of calling the provider forever.
  14041. data_sink.done = [&]() { finished = true; };
  14042. while (ok && !finished && offset < content_length) {
  14043. if (!content_provider(offset, content_length - offset, data_sink)) {
  14044. error = Error::Canceled;
  14045. output_error_log(error, &req);
  14046. return nullptr;
  14047. }
  14048. }
  14049. // A short body here means either the provider stopped early or the
  14050. // compressor gave up. The branch below reports a failing compressor as
  14051. // Error::Compression, so keep the two distinguishable.
  14052. if (offset < content_length) {
  14053. error = ok ? Error::Write : Error::Compression;
  14054. output_error_log(error, &req);
  14055. return nullptr;
  14056. }
  14057. } else {
  14058. if (!compressor->compress(body, content_length, true,
  14059. [&](const char *data, size_t data_len) {
  14060. req.body.append(data, data_len);
  14061. return true;
  14062. })) {
  14063. error = Error::Compression;
  14064. output_error_log(error, &req);
  14065. return nullptr;
  14066. }
  14067. }
  14068. } else {
  14069. if (content_provider) {
  14070. req.content_length_ = content_length;
  14071. req.content_provider_ = std::move(content_provider);
  14072. req.is_chunked_content_provider_ = false;
  14073. } else if (content_provider_without_length) {
  14074. req.content_length_ = 0;
  14075. req.content_provider_ = detail::ContentProviderAdapter(
  14076. std::move(content_provider_without_length));
  14077. req.is_chunked_content_provider_ = true;
  14078. req.set_header("Transfer-Encoding", "chunked");
  14079. } else {
  14080. req.body.assign(body, content_length);
  14081. }
  14082. }
  14083. if (content_receiver) {
  14084. req.content_receiver =
  14085. [content_receiver](const char *data, size_t data_length,
  14086. size_t /*offset*/, size_t /*total_length*/) {
  14087. return content_receiver(data, data_length);
  14088. };
  14089. }
  14090. auto res = detail::make_unique<Response>();
  14091. return send(req, *res, error) ? std::move(res) : nullptr;
  14092. }
  14093. inline Result ClientImpl::send_with_content_provider_and_receiver(
  14094. const std::string &method, const std::string &path, const Headers &headers,
  14095. const char *body, size_t content_length, ContentProvider content_provider,
  14096. ContentProviderWithoutLength content_provider_without_length,
  14097. const std::string &content_type, ContentReceiver content_receiver,
  14098. UploadProgress progress) {
  14099. Request req;
  14100. req.method = method;
  14101. req.headers = headers;
  14102. req.path = path;
  14103. req.upload_progress = std::move(progress);
  14104. if (max_timeout_msec_ > 0) {
  14105. req.start_time_ = std::chrono::steady_clock::now();
  14106. }
  14107. auto error = Error::Success;
  14108. auto res = send_with_content_provider_and_receiver(
  14109. req, body, content_length, std::move(content_provider),
  14110. std::move(content_provider_without_length), content_type,
  14111. std::move(content_receiver), error);
  14112. #ifdef CPPHTTPLIB_SSL_ENABLED
  14113. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  14114. last_backend_error_};
  14115. #else
  14116. return Result{std::move(res), error, std::move(req.headers)};
  14117. #endif
  14118. }
  14119. inline void ClientImpl::output_log(const Request &req,
  14120. const Response &res) const {
  14121. if (logger_) {
  14122. std::lock_guard<std::mutex> guard(logger_mutex_);
  14123. logger_(req, res);
  14124. }
  14125. }
  14126. inline void ClientImpl::output_error_log(const Error &err,
  14127. const Request *req) const {
  14128. if (error_logger_) {
  14129. std::lock_guard<std::mutex> guard(logger_mutex_);
  14130. error_logger_(err, req);
  14131. }
  14132. }
  14133. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  14134. Response &res, bool close_connection,
  14135. Error &error) {
  14136. // Auto-add Expect: 100-continue for large bodies
  14137. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  14138. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  14139. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  14140. req.set_header("Expect", "100-continue");
  14141. }
  14142. }
  14143. // Check for Expect: 100-continue
  14144. auto expect_100_continue =
  14145. detail::has_header_token(req.headers, "Expect", "100-continue");
  14146. // Send request (skip body if using Expect: 100-continue)
  14147. auto rejected_locally = false;
  14148. auto write_request_success =
  14149. write_request(strm, req, close_connection, error, expect_100_continue,
  14150. rejected_locally);
  14151. // A failed write normally still reads the response below, since the server
  14152. // may have answered early (e.g. 413/414) and closed while the body was being
  14153. // sent. A request rejected before any byte reached the socket gets no such
  14154. // response, and waiting for one would block until the read timeout.
  14155. if (rejected_locally) { return false; }
  14156. #ifdef CPPHTTPLIB_SSL_ENABLED
  14157. if (is_ssl() && !expect_100_continue) {
  14158. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  14159. if (!is_proxy_enabled) {
  14160. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  14161. error = Error::SSLPeerCouldBeClosed_;
  14162. output_error_log(error, &req);
  14163. return false;
  14164. }
  14165. }
  14166. }
  14167. #endif
  14168. // Handle Expect: 100-continue.
  14169. //
  14170. // Wait for an interim/early response by attempting to read the status line
  14171. // under a short timeout, instead of trusting raw socket readability. Over
  14172. // TLS, post-handshake records (e.g. session tickets) make the socket
  14173. // readable without any HTTP response being available; relying on
  14174. // `select_read` there caused the body to be withheld forever and the
  14175. // request to fail with `Read` (#2458). If no status line arrives within the
  14176. // timeout, send the body anyway (matching curl's behavior).
  14177. auto status_line_read = false;
  14178. if (expect_100_continue && write_request_success) {
  14179. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  14180. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  14181. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  14182. strm.set_read_timeout(sec, usec);
  14183. status_line_read = read_response_line(strm, req, res, false);
  14184. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  14185. }
  14186. if (!status_line_read) {
  14187. // No interim response within the timeout: send the body and handle the
  14188. // response as usual.
  14189. if (!write_request_body(strm, req, error)) { return false; }
  14190. expect_100_continue = false; // Switch to normal response handling
  14191. }
  14192. }
  14193. // Receive response and headers
  14194. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  14195. if ((!status_line_read &&
  14196. !read_response_line(strm, req, res, !expect_100_continue)) ||
  14197. !detail::read_headers(strm, res.headers)) {
  14198. if (write_request_success) { error = Error::Read; }
  14199. output_error_log(error, &req);
  14200. return false;
  14201. }
  14202. if (!write_request_success) { return false; }
  14203. // Handle Expect: 100-continue response
  14204. if (expect_100_continue) {
  14205. if (res.status == StatusCode::Continue_100) {
  14206. // Server accepted, send the body
  14207. if (!write_request_body(strm, req, error)) { return false; }
  14208. // Read the actual response
  14209. res.headers.clear();
  14210. res.body.clear();
  14211. if (!read_response_line(strm, req, res) ||
  14212. !detail::read_headers(strm, res.headers)) {
  14213. error = Error::Read;
  14214. output_error_log(error, &req);
  14215. return false;
  14216. }
  14217. } else {
  14218. // A final response came first, so the body this request declared was
  14219. // never sent, and the server may still be waiting for it. The
  14220. // connection cannot carry another request.
  14221. std::lock_guard<std::mutex> guard(socket_mutex_);
  14222. socket_should_be_closed_when_request_is_done_ = true;
  14223. }
  14224. }
  14225. // Body
  14226. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  14227. req.method != "CONNECT") {
  14228. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  14229. // whose final transfer coding is not chunked is not ambiguous: its body
  14230. // runs until the server closes the connection, so it is not rejected.
  14231. // HEAD/204 are excluded above and a 304 carries no body.
  14232. if (res.status != StatusCode::NotModified_304) {
  14233. if (detail::has_conflicting_content_length(res.headers)) {
  14234. error = Error::Read;
  14235. output_error_log(error, &req);
  14236. return false;
  14237. }
  14238. if (detail::has_faulty_transfer_encoding(res)) {
  14239. std::lock_guard<std::mutex> guard(socket_mutex_);
  14240. socket_should_be_closed_when_request_is_done_ = true;
  14241. }
  14242. }
  14243. auto redirect = 300 < res.status && res.status < 400 &&
  14244. res.status != StatusCode::NotModified_304 &&
  14245. follow_location_;
  14246. if (req.response_handler && !redirect) {
  14247. if (!req.response_handler(res)) {
  14248. error = Error::Canceled;
  14249. output_error_log(error, &req);
  14250. return false;
  14251. }
  14252. }
  14253. auto out =
  14254. req.content_receiver
  14255. ? static_cast<ContentReceiverWithProgress>(
  14256. [&](const char *buf, size_t n, size_t off, size_t len) {
  14257. if (redirect) { return true; }
  14258. auto ret = req.content_receiver(buf, n, off, len);
  14259. if (!ret) {
  14260. error = Error::Canceled;
  14261. output_error_log(error, &req);
  14262. }
  14263. return ret;
  14264. })
  14265. : static_cast<ContentReceiverWithProgress>(
  14266. [&](const char *buf, size_t n, size_t /*off*/,
  14267. size_t /*len*/) {
  14268. assert(res.body.size() + n <= res.body.max_size());
  14269. if (payload_max_length_ > 0 &&
  14270. (res.body.size() >= payload_max_length_ ||
  14271. n > payload_max_length_ - res.body.size())) {
  14272. return false;
  14273. }
  14274. res.body.append(buf, n);
  14275. return true;
  14276. });
  14277. auto progress = [&](size_t current, size_t total) {
  14278. if (!req.download_progress || redirect) { return true; }
  14279. auto ret = req.download_progress(current, total);
  14280. if (!ret) {
  14281. error = Error::Canceled;
  14282. output_error_log(error, &req);
  14283. }
  14284. return ret;
  14285. };
  14286. if (res.has_header("Content-Length")) {
  14287. if (!req.content_receiver) {
  14288. auto len = res.get_header_value_u64("Content-Length");
  14289. if (len > res.body.max_size()) {
  14290. error = Error::Read;
  14291. output_error_log(error, &req);
  14292. return false;
  14293. }
  14294. // Content-Length is only the server's claim, so reserve no more than
  14295. // payload_max_length_ allows, nor more than 1 MiB before any of the
  14296. // body has arrived. A longer body grows as it is read.
  14297. auto reserve_len =
  14298. (std::min)(static_cast<size_t>(len), size_t(1024 * 1024));
  14299. if (payload_max_length_ > 0) {
  14300. reserve_len = (std::min)(reserve_len, payload_max_length_);
  14301. }
  14302. res.body.reserve(reserve_len);
  14303. }
  14304. }
  14305. if (res.status != StatusCode::NotModified_304) {
  14306. auto content_status = 0;
  14307. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  14308. ? (std::numeric_limits<size_t>::max)()
  14309. : payload_max_length_;
  14310. if (!detail::read_content(strm, res, max_length, content_status,
  14311. std::move(progress), std::move(out),
  14312. decompress_)) {
  14313. if (error != Error::Canceled) {
  14314. // Tell the caller apart from a plain read failure when the body could
  14315. // not be decoded because of its Content-Encoding.
  14316. switch (content_status) {
  14317. case StatusCode::UnsupportedMediaType_415:
  14318. error = Error::UnsupportedContentEncoding;
  14319. break;
  14320. case StatusCode::InternalServerError_500:
  14321. error = Error::Compression;
  14322. break;
  14323. default: error = Error::Read; break;
  14324. }
  14325. }
  14326. output_error_log(error, &req);
  14327. return false;
  14328. }
  14329. }
  14330. }
  14331. // Log
  14332. output_log(req, res);
  14333. return true;
  14334. }
  14335. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  14336. const std::string &boundary, const UploadFormDataItems &items,
  14337. const FormDataProviderItems &provider_items) const {
  14338. size_t cur_item = 0;
  14339. size_t cur_start = 0;
  14340. // cur_item and cur_start are copied to within the std::function and
  14341. // maintain state between successive calls
  14342. return [&, cur_item, cur_start](size_t offset,
  14343. DataSink &sink) mutable -> bool {
  14344. if (!offset && !items.empty()) {
  14345. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  14346. return true;
  14347. } else if (cur_item < provider_items.size()) {
  14348. if (!cur_start) {
  14349. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  14350. provider_items[cur_item], boundary);
  14351. offset += begin.size();
  14352. cur_start = offset;
  14353. sink.os << begin;
  14354. }
  14355. DataSink cur_sink;
  14356. auto has_data = true;
  14357. cur_sink.write = sink.write;
  14358. // Forward is_writable so a provider item asking whether it may keep
  14359. // going gets the outer sink's answer rather than the default `true`.
  14360. cur_sink.is_writable = sink.is_writable;
  14361. cur_sink.done = [&]() { has_data = false; };
  14362. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  14363. return false;
  14364. }
  14365. if (!has_data) {
  14366. sink.os << detail::serialize_multipart_formdata_item_end();
  14367. cur_item++;
  14368. cur_start = 0;
  14369. }
  14370. return true;
  14371. } else {
  14372. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  14373. sink.done();
  14374. return true;
  14375. }
  14376. };
  14377. }
  14378. inline bool ClientImpl::process_socket(
  14379. const Socket &socket,
  14380. std::chrono::time_point<std::chrono::steady_clock> start_time,
  14381. std::function<bool(Stream &strm)> callback) {
  14382. return detail::process_client_socket(
  14383. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  14384. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  14385. }
  14386. inline bool ClientImpl::is_ssl() const { return false; }
  14387. inline Result ClientImpl::Get(const std::string &path,
  14388. DownloadProgress progress) {
  14389. return Get(path, Headers(), std::move(progress));
  14390. }
  14391. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14392. DownloadProgress progress) {
  14393. return Get(path, params, Headers(), std::move(progress));
  14394. }
  14395. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14396. const Headers &headers,
  14397. DownloadProgress progress) {
  14398. if (params.empty()) { return Get(path, headers); }
  14399. std::string path_with_query = append_query_params(path, params);
  14400. return Get(path_with_query, headers, std::move(progress));
  14401. }
  14402. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14403. DownloadProgress progress) {
  14404. Request req;
  14405. req.method = "GET";
  14406. req.path = path;
  14407. req.headers = headers;
  14408. req.download_progress = std::move(progress);
  14409. if (max_timeout_msec_ > 0) {
  14410. req.start_time_ = std::chrono::steady_clock::now();
  14411. }
  14412. return send_(std::move(req));
  14413. }
  14414. inline Result ClientImpl::Get(const std::string &path,
  14415. ContentReceiver content_receiver,
  14416. DownloadProgress progress) {
  14417. return Get(path, Headers(), nullptr, std::move(content_receiver),
  14418. std::move(progress));
  14419. }
  14420. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14421. ContentReceiver content_receiver,
  14422. DownloadProgress progress) {
  14423. return Get(path, headers, nullptr, std::move(content_receiver),
  14424. std::move(progress));
  14425. }
  14426. inline Result ClientImpl::Get(const std::string &path,
  14427. ResponseHandler response_handler,
  14428. ContentReceiver content_receiver,
  14429. DownloadProgress progress) {
  14430. return Get(path, Headers(), std::move(response_handler),
  14431. std::move(content_receiver), std::move(progress));
  14432. }
  14433. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  14434. ResponseHandler response_handler,
  14435. ContentReceiver content_receiver,
  14436. DownloadProgress progress) {
  14437. Request req;
  14438. req.method = "GET";
  14439. req.path = path;
  14440. req.headers = headers;
  14441. req.response_handler = std::move(response_handler);
  14442. req.content_receiver =
  14443. [content_receiver](const char *data, size_t data_length,
  14444. size_t /*offset*/, size_t /*total_length*/) {
  14445. return content_receiver(data, data_length);
  14446. };
  14447. req.download_progress = std::move(progress);
  14448. if (max_timeout_msec_ > 0) {
  14449. req.start_time_ = std::chrono::steady_clock::now();
  14450. }
  14451. return send_(std::move(req));
  14452. }
  14453. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14454. const Headers &headers,
  14455. ContentReceiver content_receiver,
  14456. DownloadProgress progress) {
  14457. return Get(path, params, headers, nullptr, std::move(content_receiver),
  14458. std::move(progress));
  14459. }
  14460. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  14461. const Headers &headers,
  14462. ResponseHandler response_handler,
  14463. ContentReceiver content_receiver,
  14464. DownloadProgress progress) {
  14465. if (params.empty()) {
  14466. return Get(path, headers, std::move(response_handler),
  14467. std::move(content_receiver), std::move(progress));
  14468. }
  14469. std::string path_with_query = append_query_params(path, params);
  14470. return Get(path_with_query, headers, std::move(response_handler),
  14471. std::move(content_receiver), std::move(progress));
  14472. }
  14473. inline Result ClientImpl::Head(const std::string &path) {
  14474. return Head(path, Headers());
  14475. }
  14476. inline Result ClientImpl::Head(const std::string &path,
  14477. const Headers &headers) {
  14478. Request req;
  14479. req.method = "HEAD";
  14480. req.headers = headers;
  14481. req.path = path;
  14482. if (max_timeout_msec_ > 0) {
  14483. req.start_time_ = std::chrono::steady_clock::now();
  14484. }
  14485. return send_(std::move(req));
  14486. }
  14487. inline Result ClientImpl::Post(const std::string &path) {
  14488. return Post(path, std::string(), std::string());
  14489. }
  14490. inline Result ClientImpl::Post(const std::string &path,
  14491. const Headers &headers) {
  14492. return Post(path, headers, nullptr, 0, std::string());
  14493. }
  14494. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14495. size_t content_length,
  14496. const std::string &content_type,
  14497. UploadProgress progress) {
  14498. return Post(path, Headers(), body, content_length, content_type, progress);
  14499. }
  14500. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14501. const std::string &content_type,
  14502. UploadProgress progress) {
  14503. return Post(path, Headers(), body, content_type, progress);
  14504. }
  14505. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14506. return Post(path, Headers(), params);
  14507. }
  14508. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14509. ContentProvider content_provider,
  14510. const std::string &content_type,
  14511. UploadProgress progress) {
  14512. return Post(path, Headers(), content_length, std::move(content_provider),
  14513. content_type, progress);
  14514. }
  14515. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14516. ContentProvider content_provider,
  14517. const std::string &content_type,
  14518. ContentReceiver content_receiver,
  14519. UploadProgress progress) {
  14520. return Post(path, Headers(), content_length, std::move(content_provider),
  14521. content_type, std::move(content_receiver), progress);
  14522. }
  14523. inline Result ClientImpl::Post(const std::string &path,
  14524. ContentProviderWithoutLength content_provider,
  14525. const std::string &content_type,
  14526. UploadProgress progress) {
  14527. return Post(path, Headers(), std::move(content_provider), content_type,
  14528. progress);
  14529. }
  14530. inline Result ClientImpl::Post(const std::string &path,
  14531. ContentProviderWithoutLength content_provider,
  14532. const std::string &content_type,
  14533. ContentReceiver content_receiver,
  14534. UploadProgress progress) {
  14535. return Post(path, Headers(), std::move(content_provider), content_type,
  14536. std::move(content_receiver), progress);
  14537. }
  14538. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14539. const Params &params) {
  14540. auto query = detail::params_to_query_str(params);
  14541. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14542. }
  14543. inline Result ClientImpl::Post(const std::string &path,
  14544. const UploadFormDataItems &items,
  14545. UploadProgress progress) {
  14546. return Post(path, Headers(), items, progress);
  14547. }
  14548. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14549. const UploadFormDataItems &items,
  14550. UploadProgress progress) {
  14551. const auto &boundary = detail::make_multipart_data_boundary();
  14552. const auto &content_type =
  14553. detail::serialize_multipart_formdata_get_content_type(boundary);
  14554. auto content_length = detail::get_multipart_content_length(items, boundary);
  14555. return Post(path, headers, content_length,
  14556. detail::make_multipart_content_provider(items, boundary),
  14557. content_type, progress);
  14558. }
  14559. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14560. const UploadFormDataItems &items,
  14561. const std::string &boundary,
  14562. UploadProgress progress) {
  14563. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14564. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14565. }
  14566. const auto &content_type =
  14567. detail::serialize_multipart_formdata_get_content_type(boundary);
  14568. auto content_length = detail::get_multipart_content_length(items, boundary);
  14569. return Post(path, headers, content_length,
  14570. detail::make_multipart_content_provider(items, boundary),
  14571. content_type, progress);
  14572. }
  14573. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14574. const char *body, size_t content_length,
  14575. const std::string &content_type,
  14576. UploadProgress progress) {
  14577. return send_with_content_provider_and_receiver(
  14578. "POST", path, headers, body, content_length, nullptr, nullptr,
  14579. content_type, nullptr, progress);
  14580. }
  14581. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14582. const std::string &body,
  14583. const std::string &content_type,
  14584. UploadProgress progress) {
  14585. return send_with_content_provider_and_receiver(
  14586. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14587. content_type, nullptr, progress);
  14588. }
  14589. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14590. size_t content_length,
  14591. ContentProvider content_provider,
  14592. const std::string &content_type,
  14593. UploadProgress progress) {
  14594. return send_with_content_provider_and_receiver(
  14595. "POST", path, headers, nullptr, content_length,
  14596. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14597. }
  14598. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14599. size_t content_length,
  14600. ContentProvider content_provider,
  14601. const std::string &content_type,
  14602. ContentReceiver content_receiver,
  14603. DownloadProgress progress) {
  14604. return send_with_content_provider_and_receiver(
  14605. "POST", path, headers, nullptr, content_length,
  14606. std::move(content_provider), nullptr, content_type,
  14607. std::move(content_receiver), std::move(progress));
  14608. }
  14609. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14610. ContentProviderWithoutLength content_provider,
  14611. const std::string &content_type,
  14612. UploadProgress progress) {
  14613. return send_with_content_provider_and_receiver(
  14614. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14615. content_type, nullptr, progress);
  14616. }
  14617. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14618. ContentProviderWithoutLength content_provider,
  14619. const std::string &content_type,
  14620. ContentReceiver content_receiver,
  14621. DownloadProgress progress) {
  14622. return send_with_content_provider_and_receiver(
  14623. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14624. content_type, std::move(content_receiver), std::move(progress));
  14625. }
  14626. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14627. const UploadFormDataItems &items,
  14628. const FormDataProviderItems &provider_items,
  14629. UploadProgress progress) {
  14630. const auto &boundary = detail::make_multipart_data_boundary();
  14631. const auto &content_type =
  14632. detail::serialize_multipart_formdata_get_content_type(boundary);
  14633. return send_with_content_provider_and_receiver(
  14634. "POST", path, headers, nullptr, 0, nullptr,
  14635. get_multipart_content_provider(boundary, items, provider_items),
  14636. content_type, nullptr, progress);
  14637. }
  14638. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14639. const std::string &body,
  14640. const std::string &content_type,
  14641. ContentReceiver content_receiver,
  14642. DownloadProgress progress) {
  14643. Request req;
  14644. req.method = "POST";
  14645. req.path = path;
  14646. req.headers = headers;
  14647. req.body = body;
  14648. req.content_receiver =
  14649. [content_receiver](const char *data, size_t data_length,
  14650. size_t /*offset*/, size_t /*total_length*/) {
  14651. return content_receiver(data, data_length);
  14652. };
  14653. req.download_progress = std::move(progress);
  14654. if (max_timeout_msec_ > 0) {
  14655. req.start_time_ = std::chrono::steady_clock::now();
  14656. }
  14657. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14658. return send_(std::move(req));
  14659. }
  14660. inline Result ClientImpl::Put(const std::string &path) {
  14661. return Put(path, std::string(), std::string());
  14662. }
  14663. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14664. return Put(path, headers, nullptr, 0, std::string());
  14665. }
  14666. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14667. size_t content_length,
  14668. const std::string &content_type,
  14669. UploadProgress progress) {
  14670. return Put(path, Headers(), body, content_length, content_type, progress);
  14671. }
  14672. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14673. const std::string &content_type,
  14674. UploadProgress progress) {
  14675. return Put(path, Headers(), body, content_type, progress);
  14676. }
  14677. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14678. return Put(path, Headers(), params);
  14679. }
  14680. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14681. ContentProvider content_provider,
  14682. const std::string &content_type,
  14683. UploadProgress progress) {
  14684. return Put(path, Headers(), content_length, std::move(content_provider),
  14685. content_type, progress);
  14686. }
  14687. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14688. ContentProvider content_provider,
  14689. const std::string &content_type,
  14690. ContentReceiver content_receiver,
  14691. UploadProgress progress) {
  14692. return Put(path, Headers(), content_length, std::move(content_provider),
  14693. content_type, std::move(content_receiver), progress);
  14694. }
  14695. inline Result ClientImpl::Put(const std::string &path,
  14696. ContentProviderWithoutLength content_provider,
  14697. const std::string &content_type,
  14698. UploadProgress progress) {
  14699. return Put(path, Headers(), std::move(content_provider), content_type,
  14700. progress);
  14701. }
  14702. inline Result ClientImpl::Put(const std::string &path,
  14703. ContentProviderWithoutLength content_provider,
  14704. const std::string &content_type,
  14705. ContentReceiver content_receiver,
  14706. UploadProgress progress) {
  14707. return Put(path, Headers(), std::move(content_provider), content_type,
  14708. std::move(content_receiver), progress);
  14709. }
  14710. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14711. const Params &params) {
  14712. auto query = detail::params_to_query_str(params);
  14713. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14714. }
  14715. inline Result ClientImpl::Put(const std::string &path,
  14716. const UploadFormDataItems &items,
  14717. UploadProgress progress) {
  14718. return Put(path, Headers(), items, progress);
  14719. }
  14720. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14721. const UploadFormDataItems &items,
  14722. UploadProgress progress) {
  14723. const auto &boundary = detail::make_multipart_data_boundary();
  14724. const auto &content_type =
  14725. detail::serialize_multipart_formdata_get_content_type(boundary);
  14726. auto content_length = detail::get_multipart_content_length(items, boundary);
  14727. return Put(path, headers, content_length,
  14728. detail::make_multipart_content_provider(items, boundary),
  14729. content_type, progress);
  14730. }
  14731. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14732. const UploadFormDataItems &items,
  14733. const std::string &boundary,
  14734. UploadProgress progress) {
  14735. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14736. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14737. }
  14738. const auto &content_type =
  14739. detail::serialize_multipart_formdata_get_content_type(boundary);
  14740. auto content_length = detail::get_multipart_content_length(items, boundary);
  14741. return Put(path, headers, content_length,
  14742. detail::make_multipart_content_provider(items, boundary),
  14743. content_type, progress);
  14744. }
  14745. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14746. const char *body, size_t content_length,
  14747. const std::string &content_type,
  14748. UploadProgress progress) {
  14749. return send_with_content_provider_and_receiver(
  14750. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14751. content_type, nullptr, progress);
  14752. }
  14753. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14754. const std::string &body,
  14755. const std::string &content_type,
  14756. UploadProgress progress) {
  14757. return send_with_content_provider_and_receiver(
  14758. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14759. content_type, nullptr, progress);
  14760. }
  14761. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14762. size_t content_length,
  14763. ContentProvider content_provider,
  14764. const std::string &content_type,
  14765. UploadProgress progress) {
  14766. return send_with_content_provider_and_receiver(
  14767. "PUT", path, headers, nullptr, content_length,
  14768. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14769. }
  14770. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14771. size_t content_length,
  14772. ContentProvider content_provider,
  14773. const std::string &content_type,
  14774. ContentReceiver content_receiver,
  14775. UploadProgress progress) {
  14776. return send_with_content_provider_and_receiver(
  14777. "PUT", path, headers, nullptr, content_length,
  14778. std::move(content_provider), nullptr, content_type,
  14779. std::move(content_receiver), progress);
  14780. }
  14781. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14782. ContentProviderWithoutLength content_provider,
  14783. const std::string &content_type,
  14784. UploadProgress progress) {
  14785. return send_with_content_provider_and_receiver(
  14786. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14787. content_type, nullptr, progress);
  14788. }
  14789. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14790. ContentProviderWithoutLength content_provider,
  14791. const std::string &content_type,
  14792. ContentReceiver content_receiver,
  14793. UploadProgress progress) {
  14794. return send_with_content_provider_and_receiver(
  14795. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14796. content_type, std::move(content_receiver), progress);
  14797. }
  14798. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14799. const UploadFormDataItems &items,
  14800. const FormDataProviderItems &provider_items,
  14801. UploadProgress progress) {
  14802. const auto &boundary = detail::make_multipart_data_boundary();
  14803. const auto &content_type =
  14804. detail::serialize_multipart_formdata_get_content_type(boundary);
  14805. return send_with_content_provider_and_receiver(
  14806. "PUT", path, headers, nullptr, 0, nullptr,
  14807. get_multipart_content_provider(boundary, items, provider_items),
  14808. content_type, nullptr, progress);
  14809. }
  14810. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14811. const std::string &body,
  14812. const std::string &content_type,
  14813. ContentReceiver content_receiver,
  14814. DownloadProgress progress) {
  14815. Request req;
  14816. req.method = "PUT";
  14817. req.path = path;
  14818. req.headers = headers;
  14819. req.body = body;
  14820. req.content_receiver =
  14821. [content_receiver](const char *data, size_t data_length,
  14822. size_t /*offset*/, size_t /*total_length*/) {
  14823. return content_receiver(data, data_length);
  14824. };
  14825. req.download_progress = std::move(progress);
  14826. if (max_timeout_msec_ > 0) {
  14827. req.start_time_ = std::chrono::steady_clock::now();
  14828. }
  14829. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14830. return send_(std::move(req));
  14831. }
  14832. inline Result ClientImpl::Patch(const std::string &path) {
  14833. return Patch(path, std::string(), std::string());
  14834. }
  14835. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14836. UploadProgress progress) {
  14837. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14838. }
  14839. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14840. size_t content_length,
  14841. const std::string &content_type,
  14842. UploadProgress progress) {
  14843. return Patch(path, Headers(), body, content_length, content_type, progress);
  14844. }
  14845. inline Result ClientImpl::Patch(const std::string &path,
  14846. const std::string &body,
  14847. const std::string &content_type,
  14848. UploadProgress progress) {
  14849. return Patch(path, Headers(), body, content_type, progress);
  14850. }
  14851. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14852. return Patch(path, Headers(), params);
  14853. }
  14854. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14855. ContentProvider content_provider,
  14856. const std::string &content_type,
  14857. UploadProgress progress) {
  14858. return Patch(path, Headers(), content_length, std::move(content_provider),
  14859. content_type, progress);
  14860. }
  14861. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14862. ContentProvider content_provider,
  14863. const std::string &content_type,
  14864. ContentReceiver content_receiver,
  14865. UploadProgress progress) {
  14866. return Patch(path, Headers(), content_length, std::move(content_provider),
  14867. content_type, std::move(content_receiver), progress);
  14868. }
  14869. inline Result ClientImpl::Patch(const std::string &path,
  14870. ContentProviderWithoutLength content_provider,
  14871. const std::string &content_type,
  14872. UploadProgress progress) {
  14873. return Patch(path, Headers(), std::move(content_provider), content_type,
  14874. progress);
  14875. }
  14876. inline Result ClientImpl::Patch(const std::string &path,
  14877. ContentProviderWithoutLength content_provider,
  14878. const std::string &content_type,
  14879. ContentReceiver content_receiver,
  14880. UploadProgress progress) {
  14881. return Patch(path, Headers(), std::move(content_provider), content_type,
  14882. std::move(content_receiver), progress);
  14883. }
  14884. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14885. const Params &params) {
  14886. auto query = detail::params_to_query_str(params);
  14887. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14888. }
  14889. inline Result ClientImpl::Patch(const std::string &path,
  14890. const UploadFormDataItems &items,
  14891. UploadProgress progress) {
  14892. return Patch(path, Headers(), items, progress);
  14893. }
  14894. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14895. const UploadFormDataItems &items,
  14896. UploadProgress progress) {
  14897. const auto &boundary = detail::make_multipart_data_boundary();
  14898. const auto &content_type =
  14899. detail::serialize_multipart_formdata_get_content_type(boundary);
  14900. auto content_length = detail::get_multipart_content_length(items, boundary);
  14901. return Patch(path, headers, content_length,
  14902. detail::make_multipart_content_provider(items, boundary),
  14903. content_type, progress);
  14904. }
  14905. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14906. const UploadFormDataItems &items,
  14907. const std::string &boundary,
  14908. UploadProgress progress) {
  14909. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14910. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14911. }
  14912. const auto &content_type =
  14913. detail::serialize_multipart_formdata_get_content_type(boundary);
  14914. auto content_length = detail::get_multipart_content_length(items, boundary);
  14915. return Patch(path, headers, content_length,
  14916. detail::make_multipart_content_provider(items, boundary),
  14917. content_type, progress);
  14918. }
  14919. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14920. const char *body, size_t content_length,
  14921. const std::string &content_type,
  14922. UploadProgress progress) {
  14923. return send_with_content_provider_and_receiver(
  14924. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14925. content_type, nullptr, progress);
  14926. }
  14927. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14928. const std::string &body,
  14929. const std::string &content_type,
  14930. UploadProgress progress) {
  14931. return send_with_content_provider_and_receiver(
  14932. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14933. content_type, nullptr, progress);
  14934. }
  14935. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14936. size_t content_length,
  14937. ContentProvider content_provider,
  14938. const std::string &content_type,
  14939. UploadProgress progress) {
  14940. return send_with_content_provider_and_receiver(
  14941. "PATCH", path, headers, nullptr, content_length,
  14942. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14943. }
  14944. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14945. size_t content_length,
  14946. ContentProvider content_provider,
  14947. const std::string &content_type,
  14948. ContentReceiver content_receiver,
  14949. UploadProgress progress) {
  14950. return send_with_content_provider_and_receiver(
  14951. "PATCH", path, headers, nullptr, content_length,
  14952. std::move(content_provider), nullptr, content_type,
  14953. std::move(content_receiver), progress);
  14954. }
  14955. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14956. ContentProviderWithoutLength content_provider,
  14957. const std::string &content_type,
  14958. UploadProgress progress) {
  14959. return send_with_content_provider_and_receiver(
  14960. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14961. content_type, nullptr, progress);
  14962. }
  14963. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14964. ContentProviderWithoutLength content_provider,
  14965. const std::string &content_type,
  14966. ContentReceiver content_receiver,
  14967. UploadProgress progress) {
  14968. return send_with_content_provider_and_receiver(
  14969. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14970. content_type, std::move(content_receiver), progress);
  14971. }
  14972. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14973. const UploadFormDataItems &items,
  14974. const FormDataProviderItems &provider_items,
  14975. UploadProgress progress) {
  14976. const auto &boundary = detail::make_multipart_data_boundary();
  14977. const auto &content_type =
  14978. detail::serialize_multipart_formdata_get_content_type(boundary);
  14979. return send_with_content_provider_and_receiver(
  14980. "PATCH", path, headers, nullptr, 0, nullptr,
  14981. get_multipart_content_provider(boundary, items, provider_items),
  14982. content_type, nullptr, progress);
  14983. }
  14984. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14985. const std::string &body,
  14986. const std::string &content_type,
  14987. ContentReceiver content_receiver,
  14988. DownloadProgress progress) {
  14989. Request req;
  14990. req.method = "PATCH";
  14991. req.path = path;
  14992. req.headers = headers;
  14993. req.body = body;
  14994. req.content_receiver =
  14995. [content_receiver](const char *data, size_t data_length,
  14996. size_t /*offset*/, size_t /*total_length*/) {
  14997. return content_receiver(data, data_length);
  14998. };
  14999. req.download_progress = std::move(progress);
  15000. if (max_timeout_msec_ > 0) {
  15001. req.start_time_ = std::chrono::steady_clock::now();
  15002. }
  15003. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15004. return send_(std::move(req));
  15005. }
  15006. inline Result ClientImpl::Delete(const std::string &path,
  15007. DownloadProgress progress) {
  15008. return Delete(path, Headers(), std::string(), std::string(), progress);
  15009. }
  15010. inline Result ClientImpl::Delete(const std::string &path,
  15011. const Headers &headers,
  15012. DownloadProgress progress) {
  15013. return Delete(path, headers, std::string(), std::string(), progress);
  15014. }
  15015. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  15016. size_t content_length,
  15017. const std::string &content_type,
  15018. DownloadProgress progress) {
  15019. return Delete(path, Headers(), body, content_length, content_type, progress);
  15020. }
  15021. inline Result ClientImpl::Delete(const std::string &path,
  15022. const std::string &body,
  15023. const std::string &content_type,
  15024. DownloadProgress progress) {
  15025. return Delete(path, Headers(), body.data(), body.size(), content_type,
  15026. progress);
  15027. }
  15028. inline Result ClientImpl::Delete(const std::string &path,
  15029. const Headers &headers,
  15030. const std::string &body,
  15031. const std::string &content_type,
  15032. DownloadProgress progress) {
  15033. return Delete(path, headers, body.data(), body.size(), content_type,
  15034. progress);
  15035. }
  15036. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  15037. DownloadProgress progress) {
  15038. return Delete(path, Headers(), params, progress);
  15039. }
  15040. inline Result ClientImpl::Delete(const std::string &path,
  15041. const Headers &headers, const Params &params,
  15042. DownloadProgress progress) {
  15043. auto query = detail::params_to_query_str(params);
  15044. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  15045. progress);
  15046. }
  15047. inline Result ClientImpl::Delete(const std::string &path,
  15048. const Headers &headers, const char *body,
  15049. size_t content_length,
  15050. const std::string &content_type,
  15051. DownloadProgress progress) {
  15052. Request req;
  15053. req.method = "DELETE";
  15054. req.headers = headers;
  15055. req.path = path;
  15056. req.download_progress = std::move(progress);
  15057. if (max_timeout_msec_ > 0) {
  15058. req.start_time_ = std::chrono::steady_clock::now();
  15059. }
  15060. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  15061. req.body.assign(body, content_length);
  15062. return send_(std::move(req));
  15063. }
  15064. inline Result ClientImpl::Options(const std::string &path) {
  15065. return Options(path, Headers());
  15066. }
  15067. inline Result ClientImpl::Options(const std::string &path,
  15068. const Headers &headers) {
  15069. Request req;
  15070. req.method = "OPTIONS";
  15071. req.headers = headers;
  15072. req.path = path;
  15073. if (max_timeout_msec_ > 0) {
  15074. req.start_time_ = std::chrono::steady_clock::now();
  15075. }
  15076. return send_(std::move(req));
  15077. }
  15078. inline void ClientImpl::stop() {
  15079. std::lock_guard<std::mutex> guard(socket_mutex_);
  15080. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  15081. // do is to shutdown_socket, so that threads using this socket suddenly
  15082. // discover they can't read/write any more and error out. Everything else
  15083. // (closing the socket, shutting ssl down) is unsafe because these actions
  15084. // are not thread-safe.
  15085. if (socket_requests_in_flight_ > 0) {
  15086. shutdown_socket(socket_);
  15087. // Aside from that, we set a flag for the socket to be closed when we're
  15088. // done.
  15089. socket_should_be_closed_when_request_is_done_ = true;
  15090. return;
  15091. }
  15092. disconnect(/*gracefully=*/true);
  15093. }
  15094. inline std::string ClientImpl::host() const { return host_; }
  15095. inline int ClientImpl::port() const { return port_; }
  15096. inline size_t ClientImpl::is_socket_open() const {
  15097. std::lock_guard<std::mutex> guard(socket_mutex_);
  15098. return socket_.is_open();
  15099. }
  15100. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  15101. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  15102. connection_timeout_sec_ = sec;
  15103. connection_timeout_usec_ = usec;
  15104. }
  15105. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  15106. read_timeout_sec_ = sec;
  15107. read_timeout_usec_ = usec;
  15108. }
  15109. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  15110. write_timeout_sec_ = sec;
  15111. write_timeout_usec_ = usec;
  15112. }
  15113. inline void ClientImpl::set_max_timeout(time_t msec) {
  15114. max_timeout_msec_ = msec;
  15115. }
  15116. inline void ClientImpl::set_basic_auth(const std::string &username,
  15117. const std::string &password) {
  15118. basic_auth_username_ = username;
  15119. basic_auth_password_ = password;
  15120. }
  15121. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  15122. bearer_token_auth_token_ = token;
  15123. }
  15124. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  15125. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  15126. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  15127. inline void
  15128. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15129. addr_map_ = std::move(addr_map);
  15130. }
  15131. inline void ClientImpl::set_default_headers(Headers headers) {
  15132. default_headers_ = std::move(headers);
  15133. }
  15134. inline void ClientImpl::set_header_writer(
  15135. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15136. header_writer_ = writer;
  15137. }
  15138. inline void ClientImpl::set_address_family(int family) {
  15139. address_family_ = family;
  15140. }
  15141. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  15142. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  15143. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  15144. socket_options_ = std::move(socket_options);
  15145. }
  15146. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  15147. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  15148. inline void ClientImpl::set_payload_max_length(size_t length) {
  15149. payload_max_length_ = length;
  15150. has_payload_max_length_ = true;
  15151. }
  15152. inline void ClientImpl::set_interface(const std::string &intf) {
  15153. interface_ = intf;
  15154. }
  15155. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  15156. proxy_host_ = host;
  15157. proxy_port_ = port;
  15158. std::lock_guard<std::mutex> guard(socket_mutex_);
  15159. disconnect(/*gracefully=*/true);
  15160. }
  15161. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  15162. const std::string &password) {
  15163. proxy_basic_auth_username_ = username;
  15164. proxy_basic_auth_password_ = password;
  15165. }
  15166. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  15167. proxy_bearer_token_auth_token_ = token;
  15168. }
  15169. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  15170. std::vector<detail::NoProxyEntry> parsed;
  15171. parsed.reserve(patterns.size());
  15172. for (const auto &p : patterns) {
  15173. auto trimmed = detail::trim_copy(p);
  15174. if (trimmed.empty()) { continue; }
  15175. detail::NoProxyEntry entry;
  15176. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  15177. parsed.push_back(std::move(entry));
  15178. }
  15179. }
  15180. no_proxy_entries_ = std::move(parsed);
  15181. std::lock_guard<std::mutex> guard(socket_mutex_);
  15182. disconnect(/*gracefully=*/true);
  15183. }
  15184. #ifdef CPPHTTPLIB_SSL_ENABLED
  15185. inline void ClientImpl::set_digest_auth(const std::string &username,
  15186. const std::string &password) {
  15187. digest_auth_username_ = username;
  15188. digest_auth_password_ = password;
  15189. }
  15190. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  15191. const std::string &ca_cert_dir_path) {
  15192. ca_cert_file_path_ = ca_cert_file_path;
  15193. ca_cert_dir_path_ = ca_cert_dir_path;
  15194. }
  15195. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  15196. const std::string &password) {
  15197. proxy_digest_auth_username_ = username;
  15198. proxy_digest_auth_password_ = password;
  15199. }
  15200. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  15201. server_certificate_verification_ = enabled;
  15202. }
  15203. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  15204. server_hostname_verification_ = enabled;
  15205. }
  15206. inline void ClientImpl::enable_system_ca(bool enabled) {
  15207. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  15208. }
  15209. #endif
  15210. inline void ClientImpl::set_logger(Logger logger) {
  15211. logger_ = std::move(logger);
  15212. }
  15213. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  15214. error_logger_ = std::move(error_logger);
  15215. }
  15216. /*
  15217. * SSL/TLS Common Implementation
  15218. */
  15219. inline ClientConnection::~ClientConnection() {
  15220. #ifdef CPPHTTPLIB_SSL_ENABLED
  15221. if (session) {
  15222. tls::shutdown(session, true);
  15223. tls::free_session(session);
  15224. session = nullptr;
  15225. }
  15226. #endif
  15227. if (sock != INVALID_SOCKET) {
  15228. detail::close_socket(sock);
  15229. sock = INVALID_SOCKET;
  15230. }
  15231. }
  15232. // Universal client implementation
  15233. inline Client::Client(const std::string &scheme_host_port)
  15234. : Client(scheme_host_port, std::string(), std::string()) {}
  15235. inline Client::Client(const std::string &scheme_host_port,
  15236. const std::string &client_cert_path,
  15237. const std::string &client_key_path) {
  15238. detail::UrlComponents uc;
  15239. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  15240. auto &scheme = uc.scheme;
  15241. #ifdef CPPHTTPLIB_SSL_ENABLED
  15242. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  15243. #else
  15244. if (!scheme.empty() && scheme != "http") {
  15245. #endif
  15246. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  15247. std::string msg = "'" + scheme + "' scheme is not supported.";
  15248. throw std::invalid_argument(msg);
  15249. #endif
  15250. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15251. return;
  15252. }
  15253. auto is_ssl = scheme == "https";
  15254. auto host = std::move(uc.host);
  15255. auto port = is_ssl ? 443 : 80;
  15256. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) {
  15257. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15258. return;
  15259. }
  15260. if (is_ssl) {
  15261. #ifdef CPPHTTPLIB_SSL_ENABLED
  15262. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  15263. client_key_path);
  15264. is_ssl_ = is_ssl;
  15265. #endif
  15266. } else {
  15267. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15268. client_key_path);
  15269. }
  15270. } else if (scheme_host_port.find("//") != std::string::npos) {
  15271. // A URL, but not one this client can use, such as one with userinfo
  15272. cli_ = detail::make_unique<detail::InvalidClientImpl>();
  15273. } else {
  15274. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  15275. // if port param below changes.
  15276. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  15277. client_cert_path, client_key_path);
  15278. }
  15279. }
  15280. inline Client::Client(const std::string &host, int port)
  15281. : Client(host, port, std::string(), std::string()) {}
  15282. inline Client::Client(const std::string &host, int port,
  15283. const std::string &client_cert_path,
  15284. const std::string &client_key_path)
  15285. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  15286. client_key_path)) {}
  15287. inline Client::~Client() = default;
  15288. inline bool Client::is_valid() const {
  15289. return cli_ != nullptr && cli_->is_valid();
  15290. }
  15291. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  15292. return cli_->Get(path, std::move(progress));
  15293. }
  15294. inline Result Client::Get(const std::string &path, const Headers &headers,
  15295. DownloadProgress progress) {
  15296. return cli_->Get(path, headers, std::move(progress));
  15297. }
  15298. inline Result Client::Get(const std::string &path,
  15299. ContentReceiver content_receiver,
  15300. DownloadProgress progress) {
  15301. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  15302. }
  15303. inline Result Client::Get(const std::string &path, const Headers &headers,
  15304. ContentReceiver content_receiver,
  15305. DownloadProgress progress) {
  15306. return cli_->Get(path, headers, std::move(content_receiver),
  15307. std::move(progress));
  15308. }
  15309. inline Result Client::Get(const std::string &path,
  15310. ResponseHandler response_handler,
  15311. ContentReceiver content_receiver,
  15312. DownloadProgress progress) {
  15313. return cli_->Get(path, std::move(response_handler),
  15314. std::move(content_receiver), std::move(progress));
  15315. }
  15316. inline Result Client::Get(const std::string &path, const Headers &headers,
  15317. ResponseHandler response_handler,
  15318. ContentReceiver content_receiver,
  15319. DownloadProgress progress) {
  15320. return cli_->Get(path, headers, std::move(response_handler),
  15321. std::move(content_receiver), std::move(progress));
  15322. }
  15323. inline Result Client::Get(const std::string &path, const Params &params,
  15324. DownloadProgress progress) {
  15325. return cli_->Get(path, params, std::move(progress));
  15326. }
  15327. inline Result Client::Get(const std::string &path, const Params &params,
  15328. const Headers &headers, DownloadProgress progress) {
  15329. return cli_->Get(path, params, headers, std::move(progress));
  15330. }
  15331. inline Result Client::Get(const std::string &path, const Params &params,
  15332. const Headers &headers,
  15333. ContentReceiver content_receiver,
  15334. DownloadProgress progress) {
  15335. return cli_->Get(path, params, headers, std::move(content_receiver),
  15336. std::move(progress));
  15337. }
  15338. inline Result Client::Get(const std::string &path, const Params &params,
  15339. const Headers &headers,
  15340. ResponseHandler response_handler,
  15341. ContentReceiver content_receiver,
  15342. DownloadProgress progress) {
  15343. return cli_->Get(path, params, headers, std::move(response_handler),
  15344. std::move(content_receiver), std::move(progress));
  15345. }
  15346. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  15347. inline Result Client::Head(const std::string &path, const Headers &headers) {
  15348. return cli_->Head(path, headers);
  15349. }
  15350. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  15351. inline Result Client::Post(const std::string &path, const Headers &headers) {
  15352. return cli_->Post(path, headers);
  15353. }
  15354. inline Result Client::Post(const std::string &path, const char *body,
  15355. size_t content_length,
  15356. const std::string &content_type,
  15357. UploadProgress progress) {
  15358. return cli_->Post(path, body, content_length, content_type, progress);
  15359. }
  15360. inline Result Client::Post(const std::string &path, const Headers &headers,
  15361. const char *body, size_t content_length,
  15362. const std::string &content_type,
  15363. UploadProgress progress) {
  15364. return cli_->Post(path, headers, body, content_length, content_type,
  15365. progress);
  15366. }
  15367. inline Result Client::Post(const std::string &path, const std::string &body,
  15368. const std::string &content_type,
  15369. UploadProgress progress) {
  15370. return cli_->Post(path, body, content_type, progress);
  15371. }
  15372. inline Result Client::Post(const std::string &path, const Headers &headers,
  15373. const std::string &body,
  15374. const std::string &content_type,
  15375. UploadProgress progress) {
  15376. return cli_->Post(path, headers, body, content_type, progress);
  15377. }
  15378. inline Result Client::Post(const std::string &path, size_t content_length,
  15379. ContentProvider content_provider,
  15380. const std::string &content_type,
  15381. UploadProgress progress) {
  15382. return cli_->Post(path, content_length, std::move(content_provider),
  15383. content_type, progress);
  15384. }
  15385. inline Result Client::Post(const std::string &path, size_t content_length,
  15386. ContentProvider content_provider,
  15387. const std::string &content_type,
  15388. ContentReceiver content_receiver,
  15389. UploadProgress progress) {
  15390. return cli_->Post(path, content_length, std::move(content_provider),
  15391. content_type, std::move(content_receiver), progress);
  15392. }
  15393. inline Result Client::Post(const std::string &path,
  15394. ContentProviderWithoutLength content_provider,
  15395. const std::string &content_type,
  15396. UploadProgress progress) {
  15397. return cli_->Post(path, std::move(content_provider), content_type, progress);
  15398. }
  15399. inline Result Client::Post(const std::string &path,
  15400. ContentProviderWithoutLength content_provider,
  15401. const std::string &content_type,
  15402. ContentReceiver content_receiver,
  15403. UploadProgress progress) {
  15404. return cli_->Post(path, std::move(content_provider), content_type,
  15405. std::move(content_receiver), progress);
  15406. }
  15407. inline Result Client::Post(const std::string &path, const Headers &headers,
  15408. size_t content_length,
  15409. ContentProvider content_provider,
  15410. const std::string &content_type,
  15411. UploadProgress progress) {
  15412. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15413. content_type, progress);
  15414. }
  15415. inline Result Client::Post(const std::string &path, const Headers &headers,
  15416. size_t content_length,
  15417. ContentProvider content_provider,
  15418. const std::string &content_type,
  15419. ContentReceiver content_receiver,
  15420. DownloadProgress progress) {
  15421. return cli_->Post(path, headers, content_length, std::move(content_provider),
  15422. content_type, std::move(content_receiver), progress);
  15423. }
  15424. inline Result Client::Post(const std::string &path, const Headers &headers,
  15425. ContentProviderWithoutLength content_provider,
  15426. const std::string &content_type,
  15427. UploadProgress progress) {
  15428. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15429. progress);
  15430. }
  15431. inline Result Client::Post(const std::string &path, const Headers &headers,
  15432. ContentProviderWithoutLength content_provider,
  15433. const std::string &content_type,
  15434. ContentReceiver content_receiver,
  15435. DownloadProgress progress) {
  15436. return cli_->Post(path, headers, std::move(content_provider), content_type,
  15437. std::move(content_receiver), progress);
  15438. }
  15439. inline Result Client::Post(const std::string &path, const Params &params) {
  15440. return cli_->Post(path, params);
  15441. }
  15442. inline Result Client::Post(const std::string &path, const Headers &headers,
  15443. const Params &params) {
  15444. return cli_->Post(path, headers, params);
  15445. }
  15446. inline Result Client::Post(const std::string &path,
  15447. const UploadFormDataItems &items,
  15448. UploadProgress progress) {
  15449. return cli_->Post(path, items, progress);
  15450. }
  15451. inline Result Client::Post(const std::string &path, const Headers &headers,
  15452. const UploadFormDataItems &items,
  15453. UploadProgress progress) {
  15454. return cli_->Post(path, headers, items, progress);
  15455. }
  15456. inline Result Client::Post(const std::string &path, const Headers &headers,
  15457. const UploadFormDataItems &items,
  15458. const std::string &boundary,
  15459. UploadProgress progress) {
  15460. return cli_->Post(path, headers, items, boundary, progress);
  15461. }
  15462. inline Result Client::Post(const std::string &path, const Headers &headers,
  15463. const UploadFormDataItems &items,
  15464. const FormDataProviderItems &provider_items,
  15465. UploadProgress progress) {
  15466. return cli_->Post(path, headers, items, provider_items, progress);
  15467. }
  15468. inline Result Client::Post(const std::string &path, const Headers &headers,
  15469. const std::string &body,
  15470. const std::string &content_type,
  15471. ContentReceiver content_receiver,
  15472. DownloadProgress progress) {
  15473. return cli_->Post(path, headers, body, content_type,
  15474. std::move(content_receiver), progress);
  15475. }
  15476. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  15477. inline Result Client::Put(const std::string &path, const Headers &headers) {
  15478. return cli_->Put(path, headers);
  15479. }
  15480. inline Result Client::Put(const std::string &path, const char *body,
  15481. size_t content_length,
  15482. const std::string &content_type,
  15483. UploadProgress progress) {
  15484. return cli_->Put(path, body, content_length, content_type, progress);
  15485. }
  15486. inline Result Client::Put(const std::string &path, const Headers &headers,
  15487. const char *body, size_t content_length,
  15488. const std::string &content_type,
  15489. UploadProgress progress) {
  15490. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15491. }
  15492. inline Result Client::Put(const std::string &path, const std::string &body,
  15493. const std::string &content_type,
  15494. UploadProgress progress) {
  15495. return cli_->Put(path, body, content_type, progress);
  15496. }
  15497. inline Result Client::Put(const std::string &path, const Headers &headers,
  15498. const std::string &body,
  15499. const std::string &content_type,
  15500. UploadProgress progress) {
  15501. return cli_->Put(path, headers, body, content_type, progress);
  15502. }
  15503. inline Result Client::Put(const std::string &path, size_t content_length,
  15504. ContentProvider content_provider,
  15505. const std::string &content_type,
  15506. UploadProgress progress) {
  15507. return cli_->Put(path, content_length, std::move(content_provider),
  15508. content_type, progress);
  15509. }
  15510. inline Result Client::Put(const std::string &path, size_t content_length,
  15511. ContentProvider content_provider,
  15512. const std::string &content_type,
  15513. ContentReceiver content_receiver,
  15514. UploadProgress progress) {
  15515. return cli_->Put(path, content_length, std::move(content_provider),
  15516. content_type, std::move(content_receiver), progress);
  15517. }
  15518. inline Result Client::Put(const std::string &path,
  15519. ContentProviderWithoutLength content_provider,
  15520. const std::string &content_type,
  15521. UploadProgress progress) {
  15522. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15523. }
  15524. inline Result Client::Put(const std::string &path,
  15525. ContentProviderWithoutLength content_provider,
  15526. const std::string &content_type,
  15527. ContentReceiver content_receiver,
  15528. UploadProgress progress) {
  15529. return cli_->Put(path, std::move(content_provider), content_type,
  15530. std::move(content_receiver), progress);
  15531. }
  15532. inline Result Client::Put(const std::string &path, const Headers &headers,
  15533. size_t content_length,
  15534. ContentProvider content_provider,
  15535. const std::string &content_type,
  15536. UploadProgress progress) {
  15537. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15538. content_type, progress);
  15539. }
  15540. inline Result Client::Put(const std::string &path, const Headers &headers,
  15541. size_t content_length,
  15542. ContentProvider content_provider,
  15543. const std::string &content_type,
  15544. ContentReceiver content_receiver,
  15545. UploadProgress progress) {
  15546. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15547. content_type, std::move(content_receiver), progress);
  15548. }
  15549. inline Result Client::Put(const std::string &path, const Headers &headers,
  15550. ContentProviderWithoutLength content_provider,
  15551. const std::string &content_type,
  15552. UploadProgress progress) {
  15553. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15554. progress);
  15555. }
  15556. inline Result Client::Put(const std::string &path, const Headers &headers,
  15557. ContentProviderWithoutLength content_provider,
  15558. const std::string &content_type,
  15559. ContentReceiver content_receiver,
  15560. UploadProgress progress) {
  15561. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15562. std::move(content_receiver), progress);
  15563. }
  15564. inline Result Client::Put(const std::string &path, const Params &params) {
  15565. return cli_->Put(path, params);
  15566. }
  15567. inline Result Client::Put(const std::string &path, const Headers &headers,
  15568. const Params &params) {
  15569. return cli_->Put(path, headers, params);
  15570. }
  15571. inline Result Client::Put(const std::string &path,
  15572. const UploadFormDataItems &items,
  15573. UploadProgress progress) {
  15574. return cli_->Put(path, items, progress);
  15575. }
  15576. inline Result Client::Put(const std::string &path, const Headers &headers,
  15577. const UploadFormDataItems &items,
  15578. UploadProgress progress) {
  15579. return cli_->Put(path, headers, items, progress);
  15580. }
  15581. inline Result Client::Put(const std::string &path, const Headers &headers,
  15582. const UploadFormDataItems &items,
  15583. const std::string &boundary,
  15584. UploadProgress progress) {
  15585. return cli_->Put(path, headers, items, boundary, progress);
  15586. }
  15587. inline Result Client::Put(const std::string &path, const Headers &headers,
  15588. const UploadFormDataItems &items,
  15589. const FormDataProviderItems &provider_items,
  15590. UploadProgress progress) {
  15591. return cli_->Put(path, headers, items, provider_items, progress);
  15592. }
  15593. inline Result Client::Put(const std::string &path, const Headers &headers,
  15594. const std::string &body,
  15595. const std::string &content_type,
  15596. ContentReceiver content_receiver,
  15597. DownloadProgress progress) {
  15598. return cli_->Put(path, headers, body, content_type, content_receiver,
  15599. progress);
  15600. }
  15601. inline Result Client::Patch(const std::string &path) {
  15602. return cli_->Patch(path);
  15603. }
  15604. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15605. return cli_->Patch(path, headers);
  15606. }
  15607. inline Result Client::Patch(const std::string &path, const char *body,
  15608. size_t content_length,
  15609. const std::string &content_type,
  15610. UploadProgress progress) {
  15611. return cli_->Patch(path, body, content_length, content_type, progress);
  15612. }
  15613. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15614. const char *body, size_t content_length,
  15615. const std::string &content_type,
  15616. UploadProgress progress) {
  15617. return cli_->Patch(path, headers, body, content_length, content_type,
  15618. progress);
  15619. }
  15620. inline Result Client::Patch(const std::string &path, const std::string &body,
  15621. const std::string &content_type,
  15622. UploadProgress progress) {
  15623. return cli_->Patch(path, body, content_type, progress);
  15624. }
  15625. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15626. const std::string &body,
  15627. const std::string &content_type,
  15628. UploadProgress progress) {
  15629. return cli_->Patch(path, headers, body, content_type, progress);
  15630. }
  15631. inline Result Client::Patch(const std::string &path, size_t content_length,
  15632. ContentProvider content_provider,
  15633. const std::string &content_type,
  15634. UploadProgress progress) {
  15635. return cli_->Patch(path, content_length, std::move(content_provider),
  15636. content_type, progress);
  15637. }
  15638. inline Result Client::Patch(const std::string &path, size_t content_length,
  15639. ContentProvider content_provider,
  15640. const std::string &content_type,
  15641. ContentReceiver content_receiver,
  15642. UploadProgress progress) {
  15643. return cli_->Patch(path, content_length, std::move(content_provider),
  15644. content_type, std::move(content_receiver), progress);
  15645. }
  15646. inline Result Client::Patch(const std::string &path,
  15647. ContentProviderWithoutLength content_provider,
  15648. const std::string &content_type,
  15649. UploadProgress progress) {
  15650. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15651. }
  15652. inline Result Client::Patch(const std::string &path,
  15653. ContentProviderWithoutLength content_provider,
  15654. const std::string &content_type,
  15655. ContentReceiver content_receiver,
  15656. UploadProgress progress) {
  15657. return cli_->Patch(path, std::move(content_provider), content_type,
  15658. std::move(content_receiver), progress);
  15659. }
  15660. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15661. size_t content_length,
  15662. ContentProvider content_provider,
  15663. const std::string &content_type,
  15664. UploadProgress progress) {
  15665. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15666. content_type, progress);
  15667. }
  15668. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15669. size_t content_length,
  15670. ContentProvider content_provider,
  15671. const std::string &content_type,
  15672. ContentReceiver content_receiver,
  15673. UploadProgress progress) {
  15674. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15675. content_type, std::move(content_receiver), progress);
  15676. }
  15677. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15678. ContentProviderWithoutLength content_provider,
  15679. const std::string &content_type,
  15680. UploadProgress progress) {
  15681. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15682. progress);
  15683. }
  15684. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15685. ContentProviderWithoutLength content_provider,
  15686. const std::string &content_type,
  15687. ContentReceiver content_receiver,
  15688. UploadProgress progress) {
  15689. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15690. std::move(content_receiver), progress);
  15691. }
  15692. inline Result Client::Patch(const std::string &path, const Params &params) {
  15693. return cli_->Patch(path, params);
  15694. }
  15695. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15696. const Params &params) {
  15697. return cli_->Patch(path, headers, params);
  15698. }
  15699. inline Result Client::Patch(const std::string &path,
  15700. const UploadFormDataItems &items,
  15701. UploadProgress progress) {
  15702. return cli_->Patch(path, items, progress);
  15703. }
  15704. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15705. const UploadFormDataItems &items,
  15706. UploadProgress progress) {
  15707. return cli_->Patch(path, headers, items, progress);
  15708. }
  15709. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15710. const UploadFormDataItems &items,
  15711. const std::string &boundary,
  15712. UploadProgress progress) {
  15713. return cli_->Patch(path, headers, items, boundary, progress);
  15714. }
  15715. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15716. const UploadFormDataItems &items,
  15717. const FormDataProviderItems &provider_items,
  15718. UploadProgress progress) {
  15719. return cli_->Patch(path, headers, items, provider_items, progress);
  15720. }
  15721. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15722. const std::string &body,
  15723. const std::string &content_type,
  15724. ContentReceiver content_receiver,
  15725. DownloadProgress progress) {
  15726. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15727. progress);
  15728. }
  15729. inline Result Client::Delete(const std::string &path,
  15730. DownloadProgress progress) {
  15731. return cli_->Delete(path, progress);
  15732. }
  15733. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15734. DownloadProgress progress) {
  15735. return cli_->Delete(path, headers, progress);
  15736. }
  15737. inline Result Client::Delete(const std::string &path, const char *body,
  15738. size_t content_length,
  15739. const std::string &content_type,
  15740. DownloadProgress progress) {
  15741. return cli_->Delete(path, body, content_length, content_type, progress);
  15742. }
  15743. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15744. const char *body, size_t content_length,
  15745. const std::string &content_type,
  15746. DownloadProgress progress) {
  15747. return cli_->Delete(path, headers, body, content_length, content_type,
  15748. progress);
  15749. }
  15750. inline Result Client::Delete(const std::string &path, const std::string &body,
  15751. const std::string &content_type,
  15752. DownloadProgress progress) {
  15753. return cli_->Delete(path, body, content_type, progress);
  15754. }
  15755. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15756. const std::string &body,
  15757. const std::string &content_type,
  15758. DownloadProgress progress) {
  15759. return cli_->Delete(path, headers, body, content_type, progress);
  15760. }
  15761. inline Result Client::Delete(const std::string &path, const Params &params,
  15762. DownloadProgress progress) {
  15763. return cli_->Delete(path, params, progress);
  15764. }
  15765. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15766. const Params &params, DownloadProgress progress) {
  15767. return cli_->Delete(path, headers, params, progress);
  15768. }
  15769. inline Result Client::Options(const std::string &path) {
  15770. return cli_->Options(path);
  15771. }
  15772. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15773. return cli_->Options(path, headers);
  15774. }
  15775. inline ClientImpl::StreamHandle
  15776. Client::open_stream(const std::string &method, const std::string &path,
  15777. const Params &params, const Headers &headers,
  15778. const std::string &body, const std::string &content_type) {
  15779. return cli_->open_stream(method, path, params, headers, body, content_type);
  15780. }
  15781. inline bool Client::send(Request &req, Response &res, Error &error) {
  15782. return cli_->send(req, res, error);
  15783. }
  15784. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15785. inline void Client::stop() { cli_->stop(); }
  15786. inline std::string Client::host() const { return cli_->host(); }
  15787. inline int Client::port() const { return cli_->port(); }
  15788. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15789. inline socket_t Client::socket() const { return cli_->socket(); }
  15790. inline void
  15791. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15792. cli_->set_hostname_addr_map(std::move(addr_map));
  15793. }
  15794. inline void Client::set_default_headers(Headers headers) {
  15795. cli_->set_default_headers(std::move(headers));
  15796. }
  15797. inline void Client::set_header_writer(
  15798. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15799. cli_->set_header_writer(writer);
  15800. }
  15801. inline void Client::set_address_family(int family) {
  15802. cli_->set_address_family(family);
  15803. }
  15804. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15805. inline void Client::set_socket_options(SocketOptions socket_options) {
  15806. cli_->set_socket_options(std::move(socket_options));
  15807. }
  15808. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15809. cli_->set_connection_timeout(sec, usec);
  15810. }
  15811. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15812. cli_->set_read_timeout(sec, usec);
  15813. }
  15814. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15815. cli_->set_write_timeout(sec, usec);
  15816. }
  15817. inline void Client::set_basic_auth(const std::string &username,
  15818. const std::string &password) {
  15819. cli_->set_basic_auth(username, password);
  15820. }
  15821. inline void Client::set_bearer_token_auth(const std::string &token) {
  15822. cli_->set_bearer_token_auth(token);
  15823. }
  15824. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15825. inline void Client::set_follow_location(bool on) {
  15826. cli_->set_follow_location(on);
  15827. }
  15828. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15829. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15830. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15831. inline void Client::set_payload_max_length(size_t length) {
  15832. cli_->set_payload_max_length(length);
  15833. }
  15834. inline void Client::set_interface(const std::string &intf) {
  15835. cli_->set_interface(intf);
  15836. }
  15837. inline void Client::set_proxy(const std::string &host, int port) {
  15838. cli_->set_proxy(host, port);
  15839. }
  15840. inline void Client::set_proxy_basic_auth(const std::string &username,
  15841. const std::string &password) {
  15842. cli_->set_proxy_basic_auth(username, password);
  15843. }
  15844. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15845. cli_->set_proxy_bearer_token_auth(token);
  15846. }
  15847. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15848. cli_->set_no_proxy(patterns);
  15849. }
  15850. inline void Client::set_logger(Logger logger) {
  15851. cli_->set_logger(std::move(logger));
  15852. }
  15853. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15854. cli_->set_error_logger(std::move(error_logger));
  15855. }
  15856. /*
  15857. * Group 6: SSL Server and Client implementation
  15858. */
  15859. #ifdef CPPHTTPLIB_SSL_ENABLED
  15860. // SSL HTTP server implementation
  15861. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15862. const char *client_ca_cert_file_path,
  15863. const char *client_ca_cert_dir_path,
  15864. const char *private_key_password) {
  15865. using namespace tls;
  15866. ctx_ = create_server_context();
  15867. if (!ctx_) { return; }
  15868. // Load server certificate and private key
  15869. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15870. private_key_password)) {
  15871. last_ssl_error_ = static_cast<int>(get_error());
  15872. free_context(ctx_);
  15873. ctx_ = nullptr;
  15874. return;
  15875. }
  15876. // Load client CA certificates for client authentication
  15877. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15878. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15879. client_ca_cert_dir_path)) {
  15880. last_ssl_error_ = static_cast<int>(get_error());
  15881. free_context(ctx_);
  15882. ctx_ = nullptr;
  15883. return;
  15884. }
  15885. // Enable client certificate verification
  15886. set_verify_client(ctx_, true);
  15887. }
  15888. }
  15889. inline SSLServer::SSLServer(const PemMemory &pem) {
  15890. using namespace tls;
  15891. ctx_ = create_server_context();
  15892. if (ctx_) {
  15893. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15894. pem.private_key_password)) {
  15895. last_ssl_error_ = static_cast<int>(get_error());
  15896. free_context(ctx_);
  15897. ctx_ = nullptr;
  15898. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15899. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15900. last_ssl_error_ = static_cast<int>(get_error());
  15901. free_context(ctx_);
  15902. ctx_ = nullptr;
  15903. } else {
  15904. set_verify_client(ctx_, true);
  15905. }
  15906. }
  15907. }
  15908. }
  15909. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15910. using namespace tls;
  15911. ctx_ = create_server_context();
  15912. if (ctx_) {
  15913. if (!setup_callback(ctx_)) {
  15914. free_context(ctx_);
  15915. ctx_ = nullptr;
  15916. }
  15917. }
  15918. }
  15919. inline SSLServer::~SSLServer() {
  15920. if (ctx_) { tls::free_context(ctx_); }
  15921. }
  15922. inline bool SSLServer::is_valid() const {
  15923. return ctx_ != nullptr && Server::is_valid();
  15924. }
  15925. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15926. using namespace tls;
  15927. session_t session = nullptr;
  15928. {
  15929. std::unique_lock<std::mutex> lock(ctx_mutex_);
  15930. ctx_cv_.wait(lock, [&] { return updates_pending_ == 0; });
  15931. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15932. if (session) { handshakes_in_progress_++; }
  15933. }
  15934. if (!session) {
  15935. last_ssl_error_ = static_cast<int>(get_error());
  15936. detail::shutdown_socket(sock);
  15937. detail::close_socket(sock);
  15938. return false;
  15939. }
  15940. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15941. bool handshake_done = false;
  15942. bool ret = false;
  15943. bool websocket_upgraded = false;
  15944. auto cleanup = detail::scope_exit([&] {
  15945. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15946. free_session(session);
  15947. detail::shutdown_socket(sock);
  15948. detail::close_socket(sock);
  15949. });
  15950. // Perform TLS accept handshake with timeout
  15951. TlsError tls_err;
  15952. auto accepted = accept_nonblocking(session, sock, read_timeout_sec_,
  15953. read_timeout_usec_, &tls_err);
  15954. {
  15955. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15956. if (--handshakes_in_progress_ == 0) { ctx_cv_.notify_all(); }
  15957. }
  15958. if (!accepted) {
  15959. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15960. // Map TlsError to legacy ssl_error for backward compatibility
  15961. if (tls_err.code == ErrorCode::WantRead) {
  15962. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15963. } else if (tls_err.code == ErrorCode::WantWrite) {
  15964. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15965. } else {
  15966. last_ssl_error_ = SSL_ERROR_SSL;
  15967. }
  15968. #else
  15969. last_ssl_error_ = static_cast<int>(get_error());
  15970. #endif
  15971. return false;
  15972. }
  15973. handshake_done = true;
  15974. std::string remote_addr;
  15975. int remote_port = 0;
  15976. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15977. std::string local_addr;
  15978. int local_port = 0;
  15979. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15980. ret = serve_guarded([&]() {
  15981. return detail::process_server_socket_ssl(
  15982. svr_sock_, session, sock, keep_alive_max_count_,
  15983. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15984. write_timeout_sec_, write_timeout_usec_,
  15985. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15986. return process_request(
  15987. strm, remote_addr, remote_port, local_addr, local_port,
  15988. close_connection, connection_closed,
  15989. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15990. });
  15991. });
  15992. return ret;
  15993. }
  15994. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15995. const char *key_pem,
  15996. const char *client_ca_pem,
  15997. const char *password) {
  15998. if (!ctx_) { return false; }
  15999. std::unique_lock<std::mutex> lock(ctx_mutex_);
  16000. updates_pending_++;
  16001. auto se = detail::scope_exit([&] {
  16002. if (--updates_pending_ == 0) { ctx_cv_.notify_all(); }
  16003. });
  16004. ctx_cv_.wait(lock, [&] { return handshakes_in_progress_ == 0; });
  16005. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  16006. return false;
  16007. }
  16008. if (client_ca_pem) {
  16009. return tls::update_server_client_ca(ctx_, client_ca_pem);
  16010. }
  16011. return true;
  16012. }
  16013. // SSL HTTP client implementation
  16014. inline SSLClient::~SSLClient() {
  16015. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  16016. // base function rather than the derived function once we get to the
  16017. // base class destructor, and won't free the SSL (causing a leak).
  16018. // This must happen before the context is freed below: some backends
  16019. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  16020. // context, so freeing the context first leaves close_notify reading
  16021. // freed memory.
  16022. shutdown_ssl_impl(socket_, true);
  16023. if (ctx_) {
  16024. tls::free_context(ctx_);
  16025. ctx_ = nullptr;
  16026. }
  16027. }
  16028. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  16029. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  16030. shutdown_ssl_impl(socket, shutdown_gracefully);
  16031. }
  16032. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  16033. bool shutdown_gracefully) {
  16034. if (socket.sock == INVALID_SOCKET) {
  16035. assert(socket.ssl == nullptr);
  16036. return;
  16037. }
  16038. if (socket.ssl) {
  16039. tls::shutdown(socket.ssl, shutdown_gracefully);
  16040. {
  16041. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16042. tls::free_session(socket.ssl);
  16043. }
  16044. socket.ssl = nullptr;
  16045. }
  16046. assert(socket.ssl == nullptr);
  16047. }
  16048. inline bool SSLClient::process_socket(
  16049. const Socket &socket,
  16050. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16051. std::function<bool(Stream &strm)> callback) {
  16052. assert(socket.ssl);
  16053. return detail::process_client_socket_ssl(
  16054. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  16055. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  16056. std::move(callback));
  16057. }
  16058. inline bool SSLClient::is_ssl() const { return true; }
  16059. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  16060. if (!is_valid()) {
  16061. error = Error::SSLConnection;
  16062. return false;
  16063. }
  16064. return ClientImpl::create_and_connect_socket(socket, error);
  16065. }
  16066. inline bool SSLClient::setup_proxy_connection(
  16067. Socket &socket,
  16068. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16069. Response &res, bool &success, Error &error) {
  16070. if (!is_proxy_enabled_for_host(host_)) { return true; }
  16071. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  16072. return false;
  16073. }
  16074. if (!initialize_ssl(socket, error)) {
  16075. success = false;
  16076. return false;
  16077. }
  16078. return true;
  16079. }
  16080. // Assumes that socket_mutex_ is locked and that there are no requests in
  16081. // flight
  16082. inline bool SSLClient::connect_with_proxy(
  16083. Socket &socket,
  16084. std::chrono::time_point<std::chrono::steady_clock> start_time,
  16085. Response &res, bool &success, Error &error) {
  16086. success = true;
  16087. Response proxy_res;
  16088. if (!detail::process_client_socket(
  16089. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16090. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16091. start_time, [&](Stream &strm) {
  16092. Request req2;
  16093. req2.method = "CONNECT";
  16094. req2.path =
  16095. detail::make_host_and_port_string_always_port(host_, port_);
  16096. if (max_timeout_msec_ > 0) {
  16097. req2.start_time_ = std::chrono::steady_clock::now();
  16098. }
  16099. return process_request(strm, req2, proxy_res, false, error);
  16100. })) {
  16101. // Thread-safe to close everything because we are assuming there are no
  16102. // requests in flight
  16103. shutdown_ssl(socket, true);
  16104. shutdown_socket(socket);
  16105. close_socket(socket);
  16106. success = false;
  16107. return false;
  16108. }
  16109. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16110. if (!proxy_digest_auth_username_.empty() &&
  16111. !proxy_digest_auth_password_.empty()) {
  16112. std::map<std::string, std::string> auth;
  16113. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  16114. // Close the current socket and create a new one for the authenticated
  16115. // request
  16116. shutdown_ssl(socket, true);
  16117. shutdown_socket(socket);
  16118. close_socket(socket);
  16119. // Create a new socket for the authenticated CONNECT request
  16120. if (!ensure_socket_connection(socket, error)) {
  16121. success = false;
  16122. output_error_log(error, nullptr);
  16123. return false;
  16124. }
  16125. proxy_res = Response();
  16126. if (!detail::process_client_socket(
  16127. socket.sock, read_timeout_sec_, read_timeout_usec_,
  16128. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  16129. start_time, [&](Stream &strm) {
  16130. Request req3;
  16131. req3.method = "CONNECT";
  16132. req3.path = detail::make_host_and_port_string_always_port(
  16133. host_, port_);
  16134. req3.headers.insert(detail::make_digest_authentication_header(
  16135. req3, auth, 1, detail::random_string(10),
  16136. proxy_digest_auth_username_, proxy_digest_auth_password_,
  16137. true));
  16138. if (max_timeout_msec_ > 0) {
  16139. req3.start_time_ = std::chrono::steady_clock::now();
  16140. }
  16141. return process_request(strm, req3, proxy_res, false, error);
  16142. })) {
  16143. // Thread-safe to close everything because we are assuming there are
  16144. // no requests in flight
  16145. shutdown_ssl(socket, true);
  16146. shutdown_socket(socket);
  16147. close_socket(socket);
  16148. success = false;
  16149. return false;
  16150. }
  16151. }
  16152. }
  16153. }
  16154. // If status code is not 200, proxy request is failed.
  16155. // Set error to ProxyConnection. A 407 is returned as the response of the
  16156. // request, so the caller sees the proxy asks for credentials; any other
  16157. // status would read as the answer of the origin, which it never reached.
  16158. if (proxy_res.status != StatusCode::OK_200) {
  16159. error = Error::ProxyConnection;
  16160. output_error_log(error, nullptr);
  16161. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  16162. res = std::move(proxy_res);
  16163. } else {
  16164. success = false;
  16165. }
  16166. // Thread-safe to close everything because we are assuming there are
  16167. // no requests in flight
  16168. shutdown_ssl(socket, true);
  16169. shutdown_socket(socket);
  16170. close_socket(socket);
  16171. return false;
  16172. }
  16173. return true;
  16174. }
  16175. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  16176. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  16177. if (is_proxy_enabled_for_host(host_)) { return true; }
  16178. if (!initialize_ssl(socket, error)) {
  16179. shutdown_socket(socket);
  16180. close_socket(socket);
  16181. return false;
  16182. }
  16183. return true;
  16184. }
  16185. // SSL HTTP client implementation
  16186. inline SSLClient::SSLClient(const std::string &host)
  16187. : SSLClient(host, 443, std::string(), std::string()) {}
  16188. inline SSLClient::SSLClient(const std::string &host, int port)
  16189. : SSLClient(host, port, std::string(), std::string()) {}
  16190. inline void SSLClient::init_ctx() {
  16191. ctx_ = tls::create_client_context();
  16192. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  16193. }
  16194. inline void SSLClient::reset_ctx_on_error() {
  16195. last_backend_error_ = tls::get_error();
  16196. tls::free_context(ctx_);
  16197. ctx_ = nullptr;
  16198. }
  16199. inline SSLClient::SSLClient(const std::string &host, int port,
  16200. const std::string &client_cert_path,
  16201. const std::string &client_key_path,
  16202. const std::string &private_key_password)
  16203. : ClientImpl(host, port, client_cert_path, client_key_path) {
  16204. init_ctx();
  16205. if (!ctx_) { return; }
  16206. if (!client_cert_path.empty() && !client_key_path.empty()) {
  16207. const char *password =
  16208. private_key_password.empty() ? nullptr : private_key_password.c_str();
  16209. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  16210. client_key_path.c_str(), password)) {
  16211. reset_ctx_on_error();
  16212. }
  16213. }
  16214. }
  16215. inline SSLClient::SSLClient(const std::string &host, int port,
  16216. const PemMemory &pem)
  16217. : ClientImpl(host, port) {
  16218. init_ctx();
  16219. if (!ctx_) { return; }
  16220. if (pem.cert_pem && pem.key_pem) {
  16221. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  16222. pem.private_key_password)) {
  16223. reset_ctx_on_error();
  16224. }
  16225. }
  16226. }
  16227. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16228. if (ca_cert_store && ctx_) {
  16229. // set_ca_store takes ownership of ca_cert_store
  16230. tls::set_ca_store(ctx_, ca_cert_store);
  16231. ca_cert_store_set_ = true;
  16232. } else if (ca_cert_store) {
  16233. tls::free_ca_store(ca_cert_store);
  16234. }
  16235. }
  16236. inline void
  16237. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16238. if (!ctx_) { return; }
  16239. server_certificate_verifier_ = verifier;
  16240. tls::set_verify_callback(ctx_, std::move(verifier));
  16241. }
  16242. inline void SSLClient::set_session_verifier(
  16243. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16244. session_verifier_ = std::move(verifier);
  16245. }
  16246. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16247. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  16248. enable_windows_cert_verification_ = enabled;
  16249. }
  16250. #endif
  16251. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  16252. std::size_t size) {
  16253. if (ctx_ && ca_cert && size > 0) {
  16254. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  16255. tls::load_ca_pem(ctx_, ca_cert, size);
  16256. }
  16257. }
  16258. inline bool SSLClient::load_certs() {
  16259. auto ret = true;
  16260. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  16261. // one client is shared across concurrent requests here.
  16262. std::call_once(initialize_cert_, [&]() {
  16263. std::lock_guard<std::mutex> guard(ctx_mutex_);
  16264. ret = detail::load_client_ca_config(
  16265. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  16266. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  16267. last_backend_error_);
  16268. });
  16269. return ret;
  16270. }
  16271. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  16272. // Load CA certificates if server verification is enabled
  16273. if (server_certificate_verification_) {
  16274. if (!load_certs()) {
  16275. error = Error::SSLLoadingCerts;
  16276. output_error_log(error, nullptr);
  16277. return false;
  16278. }
  16279. }
  16280. detail::ClientTlsSessionOptions options;
  16281. options.server_hostname_verification = server_hostname_verification_;
  16282. options.session_verifier = session_verifier_;
  16283. options.ctx_mutex = &ctx_mutex_;
  16284. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16285. // Skip Schannel when a custom CA cert is specified, as the Windows
  16286. // certificate store would not know about user-provided CA certificates.
  16287. // Also skip when system CA trust is explicitly disabled.
  16288. options.windows_cert_verification =
  16289. enable_windows_cert_verification_ &&
  16290. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  16291. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  16292. // Only a verifier set through set_server_certificate_verifier() is seen
  16293. // here, not one installed with tls::set_verify_callback() directly.
  16294. options.server_certificate_verifier_set =
  16295. static_cast<bool>(server_certificate_verifier_);
  16296. #endif
  16297. tls::session_t session = nullptr;
  16298. // Use scope_exit to ensure session is freed on error paths
  16299. bool success = false;
  16300. auto session_guard = detail::scope_exit([&] {
  16301. if (!success) { tls::free_session(session); }
  16302. });
  16303. detail::ClientTlsSessionError tls_error;
  16304. if (!detail::setup_client_tls_session(
  16305. host_, ctx_, session, socket.sock, server_certificate_verification_,
  16306. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  16307. options)) {
  16308. error = tls_error.error;
  16309. last_ssl_error_ = tls_error.ssl_error;
  16310. last_backend_error_ = tls_error.backend_error;
  16311. output_error_log(error, nullptr);
  16312. return false;
  16313. }
  16314. success = true;
  16315. socket.ssl = session;
  16316. return true;
  16317. }
  16318. inline void Client::set_digest_auth(const std::string &username,
  16319. const std::string &password) {
  16320. cli_->set_digest_auth(username, password);
  16321. }
  16322. inline void Client::set_proxy_digest_auth(const std::string &username,
  16323. const std::string &password) {
  16324. cli_->set_proxy_digest_auth(username, password);
  16325. }
  16326. inline void Client::enable_server_certificate_verification(bool enabled) {
  16327. cli_->enable_server_certificate_verification(enabled);
  16328. }
  16329. inline void Client::enable_server_hostname_verification(bool enabled) {
  16330. cli_->enable_server_hostname_verification(enabled);
  16331. }
  16332. inline void Client::enable_system_ca(bool enabled) {
  16333. cli_->enable_system_ca(enabled);
  16334. }
  16335. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  16336. inline void Client::enable_windows_certificate_verification(bool enabled) {
  16337. if (is_ssl_) {
  16338. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  16339. enabled);
  16340. }
  16341. }
  16342. #endif
  16343. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  16344. const std::string &ca_cert_dir_path) {
  16345. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  16346. }
  16347. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  16348. if (is_ssl_) {
  16349. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  16350. } else if (ca_cert_store) {
  16351. tls::free_ca_store(ca_cert_store);
  16352. }
  16353. }
  16354. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  16355. if (is_ssl_) {
  16356. // Use the PEM-based path so the CA data is retained for redirect transfer
  16357. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  16358. }
  16359. }
  16360. inline void
  16361. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  16362. if (is_ssl_) {
  16363. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  16364. std::move(verifier));
  16365. }
  16366. }
  16367. inline void Client::set_session_verifier(
  16368. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  16369. if (is_ssl_) {
  16370. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  16371. }
  16372. }
  16373. inline tls::ctx_t Client::tls_context() const {
  16374. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  16375. return nullptr;
  16376. }
  16377. #endif // CPPHTTPLIB_SSL_ENABLED
  16378. /*
  16379. * Group 7: TLS abstraction layer - Common API
  16380. */
  16381. #ifdef CPPHTTPLIB_SSL_ENABLED
  16382. namespace tls {
  16383. // Helper for PeerCert construction
  16384. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  16385. return PeerCert(get_peer_cert(session));
  16386. }
  16387. namespace impl {
  16388. // Check if a string is an IPv4 address
  16389. inline bool is_ipv4_address(const std::string &str) {
  16390. int dots = 0;
  16391. for (char c : str) {
  16392. if (c == '.') {
  16393. dots++;
  16394. } else if (!detail::is_ascii_digit(c)) {
  16395. return false;
  16396. }
  16397. }
  16398. return dots == 3;
  16399. }
  16400. // Parse IPv4 address string to bytes
  16401. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  16402. const char *p = str.c_str();
  16403. for (int i = 0; i < 4; i++) {
  16404. if (i > 0) {
  16405. if (*p != '.') { return false; }
  16406. p++;
  16407. }
  16408. int val = 0;
  16409. int digits = 0;
  16410. while (detail::is_ascii_digit(*p)) {
  16411. val = val * 10 + (*p - '0');
  16412. if (val > 255) { return false; }
  16413. p++;
  16414. digits++;
  16415. }
  16416. if (digits == 0) { return false; }
  16417. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  16418. if (digits > 1 && *(p - digits) == '0') { return false; }
  16419. out[i] = static_cast<unsigned char>(val);
  16420. }
  16421. return *p == '\0';
  16422. }
  16423. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  16424. // `out` must have room for at least 16 bytes. Returns the address length
  16425. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  16426. // literal. Used to match a host against iPAddress SANs the same way the
  16427. // OpenSSL backend does via X509_check_ip.
  16428. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  16429. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  16430. struct in6_addr addr6 = {};
  16431. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  16432. memcpy(out, &addr6, 16);
  16433. return 16;
  16434. }
  16435. return 0;
  16436. }
  16437. #ifdef _WIN32
  16438. // Enumerate Windows system certificates and call callback with DER data
  16439. template <typename Callback>
  16440. inline bool enumerate_windows_system_certs(Callback cb) {
  16441. bool loaded = false;
  16442. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16443. for (auto store_name : store_names) {
  16444. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  16445. if (hStore) {
  16446. PCCERT_CONTEXT pContext = nullptr;
  16447. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16448. nullptr) {
  16449. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  16450. loaded = true;
  16451. }
  16452. }
  16453. CertCloseStore(hStore, 0);
  16454. }
  16455. }
  16456. return loaded;
  16457. }
  16458. #endif
  16459. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16460. // Enumerate macOS Keychain certificates and call callback with DER data
  16461. template <typename Callback>
  16462. inline bool enumerate_macos_keychain_certs(Callback cb) {
  16463. bool loaded = false;
  16464. const SecTrustSettingsDomain domains[] = {
  16465. kSecTrustSettingsDomainSystem,
  16466. kSecTrustSettingsDomainAdmin,
  16467. kSecTrustSettingsDomainUser,
  16468. };
  16469. for (auto domain : domains) {
  16470. CFArrayRef certs = nullptr;
  16471. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  16472. if (status != errSecSuccess || !certs) {
  16473. if (certs) CFRelease(certs);
  16474. continue;
  16475. }
  16476. CFIndex count = CFArrayGetCount(certs);
  16477. for (CFIndex i = 0; i < count; i++) {
  16478. SecCertificateRef cert =
  16479. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  16480. CFDataRef data = SecCertificateCopyData(cert);
  16481. if (data) {
  16482. if (cb(CFDataGetBytePtr(data),
  16483. static_cast<size_t>(CFDataGetLength(data)))) {
  16484. loaded = true;
  16485. }
  16486. CFRelease(data);
  16487. }
  16488. }
  16489. CFRelease(certs);
  16490. }
  16491. return loaded;
  16492. }
  16493. #endif
  16494. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16495. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16496. // Common CA certificate file paths on Linux/Unix
  16497. inline const char **system_ca_paths() {
  16498. static const char *paths[] = {
  16499. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16500. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16501. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16502. "/etc/pki/tls/cacert.pem", // OpenELEC
  16503. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16504. nullptr};
  16505. return paths;
  16506. }
  16507. // Common CA certificate directory paths on Linux/Unix
  16508. inline const char **system_ca_dirs() {
  16509. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16510. "/etc/pki/tls/certs", // RHEL/CentOS
  16511. "/usr/share/ca-certificates", // Other
  16512. nullptr};
  16513. return dirs;
  16514. }
  16515. #endif
  16516. } // namespace impl
  16517. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16518. const char *ca_dir) {
  16519. if (!ctx) { return false; }
  16520. bool success = true;
  16521. if (ca_file && *ca_file) {
  16522. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16523. }
  16524. if (ca_dir && *ca_dir) {
  16525. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16526. }
  16527. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16528. // Set CA list for client certificate request (CertificateRequest message)
  16529. if (ca_file && *ca_file) {
  16530. auto list = SSL_load_client_CA_file(ca_file);
  16531. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16532. }
  16533. #endif
  16534. return success;
  16535. }
  16536. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16537. const char *password) {
  16538. return set_client_cert_pem(ctx, cert, key, password);
  16539. }
  16540. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16541. const char *key_path, const char *password) {
  16542. return set_client_cert_file(ctx, cert_path, key_path, password);
  16543. }
  16544. // PeerCert implementation
  16545. inline PeerCert::PeerCert() = default;
  16546. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16547. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16548. other.cert_ = nullptr;
  16549. }
  16550. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16551. if (this != &other) {
  16552. if (cert_) { free_cert(cert_); }
  16553. cert_ = other.cert_;
  16554. other.cert_ = nullptr;
  16555. }
  16556. return *this;
  16557. }
  16558. inline PeerCert::~PeerCert() {
  16559. if (cert_) { free_cert(cert_); }
  16560. }
  16561. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16562. inline std::string PeerCert::subject_cn() const {
  16563. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16564. }
  16565. inline std::string PeerCert::issuer_name() const {
  16566. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16567. }
  16568. inline bool PeerCert::check_hostname(const char *hostname) const {
  16569. return cert_ ? verify_hostname(cert_, hostname) : false;
  16570. }
  16571. inline std::vector<SanEntry> PeerCert::sans() const {
  16572. std::vector<SanEntry> result;
  16573. if (cert_) { get_cert_sans(cert_, result); }
  16574. return result;
  16575. }
  16576. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16577. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16578. }
  16579. inline std::string PeerCert::serial() const {
  16580. return cert_ ? get_cert_serial(cert_) : std::string();
  16581. }
  16582. // VerifyContext method implementations
  16583. inline std::string VerifyContext::subject_cn() const {
  16584. return cert ? get_cert_subject_cn(cert) : std::string();
  16585. }
  16586. inline std::string VerifyContext::issuer_name() const {
  16587. return cert ? get_cert_issuer_name(cert) : std::string();
  16588. }
  16589. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16590. return cert ? verify_hostname(cert, hostname) : false;
  16591. }
  16592. inline std::vector<SanEntry> VerifyContext::sans() const {
  16593. std::vector<SanEntry> result;
  16594. if (cert) { get_cert_sans(cert, result); }
  16595. return result;
  16596. }
  16597. inline bool VerifyContext::validity(time_t &not_before,
  16598. time_t &not_after) const {
  16599. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16600. }
  16601. inline std::string VerifyContext::serial() const {
  16602. return cert ? get_cert_serial(cert) : std::string();
  16603. }
  16604. // TlsError static method implementation
  16605. inline std::string TlsError::verify_error_to_string(long error_code) {
  16606. return verify_error_string(error_code);
  16607. }
  16608. } // namespace tls
  16609. // Request::peer_cert() implementation
  16610. inline tls::PeerCert Request::peer_cert() const {
  16611. return tls::get_peer_cert_from_session(ssl);
  16612. }
  16613. // Request::sni() implementation
  16614. inline std::string Request::sni() const {
  16615. if (!ssl) { return std::string(); }
  16616. const char *s = tls::get_sni(ssl);
  16617. return s ? std::string(s) : std::string();
  16618. }
  16619. #endif // CPPHTTPLIB_SSL_ENABLED
  16620. /*
  16621. * Group 8: TLS abstraction layer - OpenSSL backend
  16622. */
  16623. /*
  16624. * OpenSSL Backend Implementation
  16625. */
  16626. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16627. namespace tls {
  16628. namespace impl {
  16629. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16630. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16631. switch (ssl_error) {
  16632. case SSL_ERROR_NONE: return ErrorCode::Success;
  16633. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16634. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16635. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16636. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16637. case SSL_ERROR_SSL:
  16638. default: return ErrorCode::Fatal;
  16639. }
  16640. }
  16641. // Helper: Create client CA list from PEM string
  16642. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16643. // Caller takes ownership of returned list
  16644. inline STACK_OF(X509_NAME) *
  16645. create_client_ca_list_from_pem(const char *ca_pem) {
  16646. if (!ca_pem) { return nullptr; }
  16647. auto ca_list = sk_X509_NAME_new_null();
  16648. if (!ca_list) { return nullptr; }
  16649. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16650. if (!bio) {
  16651. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16652. return nullptr;
  16653. }
  16654. X509 *cert = nullptr;
  16655. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16656. nullptr) {
  16657. const X509_NAME *name = X509_get_subject_name(cert);
  16658. if (name) {
  16659. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16660. }
  16661. X509_free(cert);
  16662. }
  16663. BIO_free(bio);
  16664. return ca_list;
  16665. }
  16666. inline void free_verify_callback(void * /*parent*/, void *ptr,
  16667. CRYPTO_EX_DATA * /*ad*/, int /*idx*/,
  16668. long /*argl*/, void * /*argp*/) {
  16669. delete static_cast<VerifyCallback *>(ptr);
  16670. }
  16671. // The SSL_CTX owns its verify callback, so each client or server sees only
  16672. // its own, on whichever thread runs the handshake.
  16673. inline int verify_callback_index() {
  16674. static const auto index = SSL_CTX_get_ex_new_index(
  16675. 0, nullptr, nullptr, nullptr, free_verify_callback);
  16676. return index;
  16677. }
  16678. // OpenSSL verify callback wrapper
  16679. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16680. // Get SSL object from X509_STORE_CTX
  16681. auto ssl = static_cast<SSL *>(
  16682. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16683. if (!ssl) { return preverify_ok; }
  16684. auto callback = static_cast<VerifyCallback *>(
  16685. SSL_CTX_get_ex_data(SSL_get_SSL_CTX(ssl), verify_callback_index()));
  16686. if (!callback) { return preverify_ok; }
  16687. // Get current certificate and depth
  16688. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16689. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16690. int error = X509_STORE_CTX_get_error(ctx);
  16691. // Build context
  16692. VerifyContext verify_ctx;
  16693. verify_ctx.session = static_cast<session_t>(ssl);
  16694. verify_ctx.cert = static_cast<cert_t>(cert);
  16695. verify_ctx.depth = depth;
  16696. verify_ctx.preverify_ok = (preverify_ok != 0);
  16697. verify_ctx.error_code = error;
  16698. verify_ctx.error_string =
  16699. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16700. return (*callback)(verify_ctx) ? 1 : 0;
  16701. }
  16702. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16703. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16704. // that must be released with release_store_objects
  16705. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16706. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16707. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16708. #endif
  16709. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16710. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16711. return X509_STORE_get1_objects(store);
  16712. #else
  16713. return X509_STORE_get0_objects(store);
  16714. #endif
  16715. }
  16716. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16717. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16718. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16719. #else
  16720. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16721. #endif
  16722. }
  16723. } // namespace impl
  16724. inline ctx_t create_client_context() {
  16725. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16726. if (ctx) {
  16727. // Disable auto-retry to properly handle non-blocking I/O
  16728. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16729. // Set minimum TLS version
  16730. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16731. }
  16732. return static_cast<ctx_t>(ctx);
  16733. }
  16734. inline void free_context(ctx_t ctx) {
  16735. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16736. }
  16737. inline bool set_min_version(ctx_t ctx, Version version) {
  16738. if (!ctx) return false;
  16739. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16740. static_cast<int>(version)) == 1;
  16741. }
  16742. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16743. if (!ctx || !pem || len == 0) return false;
  16744. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16745. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16746. if (!store) return false;
  16747. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16748. if (!bio) return false;
  16749. bool ok = true;
  16750. X509 *cert = nullptr;
  16751. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16752. nullptr) {
  16753. if (X509_STORE_add_cert(store, cert) != 1) {
  16754. // Ignore duplicate errors
  16755. auto err = ERR_peek_last_error();
  16756. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16757. ok = false;
  16758. }
  16759. }
  16760. X509_free(cert);
  16761. if (!ok) break;
  16762. }
  16763. BIO_free(bio);
  16764. // Clear any "no more certificates" errors
  16765. ERR_clear_error();
  16766. return ok;
  16767. }
  16768. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16769. if (!ctx || !file_path) return false;
  16770. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16771. nullptr) == 1;
  16772. }
  16773. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16774. if (!ctx || !dir_path) return false;
  16775. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16776. dir_path) == 1;
  16777. }
  16778. inline bool load_system_certs(ctx_t ctx) {
  16779. if (!ctx) return false;
  16780. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16781. #ifdef _WIN32
  16782. // Windows: Load from system certificate store (ROOT and CA)
  16783. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16784. if (!store) return false;
  16785. bool loaded_any = false;
  16786. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16787. for (auto store_name : store_names) {
  16788. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16789. if (!hStore) continue;
  16790. PCCERT_CONTEXT pContext = nullptr;
  16791. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16792. nullptr) {
  16793. const unsigned char *data = pContext->pbCertEncoded;
  16794. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16795. if (x509) {
  16796. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16797. X509_free(x509);
  16798. }
  16799. }
  16800. CertCloseStore(hStore, 0);
  16801. }
  16802. return loaded_any;
  16803. #elif defined(__APPLE__)
  16804. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16805. // macOS: Load from Keychain
  16806. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16807. if (!store) return false;
  16808. bool loaded_any = false;
  16809. const SecTrustSettingsDomain domains[] = {
  16810. kSecTrustSettingsDomainSystem,
  16811. kSecTrustSettingsDomainAdmin,
  16812. kSecTrustSettingsDomainUser,
  16813. };
  16814. for (auto domain : domains) {
  16815. CFArrayRef certs = nullptr;
  16816. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16817. !certs) {
  16818. if (certs) CFRelease(certs);
  16819. continue;
  16820. }
  16821. auto count = CFArrayGetCount(certs);
  16822. for (CFIndex i = 0; i < count; i++) {
  16823. auto cert = reinterpret_cast<SecCertificateRef>(
  16824. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16825. CFDataRef der = SecCertificateCopyData(cert);
  16826. if (der) {
  16827. const unsigned char *data = CFDataGetBytePtr(der);
  16828. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16829. if (x509) {
  16830. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16831. X509_free(x509);
  16832. }
  16833. CFRelease(der);
  16834. }
  16835. }
  16836. CFRelease(certs);
  16837. }
  16838. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16839. #else
  16840. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16841. #endif
  16842. #else
  16843. // Other Unix: use default verify paths
  16844. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16845. #endif
  16846. }
  16847. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16848. const char *password) {
  16849. if (!ctx || !cert || !key) return false;
  16850. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16851. // Load certificate
  16852. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16853. if (!cert_bio) return false;
  16854. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16855. BIO_free(cert_bio);
  16856. if (!x509) return false;
  16857. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16858. X509_free(x509);
  16859. if (!cert_ok) return false;
  16860. // Load private key
  16861. auto key_bio = BIO_new_mem_buf(key, -1);
  16862. if (!key_bio) return false;
  16863. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16864. password ? const_cast<char *>(password)
  16865. : nullptr);
  16866. BIO_free(key_bio);
  16867. if (!pkey) return false;
  16868. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16869. EVP_PKEY_free(pkey);
  16870. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16871. }
  16872. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16873. const char *key_path, const char *password) {
  16874. if (!ctx || !cert_path || !key_path) return false;
  16875. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16876. if (password && password[0] != '\0') {
  16877. SSL_CTX_set_default_passwd_cb_userdata(
  16878. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16879. }
  16880. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16881. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16882. }
  16883. inline ctx_t create_server_context() {
  16884. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16885. if (ctx) {
  16886. // No renegotiation, as on the other backends: it would run a handshake
  16887. // that SSLServer::update_certs_pem() does not wait for
  16888. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16889. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION |
  16890. SSL_OP_NO_RENEGOTIATION);
  16891. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16892. }
  16893. return static_cast<ctx_t>(ctx);
  16894. }
  16895. inline void set_verify_client(ctx_t ctx, bool require) {
  16896. if (!ctx) return;
  16897. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16898. require
  16899. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16900. : SSL_VERIFY_NONE,
  16901. nullptr);
  16902. }
  16903. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16904. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16905. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16906. SSL *ssl = SSL_new(ssl_ctx);
  16907. if (!ssl) return nullptr;
  16908. // Disable auto-retry for proper non-blocking I/O handling
  16909. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16910. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16911. if (!bio) {
  16912. SSL_free(ssl);
  16913. return nullptr;
  16914. }
  16915. SSL_set_bio(ssl, bio, bio);
  16916. return static_cast<session_t>(ssl);
  16917. }
  16918. inline void free_session(session_t session) {
  16919. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16920. }
  16921. inline bool set_sni(session_t session, const char *hostname,
  16922. bool /*verify_hostname*/) {
  16923. if (!session || !hostname) return false;
  16924. auto ssl = static_cast<SSL *>(session);
  16925. // Set SNI (Server Name Indication) only - does not enable verification.
  16926. // OpenSSL never binds identity checking to SNI (that happens post-
  16927. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16928. #if defined(OPENSSL_IS_BORINGSSL)
  16929. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16930. #else
  16931. // Direct call instead of macro to suppress -Wold-style-cast warning
  16932. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16933. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16934. #endif
  16935. }
  16936. inline TlsError connect(session_t session) {
  16937. if (!session) { return TlsError(); }
  16938. auto ssl = static_cast<SSL *>(session);
  16939. auto ret = SSL_connect(ssl);
  16940. TlsError err;
  16941. if (ret == 1) {
  16942. err.code = ErrorCode::Success;
  16943. } else {
  16944. auto ssl_err = SSL_get_error(ssl, ret);
  16945. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16946. err.backend_code = ERR_get_error();
  16947. }
  16948. return err;
  16949. }
  16950. inline TlsError accept(session_t session) {
  16951. if (!session) { return TlsError(); }
  16952. auto ssl = static_cast<SSL *>(session);
  16953. auto ret = SSL_accept(ssl);
  16954. TlsError err;
  16955. if (ret == 1) {
  16956. err.code = ErrorCode::Success;
  16957. } else {
  16958. auto ssl_err = SSL_get_error(ssl, ret);
  16959. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16960. err.backend_code = ERR_get_error();
  16961. }
  16962. return err;
  16963. }
  16964. inline bool connect_nonblocking(session_t session, socket_t sock,
  16965. time_t timeout_sec, time_t timeout_usec,
  16966. TlsError *err) {
  16967. if (!session) {
  16968. if (err) { err->code = ErrorCode::Fatal; }
  16969. return false;
  16970. }
  16971. auto ssl = static_cast<SSL *>(session);
  16972. auto bio = SSL_get_rbio(ssl);
  16973. // Set non-blocking mode for handshake
  16974. detail::set_nonblocking(sock, true);
  16975. if (bio) { BIO_set_nbio(bio, 1); }
  16976. auto cleanup = detail::scope_exit([&]() {
  16977. // Restore blocking mode after handshake
  16978. if (bio) { BIO_set_nbio(bio, 0); }
  16979. detail::set_nonblocking(sock, false);
  16980. });
  16981. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  16982. auto res = 0;
  16983. while ((res = SSL_connect(ssl)) != 1) {
  16984. auto ssl_err = SSL_get_error(ssl, res);
  16985. switch (ssl_err) {
  16986. case SSL_ERROR_WANT_READ:
  16987. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  16988. break;
  16989. case SSL_ERROR_WANT_WRITE:
  16990. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  16991. break;
  16992. default: break;
  16993. }
  16994. if (err) {
  16995. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16996. err->backend_code = ERR_get_error();
  16997. }
  16998. return false;
  16999. }
  17000. if (err) { err->code = ErrorCode::Success; }
  17001. return true;
  17002. }
  17003. inline bool accept_nonblocking(session_t session, socket_t sock,
  17004. time_t timeout_sec, time_t timeout_usec,
  17005. TlsError *err) {
  17006. if (!session) {
  17007. if (err) { err->code = ErrorCode::Fatal; }
  17008. return false;
  17009. }
  17010. auto ssl = static_cast<SSL *>(session);
  17011. auto bio = SSL_get_rbio(ssl);
  17012. // Set non-blocking mode for handshake
  17013. detail::set_nonblocking(sock, true);
  17014. if (bio) { BIO_set_nbio(bio, 1); }
  17015. auto cleanup = detail::scope_exit([&]() {
  17016. // Restore blocking mode after handshake
  17017. if (bio) { BIO_set_nbio(bio, 0); }
  17018. detail::set_nonblocking(sock, false);
  17019. });
  17020. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  17021. auto res = 0;
  17022. while ((res = SSL_accept(ssl)) != 1) {
  17023. auto ssl_err = SSL_get_error(ssl, res);
  17024. switch (ssl_err) {
  17025. case SSL_ERROR_WANT_READ:
  17026. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  17027. break;
  17028. case SSL_ERROR_WANT_WRITE:
  17029. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  17030. break;
  17031. default: break;
  17032. }
  17033. if (err) {
  17034. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  17035. err->backend_code = ERR_get_error();
  17036. }
  17037. return false;
  17038. }
  17039. if (err) { err->code = ErrorCode::Success; }
  17040. return true;
  17041. }
  17042. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17043. if (!session || !buf) {
  17044. err.code = ErrorCode::Fatal;
  17045. return -1;
  17046. }
  17047. auto ssl = static_cast<SSL *>(session);
  17048. constexpr auto max_len =
  17049. static_cast<size_t>((std::numeric_limits<int>::max)());
  17050. if (len > max_len) { len = max_len; }
  17051. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  17052. if (ret > 0) {
  17053. err.code = ErrorCode::Success;
  17054. return ret;
  17055. }
  17056. auto ssl_err = SSL_get_error(ssl, ret);
  17057. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17058. if (err.code == ErrorCode::PeerClosed) {
  17059. return 0;
  17060. } // Gracefully handle the peer closed state.
  17061. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17062. return -1;
  17063. }
  17064. inline ssize_t write(session_t session, const void *buf, size_t len,
  17065. TlsError &err) {
  17066. if (!session || !buf) {
  17067. err.code = ErrorCode::Fatal;
  17068. return -1;
  17069. }
  17070. auto ssl = static_cast<SSL *>(session);
  17071. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  17072. if (ret > 0) {
  17073. err.code = ErrorCode::Success;
  17074. return ret;
  17075. }
  17076. auto ssl_err = SSL_get_error(ssl, ret);
  17077. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  17078. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  17079. return -1;
  17080. }
  17081. inline int pending(const_session_t session) {
  17082. if (!session) return 0;
  17083. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  17084. }
  17085. inline void shutdown(session_t session, bool graceful) {
  17086. if (!session) return;
  17087. auto ssl = static_cast<SSL *>(session);
  17088. if (graceful) {
  17089. // Send close_notify without waiting for the peer's. The connection is
  17090. // closed right after this, so a unidirectional shutdown is enough, and an
  17091. // idle peer that never answers would otherwise hold this thread until the
  17092. // read timeout. The other backends do not wait either.
  17093. SSL_shutdown(ssl);
  17094. }
  17095. }
  17096. inline bool is_peer_closed(session_t session, socket_t sock) {
  17097. if (!session) return true;
  17098. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  17099. detail::set_nonblocking(sock, true);
  17100. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17101. auto ssl = static_cast<SSL *>(session);
  17102. char buf;
  17103. auto ret = SSL_peek(ssl, &buf, 1);
  17104. if (ret > 0) return false;
  17105. auto err = SSL_get_error(ssl, ret);
  17106. return err == SSL_ERROR_ZERO_RETURN;
  17107. }
  17108. inline cert_t get_peer_cert(const_session_t session) {
  17109. if (!session) return nullptr;
  17110. return static_cast<cert_t>(SSL_get1_peer_certificate(
  17111. static_cast<SSL *>(const_cast<void *>(session))));
  17112. }
  17113. inline size_t get_peer_certs(const_session_t session,
  17114. std::vector<cert_t> &certs) {
  17115. certs.clear();
  17116. if (!session) { return 0; }
  17117. auto ssl = static_cast<const SSL *>(session);
  17118. // On the server side, the chain leaves out the peer's own certificate
  17119. if (SSL_is_server(ssl)) {
  17120. if (auto leaf = get_peer_cert(session)) { certs.push_back(leaf); }
  17121. }
  17122. auto sk = SSL_get_peer_cert_chain(ssl);
  17123. for (int i = 0; sk && i < sk_X509_num(sk); i++) {
  17124. auto x509 = sk_X509_value(sk, i);
  17125. X509_up_ref(x509);
  17126. certs.push_back(static_cast<cert_t>(x509));
  17127. }
  17128. return certs.size();
  17129. }
  17130. inline void free_cert(cert_t cert) {
  17131. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  17132. }
  17133. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17134. if (!cert || !hostname) return false;
  17135. auto x509 = static_cast<X509 *>(cert);
  17136. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  17137. if (detail::is_ip_address(hostname)) {
  17138. return X509_check_ip_asc(x509, hostname, 0) == 1;
  17139. }
  17140. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  17141. }
  17142. inline uint64_t hostname_mismatch_code() {
  17143. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  17144. }
  17145. inline long get_verify_result(const_session_t session) {
  17146. if (!session) return X509_V_ERR_UNSPECIFIED;
  17147. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  17148. }
  17149. inline std::string get_cert_subject_cn(cert_t cert) {
  17150. if (!cert) return "";
  17151. auto x509 = static_cast<X509 *>(cert);
  17152. auto subject_name = X509_get_subject_name(x509);
  17153. if (!subject_name) return "";
  17154. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  17155. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  17156. if (idx < 0) return "";
  17157. auto entry = X509_NAME_get_entry(subject_name, idx);
  17158. if (!entry) return "";
  17159. auto data = X509_NAME_ENTRY_get_data(entry);
  17160. if (!data) return "";
  17161. return std::string(
  17162. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  17163. static_cast<size_t>(ASN1_STRING_length(data)));
  17164. }
  17165. inline std::string get_cert_issuer_name(cert_t cert) {
  17166. if (!cert) return "";
  17167. auto x509 = static_cast<X509 *>(cert);
  17168. auto issuer_name = X509_get_issuer_name(x509);
  17169. if (!issuer_name) return "";
  17170. char buf[256];
  17171. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  17172. return std::string(buf);
  17173. }
  17174. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17175. sans.clear();
  17176. if (!cert) return false;
  17177. auto x509 = static_cast<X509 *>(cert);
  17178. auto names = static_cast<GENERAL_NAMES *>(
  17179. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  17180. if (!names) return true; // No SANs is valid
  17181. auto count = sk_GENERAL_NAME_num(names);
  17182. for (decltype(count) i = 0; i < count; i++) {
  17183. auto gen = sk_GENERAL_NAME_value(names, i);
  17184. if (!gen) continue;
  17185. SanEntry entry;
  17186. switch (gen->type) {
  17187. case GEN_DNS:
  17188. entry.type = SanType::DNS;
  17189. if (gen->d.dNSName) {
  17190. entry.value = std::string(
  17191. reinterpret_cast<const char *>(
  17192. ASN1_STRING_get0_data(gen->d.dNSName)),
  17193. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  17194. }
  17195. break;
  17196. case GEN_IPADD:
  17197. entry.type = SanType::IP;
  17198. if (gen->d.iPAddress) {
  17199. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  17200. auto len = ASN1_STRING_length(gen->d.iPAddress);
  17201. if (len == 4) {
  17202. // IPv4
  17203. char buf[INET_ADDRSTRLEN];
  17204. inet_ntop(AF_INET, data, buf, sizeof(buf));
  17205. entry.value = buf;
  17206. } else if (len == 16) {
  17207. // IPv6
  17208. char buf[INET6_ADDRSTRLEN];
  17209. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  17210. entry.value = buf;
  17211. }
  17212. }
  17213. break;
  17214. case GEN_EMAIL:
  17215. entry.type = SanType::EMAIL;
  17216. if (gen->d.rfc822Name) {
  17217. entry.value = std::string(
  17218. reinterpret_cast<const char *>(
  17219. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  17220. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  17221. }
  17222. break;
  17223. case GEN_URI:
  17224. entry.type = SanType::URI;
  17225. if (gen->d.uniformResourceIdentifier) {
  17226. entry.value = std::string(
  17227. reinterpret_cast<const char *>(
  17228. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  17229. static_cast<size_t>(
  17230. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  17231. }
  17232. break;
  17233. default: entry.type = SanType::OTHER; break;
  17234. }
  17235. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17236. }
  17237. GENERAL_NAMES_free(names);
  17238. return true;
  17239. }
  17240. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17241. time_t &not_after) {
  17242. if (!cert) return false;
  17243. auto x509 = static_cast<X509 *>(cert);
  17244. auto nb = X509_get0_notBefore(x509);
  17245. auto na = X509_get0_notAfter(x509);
  17246. if (!nb || !na) return false;
  17247. ASN1_TIME *epoch = ASN1_TIME_new();
  17248. if (!epoch) return false;
  17249. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  17250. if (!ASN1_TIME_set(epoch, 0)) return false;
  17251. int pday, psec;
  17252. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  17253. not_before = 86400 * (time_t)pday + psec;
  17254. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  17255. not_after = 86400 * (time_t)pday + psec;
  17256. return true;
  17257. }
  17258. inline std::string get_cert_serial(cert_t cert) {
  17259. if (!cert) return "";
  17260. auto x509 = static_cast<X509 *>(cert);
  17261. auto serial = X509_get_serialNumber(x509);
  17262. if (!serial) return "";
  17263. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  17264. if (!bn) return "";
  17265. auto hex = BN_bn2hex(bn);
  17266. BN_free(bn);
  17267. if (!hex) return "";
  17268. std::string result(hex);
  17269. OPENSSL_free(hex);
  17270. return result;
  17271. }
  17272. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17273. if (!cert) return false;
  17274. auto x509 = static_cast<X509 *>(cert);
  17275. auto len = i2d_X509(x509, nullptr);
  17276. if (len < 0) return false;
  17277. der.resize(static_cast<size_t>(len));
  17278. auto p = der.data();
  17279. i2d_X509(x509, &p);
  17280. return true;
  17281. }
  17282. inline const char *get_sni(const_session_t session) {
  17283. if (!session) return nullptr;
  17284. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17285. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  17286. }
  17287. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  17288. inline uint64_t get_error() { return ERR_get_error(); }
  17289. inline std::string error_string(uint64_t code) {
  17290. char buf[256];
  17291. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  17292. return std::string(buf);
  17293. }
  17294. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17295. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  17296. if (!mem) { return nullptr; }
  17297. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  17298. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  17299. if (!inf) { return nullptr; }
  17300. auto store = X509_STORE_new();
  17301. if (store) {
  17302. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  17303. auto itmp = sk_X509_INFO_value(inf, i);
  17304. if (!itmp) { continue; }
  17305. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  17306. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  17307. }
  17308. }
  17309. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  17310. return static_cast<ca_store_t>(store);
  17311. }
  17312. inline void free_ca_store(ca_store_t store) {
  17313. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  17314. }
  17315. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17316. if (!ctx || !store) { return false; }
  17317. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17318. auto x509_store = static_cast<X509_STORE *>(store);
  17319. // Check if same store is already set
  17320. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  17321. // SSL_CTX_set_cert_store takes ownership and frees the old store
  17322. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  17323. return true;
  17324. }
  17325. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17326. certs.clear();
  17327. if (!ctx) { return 0; }
  17328. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17329. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17330. if (!store) { return 0; }
  17331. auto objs = impl::get_store_objects(store);
  17332. if (!objs) { return 0; }
  17333. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17334. auto count = sk_X509_OBJECT_num(objs);
  17335. for (decltype(count) i = 0; i < count; i++) {
  17336. auto obj = sk_X509_OBJECT_value(objs, i);
  17337. if (!obj) { continue; }
  17338. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17339. auto x509 = X509_OBJECT_get0_X509(obj);
  17340. if (x509) {
  17341. // Increment reference count so caller can free it
  17342. X509_up_ref(x509);
  17343. certs.push_back(static_cast<cert_t>(x509));
  17344. }
  17345. }
  17346. }
  17347. return certs.size();
  17348. }
  17349. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17350. std::vector<std::string> names;
  17351. if (!ctx) { return names; }
  17352. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17353. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  17354. if (!store) { return names; }
  17355. auto objs = impl::get_store_objects(store);
  17356. if (!objs) { return names; }
  17357. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  17358. auto count = sk_X509_OBJECT_num(objs);
  17359. for (decltype(count) i = 0; i < count; i++) {
  17360. auto obj = sk_X509_OBJECT_value(objs, i);
  17361. if (!obj) { continue; }
  17362. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  17363. auto x509 = X509_OBJECT_get0_X509(obj);
  17364. if (x509) {
  17365. auto subject = X509_get_subject_name(x509);
  17366. if (subject) {
  17367. char buf[512];
  17368. X509_NAME_oneline(subject, buf, sizeof(buf));
  17369. names.push_back(buf);
  17370. }
  17371. }
  17372. }
  17373. }
  17374. return names;
  17375. }
  17376. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17377. const char *key_pem, const char *password) {
  17378. if (!ctx || !cert_pem || !key_pem) { return false; }
  17379. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17380. // Load certificate from PEM
  17381. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  17382. if (!cert_bio) { return false; }
  17383. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  17384. BIO_free(cert_bio);
  17385. if (!cert) { return false; }
  17386. // Load private key from PEM
  17387. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  17388. if (!key_bio) {
  17389. X509_free(cert);
  17390. return false;
  17391. }
  17392. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  17393. password ? const_cast<char *>(password)
  17394. : nullptr);
  17395. BIO_free(key_bio);
  17396. if (!key) {
  17397. X509_free(cert);
  17398. return false;
  17399. }
  17400. // Update certificate and key
  17401. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  17402. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  17403. X509_free(cert);
  17404. EVP_PKEY_free(key);
  17405. return ret;
  17406. }
  17407. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17408. if (!ctx || !ca_pem) { return false; }
  17409. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17410. // Create new X509_STORE from PEM
  17411. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  17412. if (!store) { return false; }
  17413. // SSL_CTX_set_cert_store takes ownership
  17414. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  17415. // Set client CA list for client certificate request
  17416. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  17417. if (ca_list) {
  17418. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  17419. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  17420. }
  17421. // A resumed session is not verified again, so forget the sessions and the
  17422. // ticket keys from before, or a client verified under the old CAs could go
  17423. // on resuming.
  17424. #if OPENSSL_VERSION_NUMBER >= 0x30400000L
  17425. SSL_CTX_flush_sessions_ex(ssl_ctx, (std::numeric_limits<time_t>::max)());
  17426. #else
  17427. SSL_CTX_flush_sessions(ssl_ctx, (std::numeric_limits<long>::max)());
  17428. #endif
  17429. unsigned char ticket_keys[80];
  17430. if (RAND_bytes(ticket_keys, sizeof(ticket_keys)) == 1) {
  17431. SSL_CTX_set_tlsext_ticket_keys(ssl_ctx, ticket_keys, sizeof(ticket_keys));
  17432. }
  17433. return true;
  17434. }
  17435. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17436. if (!ctx) { return false; }
  17437. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  17438. auto index = impl::verify_callback_index();
  17439. if (index < 0) { return false; }
  17440. auto stored = callback ? new VerifyCallback(std::move(callback)) : nullptr;
  17441. delete static_cast<VerifyCallback *>(SSL_CTX_get_ex_data(ssl_ctx, index));
  17442. SSL_CTX_set_ex_data(ssl_ctx, index, stored);
  17443. if (stored) {
  17444. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  17445. } else {
  17446. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  17447. }
  17448. return true;
  17449. }
  17450. inline long get_verify_error(const_session_t session) {
  17451. if (!session) { return -1; }
  17452. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  17453. return SSL_get_verify_result(ssl);
  17454. }
  17455. inline std::string verify_error_string(long error_code) {
  17456. if (error_code == X509_V_OK) { return ""; }
  17457. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  17458. return str ? str : "unknown error";
  17459. }
  17460. } // namespace tls
  17461. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  17462. /*
  17463. * Group 9: TLS abstraction layer - Mbed TLS backend
  17464. */
  17465. /*
  17466. * Mbed TLS Backend Implementation
  17467. */
  17468. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  17469. namespace tls {
  17470. namespace impl {
  17471. // Mbed TLS session wrapper
  17472. struct MbedTlsSession {
  17473. mbedtls_ssl_context ssl;
  17474. socket_t sock = INVALID_SOCKET;
  17475. std::string hostname; // For client: set via set_sni
  17476. std::string sni_hostname; // For server: received from client via SNI callback
  17477. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  17478. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  17479. // (e.g. a response that arrived while this side was still in its post-write
  17480. // check), the byte is pushed back here and served by the next read().
  17481. unsigned char peeked_byte = 0;
  17482. bool has_peeked_byte = false;
  17483. // Set by set_sni() when the caller disabled hostname verification, so the
  17484. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  17485. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  17486. // OpenSSL and wolfSSL keep them independent).
  17487. bool suppress_hostname_mismatch = false;
  17488. // Copied from the owning MbedTlsContext at creation, so a handshake only
  17489. // ever runs the callback of its own context.
  17490. VerifyCallback verify_callback;
  17491. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  17492. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  17493. MbedTlsSession(const MbedTlsSession &) = delete;
  17494. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  17495. };
  17496. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  17497. // queue)
  17498. inline int &mbedtls_last_error() {
  17499. static thread_local int err = 0;
  17500. return err;
  17501. }
  17502. // Helper to map Mbed TLS error to ErrorCode
  17503. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  17504. uint32_t verify_flags) {
  17505. if (ret == 0) { return ErrorCode::Success; }
  17506. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  17507. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  17508. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  17509. return ErrorCode::PeerClosed;
  17510. }
  17511. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  17512. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  17513. out_errno = errno;
  17514. return ErrorCode::SyscallError;
  17515. }
  17516. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  17517. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  17518. // the handshake's chain verification (see set_sni()); a mismatch there
  17519. // is reported the same way as any other verify_flags bit. Report it as
  17520. // HostnameMismatch, matching the other backends and the post-handshake
  17521. // identity check below, but only when naming is the sole problem -
  17522. // if the chain itself is also untrusted/expired/etc., that takes
  17523. // priority over the naming detail.
  17524. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  17525. return ErrorCode::HostnameMismatch;
  17526. }
  17527. return ErrorCode::CertVerifyFailed;
  17528. }
  17529. return ErrorCode::Fatal;
  17530. }
  17531. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  17532. // return value, including the verify-flags-dependent HostnameMismatch
  17533. // mapping; shared by connect() and connect_nonblocking() so the
  17534. // backend_code policy for that mapping only lives in one place.
  17535. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17536. int ret) {
  17537. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17538. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17539. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17540. ? static_cast<uint64_t>(verify_flags)
  17541. : static_cast<uint64_t>(-ret);
  17542. }
  17543. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17544. // non-fatal notification delivered between records, not an error and not
  17545. // application data, so I/O calls that see it should just be retried. Kept in
  17546. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17547. // splitting the closing brace across an #if.
  17548. inline bool mbedtls_is_session_ticket(int ret) {
  17549. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17550. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17551. #else
  17552. (void)ret;
  17553. return false;
  17554. #endif
  17555. }
  17556. // BIO-like send callback for Mbed TLS
  17557. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17558. size_t len) {
  17559. auto sock = *static_cast<socket_t *>(ctx);
  17560. #ifdef _WIN32
  17561. auto ret =
  17562. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17563. if (ret == SOCKET_ERROR) {
  17564. int err = WSAGetLastError();
  17565. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17566. return MBEDTLS_ERR_NET_SEND_FAILED;
  17567. }
  17568. #else
  17569. auto ret = send(sock, buf, len, 0);
  17570. if (ret < 0) {
  17571. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17572. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17573. }
  17574. return MBEDTLS_ERR_NET_SEND_FAILED;
  17575. }
  17576. #endif
  17577. return static_cast<int>(ret);
  17578. }
  17579. // BIO-like recv callback for Mbed TLS
  17580. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17581. auto sock = *static_cast<socket_t *>(ctx);
  17582. #ifdef _WIN32
  17583. auto ret =
  17584. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17585. if (ret == SOCKET_ERROR) {
  17586. int err = WSAGetLastError();
  17587. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17588. return MBEDTLS_ERR_NET_RECV_FAILED;
  17589. }
  17590. #else
  17591. auto ret = recv(sock, buf, len, 0);
  17592. if (ret < 0) {
  17593. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17594. return MBEDTLS_ERR_SSL_WANT_READ;
  17595. }
  17596. return MBEDTLS_ERR_NET_RECV_FAILED;
  17597. }
  17598. #endif
  17599. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17600. return static_cast<int>(ret);
  17601. }
  17602. // MbedTlsContext constructor/destructor implementations
  17603. inline MbedTlsContext::MbedTlsContext() {
  17604. mbedtls_ssl_config_init(&conf);
  17605. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17606. mbedtls_entropy_init(&entropy);
  17607. mbedtls_ctr_drbg_init(&ctr_drbg);
  17608. #endif
  17609. mbedtls_x509_crt_init(&ca_chain);
  17610. mbedtls_x509_crt_init(&own_cert);
  17611. mbedtls_pk_init(&own_key);
  17612. }
  17613. inline MbedTlsContext::~MbedTlsContext() {
  17614. mbedtls_pk_free(&own_key);
  17615. mbedtls_x509_crt_free(&own_cert);
  17616. mbedtls_x509_crt_free(&ca_chain);
  17617. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17618. mbedtls_ctr_drbg_free(&ctr_drbg);
  17619. mbedtls_entropy_free(&entropy);
  17620. #endif
  17621. mbedtls_ssl_config_free(&conf);
  17622. }
  17623. // Thread-local storage for SNI captured during handshake
  17624. // This is needed because the SNI callback doesn't have a way to pass
  17625. // session-specific data before the session is fully set up
  17626. inline std::string &mbedpending_sni() {
  17627. static thread_local std::string sni;
  17628. return sni;
  17629. }
  17630. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17631. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17632. const unsigned char *name, size_t name_len) {
  17633. (void)p_ctx;
  17634. (void)ssl;
  17635. // Store SNI name in thread-local storage
  17636. // It will be retrieved and stored in the session after handshake
  17637. if (name && name_len > 0) {
  17638. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17639. } else {
  17640. mbedpending_sni().clear();
  17641. }
  17642. return 0; // Accept any SNI
  17643. }
  17644. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17645. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17646. }
  17647. // Verify callback used when hostname verification is disabled for a session
  17648. // that has no user-supplied verify callback of its own.
  17649. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17650. mbedtls_x509_crt *, int,
  17651. uint32_t *flags) {
  17652. (void)data;
  17653. mbedtls_clear_cn_mismatch(flags);
  17654. return 0;
  17655. }
  17656. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17657. int cert_depth, uint32_t *flags);
  17658. // MbedTLS verify callback wrapper
  17659. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17660. int cert_depth, uint32_t *flags) {
  17661. // data points to the MbedTlsSession
  17662. auto *session = static_cast<MbedTlsSession *>(data);
  17663. // set_sni() disabled hostname verification for this session: drop the
  17664. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17665. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17666. // SNI. The final pass/fail decision still comes from the remaining flags
  17667. // (or, below, from the user's own verify callback).
  17668. if (session->suppress_hostname_mismatch) { mbedtls_clear_cn_mismatch(flags); }
  17669. // Build context
  17670. VerifyContext verify_ctx;
  17671. verify_ctx.session = static_cast<session_t>(session);
  17672. verify_ctx.cert = static_cast<cert_t>(crt);
  17673. verify_ctx.depth = cert_depth;
  17674. verify_ctx.preverify_ok = (*flags == 0);
  17675. verify_ctx.error_code = static_cast<long>(*flags);
  17676. // Convert Mbed TLS flags to error string
  17677. static thread_local char error_buf[256];
  17678. if (*flags != 0) {
  17679. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17680. verify_ctx.error_string = error_buf;
  17681. } else {
  17682. verify_ctx.error_string = nullptr;
  17683. }
  17684. bool accepted = session->verify_callback(verify_ctx);
  17685. if (accepted) {
  17686. *flags = 0; // Clear all error flags
  17687. return 0;
  17688. }
  17689. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17690. }
  17691. } // namespace impl
  17692. inline ctx_t create_client_context() {
  17693. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17694. if (!ctx) { return nullptr; }
  17695. ctx->is_server = false;
  17696. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17697. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17698. if (!detail::ensure_mbedtls_psa_crypto()) {
  17699. delete ctx;
  17700. return nullptr;
  17701. }
  17702. int ret;
  17703. #else
  17704. // Seed the random number generator
  17705. const char *pers = "httplib_client";
  17706. int ret = mbedtls_ctr_drbg_seed(
  17707. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17708. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17709. if (ret != 0) {
  17710. impl::mbedtls_last_error() = ret;
  17711. delete ctx;
  17712. return nullptr;
  17713. }
  17714. #endif
  17715. // Set up SSL config for client
  17716. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17717. MBEDTLS_SSL_TRANSPORT_STREAM,
  17718. MBEDTLS_SSL_PRESET_DEFAULT);
  17719. if (ret != 0) {
  17720. impl::mbedtls_last_error() = ret;
  17721. delete ctx;
  17722. return nullptr;
  17723. }
  17724. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17725. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17726. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17727. #endif
  17728. // Default: verify peer certificate
  17729. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17730. // Set minimum TLS version to 1.2
  17731. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17732. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17733. #else
  17734. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17735. MBEDTLS_SSL_MINOR_VERSION_3);
  17736. #endif
  17737. return static_cast<ctx_t>(ctx);
  17738. }
  17739. inline ctx_t create_server_context() {
  17740. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17741. if (!ctx) { return nullptr; }
  17742. ctx->is_server = true;
  17743. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17744. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17745. if (!detail::ensure_mbedtls_psa_crypto()) {
  17746. delete ctx;
  17747. return nullptr;
  17748. }
  17749. int ret;
  17750. #else
  17751. // Seed the random number generator
  17752. const char *pers = "httplib_server";
  17753. int ret = mbedtls_ctr_drbg_seed(
  17754. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17755. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17756. if (ret != 0) {
  17757. impl::mbedtls_last_error() = ret;
  17758. delete ctx;
  17759. return nullptr;
  17760. }
  17761. #endif
  17762. // Set up SSL config for server
  17763. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17764. MBEDTLS_SSL_TRANSPORT_STREAM,
  17765. MBEDTLS_SSL_PRESET_DEFAULT);
  17766. if (ret != 0) {
  17767. impl::mbedtls_last_error() = ret;
  17768. delete ctx;
  17769. return nullptr;
  17770. }
  17771. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17772. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17773. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17774. #endif
  17775. // Default: don't verify client
  17776. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17777. // Set minimum TLS version to 1.2
  17778. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17779. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17780. #else
  17781. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17782. MBEDTLS_SSL_MINOR_VERSION_3);
  17783. #endif
  17784. // Set SNI callback to capture client's SNI hostname
  17785. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17786. return static_cast<ctx_t>(ctx);
  17787. }
  17788. inline void free_context(ctx_t ctx) {
  17789. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17790. }
  17791. inline bool set_min_version(ctx_t ctx, Version version) {
  17792. if (!ctx) { return false; }
  17793. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17794. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17795. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17796. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17797. if (version >= Version::TLS1_3) {
  17798. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17799. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17800. #endif
  17801. }
  17802. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17803. #else
  17804. // Mbed TLS 2.x uses major/minor version numbers
  17805. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17806. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17807. if (version >= Version::TLS1_3) {
  17808. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17809. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17810. #else
  17811. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17812. #endif
  17813. }
  17814. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17815. #endif
  17816. return true;
  17817. }
  17818. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17819. if (!ctx || !pem) { return false; }
  17820. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17821. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17822. // Add null terminator if not present
  17823. std::string pem_str(pem, len);
  17824. int ret = mbedtls_x509_crt_parse(
  17825. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17826. pem_str.size() + 1);
  17827. if (ret != 0) {
  17828. impl::mbedtls_last_error() = ret;
  17829. return false;
  17830. }
  17831. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17832. return true;
  17833. }
  17834. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17835. if (!ctx || !file_path) { return false; }
  17836. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17837. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17838. if (ret != 0) {
  17839. impl::mbedtls_last_error() = ret;
  17840. return false;
  17841. }
  17842. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17843. return true;
  17844. }
  17845. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17846. if (!ctx || !dir_path) { return false; }
  17847. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17848. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17849. if (ret < 0) { // Returns number of certs on success, negative on error
  17850. impl::mbedtls_last_error() = ret;
  17851. return false;
  17852. }
  17853. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17854. return true;
  17855. }
  17856. inline bool load_system_certs(ctx_t ctx) {
  17857. if (!ctx) { return false; }
  17858. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17859. bool loaded = false;
  17860. #ifdef _WIN32
  17861. loaded = impl::enumerate_windows_system_certs(
  17862. [&](const unsigned char *data, size_t len) {
  17863. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17864. });
  17865. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17866. loaded = impl::enumerate_macos_keychain_certs(
  17867. [&](const unsigned char *data, size_t len) {
  17868. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17869. });
  17870. #else
  17871. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17872. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17873. loaded = true;
  17874. break;
  17875. }
  17876. }
  17877. if (!loaded) {
  17878. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17879. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17880. loaded = true;
  17881. break;
  17882. }
  17883. }
  17884. }
  17885. #endif
  17886. if (loaded) {
  17887. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17888. }
  17889. return loaded;
  17890. }
  17891. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17892. const char *password) {
  17893. if (!ctx || !cert || !key) { return false; }
  17894. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17895. // Parse certificate
  17896. std::string cert_str(cert);
  17897. int ret = mbedtls_x509_crt_parse(
  17898. &mctx->own_cert,
  17899. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17900. cert_str.size() + 1);
  17901. if (ret != 0) {
  17902. impl::mbedtls_last_error() = ret;
  17903. return false;
  17904. }
  17905. // Parse private key
  17906. std::string key_str(key);
  17907. const unsigned char *pwd =
  17908. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17909. size_t pwd_len = password ? strlen(password) : 0;
  17910. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17911. ret = mbedtls_pk_parse_key(
  17912. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17913. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17914. &mctx->ctr_drbg);
  17915. #else
  17916. ret = mbedtls_pk_parse_key(
  17917. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17918. key_str.size() + 1, pwd, pwd_len);
  17919. #endif
  17920. if (ret != 0) {
  17921. impl::mbedtls_last_error() = ret;
  17922. return false;
  17923. }
  17924. // Verify that the certificate and private key match.
  17925. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17926. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17927. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17928. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17929. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17930. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17931. #else
  17932. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17933. #endif
  17934. if (ret != 0) {
  17935. impl::mbedtls_last_error() = ret;
  17936. return false;
  17937. }
  17938. #endif
  17939. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17940. if (ret != 0) {
  17941. impl::mbedtls_last_error() = ret;
  17942. return false;
  17943. }
  17944. return true;
  17945. }
  17946. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17947. const char *key_path, const char *password) {
  17948. if (!ctx || !cert_path || !key_path) { return false; }
  17949. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17950. // Parse certificate file
  17951. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17952. if (ret != 0) {
  17953. impl::mbedtls_last_error() = ret;
  17954. return false;
  17955. }
  17956. // Parse private key file
  17957. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17958. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17959. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17960. #else
  17961. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17962. #endif
  17963. if (ret != 0) {
  17964. impl::mbedtls_last_error() = ret;
  17965. return false;
  17966. }
  17967. // Verify that the certificate and private key match.
  17968. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17969. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17970. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17971. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17972. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17973. #else
  17974. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17975. #endif
  17976. if (ret != 0) {
  17977. impl::mbedtls_last_error() = ret;
  17978. return false;
  17979. }
  17980. #endif
  17981. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17982. if (ret != 0) {
  17983. impl::mbedtls_last_error() = ret;
  17984. return false;
  17985. }
  17986. return true;
  17987. }
  17988. inline void set_verify_client(ctx_t ctx, bool require) {
  17989. if (!ctx) { return; }
  17990. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17991. mctx->verify_client = require;
  17992. if (require) {
  17993. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17994. } else {
  17995. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17996. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17997. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->verify_callback
  17998. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17999. : MBEDTLS_SSL_VERIFY_NONE);
  18000. }
  18001. }
  18002. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18003. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18004. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  18005. auto session = new (std::nothrow) impl::MbedTlsSession();
  18006. if (!session) { return nullptr; }
  18007. session->sock = sock;
  18008. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  18009. if (ret != 0) {
  18010. impl::mbedtls_last_error() = ret;
  18011. delete session;
  18012. return nullptr;
  18013. }
  18014. // Explicitly opt out of in-handshake hostname verification by default;
  18015. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  18016. // fails outright when no hostname was set. set_sni() installs the real
  18017. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  18018. // caller verifies the certificate identity post-handshake via
  18019. // verify_hostname().
  18020. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  18021. // Set BIO callbacks
  18022. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  18023. impl::mbedtls_net_recv_cb, nullptr);
  18024. // Set per-session verify callback with session pointer if callback is
  18025. // registered
  18026. session->verify_callback = mctx->verify_callback;
  18027. if (session->verify_callback) {
  18028. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  18029. session);
  18030. }
  18031. return static_cast<session_t>(session);
  18032. }
  18033. inline void free_session(session_t session) {
  18034. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  18035. }
  18036. inline bool set_sni(session_t session, const char *hostname,
  18037. bool verify_hostname) {
  18038. if (!session || !hostname) { return false; }
  18039. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18040. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  18041. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  18042. // independently, so a disabled hostname check is handled below by masking
  18043. // the resulting mismatch flag instead of skipping this call.
  18044. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  18045. if (ret != 0) {
  18046. impl::mbedtls_last_error() = ret;
  18047. return false;
  18048. }
  18049. msession->hostname = hostname;
  18050. if (!verify_hostname) {
  18051. msession->suppress_hostname_mismatch = true;
  18052. // If a user verify callback is already wired for this session,
  18053. // mbedtls_verify_callback() masks the mismatch flag itself before
  18054. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  18055. // here would be redundant. Otherwise install the masking callback alone.
  18056. if (!msession->verify_callback) {
  18057. mbedtls_ssl_set_verify(&msession->ssl,
  18058. impl::mbedtls_mask_hostname_mismatch_callback,
  18059. msession);
  18060. }
  18061. }
  18062. return true;
  18063. }
  18064. inline TlsError connect(session_t session) {
  18065. TlsError err;
  18066. if (!session) {
  18067. err.code = ErrorCode::Fatal;
  18068. return err;
  18069. }
  18070. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18071. int ret;
  18072. do {
  18073. ret = mbedtls_ssl_handshake(&msession->ssl);
  18074. } while (impl::mbedtls_is_session_ticket(ret));
  18075. if (ret == 0) {
  18076. err.code = ErrorCode::Success;
  18077. } else {
  18078. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  18079. impl::mbedtls_last_error() = ret;
  18080. }
  18081. return err;
  18082. }
  18083. inline TlsError accept(session_t session) {
  18084. // Same as connect for Mbed TLS - handshake works for both client and server
  18085. auto result = connect(session);
  18086. // After successful handshake, capture SNI from thread-local storage
  18087. if (result.code == ErrorCode::Success && session) {
  18088. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18089. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18090. impl::mbedpending_sni().clear();
  18091. }
  18092. return result;
  18093. }
  18094. inline bool connect_nonblocking(session_t session, socket_t sock,
  18095. time_t timeout_sec, time_t timeout_usec,
  18096. TlsError *err) {
  18097. if (!session) {
  18098. if (err) { err->code = ErrorCode::Fatal; }
  18099. return false;
  18100. }
  18101. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18102. // Set socket to non-blocking mode
  18103. detail::set_nonblocking(sock, true);
  18104. auto cleanup =
  18105. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18106. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  18107. int ret;
  18108. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  18109. // Non-fatal TLS 1.3 ticket; retry immediately.
  18110. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  18111. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  18112. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  18113. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  18114. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  18115. }
  18116. // TlsError or timeout
  18117. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  18118. impl::mbedtls_last_error() = ret;
  18119. return false;
  18120. }
  18121. if (err) { err->code = ErrorCode::Success; }
  18122. return true;
  18123. }
  18124. inline bool accept_nonblocking(session_t session, socket_t sock,
  18125. time_t timeout_sec, time_t timeout_usec,
  18126. TlsError *err) {
  18127. // Same implementation as connect for Mbed TLS
  18128. bool result =
  18129. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  18130. // After successful handshake, capture SNI from thread-local storage
  18131. if (result && session) {
  18132. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18133. msession->sni_hostname = std::move(impl::mbedpending_sni());
  18134. impl::mbedpending_sni().clear();
  18135. }
  18136. return result;
  18137. }
  18138. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18139. if (!session || !buf) {
  18140. err.code = ErrorCode::Fatal;
  18141. return -1;
  18142. }
  18143. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18144. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  18145. if (msession->has_peeked_byte) {
  18146. if (len == 0) { return 0; }
  18147. auto p = static_cast<unsigned char *>(buf);
  18148. p[0] = msession->peeked_byte;
  18149. msession->has_peeked_byte = false;
  18150. size_t n = 1;
  18151. // Top up with any already-decrypted bytes without risking a block.
  18152. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18153. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  18154. if (extra > 0) { n += static_cast<size_t>(extra); }
  18155. }
  18156. err.code = ErrorCode::Success;
  18157. return static_cast<ssize_t>(n);
  18158. }
  18159. int ret;
  18160. do {
  18161. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  18162. len);
  18163. } while (impl::mbedtls_is_session_ticket(ret));
  18164. if (ret > 0) {
  18165. err.code = ErrorCode::Success;
  18166. return static_cast<ssize_t>(ret);
  18167. }
  18168. if (ret == 0) {
  18169. err.code = ErrorCode::PeerClosed;
  18170. return 0;
  18171. }
  18172. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18173. err.backend_code = static_cast<uint64_t>(-ret);
  18174. impl::mbedtls_last_error() = ret;
  18175. // mbedTLS signals a clean close_notify via a negative error code rather
  18176. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  18177. if (err.code == ErrorCode::PeerClosed) { return 0; }
  18178. return -1;
  18179. }
  18180. inline ssize_t write(session_t session, const void *buf, size_t len,
  18181. TlsError &err) {
  18182. if (!session || !buf) {
  18183. err.code = ErrorCode::Fatal;
  18184. return -1;
  18185. }
  18186. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18187. int ret;
  18188. do {
  18189. ret = mbedtls_ssl_write(&msession->ssl,
  18190. static_cast<const unsigned char *>(buf), len);
  18191. } while (impl::mbedtls_is_session_ticket(ret));
  18192. if (ret > 0) {
  18193. err.code = ErrorCode::Success;
  18194. return static_cast<ssize_t>(ret);
  18195. }
  18196. if (ret == 0) {
  18197. err.code = ErrorCode::PeerClosed;
  18198. return 0;
  18199. }
  18200. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  18201. err.backend_code = static_cast<uint64_t>(-ret);
  18202. impl::mbedtls_last_error() = ret;
  18203. return -1;
  18204. }
  18205. inline int pending(const_session_t session) {
  18206. if (!session) { return 0; }
  18207. auto msession =
  18208. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18209. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  18210. (msession->has_peeked_byte ? 1 : 0);
  18211. }
  18212. inline void shutdown(session_t session, bool graceful) {
  18213. if (!session) { return; }
  18214. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18215. if (graceful) {
  18216. // Try to send close_notify, but don't block forever
  18217. int ret;
  18218. int attempts = 0;
  18219. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  18220. attempts < 3) {
  18221. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  18222. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  18223. break;
  18224. }
  18225. attempts++;
  18226. }
  18227. }
  18228. }
  18229. inline bool is_peer_closed(session_t session, socket_t sock) {
  18230. if (!session || sock == INVALID_SOCKET) { return true; }
  18231. auto msession = static_cast<impl::MbedTlsSession *>(session);
  18232. // Check if there's already decrypted or pushed-back data available.
  18233. // If so, the connection is definitely alive.
  18234. if (msession->has_peeked_byte ||
  18235. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  18236. return false;
  18237. }
  18238. // Set socket to non-blocking to avoid blocking on read
  18239. detail::set_nonblocking(sock, true);
  18240. auto cleanup =
  18241. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18242. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  18243. // on application data — e.g. a response that already arrived — push the
  18244. // byte back so the next read() delivers it instead of losing it.
  18245. unsigned char buf;
  18246. int ret;
  18247. do {
  18248. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  18249. } while (impl::mbedtls_is_session_ticket(ret));
  18250. // If we got data or WANT_READ (would block), connection is alive
  18251. if (ret > 0) {
  18252. msession->peeked_byte = buf;
  18253. msession->has_peeked_byte = true;
  18254. return false;
  18255. }
  18256. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  18257. // If we get a peer close notify or a connection reset, the peer is closed
  18258. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  18259. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  18260. }
  18261. inline cert_t get_peer_cert(const_session_t session) {
  18262. if (!session) { return nullptr; }
  18263. auto msession =
  18264. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18265. // Mbed TLS returns a pointer to the internal peer cert chain.
  18266. // WARNING: This pointer is only valid while the session is active.
  18267. // Do not use the certificate after calling free_session().
  18268. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  18269. return const_cast<mbedtls_x509_crt *>(cert);
  18270. }
  18271. inline size_t get_peer_certs(const_session_t session,
  18272. std::vector<cert_t> &certs) {
  18273. certs.clear();
  18274. // Mbed TLS parses the whole received chain into a list headed by the peer
  18275. // certificate, owned by the session like get_peer_cert()'s result
  18276. for (auto crt = static_cast<mbedtls_x509_crt *>(get_peer_cert(session));
  18277. crt && crt->raw.len > 0; crt = crt->next) {
  18278. certs.push_back(static_cast<cert_t>(crt));
  18279. }
  18280. return certs.size();
  18281. }
  18282. inline void free_cert(cert_t cert) {
  18283. // Mbed TLS: every cert_t handed out points into a session's or a context's
  18284. // chain, so there is nothing to free. Callers still call this for the other
  18285. // backends.
  18286. (void)cert;
  18287. }
  18288. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18289. if (!cert || !hostname) { return false; }
  18290. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  18291. std::string host_str(hostname);
  18292. // Check if hostname is an IP address (IPv4 or IPv6)
  18293. unsigned char ip_bytes[16];
  18294. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18295. auto is_ip = ip_len > 0;
  18296. // Check Subject Alternative Names (SAN). Mbed TLS keeps the GeneralName type
  18297. // in buf.tag and the raw value in buf.p / buf.len.
  18298. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  18299. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  18300. const unsigned char *p = san->buf.p;
  18301. size_t len = san->buf.len;
  18302. auto san_type = san->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK;
  18303. if (is_ip) {
  18304. // For an IP host, only a matching iPAddress SAN of the same family
  18305. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  18306. if (san_type == MBEDTLS_X509_SAN_IP_ADDRESS && len == ip_len &&
  18307. memcmp(p, ip_bytes, ip_len) == 0) {
  18308. return true;
  18309. }
  18310. } else if (san_type == MBEDTLS_X509_SAN_DNS_NAME) {
  18311. std::string san_name(reinterpret_cast<const char *>(p), len);
  18312. if (detail::match_hostname(san_name, host_str)) { return true; }
  18313. }
  18314. san = san->next;
  18315. }
  18316. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18317. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18318. // the OpenSSL backend's X509_check_ip behaves the same way).
  18319. if (!is_ip) {
  18320. char cn[256];
  18321. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  18322. if (ret > 0) {
  18323. std::string cn_str(cn);
  18324. // Look for "CN=" in the DN string
  18325. size_t cn_pos = cn_str.find("CN=");
  18326. if (cn_pos != std::string::npos) {
  18327. size_t start = cn_pos + 3;
  18328. size_t end = cn_str.find(',', start);
  18329. std::string cn_value =
  18330. cn_str.substr(start, end == std::string::npos ? end : end - start);
  18331. if (detail::match_hostname(cn_value, host_str)) { return true; }
  18332. }
  18333. }
  18334. }
  18335. return false;
  18336. }
  18337. inline uint64_t hostname_mismatch_code() {
  18338. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  18339. }
  18340. inline long get_verify_result(const_session_t session) {
  18341. if (!session) { return -1; }
  18342. auto msession =
  18343. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18344. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  18345. // Return 0 (X509_V_OK equivalent) if verification passed
  18346. return flags == 0 ? 0 : static_cast<long>(flags);
  18347. }
  18348. inline std::string get_cert_subject_cn(cert_t cert) {
  18349. if (!cert) return "";
  18350. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18351. // Find the CN in the subject
  18352. const mbedtls_x509_name *name = &x509->subject;
  18353. while (name != nullptr) {
  18354. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  18355. return std::string(reinterpret_cast<const char *>(name->val.p),
  18356. name->val.len);
  18357. }
  18358. name = name->next;
  18359. }
  18360. return "";
  18361. }
  18362. inline std::string get_cert_issuer_name(cert_t cert) {
  18363. if (!cert) return "";
  18364. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18365. // Build a human-readable issuer name string
  18366. char buf[512];
  18367. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  18368. if (ret < 0) return "";
  18369. return std::string(buf);
  18370. }
  18371. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18372. sans.clear();
  18373. if (!cert) return false;
  18374. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18375. // Parse the Subject Alternative Name extension
  18376. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  18377. while (cur != nullptr) {
  18378. if (cur->buf.len > 0) {
  18379. const unsigned char *p = cur->buf.p;
  18380. size_t value_len = cur->buf.len;
  18381. SanEntry entry;
  18382. switch (cur->buf.tag & MBEDTLS_ASN1_TAG_VALUE_MASK) {
  18383. case MBEDTLS_X509_SAN_DNS_NAME:
  18384. entry.type = SanType::DNS;
  18385. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18386. break;
  18387. case MBEDTLS_X509_SAN_IP_ADDRESS:
  18388. entry.type = SanType::IP;
  18389. if (value_len == 4) {
  18390. // IPv4
  18391. char buf[16];
  18392. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  18393. entry.value = buf;
  18394. } else if (value_len == 16) {
  18395. // IPv6
  18396. char buf[64];
  18397. snprintf(buf, sizeof(buf),
  18398. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18399. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18400. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8], p[9],
  18401. p[10], p[11], p[12], p[13], p[14], p[15]);
  18402. entry.value = buf;
  18403. }
  18404. break;
  18405. case MBEDTLS_X509_SAN_RFC822_NAME:
  18406. entry.type = SanType::EMAIL;
  18407. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18408. break;
  18409. case MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER:
  18410. entry.type = SanType::URI;
  18411. entry.value = std::string(reinterpret_cast<const char *>(p), value_len);
  18412. break;
  18413. default: entry.type = SanType::OTHER; break;
  18414. }
  18415. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18416. }
  18417. cur = cur->next;
  18418. }
  18419. return true;
  18420. }
  18421. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18422. time_t &not_after) {
  18423. if (!cert) return false;
  18424. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18425. // Convert mbedtls_x509_time to time_t
  18426. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  18427. struct tm tm_time = {};
  18428. tm_time.tm_year = t.year - 1900;
  18429. tm_time.tm_mon = t.mon - 1;
  18430. tm_time.tm_mday = t.day;
  18431. tm_time.tm_hour = t.hour;
  18432. tm_time.tm_min = t.min;
  18433. tm_time.tm_sec = t.sec;
  18434. #ifdef _WIN32
  18435. return _mkgmtime(&tm_time);
  18436. #else
  18437. return timegm(&tm_time);
  18438. #endif
  18439. };
  18440. not_before = to_time_t(x509->valid_from);
  18441. not_after = to_time_t(x509->valid_to);
  18442. return true;
  18443. }
  18444. inline std::string get_cert_serial(cert_t cert) {
  18445. if (!cert) return "";
  18446. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  18447. // Convert serial number to hex string
  18448. std::string result;
  18449. result.reserve(x509->serial.len * 2);
  18450. for (size_t i = 0; i < x509->serial.len; i++) {
  18451. char hex[3];
  18452. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  18453. result += hex;
  18454. }
  18455. return result;
  18456. }
  18457. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18458. if (!cert) return false;
  18459. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  18460. if (!crt->raw.p || crt->raw.len == 0) return false;
  18461. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  18462. return true;
  18463. }
  18464. inline const char *get_sni(const_session_t session) {
  18465. if (!session) return nullptr;
  18466. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  18467. // For server: return SNI received from client during handshake
  18468. if (!msession->sni_hostname.empty()) {
  18469. return msession->sni_hostname.c_str();
  18470. }
  18471. // For client: return the hostname set via set_sni
  18472. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  18473. return nullptr;
  18474. }
  18475. inline uint64_t peek_error() {
  18476. // Mbed TLS doesn't have an error queue, return the last error
  18477. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  18478. }
  18479. inline uint64_t get_error() {
  18480. // Mbed TLS doesn't have an error queue, return and clear the last error
  18481. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  18482. impl::mbedtls_last_error() = 0;
  18483. return err;
  18484. }
  18485. inline std::string error_string(uint64_t code) {
  18486. char buf[256];
  18487. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  18488. return std::string(buf);
  18489. }
  18490. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18491. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  18492. if (!ca_chain) { return nullptr; }
  18493. mbedtls_x509_crt_init(ca_chain);
  18494. // mbedtls_x509_crt_parse expects null-terminated PEM
  18495. int ret = mbedtls_x509_crt_parse(ca_chain,
  18496. reinterpret_cast<const unsigned char *>(pem),
  18497. len + 1); // +1 for null terminator
  18498. if (ret != 0) {
  18499. // Try without +1 in case PEM is already null-terminated
  18500. ret = mbedtls_x509_crt_parse(
  18501. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  18502. if (ret != 0) {
  18503. mbedtls_x509_crt_free(ca_chain);
  18504. delete ca_chain;
  18505. return nullptr;
  18506. }
  18507. }
  18508. return static_cast<ca_store_t>(ca_chain);
  18509. }
  18510. inline void free_ca_store(ca_store_t store) {
  18511. if (store) {
  18512. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18513. mbedtls_x509_crt_free(ca_chain);
  18514. delete ca_chain;
  18515. }
  18516. }
  18517. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18518. if (!ctx || !store) { return false; }
  18519. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18520. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18521. // Free existing CA chain
  18522. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18523. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18524. // Copy the CA chain (deep copy)
  18525. // Parse from the raw data of the source cert
  18526. mbedtls_x509_crt *src = ca_chain;
  18527. while (src != nullptr) {
  18528. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18529. src->raw.len);
  18530. if (ret != 0) {
  18531. free_ca_store(store);
  18532. return false;
  18533. }
  18534. src = src->next;
  18535. }
  18536. // This function takes ownership of the store; the chain was deep-copied
  18537. // above, so release the source
  18538. free_ca_store(store);
  18539. // Update the SSL config to use the new CA chain
  18540. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18541. return true;
  18542. }
  18543. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18544. certs.clear();
  18545. if (!ctx) { return 0; }
  18546. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18547. // Owned by the context; see free_cert()
  18548. for (auto cert = &mbed_ctx->ca_chain; cert && cert->raw.len > 0;
  18549. cert = cert->next) {
  18550. certs.push_back(static_cast<cert_t>(cert));
  18551. }
  18552. return certs.size();
  18553. }
  18554. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18555. std::vector<std::string> names;
  18556. if (!ctx) { return names; }
  18557. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18558. // Iterate through the CA chain
  18559. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18560. while (cert != nullptr && cert->raw.len > 0) {
  18561. char buf[512];
  18562. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18563. if (ret > 0) { names.push_back(buf); }
  18564. cert = cert->next;
  18565. }
  18566. return names;
  18567. }
  18568. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18569. const char *key_pem, const char *password) {
  18570. if (!ctx || !cert_pem || !key_pem) { return false; }
  18571. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18572. // Parse into new objects first, so that a bad pair leaves the old one in
  18573. // place, and swap them in after; the old ones are freed on the way out.
  18574. mbedtls_x509_crt cert;
  18575. mbedtls_pk_context key;
  18576. mbedtls_x509_crt_init(&cert);
  18577. mbedtls_pk_init(&key);
  18578. auto se = detail::scope_exit([&] {
  18579. mbedtls_x509_crt_free(&cert);
  18580. mbedtls_pk_free(&key);
  18581. });
  18582. // Parse certificate PEM
  18583. int ret = mbedtls_x509_crt_parse(
  18584. &cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18585. strlen(cert_pem) + 1);
  18586. if (ret != 0) {
  18587. impl::mbedtls_last_error() = ret;
  18588. return false;
  18589. }
  18590. // Parse private key PEM
  18591. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18592. ret = mbedtls_pk_parse_key(
  18593. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18594. strlen(key_pem) + 1,
  18595. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18596. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18597. &mbed_ctx->ctr_drbg);
  18598. #else
  18599. ret = mbedtls_pk_parse_key(
  18600. &key, reinterpret_cast<const unsigned char *>(key_pem),
  18601. strlen(key_pem) + 1,
  18602. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18603. password ? strlen(password) : 0);
  18604. #endif
  18605. if (ret != 0) {
  18606. impl::mbedtls_last_error() = ret;
  18607. return false;
  18608. }
  18609. std::swap(mbed_ctx->own_cert, cert);
  18610. std::swap(mbed_ctx->own_key, key);
  18611. // Configure SSL to use the new certificate and key
  18612. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18613. &mbed_ctx->own_key);
  18614. if (ret != 0) {
  18615. impl::mbedtls_last_error() = ret;
  18616. return false;
  18617. }
  18618. return true;
  18619. }
  18620. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18621. if (!ctx || !ca_pem) { return false; }
  18622. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18623. // Parse into a new chain first, so that a bad one leaves the old in place
  18624. mbedtls_x509_crt chain;
  18625. mbedtls_x509_crt_init(&chain);
  18626. auto se = detail::scope_exit([&] { mbedtls_x509_crt_free(&chain); });
  18627. // Parse CA PEM
  18628. int ret = mbedtls_x509_crt_parse(
  18629. &chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18630. strlen(ca_pem) + 1);
  18631. if (ret != 0) {
  18632. impl::mbedtls_last_error() = ret;
  18633. return false;
  18634. }
  18635. std::swap(mbed_ctx->ca_chain, chain);
  18636. // Update SSL config to use new CA chain
  18637. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18638. return true;
  18639. }
  18640. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18641. if (!ctx) { return false; }
  18642. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18643. // create_session() hands each session its own copy to run.
  18644. mbed_ctx->verify_callback = std::move(callback);
  18645. if (mbed_ctx->verify_callback) {
  18646. // Set OPTIONAL mode to ensure callback is called even when verification
  18647. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18648. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18649. }
  18650. return true;
  18651. }
  18652. inline long get_verify_error(const_session_t session) {
  18653. if (!session) { return -1; }
  18654. auto *msession =
  18655. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18656. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18657. }
  18658. inline std::string verify_error_string(long error_code) {
  18659. if (error_code == 0) { return ""; }
  18660. char buf[256];
  18661. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18662. static_cast<uint32_t>(error_code));
  18663. // Remove trailing newline if present
  18664. std::string result(buf);
  18665. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18666. result.pop_back();
  18667. }
  18668. return result;
  18669. }
  18670. } // namespace tls
  18671. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18672. /*
  18673. * Group 10: TLS abstraction layer - wolfSSL backend
  18674. */
  18675. /*
  18676. * wolfSSL Backend Implementation
  18677. */
  18678. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18679. namespace tls {
  18680. namespace impl {
  18681. // wolfSSL session wrapper
  18682. struct WolfSSLSession {
  18683. WOLFSSL *ssl = nullptr;
  18684. socket_t sock = INVALID_SOCKET;
  18685. std::string hostname; // For client: set via set_sni
  18686. std::string sni_hostname; // For server: received from client via SNI callback
  18687. WolfSSLSession() = default;
  18688. ~WolfSSLSession() {
  18689. if (ssl) { wolfSSL_free(ssl); }
  18690. }
  18691. WolfSSLSession(const WolfSSLSession &) = delete;
  18692. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18693. };
  18694. // Thread-local error code accessor for wolfSSL
  18695. inline uint64_t &wolfssl_last_error() {
  18696. static thread_local uint64_t err = 0;
  18697. return err;
  18698. }
  18699. // Helper to map wolfSSL error to ErrorCode.
  18700. // ssl_error is the value from wolfSSL_get_error().
  18701. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18702. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18703. int &out_errno) {
  18704. switch (ssl_error) {
  18705. case SSL_ERROR_NONE: return ErrorCode::Success;
  18706. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18707. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18708. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18709. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18710. default:
  18711. if (ssl) {
  18712. // wolfSSL stores the low-level error code as a negative value.
  18713. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18714. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18715. if (low_err == DOMAIN_NAME_MISMATCH) {
  18716. return ErrorCode::HostnameMismatch;
  18717. }
  18718. // Check verify result to distinguish cert verification from generic SSL
  18719. // errors.
  18720. long vr = wolfSSL_get_verify_result(ssl);
  18721. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18722. }
  18723. return ErrorCode::Fatal;
  18724. }
  18725. }
  18726. // WolfSSLContext constructor/destructor implementations
  18727. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18728. inline WolfSSLContext::~WolfSSLContext() {
  18729. if (ctx) { wolfSSL_CTX_free(ctx); }
  18730. }
  18731. // Thread-local storage for SNI captured during handshake
  18732. inline std::string &wolfssl_pending_sni() {
  18733. static thread_local std::string sni;
  18734. return sni;
  18735. }
  18736. // SNI callback for wolfSSL server to capture client's SNI hostname
  18737. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18738. (void)ret;
  18739. (void)exArg;
  18740. void *name_data = nullptr;
  18741. unsigned short name_len =
  18742. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18743. if (name_data && name_len > 0) {
  18744. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18745. name_len);
  18746. } else {
  18747. wolfssl_pending_sni().clear();
  18748. }
  18749. return 0; // Continue regardless
  18750. }
  18751. // The WOLFSSL_CTX points back to its WolfSSLContext, so a handshake only ever
  18752. // runs the verify callback of its own context.
  18753. inline int context_ex_data_index() {
  18754. static const auto index =
  18755. wolfSSL_CTX_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18756. return index;
  18757. }
  18758. // Each WOLFSSL points back to its WolfSSLSession, the session_t that every
  18759. // other tls:: function takes.
  18760. inline int session_ex_data_index() {
  18761. static const auto index =
  18762. wolfSSL_get_ex_new_index(0, nullptr, nullptr, nullptr, nullptr);
  18763. return index;
  18764. }
  18765. // wolfSSL verify callback wrapper
  18766. inline int wolfssl_verify_callback(int preverify_ok,
  18767. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18768. // Get the WOLFSSL object from the X509_STORE_CTX
  18769. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18770. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18771. if (!ssl) { return preverify_ok; }
  18772. auto wctx = static_cast<WolfSSLContext *>(wolfSSL_CTX_get_ex_data(
  18773. wolfSSL_get_SSL_CTX(ssl), context_ex_data_index()));
  18774. if (!wctx || !wctx->verify_callback) { return preverify_ok; }
  18775. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18776. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18777. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18778. VerifyContext verify_ctx;
  18779. verify_ctx.session = wolfSSL_get_ex_data(ssl, session_ex_data_index());
  18780. verify_ctx.cert = static_cast<cert_t>(cert);
  18781. verify_ctx.depth = depth;
  18782. verify_ctx.preverify_ok = (preverify_ok != 0);
  18783. verify_ctx.error_code = static_cast<long>(err);
  18784. if (err != 0) {
  18785. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18786. } else {
  18787. verify_ctx.error_string = nullptr;
  18788. }
  18789. bool accepted = wctx->verify_callback(verify_ctx);
  18790. return accepted ? 1 : 0;
  18791. }
  18792. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18793. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18794. wolfSSL_CTX_set_default_passwd_cb(
  18795. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18796. auto *pwd = static_cast<const char *>(userdata);
  18797. if (!pwd) return 0;
  18798. auto len = static_cast<int>(strlen(pwd));
  18799. if (len > size) len = size;
  18800. memcpy(buf, pwd, static_cast<size_t>(len));
  18801. return len;
  18802. });
  18803. }
  18804. } // namespace impl
  18805. inline ctx_t create_client_context() {
  18806. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18807. if (!ctx) { return nullptr; }
  18808. ctx->is_server = false;
  18809. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18810. if (!method) {
  18811. delete ctx;
  18812. return nullptr;
  18813. }
  18814. ctx->ctx = wolfSSL_CTX_new(method);
  18815. if (!ctx->ctx ||
  18816. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18817. WOLFSSL_SUCCESS) {
  18818. delete ctx;
  18819. return nullptr;
  18820. }
  18821. // Default: verify peer certificate
  18822. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18823. return static_cast<ctx_t>(ctx);
  18824. }
  18825. inline ctx_t create_server_context() {
  18826. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18827. if (!ctx) { return nullptr; }
  18828. ctx->is_server = true;
  18829. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18830. if (!method) {
  18831. delete ctx;
  18832. return nullptr;
  18833. }
  18834. ctx->ctx = wolfSSL_CTX_new(method);
  18835. if (!ctx->ctx ||
  18836. wolfSSL_CTX_set_ex_data(ctx->ctx, impl::context_ex_data_index(), ctx) !=
  18837. WOLFSSL_SUCCESS) {
  18838. delete ctx;
  18839. return nullptr;
  18840. }
  18841. // Default: don't verify client
  18842. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18843. // Enable SNI on server
  18844. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18845. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18846. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18847. return static_cast<ctx_t>(ctx);
  18848. }
  18849. inline void free_context(ctx_t ctx) {
  18850. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18851. }
  18852. inline bool set_min_version(ctx_t ctx, Version version) {
  18853. if (!ctx) { return false; }
  18854. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18855. int min_ver = WOLFSSL_TLSV1_2;
  18856. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18857. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18858. }
  18859. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18860. if (!ctx || !pem) { return false; }
  18861. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18862. int ret = wolfSSL_CTX_load_verify_buffer(
  18863. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18864. static_cast<long>(len), SSL_FILETYPE_PEM);
  18865. if (ret != SSL_SUCCESS) {
  18866. impl::wolfssl_last_error() =
  18867. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18868. return false;
  18869. }
  18870. wctx->ca_pem_data_.append(pem, len);
  18871. return true;
  18872. }
  18873. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18874. if (!ctx || !file_path) { return false; }
  18875. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18876. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18877. if (ret != SSL_SUCCESS) {
  18878. impl::wolfssl_last_error() =
  18879. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18880. return false;
  18881. }
  18882. return true;
  18883. }
  18884. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18885. if (!ctx || !dir_path) { return false; }
  18886. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18887. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18888. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18889. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18890. // immediately. Return true even on failure since the CA file may have
  18891. // already been loaded, matching OpenSSL's lenient behavior.
  18892. (void)ret;
  18893. return true;
  18894. }
  18895. inline bool load_system_certs(ctx_t ctx) {
  18896. if (!ctx) { return false; }
  18897. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18898. bool loaded = false;
  18899. #ifdef _WIN32
  18900. loaded = impl::enumerate_windows_system_certs(
  18901. [&](const unsigned char *data, size_t len) {
  18902. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18903. static_cast<long>(len),
  18904. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18905. });
  18906. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18907. loaded = impl::enumerate_macos_keychain_certs(
  18908. [&](const unsigned char *data, size_t len) {
  18909. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18910. static_cast<long>(len),
  18911. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18912. });
  18913. #else
  18914. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18915. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18916. SSL_SUCCESS) {
  18917. loaded = true;
  18918. break;
  18919. }
  18920. }
  18921. if (!loaded) {
  18922. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18923. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18924. SSL_SUCCESS) {
  18925. loaded = true;
  18926. break;
  18927. }
  18928. }
  18929. }
  18930. #endif
  18931. return loaded;
  18932. }
  18933. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18934. const char *password) {
  18935. if (!ctx || !cert || !key) { return false; }
  18936. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18937. // Load certificate
  18938. int ret = wolfSSL_CTX_use_certificate_buffer(
  18939. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18940. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18941. if (ret != SSL_SUCCESS) {
  18942. impl::wolfssl_last_error() =
  18943. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18944. return false;
  18945. }
  18946. // Set password callback if password is provided
  18947. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18948. // Load private key
  18949. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18950. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18951. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18952. if (ret != SSL_SUCCESS) {
  18953. impl::wolfssl_last_error() =
  18954. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18955. return false;
  18956. }
  18957. // Verify that the certificate and private key match
  18958. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18959. }
  18960. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18961. const char *key_path, const char *password) {
  18962. if (!ctx || !cert_path || !key_path) { return false; }
  18963. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18964. // Load certificate file
  18965. int ret =
  18966. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18967. if (ret != SSL_SUCCESS) {
  18968. impl::wolfssl_last_error() =
  18969. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18970. return false;
  18971. }
  18972. // Set password callback if password is provided
  18973. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18974. // Load private key file
  18975. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18976. if (ret != SSL_SUCCESS) {
  18977. impl::wolfssl_last_error() =
  18978. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18979. return false;
  18980. }
  18981. // Verify that the certificate and private key match
  18982. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18983. }
  18984. inline void set_verify_client(ctx_t ctx, bool require) {
  18985. if (!ctx) { return; }
  18986. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18987. wctx->verify_client = require;
  18988. if (require) {
  18989. wolfSSL_CTX_set_verify(
  18990. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18991. wctx->verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18992. } else {
  18993. if (wctx->verify_callback) {
  18994. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18995. impl::wolfssl_verify_callback);
  18996. } else {
  18997. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18998. }
  18999. }
  19000. }
  19001. inline session_t create_session(ctx_t ctx, socket_t sock) {
  19002. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  19003. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19004. auto session = new (std::nothrow) impl::WolfSSLSession();
  19005. if (!session) { return nullptr; }
  19006. session->sock = sock;
  19007. session->ssl = wolfSSL_new(wctx->ctx);
  19008. if (!session->ssl) {
  19009. impl::wolfssl_last_error() =
  19010. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19011. delete session;
  19012. return nullptr;
  19013. }
  19014. if (wolfSSL_set_ex_data(session->ssl, impl::session_ex_data_index(),
  19015. session) != WOLFSSL_SUCCESS) {
  19016. delete session;
  19017. return nullptr;
  19018. }
  19019. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  19020. return static_cast<session_t>(session);
  19021. }
  19022. inline void free_session(session_t session) {
  19023. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  19024. }
  19025. inline bool set_sni(session_t session, const char *hostname,
  19026. bool verify_hostname) {
  19027. if (!session || !hostname) { return false; }
  19028. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19029. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  19030. static_cast<word16>(strlen(hostname)));
  19031. if (ret != WOLFSSL_SUCCESS) {
  19032. impl::wolfssl_last_error() =
  19033. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19034. return false;
  19035. }
  19036. // wolfSSL_check_domain_name binds identity checking to the handshake,
  19037. // separately from the SNI extension sent above; skip it when hostname
  19038. // verification is disabled so only the chain is checked, matching OpenSSL.
  19039. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  19040. wsession->hostname = hostname;
  19041. return true;
  19042. }
  19043. inline TlsError connect(session_t session) {
  19044. TlsError err;
  19045. if (!session) {
  19046. err.code = ErrorCode::Fatal;
  19047. return err;
  19048. }
  19049. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19050. int ret = wolfSSL_connect(wsession->ssl);
  19051. if (ret == SSL_SUCCESS) {
  19052. err.code = ErrorCode::Success;
  19053. } else {
  19054. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19055. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19056. err.backend_code = static_cast<uint64_t>(ssl_error);
  19057. impl::wolfssl_last_error() = err.backend_code;
  19058. }
  19059. return err;
  19060. }
  19061. inline TlsError accept(session_t session) {
  19062. TlsError err;
  19063. if (!session) {
  19064. err.code = ErrorCode::Fatal;
  19065. return err;
  19066. }
  19067. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19068. int ret = wolfSSL_accept(wsession->ssl);
  19069. if (ret == SSL_SUCCESS) {
  19070. err.code = ErrorCode::Success;
  19071. // Capture SNI from thread-local storage after successful handshake
  19072. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19073. impl::wolfssl_pending_sni().clear();
  19074. } else {
  19075. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19076. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19077. err.backend_code = static_cast<uint64_t>(ssl_error);
  19078. impl::wolfssl_last_error() = err.backend_code;
  19079. }
  19080. return err;
  19081. }
  19082. inline bool connect_nonblocking(session_t session, socket_t sock,
  19083. time_t timeout_sec, time_t timeout_usec,
  19084. TlsError *err) {
  19085. if (!session) {
  19086. if (err) { err->code = ErrorCode::Fatal; }
  19087. return false;
  19088. }
  19089. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19090. // Set socket to non-blocking mode
  19091. detail::set_nonblocking(sock, true);
  19092. auto cleanup =
  19093. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19094. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19095. int ret;
  19096. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  19097. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19098. if (ssl_error == SSL_ERROR_WANT_READ) {
  19099. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19100. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19101. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19102. }
  19103. // Error or timeout
  19104. if (err) {
  19105. err->code =
  19106. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19107. err->backend_code = static_cast<uint64_t>(ssl_error);
  19108. }
  19109. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19110. return false;
  19111. }
  19112. if (err) { err->code = ErrorCode::Success; }
  19113. return true;
  19114. }
  19115. inline bool accept_nonblocking(session_t session, socket_t sock,
  19116. time_t timeout_sec, time_t timeout_usec,
  19117. TlsError *err) {
  19118. if (!session) {
  19119. if (err) { err->code = ErrorCode::Fatal; }
  19120. return false;
  19121. }
  19122. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19123. // Set socket to non-blocking mode
  19124. detail::set_nonblocking(sock, true);
  19125. auto cleanup =
  19126. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19127. auto deadline = detail::deadline_after(timeout_sec, timeout_usec);
  19128. int ret;
  19129. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  19130. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19131. if (ssl_error == SSL_ERROR_WANT_READ) {
  19132. if (detail::select_until(sock, POLLIN, deadline) > 0) { continue; }
  19133. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  19134. if (detail::select_until(sock, POLLOUT, deadline) > 0) { continue; }
  19135. }
  19136. // Error or timeout
  19137. if (err) {
  19138. err->code =
  19139. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  19140. err->backend_code = static_cast<uint64_t>(ssl_error);
  19141. }
  19142. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  19143. return false;
  19144. }
  19145. if (err) { err->code = ErrorCode::Success; }
  19146. // Capture SNI from thread-local storage after successful handshake
  19147. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  19148. impl::wolfssl_pending_sni().clear();
  19149. return true;
  19150. }
  19151. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  19152. if (!session || !buf) {
  19153. err.code = ErrorCode::Fatal;
  19154. return -1;
  19155. }
  19156. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19157. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  19158. if (ret > 0) {
  19159. err.code = ErrorCode::Success;
  19160. return static_cast<ssize_t>(ret);
  19161. }
  19162. if (ret == 0) {
  19163. err.code = ErrorCode::PeerClosed;
  19164. return 0;
  19165. }
  19166. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19167. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19168. err.backend_code = static_cast<uint64_t>(ssl_error);
  19169. impl::wolfssl_last_error() = err.backend_code;
  19170. return -1;
  19171. }
  19172. inline ssize_t write(session_t session, const void *buf, size_t len,
  19173. TlsError &err) {
  19174. if (!session || !buf) {
  19175. err.code = ErrorCode::Fatal;
  19176. return -1;
  19177. }
  19178. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19179. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  19180. if (ret > 0) {
  19181. err.code = ErrorCode::Success;
  19182. return static_cast<ssize_t>(ret);
  19183. }
  19184. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  19185. // Treat this as an error (return -1) so callers don't spin in a
  19186. // write loop adding zero to the offset.
  19187. if (ret == 0) {
  19188. err.code = ErrorCode::PeerClosed;
  19189. return -1;
  19190. }
  19191. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19192. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  19193. err.backend_code = static_cast<uint64_t>(ssl_error);
  19194. impl::wolfssl_last_error() = err.backend_code;
  19195. return -1;
  19196. }
  19197. inline int pending(const_session_t session) {
  19198. if (!session) { return 0; }
  19199. auto wsession =
  19200. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19201. return wolfSSL_pending(wsession->ssl);
  19202. }
  19203. inline void shutdown(session_t session, bool graceful) {
  19204. if (!session) { return; }
  19205. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19206. if (graceful) {
  19207. int ret;
  19208. int attempts = 0;
  19209. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  19210. attempts < 3) {
  19211. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19212. if (ssl_error != SSL_ERROR_WANT_READ &&
  19213. ssl_error != SSL_ERROR_WANT_WRITE) {
  19214. break;
  19215. }
  19216. attempts++;
  19217. }
  19218. } else {
  19219. wolfSSL_shutdown(wsession->ssl);
  19220. }
  19221. }
  19222. inline bool is_peer_closed(session_t session, socket_t sock) {
  19223. if (!session || sock == INVALID_SOCKET) { return true; }
  19224. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  19225. // Check if there's already decrypted data available
  19226. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  19227. // Set socket to non-blocking to avoid blocking on read
  19228. detail::set_nonblocking(sock, true);
  19229. auto cleanup =
  19230. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  19231. // Peek 1 byte to check connection status without consuming data
  19232. unsigned char buf;
  19233. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  19234. // If we got data or WANT_READ (would block), connection is alive
  19235. if (ret > 0) { return false; }
  19236. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  19237. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  19238. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  19239. ret == 0;
  19240. }
  19241. inline cert_t get_peer_cert(const_session_t session) {
  19242. if (!session) { return nullptr; }
  19243. auto wsession =
  19244. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19245. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  19246. return static_cast<cert_t>(cert);
  19247. }
  19248. inline size_t get_peer_certs(const_session_t session,
  19249. std::vector<cert_t> &certs) {
  19250. certs.clear();
  19251. if (!session) { return 0; }
  19252. // wolfSSL keeps the received chain only when built with SESSION_CERTS
  19253. #ifdef SESSION_CERTS
  19254. auto wsession =
  19255. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19256. auto chain = wolfSSL_get_peer_chain(wsession->ssl);
  19257. auto count = chain ? wolfSSL_get_chain_count(chain) : 0;
  19258. for (int i = 0; i < count; i++) {
  19259. auto x509 = wolfSSL_get_chain_X509(chain, i);
  19260. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19261. }
  19262. #endif
  19263. return certs.size();
  19264. }
  19265. inline void free_cert(cert_t cert) {
  19266. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  19267. }
  19268. inline bool verify_hostname(cert_t cert, const char *hostname) {
  19269. if (!cert || !hostname) { return false; }
  19270. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19271. std::string host_str(hostname);
  19272. // Check if hostname is an IP address (IPv4 or IPv6)
  19273. unsigned char ip_bytes[16];
  19274. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  19275. auto is_ip = ip_len > 0;
  19276. // Check Subject Alternative Names
  19277. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19278. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19279. if (san_names) {
  19280. int san_count = wolfSSL_sk_num(san_names);
  19281. for (int i = 0; i < san_count; i++) {
  19282. auto *names =
  19283. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19284. if (!names) continue;
  19285. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  19286. // DNS name
  19287. unsigned char *dns_name = nullptr;
  19288. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  19289. if (dns_name && dns_len > 0) {
  19290. std::string san_name(reinterpret_cast<char *>(dns_name),
  19291. static_cast<size_t>(dns_len));
  19292. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19293. if (detail::match_hostname(san_name, host_str)) {
  19294. wolfSSL_sk_free(san_names);
  19295. return true;
  19296. }
  19297. }
  19298. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  19299. // IP address: only an iPAddress SAN of the same family (4 bytes for
  19300. // IPv4, 16 bytes for IPv6) may authenticate the host.
  19301. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  19302. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  19303. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  19304. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  19305. wolfSSL_sk_free(san_names);
  19306. return true;
  19307. }
  19308. }
  19309. }
  19310. wolfSSL_sk_free(san_names);
  19311. }
  19312. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  19313. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  19314. // the OpenSSL backend's X509_check_ip behaves the same way).
  19315. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  19316. if (subject) {
  19317. char cn[256] = {};
  19318. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19319. sizeof(cn));
  19320. if (cn_len > 0) {
  19321. std::string cn_str(cn, static_cast<size_t>(cn_len));
  19322. if (detail::match_hostname(cn_str, host_str)) { return true; }
  19323. }
  19324. }
  19325. return false;
  19326. }
  19327. inline uint64_t hostname_mismatch_code() {
  19328. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  19329. }
  19330. inline long get_verify_result(const_session_t session) {
  19331. if (!session) { return -1; }
  19332. auto wsession =
  19333. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19334. long result = wolfSSL_get_verify_result(wsession->ssl);
  19335. return result;
  19336. }
  19337. inline std::string get_cert_subject_cn(cert_t cert) {
  19338. if (!cert) return "";
  19339. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19340. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19341. if (!subject) return "";
  19342. char cn[256] = {};
  19343. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  19344. sizeof(cn));
  19345. if (cn_len <= 0) return "";
  19346. return std::string(cn, static_cast<size_t>(cn_len));
  19347. }
  19348. inline std::string get_cert_issuer_name(cert_t cert) {
  19349. if (!cert) return "";
  19350. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19351. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  19352. if (!issuer) return "";
  19353. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  19354. if (!name_str) return "";
  19355. std::string result(name_str);
  19356. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19357. return result;
  19358. }
  19359. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  19360. sans.clear();
  19361. if (!cert) return false;
  19362. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19363. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  19364. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  19365. if (!san_names) return true; // No SANs is not an error
  19366. int count = wolfSSL_sk_num(san_names);
  19367. for (int i = 0; i < count; i++) {
  19368. auto *name =
  19369. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  19370. if (!name) continue;
  19371. SanEntry entry;
  19372. switch (name->type) {
  19373. case WOLFSSL_GEN_DNS: {
  19374. entry.type = SanType::DNS;
  19375. unsigned char *dns_name = nullptr;
  19376. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  19377. if (dns_name && dns_len > 0) {
  19378. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  19379. static_cast<size_t>(dns_len));
  19380. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  19381. }
  19382. break;
  19383. }
  19384. case WOLFSSL_GEN_IPADD: {
  19385. entry.type = SanType::IP;
  19386. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  19387. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  19388. if (ip_data && ip_len == 4) {
  19389. char buf[16];
  19390. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  19391. ip_data[2], ip_data[3]);
  19392. entry.value = buf;
  19393. } else if (ip_data && ip_len == 16) {
  19394. char buf[64];
  19395. snprintf(buf, sizeof(buf),
  19396. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  19397. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  19398. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  19399. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  19400. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  19401. ip_data[14], ip_data[15]);
  19402. entry.value = buf;
  19403. }
  19404. break;
  19405. }
  19406. case WOLFSSL_GEN_EMAIL:
  19407. entry.type = SanType::EMAIL;
  19408. {
  19409. unsigned char *email = nullptr;
  19410. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  19411. if (email && email_len > 0) {
  19412. entry.value = std::string(reinterpret_cast<char *>(email),
  19413. static_cast<size_t>(email_len));
  19414. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  19415. }
  19416. }
  19417. break;
  19418. case WOLFSSL_GEN_URI:
  19419. entry.type = SanType::URI;
  19420. {
  19421. unsigned char *uri = nullptr;
  19422. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  19423. &uri, name->d.uniformResourceIdentifier);
  19424. if (uri && uri_len > 0) {
  19425. entry.value = std::string(reinterpret_cast<char *>(uri),
  19426. static_cast<size_t>(uri_len));
  19427. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  19428. }
  19429. }
  19430. break;
  19431. default: entry.type = SanType::OTHER; break;
  19432. }
  19433. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  19434. }
  19435. wolfSSL_sk_free(san_names);
  19436. return true;
  19437. }
  19438. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  19439. time_t &not_after) {
  19440. if (!cert) return false;
  19441. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19442. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  19443. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  19444. if (!nb || !na) return false;
  19445. // wolfSSL_ASN1_TIME_to_tm is available
  19446. struct tm tm_nb = {}, tm_na = {};
  19447. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  19448. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  19449. #ifdef _WIN32
  19450. not_before = _mkgmtime(&tm_nb);
  19451. not_after = _mkgmtime(&tm_na);
  19452. #else
  19453. not_before = timegm(&tm_nb);
  19454. not_after = timegm(&tm_na);
  19455. #endif
  19456. return true;
  19457. }
  19458. inline std::string get_cert_serial(cert_t cert) {
  19459. if (!cert) return "";
  19460. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19461. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  19462. if (!serial_asn1) return "";
  19463. // Get the serial number data
  19464. int len = serial_asn1->length;
  19465. unsigned char *data = serial_asn1->data;
  19466. if (!data || len <= 0) return "";
  19467. std::string result;
  19468. result.reserve(static_cast<size_t>(len) * 2);
  19469. for (int i = 0; i < len; i++) {
  19470. char hex[3];
  19471. snprintf(hex, sizeof(hex), "%02X", data[i]);
  19472. result += hex;
  19473. }
  19474. return result;
  19475. }
  19476. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  19477. if (!cert) return false;
  19478. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  19479. int der_len = 0;
  19480. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  19481. if (!der_data || der_len <= 0) return false;
  19482. der.assign(der_data, der_data + der_len);
  19483. return true;
  19484. }
  19485. inline const char *get_sni(const_session_t session) {
  19486. if (!session) return nullptr;
  19487. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  19488. // For server: return SNI received from client during handshake
  19489. if (!wsession->sni_hostname.empty()) {
  19490. return wsession->sni_hostname.c_str();
  19491. }
  19492. // For client: return the hostname set via set_sni
  19493. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  19494. return nullptr;
  19495. }
  19496. inline uint64_t peek_error() {
  19497. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19498. }
  19499. inline uint64_t get_error() {
  19500. uint64_t err = impl::wolfssl_last_error();
  19501. impl::wolfssl_last_error() = 0;
  19502. return err;
  19503. }
  19504. inline std::string error_string(uint64_t code) {
  19505. char buf[256];
  19506. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  19507. return std::string(buf);
  19508. }
  19509. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  19510. if (!pem || len == 0) { return nullptr; }
  19511. // Validate by attempting to load into a temporary ctx
  19512. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  19513. if (!tmp_ctx) { return nullptr; }
  19514. int ret = wolfSSL_CTX_load_verify_buffer(
  19515. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  19516. static_cast<long>(len), SSL_FILETYPE_PEM);
  19517. wolfSSL_CTX_free(tmp_ctx);
  19518. if (ret != SSL_SUCCESS) { return nullptr; }
  19519. return static_cast<ca_store_t>(
  19520. new impl::WolfSSLCAStore{std::string(pem, len)});
  19521. }
  19522. inline void free_ca_store(ca_store_t store) {
  19523. delete static_cast<impl::WolfSSLCAStore *>(store);
  19524. }
  19525. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  19526. if (!ctx || !store) { return false; }
  19527. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19528. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  19529. int ret = wolfSSL_CTX_load_verify_buffer(
  19530. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  19531. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  19532. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  19533. // This function takes ownership of the store; the PEM data was copied into
  19534. // the context, so release the source
  19535. free_ca_store(store);
  19536. return ret == SSL_SUCCESS;
  19537. }
  19538. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  19539. certs.clear();
  19540. if (!ctx) { return 0; }
  19541. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19542. if (wctx->ca_pem_data_.empty()) { return 0; }
  19543. const std::string &pem = wctx->ca_pem_data_;
  19544. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19545. const std::string end_marker = "-----END CERTIFICATE-----";
  19546. size_t pos = 0;
  19547. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19548. size_t end_pos = pem.find(end_marker, pos);
  19549. if (end_pos == std::string::npos) { break; }
  19550. end_pos += end_marker.size();
  19551. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19552. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19553. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19554. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19555. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19556. pos = end_pos;
  19557. }
  19558. return certs.size();
  19559. }
  19560. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19561. std::vector<std::string> names;
  19562. if (!ctx) { return names; }
  19563. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19564. if (wctx->ca_pem_data_.empty()) { return names; }
  19565. const std::string &pem = wctx->ca_pem_data_;
  19566. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19567. const std::string end_marker = "-----END CERTIFICATE-----";
  19568. size_t pos = 0;
  19569. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19570. size_t end_pos = pem.find(end_marker, pos);
  19571. if (end_pos == std::string::npos) { break; }
  19572. end_pos += end_marker.size();
  19573. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19574. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19575. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19576. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19577. if (x509) {
  19578. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19579. if (subject) {
  19580. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19581. if (name_str) {
  19582. names.push_back(name_str);
  19583. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19584. }
  19585. }
  19586. wolfSSL_X509_free(x509);
  19587. }
  19588. pos = end_pos;
  19589. }
  19590. return names;
  19591. }
  19592. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19593. const char *key_pem, const char *password) {
  19594. if (!ctx || !cert_pem || !key_pem) { return false; }
  19595. // Try the pair on a scratch context first, so that a bad one leaves the
  19596. // server's certificate and key as they were
  19597. auto tmp = create_server_context();
  19598. if (!tmp) { return false; }
  19599. auto se = detail::scope_exit([&] { free_context(tmp); });
  19600. if (!set_client_cert_pem(tmp, cert_pem, key_pem, password)) { return false; }
  19601. return set_client_cert_pem(ctx, cert_pem, key_pem, password);
  19602. }
  19603. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19604. if (!ctx || !ca_pem) { return false; }
  19605. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19606. // Replace the CAs rather than add to them, as the other backends do, once
  19607. // the new ones are known to load
  19608. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  19609. if (!store) { return false; }
  19610. free_ca_store(store);
  19611. wolfSSL_CTX_UnloadCAs(wctx->ctx);
  19612. wctx->ca_pem_data_.clear();
  19613. return load_ca_pem(ctx, ca_pem, strlen(ca_pem));
  19614. }
  19615. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19616. if (!ctx) { return false; }
  19617. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19618. wctx->verify_callback = std::move(callback);
  19619. if (wctx->verify_callback) {
  19620. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19621. impl::wolfssl_verify_callback);
  19622. } else {
  19623. wolfSSL_CTX_set_verify(
  19624. wctx->ctx,
  19625. wctx->verify_client
  19626. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19627. : SSL_VERIFY_NONE,
  19628. nullptr);
  19629. }
  19630. return true;
  19631. }
  19632. inline long get_verify_error(const_session_t session) {
  19633. if (!session) { return -1; }
  19634. auto *wsession =
  19635. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19636. return wolfSSL_get_verify_result(wsession->ssl);
  19637. }
  19638. inline std::string verify_error_string(long error_code) {
  19639. if (error_code == 0) { return ""; }
  19640. const char *str =
  19641. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19642. return str ? std::string(str) : std::string();
  19643. }
  19644. } // namespace tls
  19645. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19646. // WebSocket implementation
  19647. namespace ws {
  19648. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19649. bool fin) {
  19650. std::lock_guard<std::mutex> lock(write_mutex_);
  19651. if (closed_) { return false; }
  19652. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19653. }
  19654. inline ReadResult WebSocket::read(std::string &msg) {
  19655. // Answers a control frame; any other opcode here is a protocol error.
  19656. // Returns false when the connection is done.
  19657. auto handle_control = [&](Opcode op, const std::string &payload) -> bool {
  19658. switch (op) {
  19659. case Opcode::Ping: {
  19660. std::lock_guard<std::mutex> lock(write_mutex_);
  19661. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19662. payload.size(), true, !is_server_);
  19663. return true;
  19664. }
  19665. case Opcode::Pong: {
  19666. std::lock_guard<std::mutex> lock(ping_mutex_);
  19667. unacked_pings_ = 0;
  19668. return true;
  19669. }
  19670. case Opcode::Close: {
  19671. // RFC 6455 §5.5.1: a Close is echoed back, unless its payload is
  19672. // malformed, which is answered with a protocol error instead.
  19673. if (closed_.exchange(true)) { return false; }
  19674. auto reply = payload;
  19675. if (!impl::is_valid_close_payload(payload)) {
  19676. auto code = static_cast<uint16_t>(CloseStatus::ProtocolError);
  19677. reply = {static_cast<char>(code >> 8), static_cast<char>(code & 0xff)};
  19678. }
  19679. std::lock_guard<std::mutex> lock(write_mutex_);
  19680. detail::write_websocket_frame(strm_, Opcode::Close, reply.data(),
  19681. reply.size(), true, !is_server_);
  19682. return false;
  19683. }
  19684. default: closed_ = true; return false;
  19685. }
  19686. };
  19687. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19688. while (!closed_) {
  19689. Opcode opcode;
  19690. std::string payload;
  19691. bool fin;
  19692. impl::FrameRead r =
  19693. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19694. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19695. // A timeout landed on a frame boundary: the connection is untouched and
  19696. // still usable, so hand control back without closing it. That is only
  19697. // useful to a caller who asked for the timeout; the compile-time default
  19698. // is a backstop against a peer gone quiet, and elapsing it closes the
  19699. // connection so a plain `while (ws.read(msg))` loop ends.
  19700. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19701. if (r != impl::FrameRead::Ok) {
  19702. closed_ = true;
  19703. return Fail;
  19704. }
  19705. switch (opcode) {
  19706. case Opcode::Text:
  19707. case Opcode::Binary: {
  19708. auto result = opcode == Opcode::Text ? Text : Binary;
  19709. msg = std::move(payload);
  19710. // Handle fragmentation
  19711. if (!fin) {
  19712. while (true) {
  19713. Opcode cont_opcode;
  19714. std::string cont_payload;
  19715. bool cont_fin;
  19716. // Only what is left of the limit, but room for a control frame,
  19717. // which may come between the fragments.
  19718. auto max_len =
  19719. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH == 0
  19720. ? size_t(0)
  19721. : (std::max)(size_t(125),
  19722. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH -
  19723. msg.size());
  19724. // A timeout is not reportable here: half of a fragmented message is
  19725. // already in `msg` and read() has no way to resume it, so it is a
  19726. // failure like any other. Timeouts are only ever seen on a message
  19727. // boundary.
  19728. if (impl::read_websocket_frame(strm_, cont_opcode, cont_payload,
  19729. cont_fin, is_server_,
  19730. max_len) != impl::FrameRead::Ok) {
  19731. closed_ = true;
  19732. return Fail;
  19733. }
  19734. // RFC 6455 5.4: the fragments are continuation frames, with only
  19735. // control frames between them.
  19736. if (cont_opcode != Opcode::Continuation) {
  19737. if (handle_control(cont_opcode, cont_payload)) { continue; }
  19738. return Fail;
  19739. }
  19740. msg += cont_payload;
  19741. if (CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH > 0 &&
  19742. msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19743. closed_ = true;
  19744. return Fail;
  19745. }
  19746. if (cont_fin) { break; }
  19747. }
  19748. }
  19749. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19750. if (result == Text && !impl::is_valid_utf8(msg)) {
  19751. // close() takes the read lock to wait for the peer's Close reply, so
  19752. // it must not run while this thread still holds it.
  19753. read_lock.unlock();
  19754. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19755. return Fail;
  19756. }
  19757. return result;
  19758. }
  19759. default:
  19760. if (handle_control(opcode, payload)) { continue; }
  19761. return Fail;
  19762. }
  19763. }
  19764. return Fail;
  19765. }
  19766. inline bool WebSocket::send(const std::string &data) {
  19767. return send_frame(Opcode::Text, data.data(), data.size());
  19768. }
  19769. inline bool WebSocket::send(const char *data, size_t len) {
  19770. return send_frame(Opcode::Binary, data, len);
  19771. }
  19772. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19773. if (closed_.exchange(true)) { return; }
  19774. ping_cv_.notify_all();
  19775. std::string payload;
  19776. auto code = static_cast<uint16_t>(status);
  19777. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19778. payload.push_back(static_cast<char>(code & 0xFF));
  19779. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19780. // Close frame has 2-byte status code, so reason is limited to 123 bytes,
  19781. // cut back to a whole UTF-8 character
  19782. auto short_reason = reason.substr(0, 123);
  19783. while (!short_reason.empty() && !impl::is_valid_utf8(short_reason)) {
  19784. short_reason.pop_back();
  19785. }
  19786. payload += short_reason;
  19787. // A code that may not be sent, such as NoStatus, goes without a payload
  19788. if (!impl::is_valid_close_payload(payload)) { payload.clear(); }
  19789. {
  19790. std::lock_guard<std::mutex> lock(write_mutex_);
  19791. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19792. payload.size(), true, !is_server_);
  19793. }
  19794. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19795. // Close response before closing the TCP connection.
  19796. //
  19797. // Wait only when no other thread is parsing frames. When one is, it is the
  19798. // thread positioned to see the peer's reply, and reading here would take
  19799. // bytes out of the message it is assembling. Bailing out also leaves the
  19800. // stream, including its read timeout, entirely to that thread.
  19801. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19802. if (!read_lock.owns_lock()) { return; }
  19803. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19804. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19805. Opcode op;
  19806. std::string resp;
  19807. bool fin;
  19808. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19809. impl::FrameRead::Ok) {
  19810. if (op == Opcode::Close) { break; }
  19811. }
  19812. }
  19813. inline WebSocket::~WebSocket() {
  19814. {
  19815. std::lock_guard<std::mutex> lock(ping_mutex_);
  19816. closed_ = true;
  19817. }
  19818. ping_cv_.notify_all();
  19819. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19820. }
  19821. inline void WebSocket::start_heartbeat() {
  19822. if (ping_interval_sec_ == 0) { return; }
  19823. ping_thread_ = std::thread([this]() {
  19824. std::unique_lock<std::mutex> lock(ping_mutex_);
  19825. // The predicate keeps a spurious wakeup from sending a ping early
  19826. while (!ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_),
  19827. [this]() { return closed_.load(); })) {
  19828. // If the peer has failed to respond to the previous pings, give up.
  19829. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19830. // opt-in liveness check controlled by max_missed_pongs_.
  19831. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19832. lock.unlock();
  19833. close(CloseStatus::GoingAway, "pong timeout");
  19834. // Wake a read() blocked on the unresponsive peer. Only the read side
  19835. // is shut down: a TLS backend answers the EOF with an alert, and
  19836. // writing it to a socket closed for writing raises SIGPIPE.
  19837. #ifdef _WIN32
  19838. shutdown(strm_.socket(), SD_RECEIVE);
  19839. #else
  19840. shutdown(strm_.socket(), SHUT_RD);
  19841. #endif
  19842. return;
  19843. }
  19844. lock.unlock();
  19845. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19846. lock.lock();
  19847. closed_ = true;
  19848. break;
  19849. }
  19850. lock.lock();
  19851. unacked_pings_++;
  19852. }
  19853. });
  19854. }
  19855. inline const Request &WebSocket::request() const { return req_; }
  19856. inline bool WebSocket::is_open() const { return !closed_; }
  19857. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19858. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19859. // poll(), where 0 would instead mean "return immediately", so hand it the
  19860. // negative poll uses for an unbounded wait.
  19861. if (sec == 0 && usec == 0) { sec = -1; }
  19862. strm_.set_read_timeout(sec, usec);
  19863. read_timeout_set_ = true;
  19864. }
  19865. // WebSocketClient implementation
  19866. inline WebSocketClient::WebSocketClient(
  19867. const std::string &scheme_host_port_path, const Headers &headers)
  19868. : headers_(headers) {
  19869. detail::UrlComponents uc;
  19870. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19871. !uc.host.empty() && !uc.path.empty()) {
  19872. auto &scheme = uc.scheme;
  19873. #ifdef CPPHTTPLIB_SSL_ENABLED
  19874. if (scheme != "ws" && scheme != "wss") {
  19875. #else
  19876. if (scheme != "ws") {
  19877. #endif
  19878. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19879. std::string msg = "'" + scheme + "' scheme is not supported.";
  19880. throw std::invalid_argument(msg);
  19881. #endif
  19882. return;
  19883. }
  19884. auto is_ssl = scheme == "wss";
  19885. host_ = std::move(uc.host);
  19886. port_ = is_ssl ? 443 : 80;
  19887. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19888. path_ = std::move(uc.path);
  19889. if (!uc.query.empty()) { path_ += uc.query; }
  19890. #ifdef CPPHTTPLIB_SSL_ENABLED
  19891. is_ssl_ = is_ssl;
  19892. if (is_ssl_) {
  19893. // The context lives as long as the client so that CA configuration
  19894. // survives reconnects; sessions are created per connection.
  19895. tls_ctx_ = tls::create_client_context();
  19896. if (!tls_ctx_) { return; }
  19897. }
  19898. #else
  19899. if (is_ssl) { return; }
  19900. #endif
  19901. is_valid_ = true;
  19902. }
  19903. }
  19904. #ifdef CPPHTTPLIB_SSL_ENABLED
  19905. inline WebSocketClient::WebSocketClient(
  19906. const std::string &scheme_host_port_path, const PemMemory &pem,
  19907. const Headers &headers)
  19908. : WebSocketClient(scheme_host_port_path, headers) {
  19909. // For ws:// URLs the client certificate is silently ignored, consistent
  19910. // with the TLS-only setters such as set_ca_cert_path().
  19911. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19912. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19913. pem.private_key_password)) {
  19914. tls::free_context(tls_ctx_);
  19915. tls_ctx_ = nullptr;
  19916. is_valid_ = false;
  19917. }
  19918. }
  19919. }
  19920. #endif
  19921. inline WebSocketClient::~WebSocketClient() {
  19922. shutdown_and_close();
  19923. #ifdef CPPHTTPLIB_SSL_ENABLED
  19924. if (tls_ctx_) {
  19925. tls::free_context(tls_ctx_);
  19926. tls_ctx_ = nullptr;
  19927. }
  19928. #endif
  19929. }
  19930. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19931. inline void WebSocketClient::shutdown_and_close() {
  19932. // Send the close frame while the TLS session is still alive: ws_ holds an
  19933. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19934. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19935. if (ws_ && ws_->is_open()) { ws_->close(); }
  19936. ws_.reset();
  19937. #ifdef CPPHTTPLIB_SSL_ENABLED
  19938. if (is_ssl_) {
  19939. if (tls_session_) {
  19940. tls::shutdown(tls_session_, true);
  19941. tls::free_session(tls_session_);
  19942. tls_session_ = nullptr;
  19943. }
  19944. }
  19945. #endif
  19946. if (sock_ != INVALID_SOCKET) {
  19947. detail::shutdown_socket(sock_);
  19948. detail::close_socket(sock_);
  19949. sock_ = INVALID_SOCKET;
  19950. }
  19951. }
  19952. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19953. Error &error, int &ssl_error,
  19954. uint64_t &ssl_backend_error) {
  19955. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19956. // The streams wait with poll(), where 0 instead means "return immediately",
  19957. // so they are given the negative poll uses for an unbounded wait.
  19958. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19959. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19960. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19961. // The handshake belongs to establishing the connection, so an unset read
  19962. // timeout leaves it bounded by the connection timeout instead of forever.
  19963. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19964. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19965. #ifdef CPPHTTPLIB_SSL_ENABLED
  19966. if (is_ssl_) {
  19967. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19968. // is not safe to call concurrently on one client to begin with, since
  19969. // nothing else here is guarded either.
  19970. if (server_certificate_verification_ && !certs_loaded_) {
  19971. uint64_t backend_error = 0;
  19972. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19973. ca_cert_dir_path_, custom_ca_loaded_,
  19974. system_ca_mode_, backend_error);
  19975. certs_loaded_ = true;
  19976. }
  19977. detail::ClientTlsSessionOptions options;
  19978. options.server_hostname_verification = server_hostname_verification_;
  19979. options.session_verifier = session_verifier_;
  19980. detail::ClientTlsSessionError tls_error;
  19981. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19982. server_certificate_verification_,
  19983. hs_sec, hs_usec, &tls_error,
  19984. options)) {
  19985. error = tls_error.error;
  19986. ssl_error = tls_error.ssl_error;
  19987. ssl_backend_error = tls_error.backend_error;
  19988. return false;
  19989. }
  19990. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19991. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19992. write_timeout_usec_));
  19993. return true;
  19994. }
  19995. #else
  19996. (void)error;
  19997. (void)ssl_error;
  19998. (void)ssl_backend_error;
  19999. (void)hs_sec;
  20000. (void)hs_usec;
  20001. #endif
  20002. strm = std::unique_ptr<Stream>(
  20003. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  20004. write_timeout_sec_, write_timeout_usec_));
  20005. return true;
  20006. }
  20007. inline void WebSocketClient::prepare_default_headers(Request &req) {
  20008. #ifdef CPPHTTPLIB_SSL_ENABLED
  20009. auto is_ssl = is_ssl_;
  20010. #else
  20011. auto is_ssl = false;
  20012. #endif
  20013. if (!req.has_header("Host")) {
  20014. req.headers.emplace("Host", detail::make_default_host_header_value(
  20015. host_, port_, is_ssl, address_family_));
  20016. }
  20017. detail::add_default_user_agent_header(req);
  20018. }
  20019. inline Result WebSocketClient::connect() {
  20020. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  20021. shutdown_and_close();
  20022. // Check is custom IP or hostname specified for host_
  20023. std::string connect_host;
  20024. std::string ip;
  20025. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  20026. auto error = Error::Success;
  20027. sock_ = detail::create_client_socket(
  20028. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  20029. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  20030. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  20031. write_timeout_usec_, interface_, error);
  20032. if (sock_ == INVALID_SOCKET) {
  20033. if (error == Error::Success) { error = Error::Connection; }
  20034. return Result{error, -1, Headers{}};
  20035. }
  20036. std::unique_ptr<Stream> strm;
  20037. auto stream_error = Error::SSLConnection;
  20038. int ssl_error = 0;
  20039. uint64_t ssl_backend_error = 0;
  20040. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  20041. shutdown_and_close();
  20042. #ifdef CPPHTTPLIB_SSL_ENABLED
  20043. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  20044. #else
  20045. return Result{stream_error, -1, Headers{}};
  20046. #endif
  20047. }
  20048. Request req;
  20049. req.method = "GET";
  20050. req.path = path_;
  20051. req.headers = headers_;
  20052. prepare_default_headers(req);
  20053. detail::WebSocketUpgradeResponse upgrade;
  20054. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  20055. shutdown_and_close();
  20056. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  20057. }
  20058. subprotocol_ = std::move(upgrade.selected_subprotocol);
  20059. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  20060. websocket_ping_interval_sec_,
  20061. websocket_max_missed_pongs_));
  20062. // The stream was created with the timeout already; tell the WebSocket
  20063. // whether it came from the caller, so read() knows to report it as Timeout.
  20064. ws_->read_timeout_set_ = read_timeout_set_;
  20065. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  20066. }
  20067. inline ReadResult WebSocketClient::read(std::string &msg) {
  20068. if (!ws_) { return Fail; }
  20069. return ws_->read(msg);
  20070. }
  20071. inline bool WebSocketClient::send(const std::string &data) {
  20072. if (!ws_) { return false; }
  20073. return ws_->send(data);
  20074. }
  20075. inline bool WebSocketClient::send(const char *data, size_t len) {
  20076. if (!ws_) { return false; }
  20077. return ws_->send(data, len);
  20078. }
  20079. inline void WebSocketClient::close(CloseStatus status,
  20080. const std::string &reason) {
  20081. if (ws_) { ws_->close(status, reason); }
  20082. }
  20083. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  20084. inline const std::string &WebSocketClient::subprotocol() const {
  20085. return subprotocol_;
  20086. }
  20087. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  20088. read_timeout_sec_ = sec;
  20089. read_timeout_usec_ = usec;
  20090. read_timeout_set_ = true;
  20091. // The members above only seed the next connect(); read() consults the
  20092. // stream, so an already-open connection has to be told directly.
  20093. if (ws_) { ws_->set_read_timeout(sec, usec); }
  20094. }
  20095. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  20096. write_timeout_sec_ = sec;
  20097. write_timeout_usec_ = usec;
  20098. }
  20099. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  20100. websocket_ping_interval_sec_ = sec;
  20101. }
  20102. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  20103. websocket_max_missed_pongs_ = count;
  20104. }
  20105. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  20106. inline void WebSocketClient::set_address_family(int family) {
  20107. address_family_ = family;
  20108. }
  20109. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  20110. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  20111. socket_options_ = std::move(socket_options);
  20112. }
  20113. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  20114. connection_timeout_sec_ = sec;
  20115. connection_timeout_usec_ = usec;
  20116. }
  20117. inline void WebSocketClient::set_interface(const std::string &intf) {
  20118. interface_ = intf;
  20119. }
  20120. inline void WebSocketClient::set_hostname_addr_map(
  20121. std::map<std::string, std::string> addr_map) {
  20122. addr_map_ = std::move(addr_map);
  20123. }
  20124. #ifdef CPPHTTPLIB_SSL_ENABLED
  20125. inline void
  20126. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  20127. const std::string &ca_cert_dir_path) {
  20128. ca_cert_file_path_ = ca_cert_file_path;
  20129. ca_cert_dir_path_ = ca_cert_dir_path;
  20130. }
  20131. inline void
  20132. WebSocketClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  20133. if (tls_ctx_) { tls::set_verify_callback(tls_ctx_, std::move(verifier)); }
  20134. }
  20135. inline void WebSocketClient::set_session_verifier(
  20136. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  20137. session_verifier_ = std::move(verifier);
  20138. }
  20139. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  20140. if (store && tls_ctx_) {
  20141. // set_ca_store takes ownership of store
  20142. tls::set_ca_store(tls_ctx_, store);
  20143. custom_ca_loaded_ = true;
  20144. } else if (store) {
  20145. tls::free_ca_store(store);
  20146. }
  20147. }
  20148. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  20149. std::size_t size) {
  20150. if (tls_ctx_ && ca_cert && size > 0) {
  20151. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  20152. custom_ca_loaded_ = true;
  20153. }
  20154. }
  20155. inline void
  20156. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  20157. server_certificate_verification_ = enabled;
  20158. }
  20159. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  20160. server_hostname_verification_ = enabled;
  20161. }
  20162. inline void WebSocketClient::enable_system_ca(bool enabled) {
  20163. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  20164. }
  20165. #endif // CPPHTTPLIB_SSL_ENABLED
  20166. } // namespace ws
  20167. // ----------------------------------------------------------------------------
  20168. } // namespace httplib
  20169. #endif // CPPHTTPLIB_HTTPLIB_H