httplib.h 784 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027
  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.58.0"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003a00"
  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. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong). Only a
  189. // timeout set at runtime through set_read_timeout() is reported as
  190. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  191. // ws::Fail and closes the connection.
  192. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  202. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  205. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  206. #endif
  207. /*
  208. * Headers
  209. */
  210. #ifdef _WIN32
  211. #ifndef _CRT_SECURE_NO_WARNINGS
  212. #define _CRT_SECURE_NO_WARNINGS
  213. #endif //_CRT_SECURE_NO_WARNINGS
  214. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  215. #define _CRT_NONSTDC_NO_DEPRECATE
  216. #endif //_CRT_NONSTDC_NO_DEPRECATE
  217. #if defined(_MSC_VER)
  218. #if _MSC_VER < 1900
  219. #error Sorry, Visual Studio versions prior to 2015 are not supported
  220. #endif
  221. #pragma comment(lib, "ws2_32.lib")
  222. #ifndef _SSIZE_T_DEFINED
  223. using ssize_t = __int64;
  224. #define _SSIZE_T_DEFINED
  225. #endif
  226. #endif // _MSC_VER
  227. #ifndef S_ISREG
  228. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  229. #endif // S_ISREG
  230. #ifndef S_ISDIR
  231. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  232. #endif // S_ISDIR
  233. #ifndef NOMINMAX
  234. #define NOMINMAX
  235. #endif // NOMINMAX
  236. #include <io.h>
  237. #include <winsock2.h>
  238. #include <ws2tcpip.h>
  239. #if defined(__has_include)
  240. #if __has_include(<afunix.h>)
  241. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  242. #include <afunix.h>
  243. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  244. #endif
  245. #endif
  246. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  247. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  248. #endif
  249. using nfds_t = unsigned long;
  250. using socket_t = SOCKET;
  251. using socklen_t = int;
  252. #else // not _WIN32
  253. #include <arpa/inet.h>
  254. #if !defined(_AIX) && !defined(__MVS__)
  255. #include <ifaddrs.h>
  256. #endif
  257. #ifdef __MVS__
  258. #include <strings.h>
  259. #ifndef NI_MAXHOST
  260. #define NI_MAXHOST 1025
  261. #endif
  262. #endif
  263. #include <net/if.h>
  264. #include <netdb.h>
  265. #include <netinet/in.h>
  266. #ifdef __linux__
  267. #include <resolv.h>
  268. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  269. #endif
  270. #include <csignal>
  271. #include <netinet/tcp.h>
  272. #include <poll.h>
  273. #include <pthread.h>
  274. #include <sys/mman.h>
  275. #include <sys/socket.h>
  276. #include <sys/un.h>
  277. #include <unistd.h>
  278. using socket_t = int;
  279. #ifndef INVALID_SOCKET
  280. #define INVALID_SOCKET (-1)
  281. #endif
  282. #endif //_WIN32
  283. #if defined(__APPLE__)
  284. #include <TargetConditionals.h>
  285. #endif
  286. #include <algorithm>
  287. #include <array>
  288. #include <atomic>
  289. #include <cassert>
  290. #include <chrono>
  291. #include <climits>
  292. #include <condition_variable>
  293. #include <cstdlib>
  294. #include <cstring>
  295. #include <errno.h>
  296. #include <exception>
  297. #include <fcntl.h>
  298. #include <fstream>
  299. #include <functional>
  300. #include <iomanip>
  301. #include <iostream>
  302. #include <iterator>
  303. #include <list>
  304. #include <map>
  305. #include <memory>
  306. #include <mutex>
  307. #include <random>
  308. #include <regex>
  309. #include <set>
  310. #include <sstream>
  311. #include <string>
  312. #include <sys/stat.h>
  313. #include <system_error>
  314. #include <thread>
  315. #include <type_traits>
  316. #include <unordered_map>
  317. #include <unordered_set>
  318. #include <utility>
  319. #include <vector>
  320. // On macOS with a TLS backend, enable Keychain root certificates by default
  321. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  322. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  323. // only; on those platforms the user must provide a CA bundle explicitly.
  324. #if defined(__APPLE__) && defined(__clang__) && \
  325. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  326. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  327. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  328. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  329. #if TARGET_OS_OSX
  330. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  331. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  332. #endif
  333. #endif
  334. #endif
  335. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  336. defined(__APPLE__) && !TARGET_OS_OSX
  337. #error \
  338. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  339. #endif
  340. // On Windows, enable Schannel certificate verification by default
  341. // unless the user explicitly opts out.
  342. #if defined(_WIN32) && \
  343. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  344. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  345. #endif
  346. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  347. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  348. #if TARGET_OS_MAC && defined(__clang__)
  349. #include <CFNetwork/CFHost.h>
  350. #include <CoreFoundation/CoreFoundation.h>
  351. #endif
  352. #endif
  353. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  354. #ifdef _WIN32
  355. #include <wincrypt.h>
  356. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  357. // used
  358. #undef X509_NAME
  359. #undef X509_CERT_PAIR
  360. #undef X509_EXTENSIONS
  361. #undef PKCS7_SIGNER_INFO
  362. #ifdef _MSC_VER
  363. #pragma comment(lib, "crypt32.lib")
  364. #endif
  365. #endif // _WIN32
  366. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  367. #if TARGET_OS_OSX
  368. #include <Security/Security.h>
  369. #endif
  370. #endif
  371. #include <openssl/err.h>
  372. #include <openssl/evp.h>
  373. #include <openssl/ssl.h>
  374. #include <openssl/x509v3.h>
  375. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  376. #include <openssl/applink.c>
  377. #endif
  378. #include <iostream>
  379. #include <sstream>
  380. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  381. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  382. #error Please use OpenSSL or a current version of BoringSSL
  383. #endif
  384. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  385. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  386. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  387. #endif
  388. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  389. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  390. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  391. // in with this first include group so the version gating below can use it.
  392. #include <mbedtls/error.h>
  393. #include <mbedtls/net_sockets.h>
  394. #include <mbedtls/oid.h>
  395. #include <mbedtls/pk.h>
  396. #include <mbedtls/ssl.h>
  397. #include <mbedtls/version.h>
  398. #include <mbedtls/x509_crt.h>
  399. #if MBEDTLS_VERSION_MAJOR >= 4
  400. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  401. #include <psa/crypto.h>
  402. #else
  403. #include <mbedtls/ctr_drbg.h>
  404. #include <mbedtls/entropy.h>
  405. #include <mbedtls/md5.h>
  406. #include <mbedtls/sha1.h>
  407. #include <mbedtls/sha256.h>
  408. #include <mbedtls/sha512.h>
  409. #endif
  410. #ifdef _WIN32
  411. #include <wincrypt.h>
  412. #ifdef _MSC_VER
  413. #pragma comment(lib, "crypt32.lib")
  414. #endif
  415. #endif // _WIN32
  416. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  417. #if TARGET_OS_OSX
  418. #include <Security/Security.h>
  419. #endif
  420. #endif
  421. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  422. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  423. #if MBEDTLS_VERSION_MAJOR >= 4
  424. #define CPPHTTPLIB_MBEDTLS_V4
  425. #endif
  426. #if MBEDTLS_VERSION_MAJOR >= 3
  427. #define CPPHTTPLIB_MBEDTLS_V3
  428. #endif
  429. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  430. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  431. #include <wolfssl/options.h>
  432. #include <wolfssl/openssl/x509v3.h>
  433. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  434. #ifndef WOLFSSL_GEN_EMAIL
  435. #define WOLFSSL_GEN_EMAIL 1
  436. #endif
  437. #ifndef WOLFSSL_GEN_DNS
  438. #define WOLFSSL_GEN_DNS 2
  439. #endif
  440. #ifndef WOLFSSL_GEN_URI
  441. #define WOLFSSL_GEN_URI 6
  442. #endif
  443. #ifndef WOLFSSL_GEN_IPADD
  444. #define WOLFSSL_GEN_IPADD 7
  445. #endif
  446. #include <wolfssl/ssl.h>
  447. #include <wolfssl/wolfcrypt/hash.h>
  448. #include <wolfssl/wolfcrypt/md5.h>
  449. #include <wolfssl/wolfcrypt/sha256.h>
  450. #include <wolfssl/wolfcrypt/sha512.h>
  451. #ifdef _WIN32
  452. #include <wincrypt.h>
  453. #ifdef _MSC_VER
  454. #pragma comment(lib, "crypt32.lib")
  455. #endif
  456. #endif // _WIN32
  457. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  458. #if TARGET_OS_OSX
  459. #include <Security/Security.h>
  460. #endif
  461. #endif
  462. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  463. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  464. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  465. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  466. #define CPPHTTPLIB_SSL_ENABLED
  467. #endif
  468. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  469. #include <zlib.h>
  470. #endif
  471. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  472. #include <brotli/decode.h>
  473. #include <brotli/encode.h>
  474. #endif
  475. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  476. #include <zstd.h>
  477. #endif
  478. /*
  479. * Declaration
  480. */
  481. namespace httplib {
  482. namespace ws {
  483. class WebSocket;
  484. } // namespace ws
  485. namespace detail {
  486. /*
  487. * Backport std::make_unique from C++14.
  488. *
  489. * NOTE: This code came up with the following stackoverflow post:
  490. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  491. *
  492. */
  493. template <class T, class... Args>
  494. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  495. make_unique(Args &&...args) {
  496. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  497. }
  498. template <class T>
  499. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  500. make_unique(std::size_t n) {
  501. typedef typename std::remove_extent<T>::type RT;
  502. return std::unique_ptr<T>(new RT[n]);
  503. }
  504. // Locale-independent ASCII character classification. The <cctype>
  505. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  506. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  507. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  508. // classified without regard to the locale.
  509. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  510. inline bool is_ascii_alpha(char c) {
  511. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  512. }
  513. inline bool is_ascii_alnum(char c) {
  514. return is_ascii_digit(c) || is_ascii_alpha(c);
  515. }
  516. namespace case_ignore {
  517. inline unsigned char to_lower(int c) {
  518. const static unsigned char table[256] = {
  519. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  520. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  521. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  522. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  523. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  524. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  525. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  526. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  527. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  528. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  529. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  530. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  531. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  532. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  533. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  534. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  535. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  536. 255,
  537. };
  538. return table[(unsigned char)(char)c];
  539. }
  540. inline std::string to_lower(const std::string &s) {
  541. std::string result = s;
  542. std::transform(
  543. result.begin(), result.end(), result.begin(),
  544. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  545. return result;
  546. }
  547. inline bool equal(const std::string &a, const std::string &b) {
  548. return a.size() == b.size() &&
  549. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  550. return to_lower(ca) == to_lower(cb);
  551. });
  552. }
  553. struct equal_to {
  554. bool operator()(const std::string &a, const std::string &b) const {
  555. return equal(a, b);
  556. }
  557. };
  558. struct hash {
  559. size_t operator()(const std::string &key) const {
  560. return hash_core(key.data(), key.size(), 0);
  561. }
  562. size_t hash_core(const char *s, size_t l, size_t h) const {
  563. return (l == 0) ? h
  564. : hash_core(s + 1, l - 1,
  565. // Unsets the 6 high bits of h, therefore no
  566. // overflow happens
  567. (((std::numeric_limits<size_t>::max)() >> 6) &
  568. h * 33) ^
  569. static_cast<unsigned char>(to_lower(*s)));
  570. }
  571. };
  572. template <typename T>
  573. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  574. detail::case_ignore::equal_to>;
  575. } // namespace case_ignore
  576. // This is based on
  577. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  578. struct scope_exit {
  579. explicit scope_exit(std::function<void(void)> &&f)
  580. : exit_function(std::move(f)), execute_on_destruction{true} {}
  581. scope_exit(scope_exit &&rhs) noexcept
  582. : exit_function(std::move(rhs.exit_function)),
  583. execute_on_destruction{rhs.execute_on_destruction} {
  584. rhs.release();
  585. }
  586. ~scope_exit() {
  587. if (execute_on_destruction) { this->exit_function(); }
  588. }
  589. void release() { this->execute_on_destruction = false; }
  590. private:
  591. scope_exit(const scope_exit &) = delete;
  592. void operator=(const scope_exit &) = delete;
  593. scope_exit &operator=(scope_exit &&) = delete;
  594. std::function<void(void)> exit_function;
  595. bool execute_on_destruction;
  596. };
  597. // Simple from_chars implementation for integer and double types (C++17
  598. // substitute)
  599. template <typename T> struct from_chars_result {
  600. const char *ptr;
  601. std::errc ec;
  602. };
  603. template <typename T>
  604. inline from_chars_result<T> from_chars(const char *first, const char *last,
  605. T &value, int base = 10) {
  606. value = 0;
  607. const char *p = first;
  608. bool negative = false;
  609. if (p != last && *p == '-') {
  610. negative = true;
  611. ++p;
  612. }
  613. if (p == last) { return {first, std::errc::invalid_argument}; }
  614. T result = 0;
  615. for (; p != last; ++p) {
  616. char c = *p;
  617. int digit = -1;
  618. if (is_ascii_digit(c)) {
  619. digit = c - '0';
  620. } else if ('a' <= c && c <= 'z') {
  621. digit = c - 'a' + 10;
  622. } else if ('A' <= c && c <= 'Z') {
  623. digit = c - 'A' + 10;
  624. } else {
  625. break;
  626. }
  627. if (digit < 0 || digit >= base) { break; }
  628. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  629. return {p, std::errc::result_out_of_range};
  630. }
  631. result = result * base + digit;
  632. }
  633. if (p == first || (negative && p == first + 1)) {
  634. return {first, std::errc::invalid_argument};
  635. }
  636. value = negative ? T(0) - result : result;
  637. return {p, std::errc{}};
  638. }
  639. // from_chars for double (hand-written, locale-independent)
  640. //
  641. // The only double consumed by this library is the HTTP quality value, whose
  642. // grammar is (RFC 9110 12.4.2):
  643. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  644. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  645. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  646. // '.' always the decimal separator (std::strtod would instead read it from the
  647. // global C locale, mis-parsing q-values once an embedder calls
  648. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  649. // the result to [0, 1], so inputs outside that range need not be distinguished
  650. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  651. // cases that exponent and wide-range handling would introduce.
  652. inline from_chars_result<double> from_chars(const char *first, const char *last,
  653. double &value) {
  654. value = 0.0;
  655. const char *p = first;
  656. // Each 1eN is exactly representable, so a single final division by the
  657. // matching entry yields a correctly-rounded result.
  658. static const double powers_of_ten[] = {
  659. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  660. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  661. const int max_frac_digits =
  662. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  663. // Accumulate digits into a 64-bit integer and remember how many were
  664. // fractional. Two independent caps keep this bounded and safe:
  665. // * accumulation saturates before mantissa could overflow uint64_t, and
  666. // * frac_digits is capped at max_frac_digits so it is always a valid index
  667. // into powers_of_ten (without this an input like "0.000...0" would never
  668. // grow mantissa, so the saturation cap alone would not bound it).
  669. // Both caps only drop digits far beyond the precision a q-value needs; any
  670. // value they would change is well outside [0, 1] and rejected by the caller.
  671. uint64_t mantissa = 0;
  672. int frac_digits = 0;
  673. bool seen_digit = false;
  674. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  675. auto accumulate = [&](char c) {
  676. if (mantissa <= limit) {
  677. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  678. return true;
  679. }
  680. return false;
  681. };
  682. for (; p != last && is_ascii_digit(*p); ++p) {
  683. seen_digit = true;
  684. accumulate(*p);
  685. }
  686. if (p != last && *p == '.') {
  687. ++p;
  688. for (; p != last && is_ascii_digit(*p); ++p) {
  689. seen_digit = true;
  690. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  691. }
  692. }
  693. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  694. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  695. return {p, std::errc{}};
  696. }
  697. inline bool parse_port(const char *s, size_t len, int &port) {
  698. int val = 0;
  699. auto r = from_chars(s, s + len, val);
  700. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  701. port = val;
  702. return true;
  703. }
  704. inline bool parse_port(const std::string &s, int &port) {
  705. return parse_port(s.data(), s.size(), port);
  706. }
  707. struct UrlComponents {
  708. std::string scheme;
  709. std::string host;
  710. std::string port;
  711. std::string path;
  712. std::string query;
  713. };
  714. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  715. uc = {};
  716. size_t pos = 0;
  717. auto sep = url.find("://");
  718. if (sep != std::string::npos) {
  719. uc.scheme = url.substr(0, sep);
  720. // Scheme must be [a-z]+ only
  721. if (uc.scheme.empty()) { return false; }
  722. for (auto c : uc.scheme) {
  723. if (c < 'a' || c > 'z') { return false; }
  724. }
  725. pos = sep + 3;
  726. } else if (url.compare(0, 2, "//") == 0) {
  727. pos = 2;
  728. }
  729. auto has_authority_prefix = pos > 0;
  730. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  731. url[0] != '?' && url[0] != '#');
  732. if (has_authority) {
  733. if (pos < url.size() && url[pos] == '[') {
  734. auto close = url.find(']', pos);
  735. if (close == std::string::npos) { return false; }
  736. uc.host = url.substr(pos + 1, close - pos - 1);
  737. // IPv6 host must be [a-fA-F0-9:]+ only
  738. if (uc.host.empty()) { return false; }
  739. for (auto c : uc.host) {
  740. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  741. (c >= 'A' && c <= 'F') || c == ':')) {
  742. return false;
  743. }
  744. }
  745. pos = close + 1;
  746. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  747. // path, query or fragment delimiter (or the end of input). Otherwise the
  748. // trailing bytes would be folded into the path while the connection
  749. // still targets the bracketed address.
  750. if (pos < url.size()) {
  751. auto c = url[pos];
  752. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  753. }
  754. } else {
  755. auto end = url.find_first_of(":/?#", pos);
  756. if (end == std::string::npos) { end = url.size(); }
  757. uc.host = url.substr(pos, end - pos);
  758. pos = end;
  759. }
  760. if (pos < url.size() && url[pos] == ':') {
  761. ++pos;
  762. auto end = url.find_first_of("/?#", pos);
  763. if (end == std::string::npos) { end = url.size(); }
  764. uc.port = url.substr(pos, end - pos);
  765. pos = end;
  766. }
  767. // Without :// or //, the entire input must be consumed as host[:port].
  768. // If there is leftover (path, query, etc.), this is not a valid
  769. // host[:port] string — clear and reparse as a plain path.
  770. if (!has_authority_prefix && pos < url.size()) {
  771. uc.host.clear();
  772. uc.port.clear();
  773. pos = 0;
  774. }
  775. }
  776. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  777. auto end = url.find_first_of("?#", pos);
  778. if (end == std::string::npos) { end = url.size(); }
  779. uc.path = url.substr(pos, end - pos);
  780. pos = end;
  781. }
  782. if (pos < url.size() && url[pos] == '?') {
  783. auto end = url.find('#', pos);
  784. if (end == std::string::npos) { end = url.size(); }
  785. uc.query = url.substr(pos, end - pos);
  786. }
  787. return true;
  788. }
  789. // Resolves a relative-path or query-only Location value against the path of
  790. // the request being redirected (RFC 3986 section 5.2). Absolute URIs and
  791. // references starting with '/' are returned unchanged.
  792. inline std::string resolve_relative_location(const std::string &location,
  793. const std::string &base) {
  794. if (location.empty() || location[0] == '/') { return location; }
  795. // A ':' in the first segment means the value has a scheme.
  796. if (location.find(':') < location.find_first_of("/?#")) { return location; }
  797. if (location[0] == '#') { return base.substr(0, base.find('#')) + location; }
  798. auto base_path = base.substr(0, base.find_first_of("?#"));
  799. if (location[0] == '?') { return base_path + location; }
  800. if (base_path.empty() || base_path[0] != '/') { base_path = "/"; }
  801. auto merged = base_path.substr(0, base_path.rfind('/') + 1) + location;
  802. // Remove "." and ".." segments from the merged path.
  803. auto path_end = (std::min)(merged.find_first_of("?#"), merged.size());
  804. std::string path;
  805. size_t i = 0;
  806. while (i < path_end) {
  807. auto next = (std::min)(merged.find('/', i + 1), path_end);
  808. auto segment = merged.substr(i + 1, next - i - 1);
  809. auto is_last = next == path_end;
  810. if (segment == "." || segment == "..") {
  811. if (segment == "..") {
  812. path.erase((std::min)(path.rfind('/'), path.size()));
  813. }
  814. if (is_last) { path += '/'; }
  815. } else {
  816. path += '/';
  817. path += segment;
  818. }
  819. i = next;
  820. }
  821. if (path.empty()) { path = "/"; }
  822. return path + merged.substr(path_end);
  823. }
  824. } // namespace detail
  825. enum class SSLVerifierResponse {
  826. // no decision has been made, use the built-in certificate verifier
  827. NoDecisionMade,
  828. // connection certificate is verified and accepted
  829. CertificateAccepted,
  830. // connection certificate was processed but is rejected
  831. CertificateRejected
  832. };
  833. // System CA loading policy for SSL clients. Auto (the default) loads system
  834. // CA certs only when no custom CA is configured; enable_system_ca() switches
  835. // to an explicit policy.
  836. enum class SystemCAMode { Auto, Enabled, Disabled };
  837. enum StatusCode {
  838. // Information responses
  839. Continue_100 = 100,
  840. SwitchingProtocol_101 = 101,
  841. Processing_102 = 102,
  842. EarlyHints_103 = 103,
  843. // Successful responses
  844. OK_200 = 200,
  845. Created_201 = 201,
  846. Accepted_202 = 202,
  847. NonAuthoritativeInformation_203 = 203,
  848. NoContent_204 = 204,
  849. ResetContent_205 = 205,
  850. PartialContent_206 = 206,
  851. MultiStatus_207 = 207,
  852. AlreadyReported_208 = 208,
  853. IMUsed_226 = 226,
  854. // Redirection messages
  855. MultipleChoices_300 = 300,
  856. MovedPermanently_301 = 301,
  857. Found_302 = 302,
  858. SeeOther_303 = 303,
  859. NotModified_304 = 304,
  860. UseProxy_305 = 305,
  861. unused_306 = 306,
  862. TemporaryRedirect_307 = 307,
  863. PermanentRedirect_308 = 308,
  864. // Client error responses
  865. BadRequest_400 = 400,
  866. Unauthorized_401 = 401,
  867. PaymentRequired_402 = 402,
  868. Forbidden_403 = 403,
  869. NotFound_404 = 404,
  870. MethodNotAllowed_405 = 405,
  871. NotAcceptable_406 = 406,
  872. ProxyAuthenticationRequired_407 = 407,
  873. RequestTimeout_408 = 408,
  874. Conflict_409 = 409,
  875. Gone_410 = 410,
  876. LengthRequired_411 = 411,
  877. PreconditionFailed_412 = 412,
  878. PayloadTooLarge_413 = 413,
  879. UriTooLong_414 = 414,
  880. UnsupportedMediaType_415 = 415,
  881. RangeNotSatisfiable_416 = 416,
  882. ExpectationFailed_417 = 417,
  883. ImATeapot_418 = 418,
  884. MisdirectedRequest_421 = 421,
  885. UnprocessableContent_422 = 422,
  886. Locked_423 = 423,
  887. FailedDependency_424 = 424,
  888. TooEarly_425 = 425,
  889. UpgradeRequired_426 = 426,
  890. PreconditionRequired_428 = 428,
  891. TooManyRequests_429 = 429,
  892. RequestHeaderFieldsTooLarge_431 = 431,
  893. UnavailableForLegalReasons_451 = 451,
  894. // Server error responses
  895. InternalServerError_500 = 500,
  896. NotImplemented_501 = 501,
  897. BadGateway_502 = 502,
  898. ServiceUnavailable_503 = 503,
  899. GatewayTimeout_504 = 504,
  900. HttpVersionNotSupported_505 = 505,
  901. VariantAlsoNegotiates_506 = 506,
  902. InsufficientStorage_507 = 507,
  903. LoopDetected_508 = 508,
  904. NotExtended_510 = 510,
  905. NetworkAuthenticationRequired_511 = 511,
  906. };
  907. namespace detail {
  908. // A multimap that keeps its entries in the order they were inserted.
  909. //
  910. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  911. // fields sharing a field name significant and forbids a proxy from reordering
  912. // them, and a query string's parameters are meaningful in the order the caller
  913. // wrote them. Neither standard container expresses it: std::unordered_multimap
  914. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  915. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  916. // key, which would drop control data such as Host behind whatever else the
  917. // message carries and alphabetise a query string.
  918. //
  919. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  920. // scan, which beats hashing for the handful of entries a message carries
  921. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  922. //
  923. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  924. // Params, whose parameter names are case-sensitive, not.
  925. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  926. public:
  927. using key_type = std::string;
  928. using mapped_type = Mapped;
  929. using value_type = std::pair<std::string, Mapped>;
  930. using size_type = std::size_t;
  931. using difference_type = std::ptrdiff_t;
  932. using reference = value_type &;
  933. using const_reference = const value_type &;
  934. private:
  935. static size_type npos() { return static_cast<size_type>(-1); }
  936. static bool keys_equal(const std::string &a, const std::string &b) {
  937. return KeyEqual()(a, b);
  938. }
  939. // Iterating yields every entry in insertion order, but equal_range() and
  940. // find() have to walk only the entries sharing one key, which are not
  941. // adjacent. Both are the same iterator type: key_idx_ selects between the
  942. // two traversals, and since equality compares only the position, an iterator
  943. // restricted to one key still compares equal to end().
  944. template <typename V> class iterator_t {
  945. public:
  946. using iterator_category = std::bidirectional_iterator_tag;
  947. using value_type = insertion_ordered_multimap::value_type;
  948. using difference_type = insertion_ordered_multimap::difference_type;
  949. using pointer = V *;
  950. using reference = V &;
  951. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  952. template <typename U,
  953. typename std::enable_if<std::is_convertible<U *, V *>::value,
  954. int>::type = 0>
  955. iterator_t(const iterator_t<U> &rhs)
  956. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  957. key_idx_(rhs.key_idx_) {}
  958. reference operator*() const { return data_[idx_]; }
  959. pointer operator->() const { return data_ + idx_; }
  960. iterator_t &operator++() {
  961. // Saturating, so that advancing past the last entry of a key (which
  962. // get_multimap_value() does when asked for an out-of-range id) stays at
  963. // end() instead of running off the container.
  964. if (idx_ >= size_) { return *this; }
  965. ++idx_;
  966. if (key_idx_ != npos()) {
  967. while (idx_ < size_ && !matches(idx_)) {
  968. ++idx_;
  969. }
  970. }
  971. return *this;
  972. }
  973. iterator_t operator++(int) {
  974. auto tmp = *this;
  975. ++*this;
  976. return tmp;
  977. }
  978. iterator_t &operator--() {
  979. if (idx_ == 0) { return *this; }
  980. --idx_;
  981. if (key_idx_ != npos()) {
  982. while (idx_ > 0 && !matches(idx_)) {
  983. --idx_;
  984. }
  985. }
  986. return *this;
  987. }
  988. iterator_t operator--(int) {
  989. auto tmp = *this;
  990. --*this;
  991. return tmp;
  992. }
  993. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  994. return idx_ == rhs.idx_;
  995. }
  996. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  997. return idx_ != rhs.idx_;
  998. }
  999. private:
  1000. friend class insertion_ordered_multimap;
  1001. template <typename> friend class iterator_t;
  1002. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  1003. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  1004. bool matches(size_type i) const {
  1005. return keys_equal(data_[i].first, data_[key_idx_].first);
  1006. }
  1007. V *data_;
  1008. size_type idx_;
  1009. size_type size_;
  1010. size_type key_idx_;
  1011. };
  1012. public:
  1013. using iterator = iterator_t<value_type>;
  1014. using const_iterator = iterator_t<const value_type>;
  1015. insertion_ordered_multimap() = default;
  1016. insertion_ordered_multimap(std::initializer_list<value_type> il)
  1017. : entries_(il) {}
  1018. template <typename InputIt>
  1019. insertion_ordered_multimap(InputIt first, InputIt last)
  1020. : entries_(first, last) {}
  1021. iterator begin() { return make_iter(0, npos()); }
  1022. iterator end() { return make_iter(entries_.size(), npos()); }
  1023. const_iterator begin() const { return make_citer(0, npos()); }
  1024. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  1025. const_iterator cbegin() const { return begin(); }
  1026. const_iterator cend() const { return end(); }
  1027. bool empty() const { return entries_.empty(); }
  1028. size_type size() const { return entries_.size(); }
  1029. void clear() { entries_.clear(); }
  1030. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  1031. iterator insert(const value_type &val) {
  1032. entries_.push_back(val);
  1033. return make_iter(entries_.size() - 1, npos());
  1034. }
  1035. iterator insert(value_type &&val) {
  1036. entries_.push_back(std::move(val));
  1037. return make_iter(entries_.size() - 1, npos());
  1038. }
  1039. template <typename... Args> iterator emplace(Args &&...args) {
  1040. entries_.emplace_back(std::forward<Args>(args)...);
  1041. return make_iter(entries_.size() - 1, npos());
  1042. }
  1043. // For entries that have to lead the message, such as the Host header field
  1044. // (RFC 9110 5.3 recommends sending control data first).
  1045. template <typename... Args> iterator emplace_front(Args &&...args) {
  1046. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1047. return make_iter(0, npos());
  1048. }
  1049. iterator find(const std::string &key) {
  1050. auto i = index_of(key);
  1051. return i == npos() ? end() : make_iter(i, i);
  1052. }
  1053. const_iterator find(const std::string &key) const {
  1054. auto i = index_of(key);
  1055. return i == npos() ? end() : make_citer(i, i);
  1056. }
  1057. size_type count(const std::string &key) const {
  1058. size_type n = 0;
  1059. for (const auto &entry : entries_) {
  1060. if (keys_equal(entry.first, key)) { n++; }
  1061. }
  1062. return n;
  1063. }
  1064. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1065. auto i = index_of(key);
  1066. return i == npos() ? std::make_pair(end(), end())
  1067. : std::make_pair(make_iter(i, i), end());
  1068. }
  1069. std::pair<const_iterator, const_iterator>
  1070. equal_range(const std::string &key) const {
  1071. auto i = index_of(key);
  1072. return i == npos() ? std::make_pair(end(), end())
  1073. : std::make_pair(make_citer(i, i), end());
  1074. }
  1075. size_type erase(const std::string &key) {
  1076. auto before = entries_.size();
  1077. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1078. [&](const value_type &entry) {
  1079. return keys_equal(entry.first, key);
  1080. }),
  1081. entries_.end());
  1082. return before - entries_.size();
  1083. }
  1084. iterator erase(const_iterator pos) {
  1085. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1086. return make_iter(pos.idx_, npos());
  1087. }
  1088. // Erases what iterating [first, last) would actually visit, so erasing an
  1089. // equal_range() removes only the entries with that key, not everything
  1090. // positioned between them.
  1091. iterator erase(const_iterator first, const_iterator last) {
  1092. auto from = first.idx_;
  1093. auto to = last.idx_;
  1094. if (from >= to) { return make_iter(from, npos()); }
  1095. auto begin_it = entries_.begin();
  1096. auto from_it = begin_it + static_cast<difference_type>(from);
  1097. auto to_it = begin_it + static_cast<difference_type>(to);
  1098. if (first.key_idx_ == npos()) {
  1099. entries_.erase(from_it, to_it);
  1100. } else {
  1101. auto key = entries_[first.key_idx_].first;
  1102. auto keep = from_it;
  1103. for (auto it = from_it; it != to_it; ++it) {
  1104. if (!keys_equal(it->first, key)) {
  1105. if (keep != it) { *keep = std::move(*it); }
  1106. ++keep;
  1107. }
  1108. }
  1109. if (keep != to_it) {
  1110. keep = std::move(to_it, entries_.end(), keep);
  1111. } else {
  1112. keep = entries_.end();
  1113. }
  1114. entries_.erase(keep, entries_.end());
  1115. }
  1116. return make_iter(from, npos());
  1117. }
  1118. friend bool operator==(const insertion_ordered_multimap &lhs,
  1119. const insertion_ordered_multimap &rhs) {
  1120. return lhs.entries_ == rhs.entries_;
  1121. }
  1122. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1123. const insertion_ordered_multimap &rhs) {
  1124. return !(lhs == rhs);
  1125. }
  1126. private:
  1127. size_type index_of(const std::string &key) const {
  1128. for (size_type i = 0; i < entries_.size(); i++) {
  1129. if (keys_equal(entries_[i].first, key)) { return i; }
  1130. }
  1131. return npos();
  1132. }
  1133. iterator make_iter(size_type idx, size_type key_idx) {
  1134. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1135. }
  1136. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1137. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1138. }
  1139. std::vector<value_type> entries_;
  1140. };
  1141. } // namespace detail
  1142. using Headers =
  1143. detail::insertion_ordered_multimap<std::string,
  1144. detail::case_ignore::equal_to>;
  1145. // Query parameter names are case-sensitive, unlike header field names.
  1146. using Params =
  1147. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1148. using Match = std::smatch;
  1149. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1150. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1151. /*
  1152. * detail: type-erased storage used by UserData.
  1153. * ABI-stable regardless of C++ standard — always uses this custom
  1154. * implementation instead of std::any.
  1155. */
  1156. namespace detail {
  1157. using any_type_id = const void *;
  1158. template <typename T> any_type_id any_typeid() noexcept {
  1159. static const char id = 0;
  1160. return &id;
  1161. }
  1162. struct any_storage {
  1163. virtual ~any_storage() = default;
  1164. virtual std::unique_ptr<any_storage> clone() const = 0;
  1165. virtual any_type_id type_id() const noexcept = 0;
  1166. };
  1167. template <typename T> struct any_value final : any_storage {
  1168. T value;
  1169. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1170. std::unique_ptr<any_storage> clone() const override {
  1171. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1172. }
  1173. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1174. };
  1175. } // namespace detail
  1176. class UserData {
  1177. public:
  1178. UserData() = default;
  1179. UserData(UserData &&) noexcept = default;
  1180. UserData &operator=(UserData &&) noexcept = default;
  1181. UserData(const UserData &o) {
  1182. for (const auto &e : o.entries_) {
  1183. if (e.second) { entries_[e.first] = e.second->clone(); }
  1184. }
  1185. }
  1186. UserData &operator=(const UserData &o) {
  1187. if (this != &o) {
  1188. entries_.clear();
  1189. for (const auto &e : o.entries_) {
  1190. if (e.second) { entries_[e.first] = e.second->clone(); }
  1191. }
  1192. }
  1193. return *this;
  1194. }
  1195. template <typename T> void set(const std::string &key, T &&value) {
  1196. using D = typename std::decay<T>::type;
  1197. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1198. }
  1199. template <typename T> T *get(const std::string &key) noexcept {
  1200. auto it = entries_.find(key);
  1201. if (it == entries_.end() || !it->second) { return nullptr; }
  1202. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1203. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1204. }
  1205. template <typename T> const T *get(const std::string &key) const noexcept {
  1206. auto it = entries_.find(key);
  1207. if (it == entries_.end() || !it->second) { return nullptr; }
  1208. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1209. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1210. }
  1211. bool has(const std::string &key) const noexcept {
  1212. return entries_.find(key) != entries_.end();
  1213. }
  1214. void erase(const std::string &key) { entries_.erase(key); }
  1215. void clear() noexcept { entries_.clear(); }
  1216. private:
  1217. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1218. entries_;
  1219. };
  1220. struct Response;
  1221. using ResponseHandler = std::function<bool(const Response &response)>;
  1222. struct FormData {
  1223. std::string name;
  1224. std::string content;
  1225. std::string filename;
  1226. std::string content_type;
  1227. Headers headers;
  1228. };
  1229. struct FormField {
  1230. std::string name;
  1231. std::string content;
  1232. Headers headers;
  1233. };
  1234. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1235. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1236. // should see the parts as they were sent. A std::multimap sorts by field name
  1237. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1238. // than the case-insensitive predicate Headers uses.
  1239. using FormFields =
  1240. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1241. using FormFiles =
  1242. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1243. struct MultipartFormData {
  1244. FormFields fields; // Text fields from multipart
  1245. FormFiles files; // Files from multipart
  1246. // Text field access
  1247. std::string get_field(const std::string &key, size_t id = 0) const;
  1248. std::vector<std::string> get_fields(const std::string &key) const;
  1249. bool has_field(const std::string &key) const;
  1250. size_t get_field_count(const std::string &key) const;
  1251. // File access
  1252. FormData get_file(const std::string &key, size_t id = 0) const;
  1253. std::vector<FormData> get_files(const std::string &key) const;
  1254. bool has_file(const std::string &key) const;
  1255. size_t get_file_count(const std::string &key) const;
  1256. };
  1257. struct UploadFormData {
  1258. std::string name;
  1259. std::string content;
  1260. std::string filename;
  1261. std::string content_type;
  1262. };
  1263. using UploadFormDataItems = std::vector<UploadFormData>;
  1264. class DataSink {
  1265. public:
  1266. DataSink() : os(&sb_), sb_(*this) {}
  1267. DataSink(const DataSink &) = delete;
  1268. DataSink &operator=(const DataSink &) = delete;
  1269. DataSink(DataSink &&) = delete;
  1270. DataSink &operator=(DataSink &&) = delete;
  1271. std::function<bool(const char *data, size_t data_len)> write;
  1272. // Only `write` is mandatory. The rest are defaulted so that a provider
  1273. // calling one on a writer that does not set it gets sensible behaviour
  1274. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1275. // `this` is safe: DataSink is neither copyable nor movable.
  1276. std::function<bool()> is_writable = []() { return true; };
  1277. std::function<void()> done = []() {};
  1278. std::function<void(const Headers &trailer)> done_with_trailer =
  1279. [this](const Headers & /*trailer*/) { done(); };
  1280. std::ostream os;
  1281. private:
  1282. class data_sink_streambuf final : public std::streambuf {
  1283. public:
  1284. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1285. protected:
  1286. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1287. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1288. return 0;
  1289. }
  1290. private:
  1291. DataSink &sink_;
  1292. };
  1293. data_sink_streambuf sb_;
  1294. };
  1295. using ContentProvider =
  1296. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1297. using ContentProviderWithoutLength =
  1298. std::function<bool(size_t offset, DataSink &sink)>;
  1299. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1300. struct FormDataProvider {
  1301. std::string name;
  1302. ContentProviderWithoutLength provider;
  1303. std::string filename;
  1304. std::string content_type;
  1305. };
  1306. using FormDataProviderItems = std::vector<FormDataProvider>;
  1307. inline FormDataProvider
  1308. make_file_provider(const std::string &name, const std::string &filepath,
  1309. const std::string &filename = std::string(),
  1310. const std::string &content_type = std::string()) {
  1311. FormDataProvider fdp;
  1312. fdp.name = name;
  1313. fdp.filename = filename.empty() ? filepath : filename;
  1314. fdp.content_type = content_type;
  1315. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1316. std::ifstream f(filepath, std::ios::binary);
  1317. if (!f) { return false; }
  1318. if (offset > 0) {
  1319. f.seekg(static_cast<std::streamoff>(offset));
  1320. if (!f.good()) {
  1321. sink.done();
  1322. return true;
  1323. }
  1324. }
  1325. char buf[8192];
  1326. f.read(buf, sizeof(buf));
  1327. auto n = static_cast<size_t>(f.gcount());
  1328. if (n > 0) { return sink.write(buf, n); }
  1329. sink.done(); // EOF
  1330. return true;
  1331. };
  1332. return fdp;
  1333. }
  1334. inline std::pair<size_t, ContentProvider>
  1335. make_file_body(const std::string &filepath) {
  1336. size_t size = 0;
  1337. {
  1338. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1339. if (!f) { return {0, ContentProvider{}}; }
  1340. size = static_cast<size_t>(f.tellg());
  1341. }
  1342. ContentProvider provider = [filepath](size_t offset, size_t length,
  1343. DataSink &sink) -> bool {
  1344. std::ifstream f(filepath, std::ios::binary);
  1345. if (!f) { return false; }
  1346. f.seekg(static_cast<std::streamoff>(offset));
  1347. if (!f.good()) { return false; }
  1348. char buf[8192];
  1349. while (length > 0) {
  1350. auto to_read = (std::min)(sizeof(buf), length);
  1351. f.read(buf, static_cast<std::streamsize>(to_read));
  1352. auto n = static_cast<size_t>(f.gcount());
  1353. // The file is shorter than the size make_file_body() measured, which the
  1354. // caller has already committed to as Content-Length. The body cannot be
  1355. // completed, so fail as every other error here does.
  1356. if (n == 0) { return false; }
  1357. if (!sink.write(buf, n)) { return false; }
  1358. length -= n;
  1359. }
  1360. return true;
  1361. };
  1362. return {size, std::move(provider)};
  1363. }
  1364. using ContentReceiverWithProgress = std::function<bool(
  1365. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1366. using ContentReceiver =
  1367. std::function<bool(const char *data, size_t data_length)>;
  1368. using FormDataHeader = std::function<bool(const FormData &file)>;
  1369. class ContentReader {
  1370. public:
  1371. using Reader = std::function<bool(ContentReceiver receiver)>;
  1372. using FormDataReader =
  1373. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1374. ContentReader(Reader reader, FormDataReader multipart_reader)
  1375. : reader_(std::move(reader)),
  1376. formdata_reader_(std::move(multipart_reader)) {}
  1377. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1378. return formdata_reader_(std::move(header), std::move(receiver));
  1379. }
  1380. bool operator()(ContentReceiver receiver) const {
  1381. return reader_(std::move(receiver));
  1382. }
  1383. Reader reader_;
  1384. FormDataReader formdata_reader_;
  1385. };
  1386. using Range = std::pair<ssize_t, ssize_t>;
  1387. using Ranges = std::vector<Range>;
  1388. #ifdef CPPHTTPLIB_SSL_ENABLED
  1389. // TLS abstraction layer - public type definitions and API
  1390. namespace tls {
  1391. // Opaque handles (defined as void* for abstraction)
  1392. using ctx_t = void *;
  1393. using session_t = void *;
  1394. using const_session_t = const void *; // For read-only session access
  1395. using cert_t = void *;
  1396. using ca_store_t = void *;
  1397. // TLS versions
  1398. enum class Version {
  1399. TLS1_2 = 0x0303,
  1400. TLS1_3 = 0x0304,
  1401. };
  1402. // Subject Alternative Names (SAN) entry types
  1403. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1404. // SAN entry structure
  1405. struct SanEntry {
  1406. SanType type;
  1407. std::string value;
  1408. };
  1409. // Verification context for certificate verification callback
  1410. struct VerifyContext {
  1411. session_t session; // TLS session handle
  1412. cert_t cert; // Current certificate being verified
  1413. int depth; // Certificate chain depth (0 = leaf)
  1414. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1415. long error_code; // Backend-specific error code (0 = no error)
  1416. const char *error_string; // Human-readable error description
  1417. // Certificate introspection methods
  1418. std::string subject_cn() const;
  1419. std::string issuer_name() const;
  1420. bool check_hostname(const char *hostname) const;
  1421. std::vector<SanEntry> sans() const;
  1422. bool validity(time_t &not_before, time_t &not_after) const;
  1423. std::string serial() const;
  1424. };
  1425. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1426. // TlsError codes for TLS operations (backend-independent)
  1427. enum class ErrorCode : int {
  1428. Success = 0,
  1429. WantRead, // Non-blocking: need to wait for read
  1430. WantWrite, // Non-blocking: need to wait for write
  1431. PeerClosed, // Peer closed the connection
  1432. Fatal, // Unrecoverable error
  1433. SyscallError, // System call error (check sys_errno)
  1434. CertVerifyFailed, // Certificate verification failed
  1435. HostnameMismatch, // Hostname verification failed
  1436. };
  1437. // TLS error information
  1438. struct TlsError {
  1439. ErrorCode code = ErrorCode::Fatal;
  1440. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1441. int sys_errno = 0; // errno when SyscallError
  1442. // Convert verification error code to human-readable string
  1443. static std::string verify_error_to_string(long error_code);
  1444. };
  1445. // RAII wrapper for peer certificate
  1446. class PeerCert {
  1447. public:
  1448. PeerCert();
  1449. PeerCert(PeerCert &&other) noexcept;
  1450. PeerCert &operator=(PeerCert &&other) noexcept;
  1451. ~PeerCert();
  1452. PeerCert(const PeerCert &) = delete;
  1453. PeerCert &operator=(const PeerCert &) = delete;
  1454. explicit operator bool() const;
  1455. std::string subject_cn() const;
  1456. std::string issuer_name() const;
  1457. bool check_hostname(const char *hostname) const;
  1458. std::vector<SanEntry> sans() const;
  1459. bool validity(time_t &not_before, time_t &not_after) const;
  1460. std::string serial() const;
  1461. private:
  1462. explicit PeerCert(cert_t cert);
  1463. cert_t cert_ = nullptr;
  1464. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1465. };
  1466. // Callback for TLS context setup (used by SSLServer constructor)
  1467. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1468. } // namespace tls
  1469. #endif
  1470. struct Request {
  1471. std::string method;
  1472. std::string path;
  1473. std::string matched_route;
  1474. Params params;
  1475. Headers headers;
  1476. Headers trailers;
  1477. std::string body;
  1478. std::string remote_addr;
  1479. int remote_port = -1;
  1480. std::string local_addr;
  1481. int local_port = -1;
  1482. // for server
  1483. std::string version;
  1484. std::string target;
  1485. MultipartFormData form;
  1486. Ranges ranges;
  1487. Match matches;
  1488. std::unordered_map<std::string, std::string> path_params;
  1489. std::function<bool()> is_connection_closed = []() { return true; };
  1490. // for client
  1491. std::vector<std::string> accept_content_types;
  1492. ResponseHandler response_handler;
  1493. ContentReceiverWithProgress content_receiver;
  1494. DownloadProgress download_progress;
  1495. UploadProgress upload_progress;
  1496. bool has_header(const std::string &key) const;
  1497. std::string get_header_value(const std::string &key, const char *def = "",
  1498. size_t id = 0) const;
  1499. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1500. size_t id = 0) const;
  1501. size_t get_header_value_count(const std::string &key) const;
  1502. void set_header(const std::string &key, const std::string &val);
  1503. bool has_trailer(const std::string &key) const;
  1504. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1505. size_t get_trailer_value_count(const std::string &key) const;
  1506. bool has_param(const std::string &key) const;
  1507. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1508. std::vector<std::string> get_param_values(const std::string &key) const;
  1509. size_t get_param_value_count(const std::string &key) const;
  1510. bool is_multipart_form_data() const;
  1511. // private members...
  1512. bool body_consumed_ = false;
  1513. bool expect_100_continue_pending_ = false;
  1514. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1515. size_t content_length_ = 0;
  1516. ContentProvider content_provider_;
  1517. bool is_chunked_content_provider_ = false;
  1518. size_t authorization_count_ = 0;
  1519. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1520. (std::chrono::steady_clock::time_point::min)();
  1521. #ifdef CPPHTTPLIB_SSL_ENABLED
  1522. tls::const_session_t ssl = nullptr;
  1523. tls::PeerCert peer_cert() const;
  1524. std::string sni() const;
  1525. #endif
  1526. };
  1527. namespace detail {
  1528. // Declared up here, away from the rest of the compression helpers, because
  1529. // `Response` stores one.
  1530. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1531. } // namespace detail
  1532. struct Response {
  1533. std::string version;
  1534. int status = -1;
  1535. std::string reason;
  1536. Headers headers;
  1537. Headers trailers;
  1538. std::string body;
  1539. std::string location; // Redirect location
  1540. // User-defined context — set by pre-routing/pre-request handlers and read
  1541. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1542. UserData user_data;
  1543. bool has_header(const std::string &key) const;
  1544. std::string get_header_value(const std::string &key, const char *def = "",
  1545. size_t id = 0) const;
  1546. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1547. size_t id = 0) const;
  1548. size_t get_header_value_count(const std::string &key) const;
  1549. void set_header(const std::string &key, const std::string &val);
  1550. bool has_trailer(const std::string &key) const;
  1551. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1552. size_t get_trailer_value_count(const std::string &key) const;
  1553. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1554. void set_content(const char *s, size_t n, const std::string &content_type);
  1555. void set_content(const std::string &s, const std::string &content_type);
  1556. void set_content(std::string &&s, const std::string &content_type);
  1557. void set_content_provider(
  1558. size_t length, const std::string &content_type, ContentProvider provider,
  1559. ContentProviderResourceReleaser resource_releaser = nullptr);
  1560. void set_content_provider(
  1561. const std::string &content_type, ContentProviderWithoutLength provider,
  1562. ContentProviderResourceReleaser resource_releaser = nullptr);
  1563. void set_chunked_content_provider(
  1564. const std::string &content_type, ContentProviderWithoutLength provider,
  1565. ContentProviderResourceReleaser resource_releaser = nullptr);
  1566. void set_file_content(const std::string &path,
  1567. const std::string &content_type);
  1568. void set_file_content(const std::string &path);
  1569. Response() = default;
  1570. Response(const Response &) = default;
  1571. Response &operator=(const Response &) = default;
  1572. Response(Response &&) = default;
  1573. Response &operator=(Response &&) = default;
  1574. ~Response() {
  1575. if (content_provider_resource_releaser_) {
  1576. content_provider_resource_releaser_(content_provider_success_);
  1577. }
  1578. }
  1579. // private members...
  1580. size_t content_length_ = 0;
  1581. ContentProvider content_provider_;
  1582. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1583. bool is_chunked_content_provider_ = false;
  1584. bool is_file_content_provider_ = false;
  1585. bool content_provider_success_ = false;
  1586. std::string file_content_path_;
  1587. std::string file_content_content_type_;
  1588. // Content coding chosen for the response body, decided once so that the
  1589. // headers and the body cannot disagree: where the file is opened for a
  1590. // file-backed content provider (keeping the ETag honest), and in
  1591. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1592. // for every other kind of response.
  1593. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1594. };
  1595. enum class Error {
  1596. Success = 0,
  1597. Unknown,
  1598. Connection,
  1599. BindIPAddress,
  1600. Read,
  1601. Write,
  1602. ExceedRedirectCount,
  1603. Canceled,
  1604. SSLConnection,
  1605. SSLLoadingCerts,
  1606. SSLServerVerification,
  1607. SSLServerHostnameVerification,
  1608. UnsupportedMultipartBoundaryChars,
  1609. Compression,
  1610. ConnectionTimeout,
  1611. ProxyConnection,
  1612. ConnectionClosed,
  1613. Timeout,
  1614. ResourceExhaustion,
  1615. TooManyFormDataFiles,
  1616. ExceedMaxPayloadSize,
  1617. ExceedUriMaxLength,
  1618. ExceedMaxSocketDescriptorCount,
  1619. InvalidRequestLine,
  1620. InvalidHTTPMethod,
  1621. InvalidHTTPVersion,
  1622. InvalidHeaders,
  1623. MultipartParsing,
  1624. OpenFile,
  1625. Listen,
  1626. GetSockName,
  1627. UnsupportedAddressFamily,
  1628. HTTPParsing,
  1629. InvalidRangeHeader,
  1630. UnsupportedContentEncoding,
  1631. WebSocketHandshake,
  1632. UserCallbackException,
  1633. // For internal use only
  1634. SSLPeerCouldBeClosed_,
  1635. };
  1636. std::string to_string(Error error);
  1637. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1638. class Stream {
  1639. public:
  1640. virtual ~Stream() = default;
  1641. virtual bool is_readable() const = 0;
  1642. virtual bool wait_readable() const = 0;
  1643. virtual bool wait_writable() const = 0;
  1644. virtual bool is_peer_alive() const { return wait_writable(); }
  1645. virtual ssize_t read(char *ptr, size_t size) = 0;
  1646. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1647. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1648. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1649. virtual socket_t socket() const = 0;
  1650. virtual time_t duration() const = 0;
  1651. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1652. (void)sec;
  1653. (void)usec;
  1654. }
  1655. // Bytes already pulled off the socket and sitting in this stream's own
  1656. // buffer. Exposing them lets a line reader scan for a terminator in one
  1657. // pass instead of asking for a byte at a time. A stream that does no
  1658. // buffering of its own reports none, and readers fall back to read().
  1659. virtual const char *buffered_data(size_t &size) const {
  1660. size = 0;
  1661. return nullptr;
  1662. }
  1663. // Discards `size` bytes previously returned by buffered_data().
  1664. virtual void consume_buffered(size_t size) { (void)size; }
  1665. ssize_t write(const char *ptr);
  1666. ssize_t write(const std::string &s);
  1667. Error get_error() const { return error_; }
  1668. protected:
  1669. Error error_ = Error::Success;
  1670. };
  1671. class TaskQueue {
  1672. public:
  1673. TaskQueue() = default;
  1674. virtual ~TaskQueue() = default;
  1675. virtual bool enqueue(std::function<void()> fn) = 0;
  1676. virtual void shutdown() = 0;
  1677. virtual void on_idle() {}
  1678. };
  1679. class ThreadPool final : public TaskQueue {
  1680. public:
  1681. explicit ThreadPool(
  1682. size_t n, size_t max_n = 0, size_t mqr = 0,
  1683. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1684. ThreadPool(const ThreadPool &) = delete;
  1685. ~ThreadPool() override = default;
  1686. bool enqueue(std::function<void()> fn) override;
  1687. void shutdown() override;
  1688. private:
  1689. void worker(bool is_dynamic);
  1690. void move_to_finished(std::thread::id id);
  1691. void cleanup_finished_threads();
  1692. size_t base_thread_count_;
  1693. size_t max_thread_count_;
  1694. size_t max_queued_requests_;
  1695. time_t idle_timeout_sec_;
  1696. size_t idle_thread_count_;
  1697. bool shutdown_;
  1698. std::list<std::function<void()>> jobs_;
  1699. std::vector<std::thread> threads_; // base threads
  1700. std::list<std::thread> dynamic_threads_; // dynamic threads
  1701. std::vector<std::thread>
  1702. finished_threads_; // exited dynamic threads awaiting join
  1703. std::condition_variable cond_;
  1704. std::mutex mutex_;
  1705. };
  1706. using Logger = std::function<void(const Request &, const Response &)>;
  1707. // Forward declaration for Error type
  1708. enum class Error;
  1709. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1710. using SocketOptions = std::function<void(socket_t sock)>;
  1711. void default_socket_options(socket_t sock);
  1712. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1713. const char *status_message(int status);
  1714. std::string to_string(Error error);
  1715. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1716. std::string get_bearer_token_auth(const Request &req);
  1717. namespace detail {
  1718. class MatcherBase {
  1719. public:
  1720. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1721. virtual ~MatcherBase() = default;
  1722. const std::string &pattern() const { return pattern_; }
  1723. // Match request path and populate its matches and
  1724. virtual bool match(Request &request) const = 0;
  1725. private:
  1726. std::string pattern_;
  1727. };
  1728. /**
  1729. * Captures parameters in request path and stores them in Request::path_params
  1730. *
  1731. * Capture name is a substring of a pattern from : to /.
  1732. * The rest of the pattern is matched against the request path directly
  1733. * Parameters are captured starting from the next character after
  1734. * the end of the last matched static pattern fragment until the next /.
  1735. *
  1736. * Example pattern:
  1737. * "/path/fragments/:capture/more/fragments/:second_capture"
  1738. * Static fragments:
  1739. * "/path/fragments/", "more/fragments/"
  1740. *
  1741. * Given the following request path:
  1742. * "/path/fragments/:1/more/fragments/:2"
  1743. * the resulting capture will be
  1744. * {{"capture", "1"}, {"second_capture", "2"}}
  1745. */
  1746. class PathParamsMatcher final : public MatcherBase {
  1747. public:
  1748. PathParamsMatcher(const std::string &pattern);
  1749. bool match(Request &request) const override;
  1750. private:
  1751. // Treat segment separators as the end of path parameter capture
  1752. // Does not need to handle query parameters as they are parsed before path
  1753. // matching
  1754. static constexpr char separator = '/';
  1755. // Contains static path fragments to match against, excluding the '/' after
  1756. // path params
  1757. // Fragments are separated by path params
  1758. std::vector<std::string> static_fragments_;
  1759. // Stores the names of the path parameters to be used as keys in the
  1760. // Request::path_params map
  1761. std::vector<std::string> param_names_;
  1762. };
  1763. /**
  1764. * Performs std::regex_match on request path
  1765. * and stores the result in Request::matches
  1766. *
  1767. * Note that regex match is performed directly on the whole request.
  1768. * This means that wildcard patterns may match multiple path segments with /:
  1769. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1770. */
  1771. class RegexMatcher final : public MatcherBase {
  1772. public:
  1773. RegexMatcher(const std::string &pattern)
  1774. : MatcherBase(pattern), regex_(pattern) {}
  1775. bool match(Request &request) const override;
  1776. private:
  1777. std::regex regex_;
  1778. };
  1779. int close_socket(socket_t sock) noexcept;
  1780. bool is_accept_resource_error();
  1781. bool is_accept_transient_error();
  1782. ssize_t write_headers(Stream &strm, const Headers &headers);
  1783. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1784. time_t usec);
  1785. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1786. const std::string &boundary);
  1787. ContentProvider
  1788. make_multipart_content_provider(const UploadFormDataItems &items,
  1789. const std::string &boundary);
  1790. } // namespace detail
  1791. bool is_valid_multipart_boundary(const std::string &boundary);
  1792. // Serializer for multipart/form-data request bodies. The boundary is owned
  1793. // by the writer so that per-part framing and the final terminator always
  1794. // agree. Field names and filenames are escaped following the WHATWG HTML
  1795. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1796. // in content types.
  1797. class MultipartFormDataWriter {
  1798. public:
  1799. MultipartFormDataWriter();
  1800. // precondition: is_valid_multipart_boundary(boundary)
  1801. explicit MultipartFormDataWriter(std::string boundary);
  1802. const std::string &boundary() const;
  1803. std::string content_type() const;
  1804. // In-memory items -> whole body (known length)
  1805. std::string serialize(const UploadFormDataItems &items) const;
  1806. size_t content_length(const UploadFormDataItems &items) const;
  1807. // Per-part framing for streaming via a content provider
  1808. std::string item_begin(const UploadFormData &item) const;
  1809. static std::string item_end();
  1810. std::string finish() const;
  1811. private:
  1812. std::string boundary_;
  1813. };
  1814. class Server {
  1815. public:
  1816. using Handler = std::function<void(const Request &, Response &)>;
  1817. using ExceptionHandler =
  1818. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1819. enum class HandlerResponse {
  1820. Handled,
  1821. Unhandled,
  1822. };
  1823. using HandlerWithResponse =
  1824. std::function<HandlerResponse(const Request &, Response &)>;
  1825. using HandlerWithContentReader = std::function<void(
  1826. const Request &, Response &, const ContentReader &content_reader)>;
  1827. using Expect100ContinueHandler =
  1828. std::function<int(const Request &, Response &)>;
  1829. using StartHandler = std::function<void()>;
  1830. using WebSocketHandler =
  1831. std::function<void(const Request &, ws::WebSocket &)>;
  1832. using SubProtocolSelector =
  1833. std::function<std::string(const std::vector<std::string> &protocols)>;
  1834. Server();
  1835. virtual ~Server();
  1836. virtual bool is_valid() const;
  1837. Server &Get(const std::string &pattern, Handler handler);
  1838. Server &Post(const std::string &pattern, Handler handler);
  1839. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1840. Server &Put(const std::string &pattern, Handler handler);
  1841. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1842. Server &Patch(const std::string &pattern, Handler handler);
  1843. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1844. Server &Delete(const std::string &pattern, Handler handler);
  1845. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1846. Server &Options(const std::string &pattern, Handler handler);
  1847. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1848. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1849. // server accept it; an unregistered method is still rejected with 400.
  1850. // `method` must be a valid HTTP method token and must not be one of the
  1851. // built-in methods, which have their own registration functions above. A
  1852. // rejected registration makes is_valid() return false, so listen() fails.
  1853. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1854. Handler handler);
  1855. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1856. HandlerWithContentReader handler);
  1857. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1858. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1859. SubProtocolSelector sub_protocol_selector);
  1860. bool set_base_dir(const std::string &dir,
  1861. const std::string &mount_point = std::string());
  1862. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1863. Headers headers = Headers());
  1864. bool remove_mount_point(const std::string &mount_point);
  1865. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1866. const std::string &mime);
  1867. Server &set_default_file_mimetype(const std::string &mime);
  1868. Server &set_file_request_handler(Handler handler);
  1869. template <class ErrorHandlerFunc>
  1870. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1871. return set_error_handler_core(
  1872. std::forward<ErrorHandlerFunc>(handler),
  1873. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1874. }
  1875. Server &set_exception_handler(ExceptionHandler handler);
  1876. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1877. Server &set_post_routing_handler(Handler handler);
  1878. Server &set_pre_request_handler(HandlerWithResponse handler);
  1879. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1880. Server &set_start_handler(StartHandler handler);
  1881. Server &set_logger(Logger logger);
  1882. Server &set_pre_compression_logger(Logger logger);
  1883. Server &set_error_logger(ErrorLogger error_logger);
  1884. Server &set_address_family(int family);
  1885. Server &set_tcp_nodelay(bool on);
  1886. Server &set_ipv6_v6only(bool on);
  1887. Server &set_socket_options(SocketOptions socket_options);
  1888. Server &set_default_headers(Headers headers);
  1889. Server &
  1890. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1891. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1892. Server &set_keep_alive_max_count(size_t count);
  1893. Server &set_keep_alive_timeout(time_t sec);
  1894. template <class Rep, class Period>
  1895. Server &
  1896. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1897. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1898. template <class Rep, class Period>
  1899. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1900. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1901. template <class Rep, class Period>
  1902. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1903. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1904. template <class Rep, class Period>
  1905. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1906. Server &set_payload_max_length(size_t length);
  1907. Server &set_static_file_compression(bool on);
  1908. Server &set_static_file_compression_min_length(size_t length);
  1909. Server &set_static_file_compression_max_length(size_t length);
  1910. Server &set_websocket_ping_interval(time_t sec);
  1911. template <class Rep, class Period>
  1912. Server &set_websocket_ping_interval(
  1913. const std::chrono::duration<Rep, Period> &duration);
  1914. Server &set_websocket_max_missed_pongs(int count);
  1915. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1916. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1917. bool listen_after_bind();
  1918. bool listen(const std::string &host, int port, int socket_flags = 0);
  1919. bool is_running() const;
  1920. void wait_until_ready() const;
  1921. void stop() noexcept;
  1922. void decommission();
  1923. std::function<TaskQueue *(void)> new_task_queue;
  1924. protected:
  1925. bool process_request(Stream &strm, const std::string &remote_addr,
  1926. int remote_port, const std::string &local_addr,
  1927. int local_port, bool close_connection,
  1928. bool &connection_closed,
  1929. const std::function<void(Request &)> &setup_request,
  1930. bool *websocket_upgraded = nullptr);
  1931. // Runs the per-connection serving loop and stops an exception thrown by a
  1932. // user callback from escaping the worker thread.
  1933. //
  1934. // process_request() wraps only routing() in a try/catch. Content providers,
  1935. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1936. // handlers all run outside it, and the task queue calls the job without a
  1937. // catch, so an exception from any of those would terminate the process.
  1938. //
  1939. // No 500 is possible here: by the time a content provider runs, the status
  1940. // line and headers are already on the wire. Report it through the error
  1941. // logger and drop the connection, which is what the peer observes either
  1942. // way. Other connections are unaffected.
  1943. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1944. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1945. return serve();
  1946. #else
  1947. try {
  1948. return serve();
  1949. } catch (...) {
  1950. // The error logger is a user callback too, so it must not be able to
  1951. // throw the guard back open.
  1952. try {
  1953. output_error_log(Error::UserCallbackException, nullptr);
  1954. } catch (...) {}
  1955. return false;
  1956. }
  1957. #endif
  1958. }
  1959. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1960. std::vector<std::string> trusted_proxies_;
  1961. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1962. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1963. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1964. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1965. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1966. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1967. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1968. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1969. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1970. bool static_file_compression_ = false;
  1971. size_t static_file_compression_min_length_ =
  1972. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1973. size_t static_file_compression_max_length_ =
  1974. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1975. time_t websocket_ping_interval_sec_ =
  1976. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1977. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1978. private:
  1979. using Handlers =
  1980. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1981. using HandlersForContentReader =
  1982. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1983. HandlerWithContentReader>>;
  1984. // Both handler tables for one custom method live in a single entry, so that
  1985. // routing() needs only one map lookup per request to reach either of them.
  1986. struct CustomHandlerEntry {
  1987. Handlers handlers;
  1988. HandlersForContentReader handlers_for_content_reader;
  1989. };
  1990. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1991. static std::unique_ptr<detail::MatcherBase>
  1992. make_matcher(const std::string &pattern);
  1993. static const std::set<std::string> &builtin_methods();
  1994. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1995. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1996. template <typename H>
  1997. Server &add_handler(
  1998. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1999. const std::string &pattern, H handler) {
  2000. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  2001. return *this;
  2002. }
  2003. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  2004. Server &set_error_handler_core(Handler handler, std::false_type);
  2005. socket_t create_server_socket(const std::string &host, int port,
  2006. int socket_flags,
  2007. SocketOptions socket_options) const;
  2008. int bind_internal(const std::string &host, int port, int socket_flags);
  2009. bool listen_internal();
  2010. bool routing(Request &req, Response &res, Stream &strm);
  2011. bool handle_file_request(Request &req, Response &res);
  2012. bool check_if_not_modified(const Request &req, Response &res,
  2013. const std::string &etag, time_t mtime) const;
  2014. bool check_if_range(Request &req, const std::string &etag,
  2015. time_t mtime) const;
  2016. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  2017. Stream &strm);
  2018. bool dispatch_request_for_content_reader(
  2019. Request &req, Response &res, ContentReader content_reader,
  2020. const HandlersForContentReader &handlers) const;
  2021. bool parse_request_line(const char *s, Request &req) const;
  2022. detail::EncodingType static_file_encoding(const Request &req,
  2023. const Response &res,
  2024. const std::string &content_type,
  2025. size_t length) const;
  2026. bool apply_static_file_compression(const Request &req, Response &res) const;
  2027. void apply_ranges(const Request &req, Response &res,
  2028. std::string &content_type, std::string &boundary) const;
  2029. bool write_response(Stream &strm, bool close_connection, Request &req,
  2030. Response &res);
  2031. bool write_response_with_content(Stream &strm, bool close_connection,
  2032. const Request &req, Response &res);
  2033. bool write_response_core(Stream &strm, bool close_connection,
  2034. const Request &req, Response &res,
  2035. bool need_apply_ranges);
  2036. bool write_content_with_provider(Stream &strm, const Request &req,
  2037. Response &res, const std::string &boundary,
  2038. const std::string &content_type);
  2039. bool read_content(Stream &strm, Request &req, Response &res);
  2040. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2041. Response &res,
  2042. ContentReceiver receiver,
  2043. FormDataHeader multipart_header,
  2044. ContentReceiver multipart_receiver);
  2045. bool read_content_core(Stream &strm, Request &req, Response &res,
  2046. ContentReceiver receiver,
  2047. FormDataHeader multipart_header,
  2048. ContentReceiver multipart_receiver) const;
  2049. virtual bool process_and_close_socket(socket_t sock);
  2050. void output_log(const Request &req, const Response &res) const;
  2051. void output_pre_compression_log(const Request &req,
  2052. const Response &res) const;
  2053. void output_error_log(const Error &err, const Request *req) const;
  2054. std::atomic<bool> is_running_{false};
  2055. std::atomic<bool> is_decommissioned{false};
  2056. // Set when CustomRoute() refuses a registration. Written before listen(),
  2057. // read by is_valid() on the same thread, so it needs no synchronization.
  2058. bool has_invalid_registration_ = false;
  2059. struct MountPointEntry {
  2060. std::string mount_point;
  2061. std::string base_dir;
  2062. std::string resolved_base_dir;
  2063. Headers headers;
  2064. };
  2065. std::vector<MountPointEntry> base_dirs_;
  2066. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2067. std::string default_file_mimetype_ = "application/octet-stream";
  2068. Handler file_request_handler_;
  2069. Handlers get_handlers_;
  2070. Handlers post_handlers_;
  2071. HandlersForContentReader post_handlers_for_content_reader_;
  2072. Handlers put_handlers_;
  2073. HandlersForContentReader put_handlers_for_content_reader_;
  2074. Handlers patch_handlers_;
  2075. HandlersForContentReader patch_handlers_for_content_reader_;
  2076. Handlers delete_handlers_;
  2077. HandlersForContentReader delete_handlers_for_content_reader_;
  2078. Handlers options_handlers_;
  2079. CustomHandlers custom_handlers_;
  2080. struct WebSocketHandlerEntry {
  2081. std::unique_ptr<detail::MatcherBase> matcher;
  2082. WebSocketHandler handler;
  2083. SubProtocolSelector sub_protocol_selector;
  2084. };
  2085. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2086. WebSocketHandlers websocket_handlers_;
  2087. HandlerWithResponse error_handler_;
  2088. ExceptionHandler exception_handler_;
  2089. HandlerWithResponse pre_routing_handler_;
  2090. Handler post_routing_handler_;
  2091. HandlerWithResponse pre_request_handler_;
  2092. Expect100ContinueHandler expect_100_continue_handler_;
  2093. StartHandler start_handler_;
  2094. mutable std::mutex logger_mutex_;
  2095. Logger logger_;
  2096. Logger pre_compression_logger_;
  2097. ErrorLogger error_logger_;
  2098. int address_family_ = AF_UNSPEC;
  2099. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2100. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2101. SocketOptions socket_options_ = default_socket_options;
  2102. Headers default_headers_;
  2103. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2104. detail::write_headers;
  2105. };
  2106. class Result {
  2107. public:
  2108. Result() = default;
  2109. Result(std::unique_ptr<Response> &&res, Error err,
  2110. Headers &&request_headers = Headers{})
  2111. : res_(std::move(res)), err_(err),
  2112. request_headers_(std::move(request_headers)) {}
  2113. // Response
  2114. operator bool() const { return res_ != nullptr; }
  2115. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2116. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2117. const Response &value() const { return *res_; }
  2118. Response &value() { return *res_; }
  2119. const Response &operator*() const { return *res_; }
  2120. Response &operator*() { return *res_; }
  2121. const Response *operator->() const { return res_.get(); }
  2122. Response *operator->() { return res_.get(); }
  2123. // Error
  2124. Error error() const { return err_; }
  2125. // Request Headers
  2126. bool has_request_header(const std::string &key) const;
  2127. std::string get_request_header_value(const std::string &key,
  2128. const char *def = "",
  2129. size_t id = 0) const;
  2130. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2131. size_t id = 0) const;
  2132. size_t get_request_header_value_count(const std::string &key) const;
  2133. private:
  2134. std::unique_ptr<Response> res_;
  2135. Error err_ = Error::Unknown;
  2136. Headers request_headers_;
  2137. #ifdef CPPHTTPLIB_SSL_ENABLED
  2138. public:
  2139. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2140. int ssl_error)
  2141. : res_(std::move(res)), err_(err),
  2142. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2143. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2144. int ssl_error, uint64_t ssl_backend_error)
  2145. : res_(std::move(res)), err_(err),
  2146. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2147. ssl_backend_error_(ssl_backend_error) {}
  2148. int ssl_error() const { return ssl_error_; }
  2149. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2150. private:
  2151. int ssl_error_ = 0;
  2152. uint64_t ssl_backend_error_ = 0;
  2153. #endif
  2154. };
  2155. struct ClientConnection {
  2156. socket_t sock = INVALID_SOCKET;
  2157. bool is_open() const { return sock != INVALID_SOCKET; }
  2158. ClientConnection() = default;
  2159. ~ClientConnection();
  2160. ClientConnection(const ClientConnection &) = delete;
  2161. ClientConnection &operator=(const ClientConnection &) = delete;
  2162. ClientConnection(ClientConnection &&other) noexcept
  2163. : sock(other.sock)
  2164. #ifdef CPPHTTPLIB_SSL_ENABLED
  2165. ,
  2166. session(other.session)
  2167. #endif
  2168. {
  2169. other.sock = INVALID_SOCKET;
  2170. #ifdef CPPHTTPLIB_SSL_ENABLED
  2171. other.session = nullptr;
  2172. #endif
  2173. }
  2174. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2175. if (this != &other) {
  2176. sock = other.sock;
  2177. other.sock = INVALID_SOCKET;
  2178. #ifdef CPPHTTPLIB_SSL_ENABLED
  2179. session = other.session;
  2180. other.session = nullptr;
  2181. #endif
  2182. }
  2183. return *this;
  2184. }
  2185. #ifdef CPPHTTPLIB_SSL_ENABLED
  2186. tls::session_t session = nullptr;
  2187. #endif
  2188. };
  2189. namespace detail {
  2190. struct ChunkedDecoder;
  2191. struct BodyReader {
  2192. Stream *stream = nullptr;
  2193. bool has_content_length = false;
  2194. size_t content_length = 0;
  2195. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2196. size_t bytes_read = 0;
  2197. bool chunked = false;
  2198. bool eof = false;
  2199. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2200. Error last_error = Error::Success;
  2201. ssize_t read(char *buf, size_t len);
  2202. bool has_error() const { return last_error != Error::Success; }
  2203. };
  2204. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2205. size_t len) {
  2206. (void)stream;
  2207. return br.read(buf, len);
  2208. }
  2209. class decompressor;
  2210. enum class NoProxyKind {
  2211. Wildcard, // "*"
  2212. HostnameSuffix, // "example.com" or ".example.com"
  2213. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2214. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2215. };
  2216. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2217. // Lets one CIDR matcher cover both families.
  2218. using IPBytes = std::array<uint8_t, 16>;
  2219. struct NoProxyEntry {
  2220. NoProxyKind kind = NoProxyKind::Wildcard;
  2221. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2222. IPBytes net{};
  2223. int prefix_bits = 0;
  2224. };
  2225. struct NormalizedTarget {
  2226. std::string hostname; // lowercase; brackets and trailing dot removed
  2227. bool is_ipv4 = false;
  2228. bool is_ipv6 = false;
  2229. IPBytes ip{};
  2230. };
  2231. } // namespace detail
  2232. class ClientImpl {
  2233. public:
  2234. explicit ClientImpl(const std::string &host);
  2235. explicit ClientImpl(const std::string &host, int port);
  2236. explicit ClientImpl(const std::string &host, int port,
  2237. const std::string &client_cert_path,
  2238. const std::string &client_key_path);
  2239. virtual ~ClientImpl();
  2240. virtual bool is_valid() const;
  2241. struct StreamHandle {
  2242. std::unique_ptr<Response> response;
  2243. Error error = Error::Success;
  2244. StreamHandle() = default;
  2245. StreamHandle(const StreamHandle &) = delete;
  2246. StreamHandle &operator=(const StreamHandle &) = delete;
  2247. StreamHandle(StreamHandle &&) = default;
  2248. StreamHandle &operator=(StreamHandle &&) = default;
  2249. ~StreamHandle() = default;
  2250. bool is_valid() const {
  2251. return response != nullptr && error == Error::Success;
  2252. }
  2253. ssize_t read(char *buf, size_t len);
  2254. void parse_trailers_if_needed();
  2255. Error get_read_error() const { return body_reader_.last_error; }
  2256. bool has_read_error() const { return body_reader_.has_error(); }
  2257. bool trailers_parsed_ = false;
  2258. private:
  2259. friend class ClientImpl;
  2260. ssize_t read_with_decompression(char *buf, size_t len);
  2261. std::unique_ptr<ClientConnection> connection_;
  2262. std::unique_ptr<Stream> socket_stream_;
  2263. Stream *stream_ = nullptr;
  2264. detail::BodyReader body_reader_;
  2265. std::unique_ptr<detail::decompressor> decompressor_;
  2266. std::string decompress_buffer_;
  2267. size_t decompress_offset_ = 0;
  2268. size_t decompressed_bytes_read_ = 0;
  2269. };
  2270. // clang-format off
  2271. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2272. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2273. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2274. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2275. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2276. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2277. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2278. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2279. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2280. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2281. Result Head(const std::string &path);
  2282. Result Head(const std::string &path, const Headers &headers);
  2283. Result Post(const std::string &path);
  2284. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2285. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2286. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2287. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2288. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2289. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2290. Result Post(const std::string &path, const Params &params);
  2291. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2292. Result Post(const std::string &path, const Headers &headers);
  2293. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2294. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2296. 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);
  2297. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2298. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2299. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2300. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2301. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2302. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2303. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2304. Result Put(const std::string &path);
  2305. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2306. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2307. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2308. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2309. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2310. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2311. Result Put(const std::string &path, const Params &params);
  2312. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2313. Result Put(const std::string &path, const Headers &headers);
  2314. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2315. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2316. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2317. 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);
  2318. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2319. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2320. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2321. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2322. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2323. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2324. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2325. Result Patch(const std::string &path);
  2326. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2327. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2328. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2329. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2330. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2331. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2332. Result Patch(const std::string &path, const Params &params);
  2333. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2334. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2335. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2336. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2337. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2338. 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);
  2339. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2340. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2341. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2342. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2343. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2344. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2345. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2346. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2347. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2348. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2349. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2350. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2351. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2352. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2353. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2354. Result Options(const std::string &path);
  2355. Result Options(const std::string &path, const Headers &headers);
  2356. // clang-format on
  2357. // Streaming API: Open a stream for reading response body incrementally
  2358. // Socket ownership is transferred to StreamHandle for true streaming
  2359. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2360. StreamHandle open_stream(const std::string &method, const std::string &path,
  2361. const Params &params = {},
  2362. const Headers &headers = {},
  2363. const std::string &body = {},
  2364. const std::string &content_type = {});
  2365. bool send(Request &req, Response &res, Error &error);
  2366. Result send(const Request &req);
  2367. void stop();
  2368. std::string host() const;
  2369. int port() const;
  2370. size_t is_socket_open() const;
  2371. socket_t socket() const;
  2372. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2373. void set_default_headers(Headers headers);
  2374. void
  2375. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2376. void set_address_family(int family);
  2377. void set_tcp_nodelay(bool on);
  2378. void set_ipv6_v6only(bool on);
  2379. void set_socket_options(SocketOptions socket_options);
  2380. void set_connection_timeout(time_t sec, time_t usec = 0);
  2381. template <class Rep, class Period>
  2382. void
  2383. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2384. void set_read_timeout(time_t sec, time_t usec = 0);
  2385. template <class Rep, class Period>
  2386. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2387. void set_write_timeout(time_t sec, time_t usec = 0);
  2388. template <class Rep, class Period>
  2389. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2390. void set_max_timeout(time_t msec);
  2391. template <class Rep, class Period>
  2392. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2393. void set_basic_auth(const std::string &username, const std::string &password);
  2394. void set_bearer_token_auth(const std::string &token);
  2395. void set_keep_alive(bool on);
  2396. void set_follow_location(bool on);
  2397. void set_path_encode(bool on);
  2398. void set_compress(bool on);
  2399. void set_decompress(bool on);
  2400. void set_payload_max_length(size_t length);
  2401. void set_interface(const std::string &intf);
  2402. void set_proxy(const std::string &host, int port);
  2403. void set_proxy_basic_auth(const std::string &username,
  2404. const std::string &password);
  2405. void set_proxy_bearer_token_auth(const std::string &token);
  2406. void set_no_proxy(const std::vector<std::string> &patterns);
  2407. void set_logger(Logger logger);
  2408. void set_error_logger(ErrorLogger error_logger);
  2409. protected:
  2410. struct Socket {
  2411. socket_t sock = INVALID_SOCKET;
  2412. // For Mbed TLS compatibility: start_time for request timeout tracking
  2413. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2414. bool is_open() const { return sock != INVALID_SOCKET; }
  2415. #ifdef CPPHTTPLIB_SSL_ENABLED
  2416. tls::session_t ssl = nullptr;
  2417. #endif
  2418. };
  2419. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2420. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2421. virtual bool setup_proxy_connection(
  2422. Socket &socket,
  2423. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2424. Response &res, bool &success, Error &error);
  2425. bool is_proxy_enabled_for_host(const std::string &host) const;
  2426. // All of:
  2427. // shutdown_ssl
  2428. // shutdown_socket
  2429. // close_socket
  2430. // disconnect
  2431. // should ONLY be called when socket_mutex_ is locked, and only when
  2432. // no other thread is using the socket.
  2433. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2434. void shutdown_socket(Socket &socket) const;
  2435. void close_socket(Socket &socket);
  2436. void disconnect(bool gracefully);
  2437. bool process_request(Stream &strm, Request &req, Response &res,
  2438. bool close_connection, Error &error);
  2439. bool write_content_with_provider(Stream &strm, const Request &req,
  2440. Error &error) const;
  2441. void copy_settings(const ClientImpl &rhs);
  2442. void output_log(const Request &req, const Response &res) const;
  2443. void output_error_log(const Error &err, const Request *req) const;
  2444. // Socket endpoint information
  2445. const std::string host_;
  2446. const int port_;
  2447. // Current open socket
  2448. Socket socket_;
  2449. mutable std::mutex socket_mutex_;
  2450. std::recursive_mutex request_mutex_;
  2451. // These are all protected under socket_mutex
  2452. size_t socket_requests_in_flight_ = 0;
  2453. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2454. bool socket_should_be_closed_when_request_is_done_ = false;
  2455. // Hostname to connection target map. The value is an IP literal or another
  2456. // hostname; only the connection target changes, never the identity.
  2457. std::map<std::string, std::string> addr_map_;
  2458. // Default headers
  2459. Headers default_headers_;
  2460. // Header writer
  2461. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2462. detail::write_headers;
  2463. // Settings
  2464. std::string client_cert_path_;
  2465. std::string client_key_path_;
  2466. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2467. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2468. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2469. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2470. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2471. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2472. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2473. std::string basic_auth_username_;
  2474. std::string basic_auth_password_;
  2475. std::string bearer_token_auth_token_;
  2476. bool keep_alive_ = false;
  2477. bool follow_location_ = false;
  2478. bool path_encode_ = true;
  2479. int address_family_ = AF_UNSPEC;
  2480. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2481. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2482. SocketOptions socket_options_ = nullptr;
  2483. bool compress_ = false;
  2484. bool decompress_ = true;
  2485. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2486. bool has_payload_max_length_ = false;
  2487. std::string interface_;
  2488. std::string proxy_host_;
  2489. int proxy_port_ = -1;
  2490. std::string proxy_basic_auth_username_;
  2491. std::string proxy_basic_auth_password_;
  2492. std::string proxy_bearer_token_auth_token_;
  2493. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2494. mutable detail::NormalizedTarget host_normalized_;
  2495. mutable bool host_normalized_valid_ = false;
  2496. mutable std::mutex logger_mutex_;
  2497. Logger logger_;
  2498. ErrorLogger error_logger_;
  2499. private:
  2500. bool send_(Request &req, Response &res, Error &error);
  2501. Result send_(Request &&req);
  2502. socket_t create_client_socket(Error &error) const;
  2503. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2504. bool skip_100_continue = true) const;
  2505. bool write_request(Stream &strm, Request &req, bool close_connection,
  2506. Error &error, bool skip_body, bool &rejected_locally);
  2507. bool write_request_body(Stream &strm, Request &req, Error &error);
  2508. void prepare_default_headers(Request &r, bool for_stream,
  2509. const std::string &ct);
  2510. bool redirect(Request &req, Response &res, Error &error);
  2511. bool create_redirect_client(const std::string &scheme,
  2512. const std::string &host, int port, Request &req,
  2513. Response &res, const std::string &path,
  2514. const std::string &location, Error &error);
  2515. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2516. bool handle_request(Stream &strm, Request &req, Response &res,
  2517. bool close_connection, Error &error);
  2518. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2519. Request &req, const char *body, size_t content_length,
  2520. ContentProvider content_provider,
  2521. ContentProviderWithoutLength content_provider_without_length,
  2522. const std::string &content_type, ContentReceiver content_receiver,
  2523. Error &error);
  2524. Result send_with_content_provider_and_receiver(
  2525. const std::string &method, const std::string &path,
  2526. const Headers &headers, const char *body, size_t content_length,
  2527. ContentProvider content_provider,
  2528. ContentProviderWithoutLength content_provider_without_length,
  2529. const std::string &content_type, ContentReceiver content_receiver,
  2530. UploadProgress progress);
  2531. ContentProviderWithoutLength get_multipart_content_provider(
  2532. const std::string &boundary, const UploadFormDataItems &items,
  2533. const FormDataProviderItems &provider_items) const;
  2534. virtual bool
  2535. process_socket(const Socket &socket,
  2536. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2537. std::function<bool(Stream &strm)> callback);
  2538. virtual bool is_ssl() const;
  2539. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2540. #ifdef CPPHTTPLIB_SSL_ENABLED
  2541. public:
  2542. void set_digest_auth(const std::string &username,
  2543. const std::string &password);
  2544. void set_proxy_digest_auth(const std::string &username,
  2545. const std::string &password);
  2546. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2547. const std::string &ca_cert_dir_path = std::string());
  2548. void enable_server_certificate_verification(bool enabled);
  2549. void enable_server_hostname_verification(bool enabled);
  2550. void enable_system_ca(bool enabled);
  2551. protected:
  2552. std::string digest_auth_username_;
  2553. std::string digest_auth_password_;
  2554. std::string proxy_digest_auth_username_;
  2555. std::string proxy_digest_auth_password_;
  2556. std::string ca_cert_file_path_;
  2557. std::string ca_cert_dir_path_;
  2558. bool server_certificate_verification_ = true;
  2559. bool server_hostname_verification_ = true;
  2560. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2561. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2562. int last_ssl_error_ = 0;
  2563. uint64_t last_backend_error_ = 0;
  2564. #endif
  2565. };
  2566. class Client {
  2567. public:
  2568. // Universal interface
  2569. explicit Client(const std::string &scheme_host_port);
  2570. explicit Client(const std::string &scheme_host_port,
  2571. const std::string &client_cert_path,
  2572. const std::string &client_key_path);
  2573. // HTTP only interface
  2574. explicit Client(const std::string &host, int port);
  2575. explicit Client(const std::string &host, int port,
  2576. const std::string &client_cert_path,
  2577. const std::string &client_key_path);
  2578. Client(Client &&) = default;
  2579. Client &operator=(Client &&) = default;
  2580. ~Client();
  2581. bool is_valid() const;
  2582. // clang-format off
  2583. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2584. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2585. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2586. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2587. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2588. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2589. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2590. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2591. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2592. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2593. Result Head(const std::string &path);
  2594. Result Head(const std::string &path, const Headers &headers);
  2595. Result Post(const std::string &path);
  2596. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2597. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2598. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2599. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2600. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2601. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2602. Result Post(const std::string &path, const Params &params);
  2603. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2604. Result Post(const std::string &path, const Headers &headers);
  2605. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2606. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2608. 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);
  2609. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2611. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2612. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2613. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2614. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2615. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2616. Result Put(const std::string &path);
  2617. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2618. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2619. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2620. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2621. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2622. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2623. Result Put(const std::string &path, const Params &params);
  2624. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2625. Result Put(const std::string &path, const Headers &headers);
  2626. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2627. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2628. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2629. 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);
  2630. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2631. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2632. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2633. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2634. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2635. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2636. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2637. Result Patch(const std::string &path);
  2638. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2639. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2640. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2641. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2642. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2643. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2644. Result Patch(const std::string &path, const Params &params);
  2645. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2646. Result Patch(const std::string &path, const Headers &headers);
  2647. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2648. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2649. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2650. 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);
  2651. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2652. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2653. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2654. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2655. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2656. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2657. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2658. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2659. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2660. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2661. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2662. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2663. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2664. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2665. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2666. Result Options(const std::string &path);
  2667. Result Options(const std::string &path, const Headers &headers);
  2668. // clang-format on
  2669. // Streaming API: Open a stream for reading response body incrementally
  2670. // Socket ownership is transferred to StreamHandle for true streaming
  2671. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2672. ClientImpl::StreamHandle open_stream(const std::string &method,
  2673. const std::string &path,
  2674. const Params &params = {},
  2675. const Headers &headers = {},
  2676. const std::string &body = {},
  2677. const std::string &content_type = {});
  2678. bool send(Request &req, Response &res, Error &error);
  2679. Result send(const Request &req);
  2680. void stop();
  2681. std::string host() const;
  2682. int port() const;
  2683. size_t is_socket_open() const;
  2684. socket_t socket() const;
  2685. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2686. void set_default_headers(Headers headers);
  2687. void
  2688. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2689. void set_address_family(int family);
  2690. void set_tcp_nodelay(bool on);
  2691. void set_socket_options(SocketOptions socket_options);
  2692. void set_connection_timeout(time_t sec, time_t usec = 0);
  2693. template <class Rep, class Period>
  2694. void
  2695. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2696. void set_read_timeout(time_t sec, time_t usec = 0);
  2697. template <class Rep, class Period>
  2698. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2699. void set_write_timeout(time_t sec, time_t usec = 0);
  2700. template <class Rep, class Period>
  2701. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2702. void set_max_timeout(time_t msec);
  2703. template <class Rep, class Period>
  2704. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2705. void set_basic_auth(const std::string &username, const std::string &password);
  2706. void set_bearer_token_auth(const std::string &token);
  2707. void set_keep_alive(bool on);
  2708. void set_follow_location(bool on);
  2709. void set_path_encode(bool on);
  2710. void set_compress(bool on);
  2711. void set_decompress(bool on);
  2712. void set_payload_max_length(size_t length);
  2713. void set_interface(const std::string &intf);
  2714. void set_proxy(const std::string &host, int port);
  2715. void set_proxy_basic_auth(const std::string &username,
  2716. const std::string &password);
  2717. void set_proxy_bearer_token_auth(const std::string &token);
  2718. void set_no_proxy(const std::vector<std::string> &patterns);
  2719. void set_logger(Logger logger);
  2720. void set_error_logger(ErrorLogger error_logger);
  2721. private:
  2722. std::unique_ptr<ClientImpl> cli_;
  2723. #ifdef CPPHTTPLIB_SSL_ENABLED
  2724. public:
  2725. void set_digest_auth(const std::string &username,
  2726. const std::string &password);
  2727. void set_proxy_digest_auth(const std::string &username,
  2728. const std::string &password);
  2729. void enable_server_certificate_verification(bool enabled);
  2730. void enable_server_hostname_verification(bool enabled);
  2731. void enable_system_ca(bool enabled);
  2732. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2733. const std::string &ca_cert_dir_path = std::string());
  2734. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2735. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2736. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2737. void set_session_verifier(
  2738. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2739. tls::ctx_t tls_context() const;
  2740. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2741. void enable_windows_certificate_verification(bool enabled);
  2742. #endif
  2743. private:
  2744. bool is_ssl_ = false;
  2745. #endif
  2746. };
  2747. #ifdef CPPHTTPLIB_SSL_ENABLED
  2748. class SSLServer : public Server {
  2749. public:
  2750. SSLServer(const char *cert_path, const char *private_key_path,
  2751. const char *client_ca_cert_file_path = nullptr,
  2752. const char *client_ca_cert_dir_path = nullptr,
  2753. const char *private_key_password = nullptr);
  2754. struct PemMemory {
  2755. const char *cert_pem;
  2756. size_t cert_pem_len;
  2757. const char *key_pem;
  2758. size_t key_pem_len;
  2759. const char *client_ca_pem;
  2760. size_t client_ca_pem_len;
  2761. const char *private_key_password;
  2762. };
  2763. explicit SSLServer(const PemMemory &pem);
  2764. // The callback receives the ctx_t handle which can be cast to the
  2765. // appropriate backend type (SSL_CTX* for OpenSSL,
  2766. // tls::impl::MbedTlsContext* for Mbed TLS)
  2767. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2768. ~SSLServer() override;
  2769. bool is_valid() const override;
  2770. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2771. const char *client_ca_pem = nullptr,
  2772. const char *password = nullptr);
  2773. tls::ctx_t tls_context() const { return ctx_; }
  2774. int ssl_last_error() const { return last_ssl_error_; }
  2775. private:
  2776. bool process_and_close_socket(socket_t sock) override;
  2777. tls::ctx_t ctx_ = nullptr;
  2778. std::mutex ctx_mutex_;
  2779. int last_ssl_error_ = 0;
  2780. };
  2781. class SSLClient final : public ClientImpl {
  2782. public:
  2783. explicit SSLClient(const std::string &host);
  2784. explicit SSLClient(const std::string &host, int port);
  2785. explicit SSLClient(const std::string &host, int port,
  2786. const std::string &client_cert_path,
  2787. const std::string &client_key_path,
  2788. const std::string &private_key_password = std::string());
  2789. struct PemMemory {
  2790. const char *cert_pem;
  2791. size_t cert_pem_len;
  2792. const char *key_pem;
  2793. size_t key_pem_len;
  2794. const char *private_key_password;
  2795. };
  2796. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2797. ~SSLClient() override;
  2798. bool is_valid() const override;
  2799. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2800. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2801. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2802. // Post-handshake session verifier (backend-independent)
  2803. void set_session_verifier(
  2804. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2805. tls::ctx_t tls_context() const { return ctx_; }
  2806. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2807. void enable_windows_certificate_verification(bool enabled);
  2808. #endif
  2809. private:
  2810. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2811. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2812. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2813. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2814. bool
  2815. process_socket(const Socket &socket,
  2816. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2817. std::function<bool(Stream &strm)> callback) override;
  2818. bool is_ssl() const override;
  2819. bool setup_proxy_connection(
  2820. Socket &socket,
  2821. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2822. Response &res, bool &success, Error &error) override;
  2823. bool connect_with_proxy(
  2824. Socket &sock,
  2825. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2826. Response &res, bool &success, Error &error);
  2827. bool initialize_ssl(Socket &socket, Error &error);
  2828. void init_ctx();
  2829. void reset_ctx_on_error();
  2830. bool load_certs();
  2831. tls::ctx_t ctx_ = nullptr;
  2832. std::mutex ctx_mutex_;
  2833. std::once_flag initialize_cert_;
  2834. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2835. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2836. // Used to keep custom CA configuration exclusive with system CA loading.
  2837. bool ca_cert_store_set_ = false;
  2838. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2839. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2840. bool enable_windows_cert_verification_ = true;
  2841. #endif
  2842. friend class ClientImpl;
  2843. };
  2844. #endif // CPPHTTPLIB_SSL_ENABLED
  2845. namespace detail {
  2846. template <typename T, typename U>
  2847. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2848. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2849. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2850. duration - std::chrono::seconds(sec))
  2851. .count();
  2852. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2853. }
  2854. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2855. return N - 1;
  2856. }
  2857. inline bool is_numeric(const std::string &str) {
  2858. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2859. }
  2860. inline size_t get_header_value_u64(const Headers &headers,
  2861. const std::string &key, size_t def,
  2862. size_t id, bool &is_invalid_value) {
  2863. is_invalid_value = false;
  2864. auto rng = headers.equal_range(key);
  2865. auto it = rng.first;
  2866. std::advance(it, static_cast<ssize_t>(id));
  2867. if (it != rng.second) {
  2868. if (is_numeric(it->second)) {
  2869. // Parse at size_t width so an out-of-range Content-Length is reported
  2870. // rather than silently saturated/truncated (a value above 2^32 would
  2871. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2872. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2873. size_t val = 0;
  2874. const auto &s = it->second;
  2875. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2876. if (r.ec == std::errc::result_out_of_range) {
  2877. is_invalid_value = true;
  2878. return (std::numeric_limits<size_t>::max)();
  2879. }
  2880. return val;
  2881. } else {
  2882. is_invalid_value = true;
  2883. }
  2884. }
  2885. return def;
  2886. }
  2887. inline size_t get_header_value_u64(const Headers &headers,
  2888. const std::string &key, size_t def,
  2889. size_t id) {
  2890. auto dummy = false;
  2891. return get_header_value_u64(headers, key, def, id, dummy);
  2892. }
  2893. } // namespace detail
  2894. template <class Rep, class Period>
  2895. inline Server &
  2896. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2897. detail::duration_to_sec_and_usec(
  2898. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2899. return *this;
  2900. }
  2901. template <class Rep, class Period>
  2902. inline Server &
  2903. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2904. detail::duration_to_sec_and_usec(
  2905. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2906. return *this;
  2907. }
  2908. template <class Rep, class Period>
  2909. inline Server &
  2910. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2911. detail::duration_to_sec_and_usec(
  2912. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2913. return *this;
  2914. }
  2915. template <class Rep, class Period>
  2916. inline void ClientImpl::set_connection_timeout(
  2917. const std::chrono::duration<Rep, Period> &duration) {
  2918. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2919. set_connection_timeout(sec, usec);
  2920. });
  2921. }
  2922. template <class Rep, class Period>
  2923. inline void ClientImpl::set_read_timeout(
  2924. const std::chrono::duration<Rep, Period> &duration) {
  2925. detail::duration_to_sec_and_usec(
  2926. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2927. }
  2928. template <class Rep, class Period>
  2929. inline void ClientImpl::set_write_timeout(
  2930. const std::chrono::duration<Rep, Period> &duration) {
  2931. detail::duration_to_sec_and_usec(
  2932. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2933. }
  2934. template <class Rep, class Period>
  2935. inline void ClientImpl::set_max_timeout(
  2936. const std::chrono::duration<Rep, Period> &duration) {
  2937. auto msec =
  2938. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2939. set_max_timeout(msec);
  2940. }
  2941. template <class Rep, class Period>
  2942. inline void Client::set_connection_timeout(
  2943. const std::chrono::duration<Rep, Period> &duration) {
  2944. cli_->set_connection_timeout(duration);
  2945. }
  2946. template <class Rep, class Period>
  2947. inline void
  2948. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2949. cli_->set_read_timeout(duration);
  2950. }
  2951. template <class Rep, class Period>
  2952. inline void
  2953. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2954. cli_->set_write_timeout(duration);
  2955. }
  2956. inline void Client::set_max_timeout(time_t msec) {
  2957. cli_->set_max_timeout(msec);
  2958. }
  2959. template <class Rep, class Period>
  2960. inline void
  2961. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2962. cli_->set_max_timeout(duration);
  2963. }
  2964. /*
  2965. * Forward declarations and types that will be part of the .h file if split into
  2966. * .h + .cc.
  2967. */
  2968. std::string hosted_at(const std::string &hostname);
  2969. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2970. // JavaScript-style URL encoding/decoding functions
  2971. std::string encode_uri_component(const std::string &value);
  2972. std::string encode_uri(const std::string &value);
  2973. std::string decode_uri_component(const std::string &value);
  2974. std::string decode_uri(const std::string &value);
  2975. // RFC 3986 compliant URL component encoding/decoding functions
  2976. std::string encode_path_component(const std::string &component);
  2977. std::string decode_path_component(const std::string &component);
  2978. std::string encode_query_component(const std::string &component,
  2979. bool space_as_plus = true);
  2980. std::string decode_query_component(const std::string &component,
  2981. bool plus_as_space = true);
  2982. std::string sanitize_filename(const std::string &filename);
  2983. std::string append_query_params(const std::string &path, const Params &params);
  2984. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2985. std::pair<std::string, std::string>
  2986. make_basic_authentication_header(const std::string &username,
  2987. const std::string &password,
  2988. bool is_proxy = false);
  2989. namespace detail {
  2990. #if defined(_WIN32)
  2991. inline std::wstring u8string_to_wstring(const char *s) {
  2992. if (!s) { return std::wstring(); }
  2993. auto len = static_cast<int>(strlen(s));
  2994. if (!len) { return std::wstring(); }
  2995. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2996. if (!wlen) { return std::wstring(); }
  2997. std::wstring ws;
  2998. ws.resize(wlen);
  2999. wlen = ::MultiByteToWideChar(
  3000. CP_UTF8, 0, s, len,
  3001. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  3002. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  3003. return ws;
  3004. }
  3005. #endif
  3006. struct FileStat {
  3007. FileStat(const std::string &path);
  3008. bool is_file() const;
  3009. bool is_dir() const;
  3010. time_t mtime() const;
  3011. size_t size() const;
  3012. private:
  3013. #if defined(_WIN32)
  3014. struct _stat st_;
  3015. #else
  3016. struct stat st_;
  3017. #endif
  3018. int ret_ = -1;
  3019. };
  3020. std::string make_host_and_port_string(const std::string &host, int port,
  3021. bool is_ssl);
  3022. template <typename T>
  3023. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  3024. Error &error);
  3025. std::string trim_copy(const std::string &s);
  3026. void divide(
  3027. const char *data, std::size_t size, char d,
  3028. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3029. fn);
  3030. void divide(
  3031. const std::string &str, char d,
  3032. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  3033. fn);
  3034. void split(const char *b, const char *e, char d,
  3035. std::function<void(const char *, const char *)> fn);
  3036. void split(const char *b, const char *e, char d, size_t m,
  3037. std::function<void(const char *, const char *)> fn);
  3038. bool split_find(const char *b, const char *e, char d,
  3039. std::function<bool(const char *, const char *)> fn);
  3040. bool has_header_token(const Headers &headers, const std::string &key,
  3041. const std::string &token);
  3042. std::string websocket_accept_key(const std::string &client_key);
  3043. bool is_websocket_upgrade(const Request &req);
  3044. bool process_client_socket(
  3045. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3046. time_t write_timeout_sec, time_t write_timeout_usec,
  3047. time_t max_timeout_msec,
  3048. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3049. std::function<bool(Stream &)> callback);
  3050. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3051. int port, int address_family, bool tcp_nodelay,
  3052. bool ipv6_v6only, SocketOptions socket_options,
  3053. time_t connection_timeout_sec,
  3054. time_t connection_timeout_usec,
  3055. time_t read_timeout_sec, time_t read_timeout_usec,
  3056. time_t write_timeout_sec,
  3057. time_t write_timeout_usec,
  3058. const std::string &intf, Error &error);
  3059. const char *get_header_value(const Headers &headers, const std::string &key,
  3060. const char *def, size_t id);
  3061. std::string get_combined_header_value(const Headers &headers,
  3062. const std::string &key);
  3063. std::string params_to_query_str(const Params &params);
  3064. void parse_query_text(const char *data, std::size_t size, Params &params);
  3065. void parse_query_text(const std::string &s, Params &params);
  3066. bool parse_multipart_boundary(const std::string &content_type,
  3067. std::string &boundary);
  3068. bool parse_range_header(const std::string &s, Ranges &ranges);
  3069. bool parse_accept_header(const std::string &s,
  3070. std::vector<std::string> &content_types);
  3071. void parse_disposition_params(const std::string &s, Params &params);
  3072. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3073. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3074. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3075. EncodingType encoding_type(const Request &req, const Response &res,
  3076. const std::string &content_type);
  3077. EncodingType encoding_type(const Request &req, const Response &res);
  3078. class BufferStream final : public Stream {
  3079. public:
  3080. BufferStream() = default;
  3081. ~BufferStream() override = default;
  3082. bool is_readable() const override;
  3083. bool wait_readable() const override;
  3084. bool wait_writable() const override;
  3085. ssize_t read(char *ptr, size_t size) override;
  3086. ssize_t write(const char *ptr, size_t size) override;
  3087. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3088. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3089. socket_t socket() const override;
  3090. time_t duration() const override;
  3091. const std::string &get_buffer() const;
  3092. private:
  3093. std::string buffer;
  3094. size_t position = 0;
  3095. };
  3096. class compressor {
  3097. public:
  3098. virtual ~compressor() = default;
  3099. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3100. virtual bool compress(const char *data, size_t data_length, bool last,
  3101. Callback callback) = 0;
  3102. };
  3103. class decompressor {
  3104. public:
  3105. virtual ~decompressor() = default;
  3106. virtual bool is_valid() const = 0;
  3107. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3108. virtual bool decompress(const char *data, size_t data_length,
  3109. Callback callback) = 0;
  3110. };
  3111. class nocompressor final : public compressor {
  3112. public:
  3113. ~nocompressor() override = default;
  3114. bool compress(const char *data, size_t data_length, bool /*last*/,
  3115. Callback callback) override;
  3116. };
  3117. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3118. class gzip_compressor final : public compressor {
  3119. public:
  3120. gzip_compressor();
  3121. ~gzip_compressor() override;
  3122. bool compress(const char *data, size_t data_length, bool last,
  3123. Callback callback) override;
  3124. private:
  3125. bool is_valid_ = false;
  3126. z_stream strm_;
  3127. };
  3128. class gzip_decompressor final : public decompressor {
  3129. public:
  3130. gzip_decompressor();
  3131. ~gzip_decompressor() override;
  3132. bool is_valid() const override;
  3133. bool decompress(const char *data, size_t data_length,
  3134. Callback callback) override;
  3135. private:
  3136. bool is_valid_ = false;
  3137. z_stream strm_;
  3138. };
  3139. #endif
  3140. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3141. class brotli_compressor final : public compressor {
  3142. public:
  3143. brotli_compressor();
  3144. ~brotli_compressor();
  3145. bool compress(const char *data, size_t data_length, bool last,
  3146. Callback callback) override;
  3147. private:
  3148. BrotliEncoderState *state_ = nullptr;
  3149. };
  3150. class brotli_decompressor final : public decompressor {
  3151. public:
  3152. brotli_decompressor();
  3153. ~brotli_decompressor();
  3154. bool is_valid() const override;
  3155. bool decompress(const char *data, size_t data_length,
  3156. Callback callback) override;
  3157. private:
  3158. BrotliDecoderResult decoder_r;
  3159. BrotliDecoderState *decoder_s = nullptr;
  3160. };
  3161. #endif
  3162. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3163. class zstd_compressor : public compressor {
  3164. public:
  3165. zstd_compressor();
  3166. ~zstd_compressor();
  3167. bool compress(const char *data, size_t data_length, bool last,
  3168. Callback callback) override;
  3169. private:
  3170. ZSTD_CCtx *ctx_ = nullptr;
  3171. };
  3172. class zstd_decompressor : public decompressor {
  3173. public:
  3174. zstd_decompressor();
  3175. ~zstd_decompressor();
  3176. bool is_valid() const override;
  3177. bool decompress(const char *data, size_t data_length,
  3178. Callback callback) override;
  3179. private:
  3180. ZSTD_DCtx *ctx_ = nullptr;
  3181. };
  3182. #endif
  3183. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3184. // to store data. The call can set memory on stack for performance.
  3185. class stream_line_reader {
  3186. public:
  3187. stream_line_reader(Stream &strm, char *fixed_buffer,
  3188. size_t fixed_buffer_size);
  3189. const char *ptr() const;
  3190. size_t size() const;
  3191. bool end_with_crlf() const;
  3192. bool getline();
  3193. private:
  3194. void append(char c);
  3195. void append(const char *data, size_t size);
  3196. Stream &strm_;
  3197. char *fixed_buffer_;
  3198. const size_t fixed_buffer_size_;
  3199. size_t fixed_buffer_used_size_ = 0;
  3200. std::string growable_buffer_;
  3201. };
  3202. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3203. const Headers &src_headers);
  3204. struct ChunkedDecoder {
  3205. Stream &strm;
  3206. size_t chunk_remaining = 0;
  3207. bool finished = false;
  3208. char line_buf[64];
  3209. size_t last_chunk_total = 0;
  3210. size_t last_chunk_offset = 0;
  3211. explicit ChunkedDecoder(Stream &s);
  3212. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3213. size_t &out_chunk_total);
  3214. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3215. };
  3216. class mmap {
  3217. public:
  3218. mmap(const char *path);
  3219. ~mmap();
  3220. bool open(const char *path);
  3221. void close();
  3222. bool is_open() const;
  3223. size_t size() const;
  3224. const char *data() const;
  3225. private:
  3226. #if defined(_WIN32)
  3227. HANDLE hFile_ = NULL;
  3228. HANDLE hMapping_ = NULL;
  3229. #else
  3230. int fd_ = -1;
  3231. #endif
  3232. size_t size_ = 0;
  3233. void *addr_ = nullptr;
  3234. bool is_open_empty_file = false;
  3235. };
  3236. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3237. namespace fields {
  3238. bool is_token_char(char c);
  3239. bool is_token(const std::string &s);
  3240. bool is_field_name(const std::string &s);
  3241. bool is_vchar(char c);
  3242. bool is_obs_text(char c);
  3243. bool is_field_vchar(char c);
  3244. bool is_field_content(const std::string &s);
  3245. bool is_field_value(const std::string &s);
  3246. bool is_field_valid(const std::string &name, const std::string &value);
  3247. } // namespace fields
  3248. } // namespace detail
  3249. /*
  3250. * TLS Abstraction Layer Declarations
  3251. */
  3252. #ifdef CPPHTTPLIB_SSL_ENABLED
  3253. // TLS abstraction layer - backend-specific type declarations
  3254. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3255. namespace tls {
  3256. namespace impl {
  3257. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3258. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3259. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3260. struct MbedTlsContext {
  3261. mbedtls_ssl_config conf;
  3262. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3263. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3264. mbedtls_entropy_context entropy;
  3265. mbedtls_ctr_drbg_context ctr_drbg;
  3266. #endif
  3267. mbedtls_x509_crt ca_chain;
  3268. mbedtls_x509_crt own_cert;
  3269. mbedtls_pk_context own_key;
  3270. bool is_server = false;
  3271. bool verify_client = false;
  3272. bool has_verify_callback = false;
  3273. MbedTlsContext();
  3274. ~MbedTlsContext();
  3275. MbedTlsContext(const MbedTlsContext &) = delete;
  3276. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3277. };
  3278. } // namespace impl
  3279. } // namespace tls
  3280. #endif
  3281. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3282. namespace tls {
  3283. namespace impl {
  3284. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3285. // This struct is accessible via tls::impl for use in SSL context
  3286. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3287. struct WolfSSLContext {
  3288. WOLFSSL_CTX *ctx = nullptr;
  3289. bool is_server = false;
  3290. bool verify_client = false;
  3291. bool has_verify_callback = false;
  3292. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3293. WolfSSLContext();
  3294. ~WolfSSLContext();
  3295. WolfSSLContext(const WolfSSLContext &) = delete;
  3296. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3297. };
  3298. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3299. struct WolfSSLCAStore {
  3300. std::string pem_data;
  3301. };
  3302. } // namespace impl
  3303. } // namespace tls
  3304. #endif
  3305. #endif // CPPHTTPLIB_SSL_ENABLED
  3306. namespace stream {
  3307. class Result {
  3308. public:
  3309. Result();
  3310. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3311. Result(Result &&other) noexcept;
  3312. Result &operator=(Result &&other) noexcept;
  3313. Result(const Result &) = delete;
  3314. Result &operator=(const Result &) = delete;
  3315. // Response info
  3316. bool is_valid() const;
  3317. explicit operator bool() const;
  3318. int status() const;
  3319. const Headers &headers() const;
  3320. std::string get_header_value(const std::string &key,
  3321. const char *def = "") const;
  3322. bool has_header(const std::string &key) const;
  3323. Error error() const;
  3324. Error read_error() const;
  3325. bool has_read_error() const;
  3326. // Stream reading
  3327. bool next();
  3328. const char *data() const;
  3329. size_t size() const;
  3330. std::string read_all();
  3331. private:
  3332. ClientImpl::StreamHandle handle_;
  3333. std::string buffer_;
  3334. size_t current_size_ = 0;
  3335. size_t chunk_size_;
  3336. bool finished_ = false;
  3337. };
  3338. // GET
  3339. template <typename ClientType>
  3340. inline Result Get(ClientType &cli, const std::string &path,
  3341. size_t chunk_size = 8192) {
  3342. return Result{cli.open_stream("GET", path), chunk_size};
  3343. }
  3344. template <typename ClientType>
  3345. inline Result Get(ClientType &cli, const std::string &path,
  3346. const Headers &headers, size_t chunk_size = 8192) {
  3347. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3348. }
  3349. template <typename ClientType>
  3350. inline Result Get(ClientType &cli, const std::string &path,
  3351. const Params &params, size_t chunk_size = 8192) {
  3352. return Result{cli.open_stream("GET", path, params), chunk_size};
  3353. }
  3354. template <typename ClientType>
  3355. inline Result Get(ClientType &cli, const std::string &path,
  3356. const Params &params, const Headers &headers,
  3357. size_t chunk_size = 8192) {
  3358. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3359. }
  3360. // POST
  3361. template <typename ClientType>
  3362. inline Result Post(ClientType &cli, const std::string &path,
  3363. const std::string &body, const std::string &content_type,
  3364. size_t chunk_size = 8192) {
  3365. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3366. chunk_size};
  3367. }
  3368. template <typename ClientType>
  3369. inline Result Post(ClientType &cli, const std::string &path,
  3370. const Headers &headers, const std::string &body,
  3371. const std::string &content_type, size_t chunk_size = 8192) {
  3372. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3373. chunk_size};
  3374. }
  3375. template <typename ClientType>
  3376. inline Result Post(ClientType &cli, const std::string &path,
  3377. const Params &params, const std::string &body,
  3378. const std::string &content_type, size_t chunk_size = 8192) {
  3379. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3380. chunk_size};
  3381. }
  3382. template <typename ClientType>
  3383. inline Result Post(ClientType &cli, const std::string &path,
  3384. const Params &params, const Headers &headers,
  3385. const std::string &body, const std::string &content_type,
  3386. size_t chunk_size = 8192) {
  3387. return Result{
  3388. cli.open_stream("POST", path, params, headers, body, content_type),
  3389. chunk_size};
  3390. }
  3391. // PUT
  3392. template <typename ClientType>
  3393. inline Result Put(ClientType &cli, const std::string &path,
  3394. const std::string &body, const std::string &content_type,
  3395. size_t chunk_size = 8192) {
  3396. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3397. chunk_size};
  3398. }
  3399. template <typename ClientType>
  3400. inline Result Put(ClientType &cli, const std::string &path,
  3401. const Headers &headers, const std::string &body,
  3402. const std::string &content_type, size_t chunk_size = 8192) {
  3403. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3404. chunk_size};
  3405. }
  3406. template <typename ClientType>
  3407. inline Result Put(ClientType &cli, const std::string &path,
  3408. const Params &params, const std::string &body,
  3409. const std::string &content_type, size_t chunk_size = 8192) {
  3410. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3411. chunk_size};
  3412. }
  3413. template <typename ClientType>
  3414. inline Result Put(ClientType &cli, const std::string &path,
  3415. const Params &params, const Headers &headers,
  3416. const std::string &body, const std::string &content_type,
  3417. size_t chunk_size = 8192) {
  3418. return Result{
  3419. cli.open_stream("PUT", path, params, headers, body, content_type),
  3420. chunk_size};
  3421. }
  3422. // PATCH
  3423. template <typename ClientType>
  3424. inline Result Patch(ClientType &cli, const std::string &path,
  3425. const std::string &body, const std::string &content_type,
  3426. size_t chunk_size = 8192) {
  3427. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3428. chunk_size};
  3429. }
  3430. template <typename ClientType>
  3431. inline Result Patch(ClientType &cli, const std::string &path,
  3432. const Headers &headers, const std::string &body,
  3433. const std::string &content_type, size_t chunk_size = 8192) {
  3434. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3435. chunk_size};
  3436. }
  3437. template <typename ClientType>
  3438. inline Result Patch(ClientType &cli, const std::string &path,
  3439. const Params &params, const std::string &body,
  3440. const std::string &content_type, size_t chunk_size = 8192) {
  3441. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3442. chunk_size};
  3443. }
  3444. template <typename ClientType>
  3445. inline Result Patch(ClientType &cli, const std::string &path,
  3446. const Params &params, const Headers &headers,
  3447. const std::string &body, const std::string &content_type,
  3448. size_t chunk_size = 8192) {
  3449. return Result{
  3450. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3451. chunk_size};
  3452. }
  3453. // DELETE
  3454. template <typename ClientType>
  3455. inline Result Delete(ClientType &cli, const std::string &path,
  3456. size_t chunk_size = 8192) {
  3457. return Result{cli.open_stream("DELETE", path), chunk_size};
  3458. }
  3459. template <typename ClientType>
  3460. inline Result Delete(ClientType &cli, const std::string &path,
  3461. const Headers &headers, size_t chunk_size = 8192) {
  3462. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3463. }
  3464. template <typename ClientType>
  3465. inline Result Delete(ClientType &cli, const std::string &path,
  3466. const std::string &body, const std::string &content_type,
  3467. size_t chunk_size = 8192) {
  3468. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3469. chunk_size};
  3470. }
  3471. template <typename ClientType>
  3472. inline Result Delete(ClientType &cli, const std::string &path,
  3473. const Headers &headers, const std::string &body,
  3474. const std::string &content_type,
  3475. size_t chunk_size = 8192) {
  3476. return Result{
  3477. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3478. chunk_size};
  3479. }
  3480. template <typename ClientType>
  3481. inline Result Delete(ClientType &cli, const std::string &path,
  3482. const Params &params, size_t chunk_size = 8192) {
  3483. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3484. }
  3485. template <typename ClientType>
  3486. inline Result Delete(ClientType &cli, const std::string &path,
  3487. const Params &params, const Headers &headers,
  3488. size_t chunk_size = 8192) {
  3489. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3490. }
  3491. template <typename ClientType>
  3492. inline Result Delete(ClientType &cli, const std::string &path,
  3493. const Params &params, const std::string &body,
  3494. const std::string &content_type,
  3495. size_t chunk_size = 8192) {
  3496. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3497. chunk_size};
  3498. }
  3499. template <typename ClientType>
  3500. inline Result Delete(ClientType &cli, const std::string &path,
  3501. const Params &params, const Headers &headers,
  3502. const std::string &body, const std::string &content_type,
  3503. size_t chunk_size = 8192) {
  3504. return Result{
  3505. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3506. chunk_size};
  3507. }
  3508. // HEAD
  3509. template <typename ClientType>
  3510. inline Result Head(ClientType &cli, const std::string &path,
  3511. size_t chunk_size = 8192) {
  3512. return Result{cli.open_stream("HEAD", path), chunk_size};
  3513. }
  3514. template <typename ClientType>
  3515. inline Result Head(ClientType &cli, const std::string &path,
  3516. const Headers &headers, size_t chunk_size = 8192) {
  3517. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3518. }
  3519. template <typename ClientType>
  3520. inline Result Head(ClientType &cli, const std::string &path,
  3521. const Params &params, size_t chunk_size = 8192) {
  3522. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3523. }
  3524. template <typename ClientType>
  3525. inline Result Head(ClientType &cli, const std::string &path,
  3526. const Params &params, const Headers &headers,
  3527. size_t chunk_size = 8192) {
  3528. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3529. }
  3530. // OPTIONS
  3531. template <typename ClientType>
  3532. inline Result Options(ClientType &cli, const std::string &path,
  3533. size_t chunk_size = 8192) {
  3534. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3535. }
  3536. template <typename ClientType>
  3537. inline Result Options(ClientType &cli, const std::string &path,
  3538. const Headers &headers, size_t chunk_size = 8192) {
  3539. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3540. }
  3541. template <typename ClientType>
  3542. inline Result Options(ClientType &cli, const std::string &path,
  3543. const Params &params, size_t chunk_size = 8192) {
  3544. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3545. }
  3546. template <typename ClientType>
  3547. inline Result Options(ClientType &cli, const std::string &path,
  3548. const Params &params, const Headers &headers,
  3549. size_t chunk_size = 8192) {
  3550. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3551. }
  3552. } // namespace stream
  3553. namespace sse {
  3554. struct SSEMessage {
  3555. std::string event; // Event type (default: "message")
  3556. std::string data; // Event payload
  3557. std::string id; // Event ID for Last-Event-ID header
  3558. SSEMessage();
  3559. void clear();
  3560. };
  3561. class SSEClient {
  3562. public:
  3563. using MessageHandler = std::function<void(const SSEMessage &)>;
  3564. using ErrorHandler = std::function<void(Error)>;
  3565. using OpenHandler = std::function<void()>;
  3566. SSEClient(Client &client, const std::string &path);
  3567. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3568. ~SSEClient();
  3569. SSEClient(const SSEClient &) = delete;
  3570. SSEClient &operator=(const SSEClient &) = delete;
  3571. // Event handlers
  3572. SSEClient &on_message(MessageHandler handler);
  3573. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3574. SSEClient &on_open(OpenHandler handler);
  3575. SSEClient &on_error(ErrorHandler handler);
  3576. SSEClient &set_reconnect_interval(int ms);
  3577. SSEClient &set_max_reconnect_attempts(int n);
  3578. // Update headers (thread-safe)
  3579. SSEClient &set_headers(const Headers &headers);
  3580. // State accessors
  3581. bool is_connected() const;
  3582. const std::string &last_event_id() const;
  3583. // Blocking start - runs event loop with auto-reconnect
  3584. void start();
  3585. // Non-blocking start - runs in background thread
  3586. void start_async();
  3587. // Stop the client (thread-safe)
  3588. void stop();
  3589. private:
  3590. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3591. void run_event_loop();
  3592. void dispatch_event(const SSEMessage &msg);
  3593. bool should_reconnect(int count) const;
  3594. void wait_for_reconnect();
  3595. // Client and path
  3596. Client &client_;
  3597. std::string path_;
  3598. Headers headers_;
  3599. mutable std::mutex headers_mutex_;
  3600. // Callbacks
  3601. MessageHandler on_message_;
  3602. std::map<std::string, MessageHandler> event_handlers_;
  3603. OpenHandler on_open_;
  3604. ErrorHandler on_error_;
  3605. // Configuration
  3606. int reconnect_interval_ms_ = 3000;
  3607. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3608. // State
  3609. std::atomic<bool> running_{false};
  3610. std::atomic<bool> connected_{false};
  3611. std::string last_event_id_;
  3612. // Async support
  3613. std::thread async_thread_;
  3614. };
  3615. } // namespace sse
  3616. namespace ws {
  3617. enum class Opcode : uint8_t {
  3618. Continuation = 0x0,
  3619. Text = 0x1,
  3620. Binary = 0x2,
  3621. Close = 0x8,
  3622. Ping = 0x9,
  3623. Pong = 0xA,
  3624. };
  3625. enum class CloseStatus : uint16_t {
  3626. Normal = 1000,
  3627. GoingAway = 1001,
  3628. ProtocolError = 1002,
  3629. UnsupportedData = 1003,
  3630. NoStatus = 1005,
  3631. Abnormal = 1006,
  3632. InvalidPayload = 1007,
  3633. PolicyViolation = 1008,
  3634. MessageTooBig = 1009,
  3635. MandatoryExtension = 1010,
  3636. InternalError = 1011,
  3637. };
  3638. // Timeout is returned only when a read timeout was set and it elapsed before
  3639. // any byte of a frame arrived: nothing was consumed and the connection is
  3640. // still open, so the caller can send on it and read again. `msg` is left
  3641. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3642. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3643. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3644. // upgrade handshake fully succeeded. On failure error() identifies the
  3645. // failing layer; status()/headers() expose the server's upgrade response
  3646. // when one was received (status() is -1 otherwise).
  3647. class Result {
  3648. public:
  3649. Result() = default;
  3650. Result(Error err, int status, Headers &&headers)
  3651. : err_(err), status_(status), headers_(std::move(headers)) {}
  3652. explicit operator bool() const { return err_ == Error::Success; }
  3653. Error error() const { return err_; }
  3654. // Upgrade response info
  3655. int status() const { return status_; }
  3656. const Headers &headers() const { return headers_; }
  3657. std::string get_header_value(const std::string &key,
  3658. const char *def = "") const {
  3659. return detail::get_header_value(headers_, key, def, 0);
  3660. }
  3661. bool has_header(const std::string &key) const {
  3662. return headers_.find(key) != headers_.end();
  3663. }
  3664. #ifdef CPPHTTPLIB_SSL_ENABLED
  3665. Result(Error err, int status, Headers &&headers, int ssl_error,
  3666. uint64_t ssl_backend_error)
  3667. : err_(err), status_(status), headers_(std::move(headers)),
  3668. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3669. int ssl_error() const { return ssl_error_; }
  3670. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3671. #endif
  3672. private:
  3673. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3674. int status_ = -1;
  3675. Headers headers_;
  3676. #ifdef CPPHTTPLIB_SSL_ENABLED
  3677. int ssl_error_ = 0;
  3678. uint64_t ssl_backend_error_ = 0;
  3679. #endif
  3680. };
  3681. class WebSocket {
  3682. public:
  3683. WebSocket(const WebSocket &) = delete;
  3684. WebSocket &operator=(const WebSocket &) = delete;
  3685. ~WebSocket();
  3686. ReadResult read(std::string &msg);
  3687. bool send(const std::string &data);
  3688. bool send(const char *data, size_t len);
  3689. void close(CloseStatus status = CloseStatus::Normal,
  3690. const std::string &reason = "");
  3691. const Request &request() const;
  3692. bool is_open() const;
  3693. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3694. // A server handler owns its connection's timeout this way; a client sets it
  3695. // through WebSocketClient. Safe to call while another thread is in read().
  3696. //
  3697. // Only a timeout set here is reported as Timeout. The compile-time default
  3698. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3699. // than a request for control, so when it elapses read() returns Fail and
  3700. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3701. void set_read_timeout(time_t sec, time_t usec = 0);
  3702. template <class Rep, class Period>
  3703. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3704. private:
  3705. friend class httplib::Server;
  3706. friend class WebSocketClient;
  3707. WebSocket(
  3708. Stream &strm, const Request &req, bool is_server,
  3709. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3710. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3711. : strm_(strm), req_(req), is_server_(is_server),
  3712. ping_interval_sec_(ping_interval_sec),
  3713. max_missed_pongs_(max_missed_pongs) {
  3714. start_heartbeat();
  3715. }
  3716. WebSocket(
  3717. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3718. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3719. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3720. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3721. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3722. max_missed_pongs_(max_missed_pongs) {
  3723. start_heartbeat();
  3724. }
  3725. void start_heartbeat();
  3726. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3727. Stream &strm_;
  3728. std::unique_ptr<Stream> owned_strm_;
  3729. Request req_;
  3730. bool is_server_;
  3731. time_t ping_interval_sec_;
  3732. int max_missed_pongs_;
  3733. int unacked_pings_ = 0;
  3734. std::atomic<bool> closed_{false};
  3735. // Set once the caller has bounded read() through set_read_timeout(). Until
  3736. // then the timeout in effect is the compile-time default, and elapsing it
  3737. // is a failure that closes the connection, not a Timeout.
  3738. std::atomic<bool> read_timeout_set_{false};
  3739. std::mutex write_mutex_;
  3740. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3741. // may do so: read_websocket_frame() reads a payload until it has the whole
  3742. // declared length, so a second parser stealing bytes silently corrupts the
  3743. // message the first one is assembling.
  3744. std::mutex read_mutex_;
  3745. std::thread ping_thread_;
  3746. std::mutex ping_mutex_;
  3747. std::condition_variable ping_cv_;
  3748. };
  3749. class WebSocketClient {
  3750. public:
  3751. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3752. const Headers &headers = {});
  3753. ~WebSocketClient();
  3754. WebSocketClient(const WebSocketClient &) = delete;
  3755. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3756. bool is_valid() const;
  3757. Result connect();
  3758. ReadResult read(std::string &msg);
  3759. bool send(const std::string &data);
  3760. bool send(const char *data, size_t len);
  3761. void close(CloseStatus status = CloseStatus::Normal,
  3762. const std::string &reason = "");
  3763. bool is_open() const;
  3764. const std::string &subprotocol() const;
  3765. void set_read_timeout(time_t sec, time_t usec = 0);
  3766. template <class Rep, class Period>
  3767. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3768. void set_write_timeout(time_t sec, time_t usec = 0);
  3769. template <class Rep, class Period>
  3770. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3771. void set_websocket_ping_interval(time_t sec);
  3772. void set_websocket_max_missed_pongs(int count);
  3773. void set_tcp_nodelay(bool on);
  3774. void set_address_family(int family);
  3775. void set_ipv6_v6only(bool on);
  3776. void set_socket_options(SocketOptions socket_options);
  3777. void set_connection_timeout(time_t sec, time_t usec = 0);
  3778. template <class Rep, class Period>
  3779. void
  3780. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3781. void set_interface(const std::string &intf);
  3782. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3783. #ifdef CPPHTTPLIB_SSL_ENABLED
  3784. struct PemMemory {
  3785. const char *cert_pem;
  3786. size_t cert_pem_len;
  3787. const char *key_pem;
  3788. size_t key_pem_len;
  3789. const char *private_key_password;
  3790. };
  3791. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3792. const PemMemory &pem, const Headers &headers = {});
  3793. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3794. const std::string &ca_cert_dir_path = std::string());
  3795. void set_ca_cert_store(tls::ca_store_t store);
  3796. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3797. void enable_server_certificate_verification(bool enabled);
  3798. void enable_server_hostname_verification(bool enabled);
  3799. void enable_system_ca(bool enabled);
  3800. #endif
  3801. private:
  3802. void shutdown_and_close();
  3803. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3804. int &ssl_error, uint64_t &ssl_backend_error);
  3805. void prepare_default_headers(Request &req);
  3806. std::string host_;
  3807. int port_;
  3808. std::string path_;
  3809. Headers headers_;
  3810. std::string subprotocol_;
  3811. bool is_valid_ = false;
  3812. socket_t sock_ = INVALID_SOCKET;
  3813. std::unique_ptr<WebSocket> ws_;
  3814. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3815. time_t read_timeout_usec_ = 0;
  3816. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3817. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3818. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3819. time_t websocket_ping_interval_sec_ =
  3820. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3821. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3822. int address_family_ = AF_UNSPEC;
  3823. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3824. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3825. SocketOptions socket_options_ = nullptr;
  3826. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3827. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3828. std::string interface_;
  3829. // Hostname to connection target map. The value is an IP literal or another
  3830. // hostname; only the connection target changes, never the identity.
  3831. std::map<std::string, std::string> addr_map_;
  3832. #ifdef CPPHTTPLIB_SSL_ENABLED
  3833. bool is_ssl_ = false;
  3834. tls::ctx_t tls_ctx_ = nullptr;
  3835. tls::session_t tls_session_ = nullptr;
  3836. std::string ca_cert_file_path_;
  3837. std::string ca_cert_dir_path_;
  3838. bool custom_ca_loaded_ = false;
  3839. bool certs_loaded_ = false;
  3840. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3841. bool server_certificate_verification_ = true;
  3842. bool server_hostname_verification_ = true;
  3843. #endif
  3844. };
  3845. template <class Rep, class Period>
  3846. inline void WebSocket::set_read_timeout(
  3847. const std::chrono::duration<Rep, Period> &duration) {
  3848. detail::duration_to_sec_and_usec(
  3849. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3850. }
  3851. template <class Rep, class Period>
  3852. inline void WebSocketClient::set_read_timeout(
  3853. const std::chrono::duration<Rep, Period> &duration) {
  3854. detail::duration_to_sec_and_usec(
  3855. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3856. }
  3857. template <class Rep, class Period>
  3858. inline void WebSocketClient::set_write_timeout(
  3859. const std::chrono::duration<Rep, Period> &duration) {
  3860. detail::duration_to_sec_and_usec(
  3861. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3862. }
  3863. template <class Rep, class Period>
  3864. inline void WebSocketClient::set_connection_timeout(
  3865. const std::chrono::duration<Rep, Period> &duration) {
  3866. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3867. set_connection_timeout(sec, usec);
  3868. });
  3869. }
  3870. namespace impl {
  3871. bool is_valid_utf8(const std::string &s);
  3872. // Three states, because a failure that consumed bytes and one that consumed
  3873. // none are not the same thing: the first has left the stream in the middle of
  3874. // a frame and the connection cannot be reused, the second can just be retried.
  3875. enum class FrameRead { Ok, Fail, Timeout };
  3876. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3877. std::string &payload, bool &fin,
  3878. bool expect_masked, size_t max_len);
  3879. } // namespace impl
  3880. } // namespace ws
  3881. // ----------------------------------------------------------------------------
  3882. /*
  3883. * Implementation that will be part of the .cc file if split into .h + .cc.
  3884. */
  3885. namespace stream {
  3886. // stream::Result implementations
  3887. inline Result::Result() : chunk_size_(8192) {}
  3888. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3889. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3890. inline Result::Result(Result &&other) noexcept
  3891. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3892. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3893. finished_(other.finished_) {
  3894. other.current_size_ = 0;
  3895. other.finished_ = true;
  3896. }
  3897. inline Result &Result::operator=(Result &&other) noexcept {
  3898. if (this != &other) {
  3899. handle_ = std::move(other.handle_);
  3900. buffer_ = std::move(other.buffer_);
  3901. current_size_ = other.current_size_;
  3902. chunk_size_ = other.chunk_size_;
  3903. finished_ = other.finished_;
  3904. other.current_size_ = 0;
  3905. other.finished_ = true;
  3906. }
  3907. return *this;
  3908. }
  3909. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3910. inline Result::operator bool() const { return is_valid(); }
  3911. inline int Result::status() const {
  3912. return handle_.response ? handle_.response->status : -1;
  3913. }
  3914. inline const Headers &Result::headers() const {
  3915. static const Headers empty_headers;
  3916. return handle_.response ? handle_.response->headers : empty_headers;
  3917. }
  3918. inline std::string Result::get_header_value(const std::string &key,
  3919. const char *def) const {
  3920. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3921. }
  3922. inline bool Result::has_header(const std::string &key) const {
  3923. return handle_.response ? handle_.response->has_header(key) : false;
  3924. }
  3925. inline Error Result::error() const { return handle_.error; }
  3926. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3927. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3928. inline bool Result::next() {
  3929. if (!handle_.is_valid() || finished_) { return false; }
  3930. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3931. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3932. if (n > 0) {
  3933. current_size_ = static_cast<size_t>(n);
  3934. return true;
  3935. }
  3936. current_size_ = 0;
  3937. finished_ = true;
  3938. return false;
  3939. }
  3940. inline const char *Result::data() const { return buffer_.data(); }
  3941. inline size_t Result::size() const { return current_size_; }
  3942. inline std::string Result::read_all() {
  3943. std::string result;
  3944. while (next()) {
  3945. result.append(data(), size());
  3946. }
  3947. return result;
  3948. }
  3949. } // namespace stream
  3950. namespace sse {
  3951. // SSEMessage implementations
  3952. inline SSEMessage::SSEMessage() : event("message") {}
  3953. inline void SSEMessage::clear() {
  3954. event = "message";
  3955. data.clear();
  3956. id.clear();
  3957. }
  3958. // SSEClient implementations
  3959. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3960. : client_(client), path_(path) {}
  3961. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3962. const Headers &headers)
  3963. : client_(client), path_(path), headers_(headers) {}
  3964. inline SSEClient::~SSEClient() { stop(); }
  3965. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3966. on_message_ = std::move(handler);
  3967. return *this;
  3968. }
  3969. inline SSEClient &SSEClient::on_event(const std::string &type,
  3970. MessageHandler handler) {
  3971. event_handlers_[type] = std::move(handler);
  3972. return *this;
  3973. }
  3974. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3975. on_open_ = std::move(handler);
  3976. return *this;
  3977. }
  3978. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3979. on_error_ = std::move(handler);
  3980. return *this;
  3981. }
  3982. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3983. reconnect_interval_ms_ = ms;
  3984. return *this;
  3985. }
  3986. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3987. max_reconnect_attempts_ = n;
  3988. return *this;
  3989. }
  3990. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3991. std::lock_guard<std::mutex> lock(headers_mutex_);
  3992. headers_ = headers;
  3993. return *this;
  3994. }
  3995. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3996. inline const std::string &SSEClient::last_event_id() const {
  3997. return last_event_id_;
  3998. }
  3999. inline void SSEClient::start() {
  4000. running_.store(true);
  4001. run_event_loop();
  4002. }
  4003. inline void SSEClient::start_async() {
  4004. running_.store(true);
  4005. async_thread_ = std::thread([this]() { run_event_loop(); });
  4006. }
  4007. inline void SSEClient::stop() {
  4008. running_.store(false);
  4009. client_.stop(); // Cancel any pending operations
  4010. if (async_thread_.joinable()) { async_thread_.join(); }
  4011. }
  4012. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  4013. int &retry_ms) {
  4014. // Blank line signals end of event
  4015. if (line.empty() || line == "\r") { return true; }
  4016. // Lines starting with ':' are comments (ignored)
  4017. if (!line.empty() && line[0] == ':') { return false; }
  4018. // Find the colon separator
  4019. auto colon_pos = line.find(':');
  4020. if (colon_pos == std::string::npos) {
  4021. // Line with no colon is treated as field name with empty value
  4022. return false;
  4023. }
  4024. auto field = line.substr(0, colon_pos);
  4025. std::string value;
  4026. // Value starts after colon, skip optional single space
  4027. if (colon_pos + 1 < line.size()) {
  4028. auto value_start = colon_pos + 1;
  4029. if (line[value_start] == ' ') { value_start++; }
  4030. value = line.substr(value_start);
  4031. // Remove trailing \r if present
  4032. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  4033. }
  4034. // Handle known fields
  4035. if (field == "event") {
  4036. msg.event = value;
  4037. } else if (field == "data") {
  4038. // Multiple data lines are concatenated with newlines
  4039. if (!msg.data.empty()) { msg.data += "\n"; }
  4040. msg.data += value;
  4041. } else if (field == "id") {
  4042. // Empty id is valid (clears the last event ID)
  4043. msg.id = value;
  4044. } else if (field == "retry") {
  4045. // Parse retry interval in milliseconds
  4046. {
  4047. int v = 0;
  4048. auto res =
  4049. detail::from_chars(value.data(), value.data() + value.size(), v);
  4050. if (res.ec == std::errc{}) { retry_ms = v; }
  4051. }
  4052. }
  4053. // Unknown fields are ignored per SSE spec
  4054. return false;
  4055. }
  4056. inline void SSEClient::run_event_loop() {
  4057. auto reconnect_count = 0;
  4058. while (running_.load()) {
  4059. // Build headers, including Last-Event-ID if we have one
  4060. Headers request_headers;
  4061. {
  4062. std::lock_guard<std::mutex> lock(headers_mutex_);
  4063. request_headers = headers_;
  4064. }
  4065. if (!last_event_id_.empty()) {
  4066. request_headers.emplace("Last-Event-ID", last_event_id_);
  4067. }
  4068. // Open streaming connection
  4069. auto result = stream::Get(client_, path_, request_headers);
  4070. // Connection error handling
  4071. if (!result) {
  4072. connected_.store(false);
  4073. if (on_error_) { on_error_(result.error()); }
  4074. if (!should_reconnect(reconnect_count)) { break; }
  4075. wait_for_reconnect();
  4076. reconnect_count++;
  4077. continue;
  4078. }
  4079. if (result.status() != StatusCode::OK_200) {
  4080. connected_.store(false);
  4081. if (on_error_) { on_error_(Error::Connection); }
  4082. // For certain errors, don't reconnect.
  4083. // Note: 401 is intentionally absent so that handlers can refresh
  4084. // credentials via set_headers() and let the client reconnect.
  4085. if (result.status() == StatusCode::NoContent_204 ||
  4086. result.status() == StatusCode::NotFound_404 ||
  4087. result.status() == StatusCode::Forbidden_403) {
  4088. break;
  4089. }
  4090. if (!should_reconnect(reconnect_count)) { break; }
  4091. wait_for_reconnect();
  4092. reconnect_count++;
  4093. continue;
  4094. }
  4095. // Connection successful
  4096. connected_.store(true);
  4097. reconnect_count = 0;
  4098. if (on_open_) { on_open_(); }
  4099. // Event receiving loop
  4100. std::string buffer;
  4101. SSEMessage current_msg;
  4102. while (running_.load() && result.next()) {
  4103. buffer.append(result.data(), result.size());
  4104. // Process complete lines in the buffer
  4105. size_t line_start = 0;
  4106. size_t newline_pos;
  4107. while ((newline_pos = buffer.find('\n', line_start)) !=
  4108. std::string::npos) {
  4109. auto line = buffer.substr(line_start, newline_pos - line_start);
  4110. line_start = newline_pos + 1;
  4111. // Parse the line and check if event is complete
  4112. auto event_complete =
  4113. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4114. if (event_complete && !current_msg.data.empty()) {
  4115. // Update last_event_id for reconnection
  4116. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4117. // Dispatch event to appropriate handler
  4118. dispatch_event(current_msg);
  4119. current_msg.clear();
  4120. }
  4121. }
  4122. // Keep unprocessed data in buffer
  4123. buffer.erase(0, line_start);
  4124. }
  4125. // Connection ended
  4126. connected_.store(false);
  4127. if (!running_.load()) { break; }
  4128. // Check for read errors
  4129. if (result.has_read_error()) {
  4130. if (on_error_) { on_error_(result.read_error()); }
  4131. }
  4132. if (!should_reconnect(reconnect_count)) { break; }
  4133. wait_for_reconnect();
  4134. reconnect_count++;
  4135. }
  4136. connected_.store(false);
  4137. }
  4138. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4139. // Check for specific event type handler first
  4140. auto it = event_handlers_.find(msg.event);
  4141. if (it != event_handlers_.end()) {
  4142. it->second(msg);
  4143. return;
  4144. }
  4145. // Fall back to generic message handler
  4146. if (on_message_) { on_message_(msg); }
  4147. }
  4148. inline bool SSEClient::should_reconnect(int count) const {
  4149. if (!running_.load()) { return false; }
  4150. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4151. return count < max_reconnect_attempts_;
  4152. }
  4153. inline void SSEClient::wait_for_reconnect() {
  4154. // Use small increments to check running_ flag frequently
  4155. auto waited = 0;
  4156. while (running_.load() && waited < reconnect_interval_ms_) {
  4157. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4158. waited += 100;
  4159. }
  4160. }
  4161. } // namespace sse
  4162. #ifdef CPPHTTPLIB_SSL_ENABLED
  4163. /*
  4164. * TLS abstraction layer - internal function declarations
  4165. * These are implementation details and not part of the public API.
  4166. */
  4167. namespace tls {
  4168. // Client context
  4169. ctx_t create_client_context();
  4170. void free_context(ctx_t ctx);
  4171. bool set_min_version(ctx_t ctx, Version version);
  4172. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4173. bool load_ca_file(ctx_t ctx, const char *file_path);
  4174. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4175. bool load_system_certs(ctx_t ctx);
  4176. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4177. const char *password);
  4178. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4179. const char *key_path, const char *password);
  4180. // Server context
  4181. ctx_t create_server_context();
  4182. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4183. const char *password);
  4184. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4185. const char *key_path, const char *password);
  4186. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4187. void set_verify_client(ctx_t ctx, bool require);
  4188. // Session management
  4189. session_t create_session(ctx_t ctx, socket_t sock);
  4190. void free_session(session_t session);
  4191. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4192. // Handshake (non-blocking capable)
  4193. TlsError connect(session_t session);
  4194. TlsError accept(session_t session);
  4195. // Handshake with timeout (blocking until timeout)
  4196. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4197. time_t timeout_usec, TlsError *err);
  4198. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4199. time_t timeout_usec, TlsError *err);
  4200. // I/O (non-blocking capable)
  4201. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4202. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4203. int pending(const_session_t session);
  4204. void shutdown(session_t session, bool graceful);
  4205. // Connection state
  4206. bool is_peer_closed(session_t session, socket_t sock);
  4207. // Certificate verification
  4208. cert_t get_peer_cert(const_session_t session);
  4209. void free_cert(cert_t cert);
  4210. bool verify_hostname(cert_t cert, const char *hostname);
  4211. uint64_t hostname_mismatch_code();
  4212. long get_verify_result(const_session_t session);
  4213. // Certificate introspection
  4214. std::string get_cert_subject_cn(cert_t cert);
  4215. std::string get_cert_issuer_name(cert_t cert);
  4216. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4217. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4218. std::string get_cert_serial(cert_t cert);
  4219. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4220. const char *get_sni(const_session_t session);
  4221. // CA store management
  4222. ca_store_t create_ca_store(const char *pem, size_t len);
  4223. void free_ca_store(ca_store_t store);
  4224. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4225. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4226. std::vector<std::string> get_ca_names(ctx_t ctx);
  4227. // Dynamic certificate update (for servers)
  4228. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4229. const char *password);
  4230. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4231. // Certificate verification callback
  4232. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4233. long get_verify_error(const_session_t session);
  4234. std::string verify_error_string(long error_code);
  4235. // TlsError information
  4236. uint64_t peek_error();
  4237. uint64_t get_error();
  4238. std::string error_string(uint64_t code);
  4239. } // namespace tls
  4240. #endif // CPPHTTPLIB_SSL_ENABLED
  4241. /*
  4242. * Group 1: detail namespace - Non-SSL utilities
  4243. */
  4244. namespace detail {
  4245. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4246. const void *optval, socklen_t optlen) {
  4247. return setsockopt(sock, level, optname,
  4248. #ifdef _WIN32
  4249. reinterpret_cast<const char *>(optval),
  4250. #else
  4251. optval,
  4252. #endif
  4253. optlen) == 0;
  4254. }
  4255. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4256. time_t sec, time_t usec) {
  4257. #ifdef _WIN32
  4258. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4259. #else
  4260. timeval timeout;
  4261. timeout.tv_sec = static_cast<long>(sec);
  4262. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4263. #endif
  4264. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4265. }
  4266. inline bool is_hex(char c, int &v) {
  4267. if (is_ascii_digit(c)) {
  4268. v = c - '0';
  4269. return true;
  4270. } else if ('A' <= c && c <= 'F') {
  4271. v = c - 'A' + 10;
  4272. return true;
  4273. } else if ('a' <= c && c <= 'f') {
  4274. v = c - 'a' + 10;
  4275. return true;
  4276. }
  4277. return false;
  4278. }
  4279. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4280. int &val) {
  4281. if (i >= s.size()) { return false; }
  4282. val = 0;
  4283. for (; cnt; i++, cnt--) {
  4284. if (!s[i]) { return false; }
  4285. auto v = 0;
  4286. if (is_hex(s[i], v)) {
  4287. val = val * 16 + v;
  4288. } else {
  4289. return false;
  4290. }
  4291. }
  4292. return true;
  4293. }
  4294. inline std::string from_i_to_hex(size_t n) {
  4295. static const auto charset = "0123456789abcdef";
  4296. std::string ret;
  4297. do {
  4298. ret = charset[n & 15] + ret;
  4299. n >>= 4;
  4300. } while (n > 0);
  4301. return ret;
  4302. }
  4303. inline std::string compute_etag(const FileStat &fs,
  4304. const std::string &suffix = std::string()) {
  4305. if (!fs.is_file()) { return std::string(); }
  4306. // If mtime cannot be determined (negative value indicates an error
  4307. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4308. // value like 0 could collide with a real file that legitimately has
  4309. // mtime == 0 (epoch) and lead to misleading validators.
  4310. auto mtime_raw = fs.mtime();
  4311. if (mtime_raw < 0) { return std::string(); }
  4312. auto mtime = static_cast<size_t>(mtime_raw);
  4313. auto size = fs.size();
  4314. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4315. from_i_to_hex(size) + suffix + "\"";
  4316. }
  4317. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4318. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4319. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4320. inline std::string file_mtime_to_http_date(time_t mtime) {
  4321. if (mtime < 0) { return std::string(); }
  4322. struct tm tm_buf;
  4323. #ifdef _WIN32
  4324. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4325. #else
  4326. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4327. #endif
  4328. char buf[64];
  4329. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4330. return std::string();
  4331. }
  4332. return std::string(buf);
  4333. }
  4334. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4335. inline time_t parse_http_date(const std::string &date_str) {
  4336. struct tm tm_buf;
  4337. // Create a classic locale object once for all parsing attempts
  4338. const std::locale classic_locale = std::locale::classic();
  4339. // Try to parse using std::get_time (C++11, cross-platform)
  4340. auto try_parse = [&](const char *fmt) -> bool {
  4341. std::istringstream ss(date_str);
  4342. ss.imbue(classic_locale);
  4343. memset(&tm_buf, 0, sizeof(tm_buf));
  4344. ss >> std::get_time(&tm_buf, fmt);
  4345. return !ss.fail();
  4346. };
  4347. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4348. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4349. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4350. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4351. // asctime format: "Sun Nov 6 08:49:37 1994"
  4352. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4353. return static_cast<time_t>(-1);
  4354. }
  4355. }
  4356. }
  4357. #ifdef _WIN32
  4358. return _mkgmtime(&tm_buf);
  4359. #elif defined _AIX
  4360. return mktime(&tm_buf);
  4361. #else
  4362. return timegm(&tm_buf);
  4363. #endif
  4364. }
  4365. inline bool is_weak_etag(const std::string &s) {
  4366. // Check if the string is a weak ETag (starts with 'W/"')
  4367. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4368. }
  4369. inline bool is_strong_etag(const std::string &s) {
  4370. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4371. // chars)
  4372. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4373. }
  4374. inline size_t to_utf8(int code, char *buff) {
  4375. if (code < 0x0080) {
  4376. buff[0] = static_cast<char>(code & 0x7F);
  4377. return 1;
  4378. } else if (code < 0x0800) {
  4379. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4380. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4381. return 2;
  4382. } else if (code < 0xD800) {
  4383. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4384. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4385. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4386. return 3;
  4387. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4388. return 0;
  4389. } else if (code < 0x10000) {
  4390. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4391. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4392. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4393. return 3;
  4394. } else if (code < 0x110000) {
  4395. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4396. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4397. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4398. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4399. return 4;
  4400. }
  4401. // NOTREACHED
  4402. return 0;
  4403. }
  4404. } // namespace detail
  4405. namespace ws {
  4406. namespace impl {
  4407. inline bool is_valid_utf8(const std::string &s) {
  4408. size_t i = 0;
  4409. auto n = s.size();
  4410. while (i < n) {
  4411. auto c = static_cast<unsigned char>(s[i]);
  4412. size_t len;
  4413. uint32_t cp;
  4414. if (c < 0x80) {
  4415. i++;
  4416. continue;
  4417. } else if ((c & 0xE0) == 0xC0) {
  4418. len = 2;
  4419. cp = c & 0x1F;
  4420. } else if ((c & 0xF0) == 0xE0) {
  4421. len = 3;
  4422. cp = c & 0x0F;
  4423. } else if ((c & 0xF8) == 0xF0) {
  4424. len = 4;
  4425. cp = c & 0x07;
  4426. } else {
  4427. return false;
  4428. }
  4429. if (i + len > n) { return false; }
  4430. for (size_t j = 1; j < len; j++) {
  4431. auto b = static_cast<unsigned char>(s[i + j]);
  4432. if ((b & 0xC0) != 0x80) { return false; }
  4433. cp = (cp << 6) | (b & 0x3F);
  4434. }
  4435. // Overlong encoding check
  4436. if (len == 2 && cp < 0x80) { return false; }
  4437. if (len == 3 && cp < 0x800) { return false; }
  4438. if (len == 4 && cp < 0x10000) { return false; }
  4439. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4440. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4441. if (cp > 0x10FFFF) { return false; }
  4442. i += len;
  4443. }
  4444. return true;
  4445. }
  4446. } // namespace impl
  4447. } // namespace ws
  4448. namespace detail {
  4449. // NOTE: This code came up with the following stackoverflow post:
  4450. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4451. inline std::string base64_encode(const std::string &in) {
  4452. static const auto lookup =
  4453. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4454. std::string out;
  4455. out.reserve(in.size());
  4456. // Unsigned: the accumulator is never masked, so with a signed int the
  4457. // `val << 8` below overflows once enough bytes are folded in (undefined
  4458. // behaviour before C++20). Only the low bits are ever emitted, so the
  4459. // wrap-around of an unsigned accumulator does not affect the output.
  4460. uint32_t val = 0;
  4461. auto valb = -6;
  4462. for (auto c : in) {
  4463. val = (val << 8) + static_cast<uint8_t>(c);
  4464. valb += 8;
  4465. while (valb >= 0) {
  4466. out.push_back(lookup[(val >> valb) & 0x3F]);
  4467. valb -= 6;
  4468. }
  4469. }
  4470. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4471. while (out.size() % 4) {
  4472. out.push_back('=');
  4473. }
  4474. return out;
  4475. }
  4476. inline std::string sha1(const std::string &input) {
  4477. // RFC 3174 SHA-1 implementation
  4478. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4479. return (x << n) | (x >> (32 - n));
  4480. };
  4481. uint32_t h0 = 0x67452301;
  4482. uint32_t h1 = 0xEFCDAB89;
  4483. uint32_t h2 = 0x98BADCFE;
  4484. uint32_t h3 = 0x10325476;
  4485. uint32_t h4 = 0xC3D2E1F0;
  4486. // Pre-processing: adding padding bits
  4487. std::string msg = input;
  4488. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4489. msg.push_back(static_cast<char>(0x80u));
  4490. while (msg.size() % 64 != 56) {
  4491. msg.push_back(0);
  4492. }
  4493. // Append original length in bits as 64-bit big-endian
  4494. for (int i = 56; i >= 0; i -= 8) {
  4495. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4496. }
  4497. // Process each 512-bit chunk
  4498. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4499. uint32_t w[80];
  4500. for (size_t i = 0; i < 16; i++) {
  4501. w[i] =
  4502. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4503. << 24) |
  4504. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4505. << 16) |
  4506. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4507. << 8) |
  4508. (static_cast<uint32_t>(
  4509. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4510. }
  4511. for (int i = 16; i < 80; i++) {
  4512. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4513. }
  4514. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4515. for (int i = 0; i < 80; i++) {
  4516. uint32_t f, k;
  4517. if (i < 20) {
  4518. f = (b & c) | ((~b) & d);
  4519. k = 0x5A827999;
  4520. } else if (i < 40) {
  4521. f = b ^ c ^ d;
  4522. k = 0x6ED9EBA1;
  4523. } else if (i < 60) {
  4524. f = (b & c) | (b & d) | (c & d);
  4525. k = 0x8F1BBCDC;
  4526. } else {
  4527. f = b ^ c ^ d;
  4528. k = 0xCA62C1D6;
  4529. }
  4530. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4531. e = d;
  4532. d = c;
  4533. c = left_rotate(b, 30);
  4534. b = a;
  4535. a = temp;
  4536. }
  4537. h0 += a;
  4538. h1 += b;
  4539. h2 += c;
  4540. h3 += d;
  4541. h4 += e;
  4542. }
  4543. // Produce the final hash as a 20-byte binary string
  4544. std::string hash(20, '\0');
  4545. for (size_t i = 0; i < 4; i++) {
  4546. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4547. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4548. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4549. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4550. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4551. }
  4552. return hash;
  4553. }
  4554. inline std::string websocket_accept_key(const std::string &client_key) {
  4555. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4556. return base64_encode(sha1(client_key + magic));
  4557. }
  4558. inline bool is_websocket_upgrade(const Request &req) {
  4559. if (req.method != "GET") { return false; }
  4560. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4561. // list of protocols and asks recipients to match each name
  4562. // case-insensitively, so look for the token rather than compare the whole
  4563. // field value.
  4564. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4565. // Check Connection: Upgrade
  4566. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4567. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4568. // RFC 6455 Section 4.2.1
  4569. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4570. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4571. return false;
  4572. }
  4573. static const std::string b64chars =
  4574. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4575. for (size_t i = 0; i < 22; i++) {
  4576. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4577. }
  4578. // Check Sec-WebSocket-Version: 13
  4579. auto version = req.get_header_value("Sec-WebSocket-Version");
  4580. if (version != "13") { return false; }
  4581. return true;
  4582. }
  4583. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4584. const char *data, size_t len, bool fin,
  4585. bool mask) {
  4586. // First byte: FIN + opcode
  4587. uint8_t header[2];
  4588. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4589. (static_cast<uint8_t>(opcode) & 0x0F));
  4590. // Second byte: MASK + payload length
  4591. if (len < 126) {
  4592. header[1] = static_cast<uint8_t>(len);
  4593. if (mask) { header[1] |= 0x80; }
  4594. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4595. } else if (len <= 0xFFFF) {
  4596. header[1] = 126;
  4597. if (mask) { header[1] |= 0x80; }
  4598. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4599. uint8_t ext[2];
  4600. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4601. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4602. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4603. } else {
  4604. header[1] = 127;
  4605. if (mask) { header[1] |= 0x80; }
  4606. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4607. uint8_t ext[8];
  4608. for (int i = 7; i >= 0; i--) {
  4609. ext[7 - i] =
  4610. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4611. }
  4612. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4613. }
  4614. if (mask) {
  4615. // Generate random mask key
  4616. thread_local std::mt19937 rng(std::random_device{}());
  4617. uint8_t mask_key[4];
  4618. auto r = rng();
  4619. std::memcpy(mask_key, &r, 4);
  4620. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4621. // Write masked payload in chunks
  4622. const size_t chunk_size = 4096;
  4623. std::vector<char> buf((std::min)(len, chunk_size));
  4624. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4625. size_t n = (std::min)(chunk_size, len - offset);
  4626. for (size_t i = 0; i < n; i++) {
  4627. buf[i] =
  4628. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4629. }
  4630. if (strm.write(buf.data(), n) < 0) { return false; }
  4631. }
  4632. } else {
  4633. if (len > 0) {
  4634. if (strm.write(data, len) < 0) { return false; }
  4635. }
  4636. }
  4637. return true;
  4638. }
  4639. } // namespace detail
  4640. namespace ws {
  4641. namespace impl {
  4642. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4643. // hands back whatever its buffer already holds -- so every multi-byte field has
  4644. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4645. // header straddles the read buffer's boundary.
  4646. //
  4647. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4648. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4649. // there is a failure like any other. (When read() fails it always records why,
  4650. // so the error belongs to this call and not to an earlier one.)
  4651. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4652. auto p = static_cast<char *>(buf);
  4653. size_t total = 0;
  4654. while (total < size) {
  4655. auto n = strm.read(p + total, size - total);
  4656. if (n <= 0) {
  4657. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4658. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4659. }
  4660. total += static_cast<size_t>(n);
  4661. }
  4662. return FrameRead::Ok;
  4663. }
  4664. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4665. std::string &payload, bool &fin,
  4666. bool expect_masked, size_t max_len) {
  4667. // Read first 2 bytes. This is the only read that may report a timeout: it
  4668. // sits on a frame boundary, where nothing has been consumed yet.
  4669. uint8_t header[2];
  4670. FrameRead first = read_exact(strm, header, 2);
  4671. if (first != FrameRead::Ok) { return first; }
  4672. fin = (header[0] & 0x80) != 0;
  4673. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4674. if (header[0] & 0x70) { return FrameRead::Fail; }
  4675. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4676. bool masked = (header[1] & 0x80) != 0;
  4677. uint64_t payload_len = header[1] & 0x7F;
  4678. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4679. // MUST have a payload length of 125 bytes or less
  4680. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4681. if (is_control) {
  4682. if (!fin) { return FrameRead::Fail; }
  4683. if (payload_len > 125) { return FrameRead::Fail; }
  4684. }
  4685. if (masked != expect_masked) { return FrameRead::Fail; }
  4686. // Extended payload length
  4687. if (payload_len == 126) {
  4688. uint8_t ext[2];
  4689. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4690. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4691. } else if (payload_len == 127) {
  4692. uint8_t ext[8];
  4693. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4694. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4695. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4696. payload_len = 0;
  4697. for (int i = 0; i < 8; i++) {
  4698. payload_len = (payload_len << 8) | ext[i];
  4699. }
  4700. }
  4701. if (payload_len > max_len) { return FrameRead::Fail; }
  4702. // Read mask key if present
  4703. uint8_t mask_key[4] = {0};
  4704. if (masked) {
  4705. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4706. return FrameRead::Fail;
  4707. }
  4708. }
  4709. // Read payload
  4710. payload.resize(static_cast<size_t>(payload_len));
  4711. if (payload_len > 0 &&
  4712. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4713. FrameRead::Ok) {
  4714. return FrameRead::Fail;
  4715. }
  4716. // Unmask if needed
  4717. if (masked) {
  4718. for (size_t i = 0; i < payload.size(); i++) {
  4719. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4720. }
  4721. }
  4722. return FrameRead::Ok;
  4723. }
  4724. } // namespace impl
  4725. } // namespace ws
  4726. namespace detail {
  4727. inline bool is_valid_path(const std::string &path) {
  4728. size_t level = 0;
  4729. size_t i = 0;
  4730. // Skip slash
  4731. while (i < path.size() && path[i] == '/') {
  4732. i++;
  4733. }
  4734. while (i < path.size()) {
  4735. // Read component
  4736. auto beg = i;
  4737. while (i < path.size() && path[i] != '/') {
  4738. if (path[i] == '\0') {
  4739. return false;
  4740. } else if (path[i] == '\\') {
  4741. return false;
  4742. }
  4743. i++;
  4744. }
  4745. auto len = i - beg;
  4746. assert(len > 0);
  4747. if (!path.compare(beg, len, ".")) {
  4748. ;
  4749. } else if (!path.compare(beg, len, "..")) {
  4750. if (level == 0) { return false; }
  4751. level--;
  4752. } else {
  4753. level++;
  4754. }
  4755. // Skip slash
  4756. while (i < path.size() && path[i] == '/') {
  4757. i++;
  4758. }
  4759. }
  4760. return true;
  4761. }
  4762. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4763. #if defined(_WIN32)
  4764. char buf[_MAX_PATH];
  4765. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4766. resolved = buf;
  4767. #elif defined(PATH_MAX)
  4768. char buf[PATH_MAX];
  4769. if (realpath(path, buf) == nullptr) { return false; }
  4770. resolved = buf;
  4771. #else
  4772. auto buf = realpath(path, nullptr);
  4773. auto guard = scope_exit([&]() { std::free(buf); });
  4774. if (buf == nullptr) { return false; }
  4775. resolved = buf;
  4776. #endif
  4777. return true;
  4778. }
  4779. inline bool is_path_within_base(const std::string &resolved_path,
  4780. const std::string &resolved_base) {
  4781. #if defined(_WIN32)
  4782. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4783. resolved_base.size()) == 0;
  4784. #else
  4785. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4786. resolved_base.size()) == 0;
  4787. #endif
  4788. }
  4789. inline FileStat::FileStat(const std::string &path) {
  4790. #if defined(_WIN32)
  4791. auto wpath = u8string_to_wstring(path.c_str());
  4792. ret_ = _wstat(wpath.c_str(), &st_);
  4793. #else
  4794. ret_ = stat(path.c_str(), &st_);
  4795. #endif
  4796. }
  4797. inline bool FileStat::is_file() const {
  4798. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4799. }
  4800. inline bool FileStat::is_dir() const {
  4801. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4802. }
  4803. inline time_t FileStat::mtime() const {
  4804. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4805. : static_cast<time_t>(-1);
  4806. }
  4807. inline size_t FileStat::size() const {
  4808. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4809. }
  4810. inline std::string encode_path(const std::string &s) {
  4811. std::string result;
  4812. result.reserve(s.size());
  4813. for (size_t i = 0; s[i]; i++) {
  4814. switch (s[i]) {
  4815. case ' ': result += "%20"; break;
  4816. case '+': result += "%2B"; break;
  4817. case '\r': result += "%0D"; break;
  4818. case '\n': result += "%0A"; break;
  4819. case '\'': result += "%27"; break;
  4820. case ',': result += "%2C"; break;
  4821. // case ':': result += "%3A"; break; // ok? probably...
  4822. case ';': result += "%3B"; break;
  4823. default:
  4824. auto c = static_cast<uint8_t>(s[i]);
  4825. if (c >= 0x80) {
  4826. result += '%';
  4827. char hex[4];
  4828. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4829. assert(len == 2);
  4830. result.append(hex, static_cast<size_t>(len));
  4831. } else {
  4832. result += s[i];
  4833. }
  4834. break;
  4835. }
  4836. }
  4837. return result;
  4838. }
  4839. inline std::string file_extension(const std::string &path) {
  4840. std::smatch m;
  4841. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4842. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4843. return std::string();
  4844. }
  4845. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4846. template <typename T>
  4847. inline bool parse_header(const char *beg, const char *end, T fn);
  4848. template <typename T>
  4849. inline bool parse_header(const char *beg, const char *end, T fn) {
  4850. // Skip trailing spaces and tabs.
  4851. while (beg < end && is_space_or_tab(end[-1])) {
  4852. end--;
  4853. }
  4854. auto p = beg;
  4855. while (p < end && *p != ':') {
  4856. p++;
  4857. }
  4858. auto name = std::string(beg, p);
  4859. if (!detail::fields::is_field_name(name)) { return false; }
  4860. if (p == end) { return false; }
  4861. auto key_end = p;
  4862. if (*p++ != ':') { return false; }
  4863. while (p < end && is_space_or_tab(*p)) {
  4864. p++;
  4865. }
  4866. if (p <= end) {
  4867. auto key_len = key_end - beg;
  4868. if (!key_len) { return false; }
  4869. auto key = std::string(beg, key_end);
  4870. auto val = std::string(p, end);
  4871. if (!detail::fields::is_field_value(val)) { return false; }
  4872. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4873. // percent-decoded by the recipient. Applications that need to interpret a
  4874. // value as a URI component should call httplib::decode_uri_component()
  4875. // (or decode_path_component()) explicitly.
  4876. fn(key, val);
  4877. return true;
  4878. }
  4879. return false;
  4880. }
  4881. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4882. const Headers &src_headers) {
  4883. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4884. // transfer coding is complete when a chunk with a chunk-size of zero is
  4885. // received, possibly followed by a trailer section, and finally terminated by
  4886. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4887. //
  4888. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4889. // doesn't care for the existence of the final CRLF. In other words, it seems
  4890. // to be ok whether the final CRLF exists or not in the chunked data.
  4891. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4892. //
  4893. // According to the reference code in RFC 9112, cpp-httplib now allows
  4894. // chunked transfer coding data without the final CRLF.
  4895. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4896. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4897. "transfer-encoding",
  4898. "content-length",
  4899. "host",
  4900. "authorization",
  4901. "www-authenticate",
  4902. "proxy-authenticate",
  4903. "proxy-authorization",
  4904. "cookie",
  4905. "set-cookie",
  4906. "cache-control",
  4907. "expect",
  4908. "max-forwards",
  4909. "pragma",
  4910. "range",
  4911. "te",
  4912. "age",
  4913. "expires",
  4914. "date",
  4915. "location",
  4916. "retry-after",
  4917. "vary",
  4918. "warning",
  4919. "content-encoding",
  4920. "content-type",
  4921. "content-range",
  4922. "trailer"};
  4923. case_ignore::unordered_set<std::string> declared_trailers;
  4924. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4925. if (!trailer_header.empty()) {
  4926. // split() trims each token and skips empty ones, so the name arrives ready
  4927. // to look up.
  4928. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4929. ',', [&](const char *b, const char *e) {
  4930. // A legitimate message declares only a handful of trailers. Cap the
  4931. // set so a peer cannot grow it without bound: an oversized set only
  4932. // arises from an attempt to force many colliding names into
  4933. // quadratic lookups (case_ignore::hash is unkeyed).
  4934. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4935. return;
  4936. }
  4937. std::string key(b, e);
  4938. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4939. declared_trailers.insert(key);
  4940. }
  4941. });
  4942. }
  4943. size_t trailer_header_count = 0;
  4944. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4945. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4946. // Count every received trailer field, not only the declared ones stored in
  4947. // dest, so undeclared fields cannot keep this loop running past the limit.
  4948. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4949. constexpr auto line_terminator_len = 2;
  4950. auto line_beg = line_reader.ptr();
  4951. auto line_end =
  4952. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4953. if (!parse_header(line_beg, line_end,
  4954. [&](const std::string &key, const std::string &val) {
  4955. if (declared_trailers.find(key) !=
  4956. declared_trailers.end()) {
  4957. dest.emplace(key, val);
  4958. }
  4959. })) {
  4960. return false;
  4961. }
  4962. trailer_header_count++;
  4963. if (!line_reader.getline()) { return false; }
  4964. }
  4965. return true;
  4966. }
  4967. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4968. size_t right) {
  4969. while (b + left < e && is_space_or_tab(b[left])) {
  4970. left++;
  4971. }
  4972. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4973. right--;
  4974. }
  4975. return std::make_pair(left, right);
  4976. }
  4977. inline std::string trim_copy(const std::string &s) {
  4978. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4979. return s.substr(r.first, r.second - r.first);
  4980. }
  4981. inline std::string trim_double_quotes_copy(const std::string &s) {
  4982. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4983. return s.substr(1, s.size() - 2);
  4984. }
  4985. return s;
  4986. }
  4987. inline void
  4988. divide(const char *data, std::size_t size, char d,
  4989. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4990. fn) {
  4991. const auto it = std::find(data, data + size, d);
  4992. const auto found = static_cast<std::size_t>(it != data + size);
  4993. const auto lhs_data = data;
  4994. const auto lhs_size = static_cast<std::size_t>(it - data);
  4995. const auto rhs_data = it + found;
  4996. const auto rhs_size = size - lhs_size - found;
  4997. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4998. }
  4999. inline void
  5000. divide(const std::string &str, char d,
  5001. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  5002. fn) {
  5003. divide(str.data(), str.size(), d, std::move(fn));
  5004. }
  5005. inline void split(const char *b, const char *e, char d,
  5006. std::function<void(const char *, const char *)> fn) {
  5007. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  5008. }
  5009. inline void split(const char *b, const char *e, char d, size_t m,
  5010. std::function<void(const char *, const char *)> fn) {
  5011. size_t i = 0;
  5012. size_t beg = 0;
  5013. size_t count = 1;
  5014. while (e ? (b + i < e) : (b[i] != '\0')) {
  5015. if (b[i] == d && count < m) {
  5016. auto r = trim(b, e, beg, i);
  5017. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5018. beg = i + 1;
  5019. count++;
  5020. }
  5021. i++;
  5022. }
  5023. if (i) {
  5024. auto r = trim(b, e, beg, i);
  5025. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5026. }
  5027. }
  5028. // Same contract as split(), except that a delimiter inside a quoted-string is
  5029. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  5030. // quoted-string, and ';' and '=' are legal characters inside one.
  5031. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  5032. std::function<void(const char *, const char *)> fn) {
  5033. size_t i = 0;
  5034. size_t beg = 0;
  5035. size_t count = 1;
  5036. auto in_quotes = false;
  5037. while (e ? (b + i < e) : (b[i] != '\0')) {
  5038. if (b[i] == '"') {
  5039. in_quotes = !in_quotes;
  5040. } else if (b[i] == d && !in_quotes && count < m) {
  5041. auto r = trim(b, e, beg, i);
  5042. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5043. beg = i + 1;
  5044. count++;
  5045. }
  5046. i++;
  5047. }
  5048. if (i) {
  5049. auto r = trim(b, e, beg, i);
  5050. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5051. }
  5052. }
  5053. inline void split_unquoted(const char *b, const char *e, char d,
  5054. std::function<void(const char *, const char *)> fn) {
  5055. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5056. std::move(fn));
  5057. }
  5058. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5059. // key a token, so the first '=' is the separator even when the value is a
  5060. // quoted-string carrying more of them.
  5061. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5062. std::string &val) {
  5063. divide(
  5064. b, static_cast<std::size_t>(e - b), '=',
  5065. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5066. const auto kr = trim(kb, kb + klen, 0, klen);
  5067. key.assign(kb + kr.first, kb + kr.second);
  5068. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5069. val.assign(vb + vr.first, vb + vr.second);
  5070. });
  5071. }
  5072. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5073. std::function<bool(const char *, const char *)> fn) {
  5074. size_t i = 0;
  5075. size_t beg = 0;
  5076. size_t count = 1;
  5077. while (e ? (b + i < e) : (b[i] != '\0')) {
  5078. if (b[i] == d && count < m) {
  5079. auto r = trim(b, e, beg, i);
  5080. if (r.first < r.second) {
  5081. auto found = fn(&b[r.first], &b[r.second]);
  5082. if (found) { return true; }
  5083. }
  5084. beg = i + 1;
  5085. count++;
  5086. }
  5087. i++;
  5088. }
  5089. if (i) {
  5090. auto r = trim(b, e, beg, i);
  5091. if (r.first < r.second) {
  5092. auto found = fn(&b[r.first], &b[r.second]);
  5093. if (found) { return true; }
  5094. }
  5095. }
  5096. return false;
  5097. }
  5098. inline bool split_find(const char *b, const char *e, char d,
  5099. std::function<bool(const char *, const char *)> fn) {
  5100. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5101. std::move(fn));
  5102. }
  5103. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5104. size_t fixed_buffer_size)
  5105. : strm_(strm), fixed_buffer_(fixed_buffer),
  5106. fixed_buffer_size_(fixed_buffer_size) {}
  5107. inline const char *stream_line_reader::ptr() const {
  5108. if (growable_buffer_.empty()) {
  5109. return fixed_buffer_;
  5110. } else {
  5111. return growable_buffer_.data();
  5112. }
  5113. }
  5114. inline size_t stream_line_reader::size() const {
  5115. if (growable_buffer_.empty()) {
  5116. return fixed_buffer_used_size_;
  5117. } else {
  5118. return growable_buffer_.size();
  5119. }
  5120. }
  5121. inline bool stream_line_reader::end_with_crlf() const {
  5122. auto end = ptr() + size();
  5123. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5124. }
  5125. inline bool stream_line_reader::getline() {
  5126. fixed_buffer_used_size_ = 0;
  5127. growable_buffer_.clear();
  5128. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5129. char prev_byte = 0;
  5130. #endif
  5131. for (size_t i = 0;; i++) {
  5132. // Fast path: whatever the stream has already buffered can be scanned for
  5133. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5134. // call, a bounds check and a one-byte copy per character of the request.
  5135. size_t buffered_size = 0;
  5136. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5137. auto take = buffered_size;
  5138. auto terminated = false;
  5139. for (size_t at = 0; at < buffered_size;) {
  5140. auto nl = static_cast<const char *>(
  5141. memchr(buffered + at, '\n', buffered_size - at));
  5142. if (!nl) { break; }
  5143. auto pos = static_cast<size_t>(nl - buffered);
  5144. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5145. take = pos + 1;
  5146. terminated = true;
  5147. break;
  5148. #else
  5149. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5150. // be the last byte of an earlier chunk, hence prev_byte.
  5151. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5152. take = pos + 1;
  5153. terminated = true;
  5154. break;
  5155. }
  5156. at = pos + 1;
  5157. #endif
  5158. }
  5159. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5160. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5161. prev_byte = buffered[take - 1];
  5162. #endif
  5163. append(buffered, take);
  5164. strm_.consume_buffered(take);
  5165. i += take;
  5166. if (terminated) { return true; }
  5167. continue;
  5168. }
  5169. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5170. // Treat exceptionally long lines as an error to
  5171. // prevent infinite loops/memory exhaustion
  5172. return false;
  5173. }
  5174. char byte;
  5175. auto n = strm_.read(&byte, 1);
  5176. if (n < 0) {
  5177. return false;
  5178. } else if (n == 0) {
  5179. if (i == 0) {
  5180. return false;
  5181. } else {
  5182. break;
  5183. }
  5184. }
  5185. append(byte);
  5186. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5187. if (byte == '\n') { break; }
  5188. #else
  5189. if (prev_byte == '\r' && byte == '\n') { break; }
  5190. prev_byte = byte;
  5191. #endif
  5192. }
  5193. return true;
  5194. }
  5195. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5196. inline void stream_line_reader::append(const char *data, size_t size) {
  5197. // Once the line has outgrown the fixed buffer everything must keep going to
  5198. // the growable one, even if a later chunk would have fit. Without the
  5199. // emptiness check a short append after a long one would land in the fixed
  5200. // buffer, which ptr() and size() no longer look at, and be lost.
  5201. if (growable_buffer_.empty() &&
  5202. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5203. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5204. fixed_buffer_used_size_ += size;
  5205. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5206. } else {
  5207. // Unlike the per-character overload, this can be the very first append of
  5208. // the line, so the fixed buffer may hold nothing and carry no terminator
  5209. // yet. assign() takes an explicit length and does not need one.
  5210. if (growable_buffer_.empty()) {
  5211. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5212. }
  5213. growable_buffer_.append(data, size);
  5214. }
  5215. }
  5216. inline mmap::mmap(const char *path) { open(path); }
  5217. inline mmap::~mmap() { close(); }
  5218. inline bool mmap::open(const char *path) {
  5219. close();
  5220. #if defined(_WIN32)
  5221. auto wpath = u8string_to_wstring(path);
  5222. if (wpath.empty()) { return false; }
  5223. hFile_ =
  5224. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5225. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5226. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5227. LARGE_INTEGER size{};
  5228. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5229. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5230. // See:
  5231. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5232. if (static_cast<ULONGLONG>(size.QuadPart) >
  5233. (std::numeric_limits<decltype(size_)>::max)()) {
  5234. // `size_t` might be 32-bits, on 32-bits Windows.
  5235. return false;
  5236. }
  5237. size_ = static_cast<size_t>(size.QuadPart);
  5238. hMapping_ =
  5239. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5240. // Special treatment for an empty file...
  5241. if (hMapping_ == NULL && size_ == 0) {
  5242. close();
  5243. is_open_empty_file = true;
  5244. return true;
  5245. }
  5246. if (hMapping_ == NULL) {
  5247. close();
  5248. return false;
  5249. }
  5250. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5251. if (addr_ == nullptr) {
  5252. close();
  5253. return false;
  5254. }
  5255. #else
  5256. fd_ = ::open(path, O_RDONLY);
  5257. if (fd_ == -1) { return false; }
  5258. struct stat sb;
  5259. if (fstat(fd_, &sb) == -1) {
  5260. close();
  5261. return false;
  5262. }
  5263. size_ = static_cast<size_t>(sb.st_size);
  5264. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5265. // Special treatment for an empty file...
  5266. if (addr_ == MAP_FAILED && size_ == 0) {
  5267. close();
  5268. is_open_empty_file = true;
  5269. return false;
  5270. }
  5271. if (addr_ == MAP_FAILED) {
  5272. // Clear the sentinel before `close()`, since `is_open()` only checks
  5273. // `addr_` against nullptr and `munmap()` must not be called with it.
  5274. addr_ = nullptr;
  5275. close();
  5276. return false;
  5277. }
  5278. #endif
  5279. return true;
  5280. }
  5281. inline bool mmap::is_open() const {
  5282. return is_open_empty_file ? true : addr_ != nullptr;
  5283. }
  5284. inline size_t mmap::size() const { return size_; }
  5285. inline const char *mmap::data() const {
  5286. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5287. }
  5288. inline void mmap::close() {
  5289. #if defined(_WIN32)
  5290. if (addr_) {
  5291. ::UnmapViewOfFile(addr_);
  5292. addr_ = nullptr;
  5293. }
  5294. if (hMapping_) {
  5295. ::CloseHandle(hMapping_);
  5296. hMapping_ = NULL;
  5297. }
  5298. if (hFile_ != INVALID_HANDLE_VALUE) {
  5299. ::CloseHandle(hFile_);
  5300. hFile_ = INVALID_HANDLE_VALUE;
  5301. }
  5302. is_open_empty_file = false;
  5303. #else
  5304. if (addr_ != nullptr) {
  5305. munmap(addr_, size_);
  5306. addr_ = nullptr;
  5307. }
  5308. if (fd_ != -1) {
  5309. ::close(fd_);
  5310. fd_ = -1;
  5311. }
  5312. #endif
  5313. size_ = 0;
  5314. }
  5315. inline int close_socket(socket_t sock) noexcept {
  5316. #ifdef _WIN32
  5317. return closesocket(sock);
  5318. #else
  5319. return close(sock);
  5320. #endif
  5321. }
  5322. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5323. ssize_t res = 0;
  5324. while (true) {
  5325. res = fn();
  5326. if (res < 0 && errno == EINTR) {
  5327. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5328. continue;
  5329. }
  5330. break;
  5331. }
  5332. return res;
  5333. }
  5334. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5335. return handle_EINTR([&]() {
  5336. return recv(sock,
  5337. #ifdef _WIN32
  5338. static_cast<char *>(ptr), static_cast<int>(size),
  5339. #else
  5340. ptr, size,
  5341. #endif
  5342. flags);
  5343. });
  5344. }
  5345. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5346. int flags) {
  5347. return handle_EINTR([&]() {
  5348. return send(sock,
  5349. #ifdef _WIN32
  5350. static_cast<const char *>(ptr), static_cast<int>(size),
  5351. #else
  5352. ptr, size,
  5353. #endif
  5354. flags);
  5355. });
  5356. }
  5357. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5358. #ifdef _WIN32
  5359. return ::WSAPoll(fds, nfds, timeout);
  5360. #else
  5361. return ::poll(fds, nfds, timeout);
  5362. #endif
  5363. }
  5364. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5365. time_t usec) {
  5366. struct pollfd pfd;
  5367. pfd.fd = sock;
  5368. pfd.events = events;
  5369. pfd.revents = 0;
  5370. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5371. // "return immediately", which callers here rely on to probe a socket.
  5372. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5373. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5374. }
  5375. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5376. return select_impl(sock, POLLIN, sec, usec);
  5377. }
  5378. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5379. return select_impl(sock, POLLOUT, sec, usec);
  5380. }
  5381. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5382. time_t usec) {
  5383. struct pollfd pfd_read;
  5384. pfd_read.fd = sock;
  5385. pfd_read.events = POLLIN | POLLOUT;
  5386. pfd_read.revents = 0;
  5387. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5388. auto poll_res =
  5389. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5390. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5391. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5392. auto error = 0;
  5393. socklen_t len = sizeof(error);
  5394. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5395. reinterpret_cast<char *>(&error), &len);
  5396. auto successful = res >= 0 && !error;
  5397. return successful ? Error::Success : Error::Connection;
  5398. }
  5399. return Error::Connection;
  5400. }
  5401. inline bool is_socket_alive(socket_t sock) {
  5402. const auto val = detail::select_read(sock, 0, 0);
  5403. if (val == 0) {
  5404. return true;
  5405. } else if (val < 0 && errno == EBADF) {
  5406. return false;
  5407. }
  5408. char buf[1];
  5409. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5410. }
  5411. class SocketStream final : public Stream {
  5412. public:
  5413. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5414. time_t write_timeout_sec, time_t write_timeout_usec,
  5415. time_t max_timeout_msec = 0,
  5416. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5417. (std::chrono::steady_clock::time_point::min)());
  5418. ~SocketStream() override;
  5419. bool is_readable() const override;
  5420. bool wait_readable() const override;
  5421. bool wait_writable() const override;
  5422. bool is_peer_alive() const override;
  5423. ssize_t read(char *ptr, size_t size) override;
  5424. ssize_t write(const char *ptr, size_t size) override;
  5425. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5426. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5427. socket_t socket() const override;
  5428. time_t duration() const override;
  5429. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5430. const char *buffered_data(size_t &size) const override;
  5431. void consume_buffered(size_t size) override;
  5432. // The caller has just seen this socket become readable. Lets the next read
  5433. // skip its own readiness wait, which would otherwise ask the kernel a
  5434. // question that was answered a moment ago. Consumed by that read.
  5435. void set_readable_hint() { readable_hint_ = true; }
  5436. private:
  5437. bool ensure_readable();
  5438. socket_t sock_;
  5439. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5440. // thread while a read is in flight -- that is the point of it, for a caller
  5441. // holding one connection and wanting control back to send on it.
  5442. std::atomic<time_t> read_timeout_sec_;
  5443. std::atomic<time_t> read_timeout_usec_;
  5444. time_t write_timeout_sec_;
  5445. time_t write_timeout_usec_;
  5446. time_t max_timeout_msec_;
  5447. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5448. std::vector<char> read_buff_;
  5449. size_t read_buff_off_ = 0;
  5450. size_t read_buff_content_size_ = 0;
  5451. bool readable_hint_ = false;
  5452. static const size_t read_buff_size_ = 1024l * 4;
  5453. };
  5454. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5455. time_t keep_alive_timeout_sec) {
  5456. using namespace std::chrono;
  5457. const auto interval_usec =
  5458. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5459. // Avoid expensive `steady_clock::now()` call for the first time
  5460. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5461. const auto start = steady_clock::now() - microseconds{interval_usec};
  5462. const auto timeout = seconds{keep_alive_timeout_sec};
  5463. while (true) {
  5464. if (svr_sock == INVALID_SOCKET) {
  5465. break; // Server socket is closed
  5466. }
  5467. auto val = select_read(sock, 0, interval_usec);
  5468. if (val < 0) {
  5469. break; // Ssocket error
  5470. } else if (val == 0) {
  5471. if (steady_clock::now() - start > timeout) {
  5472. break; // Timeout
  5473. }
  5474. } else {
  5475. return true; // Ready for read
  5476. }
  5477. }
  5478. return false;
  5479. }
  5480. template <typename T>
  5481. inline bool
  5482. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5483. size_t keep_alive_max_count,
  5484. time_t keep_alive_timeout_sec, T callback) {
  5485. assert(keep_alive_max_count > 0);
  5486. auto ret = false;
  5487. auto count = keep_alive_max_count;
  5488. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5489. auto close_connection = count == 1;
  5490. auto connection_closed = false;
  5491. ret = callback(close_connection, connection_closed);
  5492. if (!ret || connection_closed) { break; }
  5493. count--;
  5494. }
  5495. return ret;
  5496. }
  5497. template <typename T>
  5498. inline bool
  5499. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5500. size_t keep_alive_max_count,
  5501. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5502. time_t read_timeout_usec, time_t write_timeout_sec,
  5503. time_t write_timeout_usec, T callback) {
  5504. return process_server_socket_core(
  5505. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5506. [&](bool close_connection, bool &connection_closed) {
  5507. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5508. write_timeout_sec, write_timeout_usec);
  5509. // process_server_socket_core() only gets here once keep_alive() has
  5510. // seen the socket go readable.
  5511. strm.set_readable_hint();
  5512. return callback(strm, close_connection, connection_closed);
  5513. });
  5514. }
  5515. inline bool process_client_socket(
  5516. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5517. time_t write_timeout_sec, time_t write_timeout_usec,
  5518. time_t max_timeout_msec,
  5519. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5520. std::function<bool(Stream &)> callback) {
  5521. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5522. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5523. start_time);
  5524. return callback(strm);
  5525. }
  5526. inline int shutdown_socket(socket_t sock) noexcept {
  5527. #ifdef _WIN32
  5528. return shutdown(sock, SD_BOTH);
  5529. #else
  5530. return shutdown(sock, SHUT_RDWR);
  5531. #endif
  5532. }
  5533. // Half-closes the write side and drains any in-flight/queued bytes before
  5534. // the final shutdown+close. Closing with unread data in the receive queue
  5535. // (or bytes arriving after the receive side is closed) makes the stack send
  5536. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5537. // response as a failed read even though it was fully written.
  5538. inline void drain_and_close_socket(socket_t sock) noexcept {
  5539. #ifdef _WIN32
  5540. shutdown(sock, SD_SEND);
  5541. #else
  5542. shutdown(sock, SHUT_WR);
  5543. #endif
  5544. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5545. size_t total = 0;
  5546. const auto deadline = std::chrono::steady_clock::now() +
  5547. std::chrono::milliseconds(100); // bound #1
  5548. while (total < size_t(1024u * 1024u)) { // bound #2
  5549. const auto remaining =
  5550. std::chrono::duration_cast<std::chrono::microseconds>(
  5551. deadline - std::chrono::steady_clock::now())
  5552. .count();
  5553. if (remaining <= 0) { break; }
  5554. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5555. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5556. if (n <= 0) { break; }
  5557. total += static_cast<size_t>(n);
  5558. }
  5559. shutdown_socket(sock);
  5560. close_socket(sock);
  5561. }
  5562. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5563. if (s.size() > 1 && s[0] == '\0') {
  5564. auto ret = s;
  5565. ret[0] = '@';
  5566. return ret;
  5567. }
  5568. return s;
  5569. }
  5570. inline std::string
  5571. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5572. if (s.size() > 1 && s[0] == '@') {
  5573. auto ret = s;
  5574. ret[0] = '\0';
  5575. return ret;
  5576. }
  5577. return s;
  5578. }
  5579. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5580. const struct addrinfo *hints,
  5581. struct addrinfo **res, time_t timeout_sec) {
  5582. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5583. if (timeout_sec <= 0) {
  5584. // No timeout specified, use standard getaddrinfo
  5585. return getaddrinfo(node, service, hints, res);
  5586. }
  5587. #ifdef _WIN32
  5588. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5589. OVERLAPPED overlapped = {};
  5590. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5591. if (!event) { return EAI_FAIL; }
  5592. overlapped.hEvent = event;
  5593. PADDRINFOEXW result_addrinfo = nullptr;
  5594. HANDLE cancel_handle = nullptr;
  5595. ADDRINFOEXW hints_ex = {};
  5596. if (hints) {
  5597. hints_ex.ai_flags = hints->ai_flags;
  5598. hints_ex.ai_family = hints->ai_family;
  5599. hints_ex.ai_socktype = hints->ai_socktype;
  5600. hints_ex.ai_protocol = hints->ai_protocol;
  5601. }
  5602. auto wnode = u8string_to_wstring(node);
  5603. auto wservice = u8string_to_wstring(service);
  5604. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5605. hints ? &hints_ex : nullptr, &result_addrinfo,
  5606. nullptr, &overlapped, nullptr, &cancel_handle);
  5607. if (ret == WSA_IO_PENDING) {
  5608. auto wait_result =
  5609. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5610. if (wait_result == WAIT_TIMEOUT) {
  5611. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5612. ::CloseHandle(event);
  5613. return EAI_AGAIN;
  5614. }
  5615. DWORD bytes_returned;
  5616. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5617. &bytes_returned, FALSE)) {
  5618. ::CloseHandle(event);
  5619. return ::WSAGetLastError();
  5620. }
  5621. }
  5622. ::CloseHandle(event);
  5623. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5624. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5625. return 0;
  5626. }
  5627. return ret;
  5628. #elif TARGET_OS_MAC && defined(__clang__)
  5629. if (!node) { return EAI_NONAME; }
  5630. // macOS implementation using CFHost API for asynchronous DNS resolution
  5631. CFStringRef hostname_ref = CFStringCreateWithCString(
  5632. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5633. if (!hostname_ref) { return EAI_MEMORY; }
  5634. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5635. CFRelease(hostname_ref);
  5636. if (!host_ref) { return EAI_MEMORY; }
  5637. // Set up context for callback
  5638. struct CFHostContext {
  5639. bool completed = false;
  5640. bool success = false;
  5641. CFArrayRef addresses = nullptr;
  5642. std::mutex mutex;
  5643. std::condition_variable cv;
  5644. } context;
  5645. CFHostClientContext client_context;
  5646. memset(&client_context, 0, sizeof(client_context));
  5647. client_context.info = &context;
  5648. // Set callback
  5649. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5650. const CFStreamError *error, void *info) {
  5651. auto ctx = static_cast<CFHostContext *>(info);
  5652. std::lock_guard<std::mutex> lock(ctx->mutex);
  5653. if (error && error->error != 0) {
  5654. ctx->success = false;
  5655. } else {
  5656. Boolean hasBeenResolved;
  5657. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5658. if (ctx->addresses && hasBeenResolved) {
  5659. CFRetain(ctx->addresses);
  5660. ctx->success = true;
  5661. } else {
  5662. ctx->success = false;
  5663. }
  5664. }
  5665. ctx->completed = true;
  5666. ctx->cv.notify_one();
  5667. };
  5668. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5669. CFRelease(host_ref);
  5670. return EAI_SYSTEM;
  5671. }
  5672. // Schedule on run loop
  5673. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5674. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5675. // Start resolution
  5676. CFStreamError stream_error;
  5677. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5678. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5679. CFRelease(host_ref);
  5680. return EAI_FAIL;
  5681. }
  5682. // Wait for completion with timeout
  5683. auto timeout_time =
  5684. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5685. bool timed_out = false;
  5686. {
  5687. std::unique_lock<std::mutex> lock(context.mutex);
  5688. while (!context.completed) {
  5689. auto now = std::chrono::steady_clock::now();
  5690. if (now >= timeout_time) {
  5691. timed_out = true;
  5692. break;
  5693. }
  5694. // Run the runloop for a short time
  5695. lock.unlock();
  5696. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5697. lock.lock();
  5698. }
  5699. }
  5700. // Clean up
  5701. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5702. CFHostSetClient(host_ref, nullptr, nullptr);
  5703. if (timed_out || !context.completed) {
  5704. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5705. CFRelease(host_ref);
  5706. return EAI_AGAIN;
  5707. }
  5708. if (!context.success || !context.addresses) {
  5709. CFRelease(host_ref);
  5710. return EAI_NODATA;
  5711. }
  5712. // Convert CFArray to addrinfo
  5713. CFIndex count = CFArrayGetCount(context.addresses);
  5714. if (count == 0) {
  5715. CFRelease(context.addresses);
  5716. CFRelease(host_ref);
  5717. return EAI_NODATA;
  5718. }
  5719. struct addrinfo *result_addrinfo = nullptr;
  5720. struct addrinfo **current = &result_addrinfo;
  5721. for (CFIndex i = 0; i < count; i++) {
  5722. CFDataRef addr_data =
  5723. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5724. if (!addr_data) continue;
  5725. const struct sockaddr *sockaddr_ptr =
  5726. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5727. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5728. // Allocate addrinfo structure
  5729. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5730. if (!*current) {
  5731. freeaddrinfo(result_addrinfo);
  5732. CFRelease(context.addresses);
  5733. CFRelease(host_ref);
  5734. return EAI_MEMORY;
  5735. }
  5736. memset(*current, 0, sizeof(struct addrinfo));
  5737. // Set up addrinfo fields
  5738. (*current)->ai_family = sockaddr_ptr->sa_family;
  5739. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5740. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5741. (*current)->ai_addrlen = sockaddr_len;
  5742. // Copy sockaddr
  5743. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5744. if (!(*current)->ai_addr) {
  5745. freeaddrinfo(result_addrinfo);
  5746. CFRelease(context.addresses);
  5747. CFRelease(host_ref);
  5748. return EAI_MEMORY;
  5749. }
  5750. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5751. // Set port if service is specified
  5752. if (service && *service) {
  5753. int port = 0;
  5754. if (parse_port(service, strlen(service), port)) {
  5755. if (sockaddr_ptr->sa_family == AF_INET) {
  5756. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5757. ->sin_port = htons(static_cast<uint16_t>(port));
  5758. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5759. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5760. ->sin6_port = htons(static_cast<uint16_t>(port));
  5761. }
  5762. }
  5763. }
  5764. current = &((*current)->ai_next);
  5765. }
  5766. CFRelease(context.addresses);
  5767. CFRelease(host_ref);
  5768. *res = result_addrinfo;
  5769. return 0;
  5770. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5771. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5772. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5773. // the resolver worker still references the stack-local gaicb. The cancel
  5774. // path therefore waits (gai_suspend with no timeout) for the worker to
  5775. // actually finish before letting the stack frame go. The trade-off is that
  5776. // a wedged DNS server can hold this thread for the system resolver timeout
  5777. // (~30s by default) past the caller's connection timeout.
  5778. struct gaicb request{};
  5779. struct gaicb *requests[1] = {&request};
  5780. struct sigevent sevp{};
  5781. struct timespec timeout{timeout_sec, 0};
  5782. request.ar_name = node;
  5783. request.ar_service = service;
  5784. request.ar_request = hints;
  5785. sevp.sigev_notify = SIGEV_NONE;
  5786. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5787. if (rc != 0) { return rc; }
  5788. auto cleanup = scope_exit([&] {
  5789. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5790. });
  5791. int wait_result = gai_suspend(requests, 1, &timeout);
  5792. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5793. int gai_result = gai_error(&request);
  5794. if (gai_result == 0) {
  5795. *res = request.ar_result;
  5796. request.ar_result = nullptr;
  5797. return 0;
  5798. }
  5799. return gai_result;
  5800. }
  5801. gai_cancel(&request);
  5802. while (gai_error(&request) == EAI_INPROGRESS) {
  5803. gai_suspend(requests, 1, nullptr);
  5804. }
  5805. return wait_result;
  5806. #else
  5807. // Fallback implementation using thread-based timeout for other Unix systems.
  5808. struct GetAddrInfoState {
  5809. ~GetAddrInfoState() {
  5810. if (info) { freeaddrinfo(info); }
  5811. }
  5812. std::mutex mutex;
  5813. std::condition_variable result_cv;
  5814. bool completed = false;
  5815. int result = EAI_SYSTEM;
  5816. std::string node;
  5817. std::string service;
  5818. struct addrinfo hints;
  5819. struct addrinfo *info = nullptr;
  5820. };
  5821. // Allocate on the heap, so the resolver thread can keep using the data.
  5822. auto state = std::make_shared<GetAddrInfoState>();
  5823. if (node) { state->node = node; }
  5824. state->service = service;
  5825. state->hints = *hints;
  5826. std::thread resolve_thread([state]() {
  5827. auto thread_result =
  5828. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5829. &state->info);
  5830. std::lock_guard<std::mutex> lock(state->mutex);
  5831. state->result = thread_result;
  5832. state->completed = true;
  5833. state->result_cv.notify_one();
  5834. });
  5835. // Wait for completion or timeout
  5836. std::unique_lock<std::mutex> lock(state->mutex);
  5837. auto finished =
  5838. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5839. [&] { return state->completed; });
  5840. if (finished) {
  5841. // Operation completed within timeout
  5842. resolve_thread.join();
  5843. *res = state->info;
  5844. state->info = nullptr; // Pass ownership to caller
  5845. return state->result;
  5846. } else {
  5847. // Timeout occurred
  5848. resolve_thread.detach(); // Let the thread finish in background
  5849. return EAI_AGAIN; // Return timeout error
  5850. }
  5851. #endif
  5852. #else
  5853. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5854. return getaddrinfo(node, service, hints, res);
  5855. #endif
  5856. }
  5857. template <typename BindOrConnect>
  5858. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5859. int address_family, int socket_flags, bool tcp_nodelay,
  5860. bool ipv6_v6only, SocketOptions socket_options,
  5861. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5862. // Get address info
  5863. const char *node = nullptr;
  5864. struct addrinfo hints;
  5865. struct addrinfo *result;
  5866. memset(&hints, 0, sizeof(struct addrinfo));
  5867. hints.ai_socktype = SOCK_STREAM;
  5868. hints.ai_protocol = IPPROTO_IP;
  5869. if (!ip.empty()) {
  5870. node = ip.c_str();
  5871. // Ask getaddrinfo to convert IP in c-string to address
  5872. hints.ai_family = AF_UNSPEC;
  5873. hints.ai_flags = AI_NUMERICHOST;
  5874. } else {
  5875. if (!host.empty()) { node = host.c_str(); }
  5876. hints.ai_family = address_family;
  5877. hints.ai_flags = socket_flags;
  5878. }
  5879. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5880. if (hints.ai_family == AF_UNIX) {
  5881. const auto addrlen = host.length();
  5882. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5883. #ifdef SOCK_CLOEXEC
  5884. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5885. hints.ai_protocol);
  5886. #else
  5887. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5888. #endif
  5889. if (sock != INVALID_SOCKET) {
  5890. sockaddr_un addr{};
  5891. addr.sun_family = AF_UNIX;
  5892. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5893. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5894. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5895. hints.ai_addrlen = static_cast<socklen_t>(
  5896. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5897. #ifndef SOCK_CLOEXEC
  5898. #ifndef _WIN32
  5899. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5900. #endif
  5901. #endif
  5902. if (socket_options) { socket_options(sock); }
  5903. #ifdef _WIN32
  5904. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5905. // remove the option.
  5906. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5907. #endif
  5908. bool dummy;
  5909. if (!bind_or_connect(sock, hints, dummy)) {
  5910. close_socket(sock);
  5911. sock = INVALID_SOCKET;
  5912. }
  5913. }
  5914. return sock;
  5915. }
  5916. #endif
  5917. auto service = std::to_string(port);
  5918. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5919. timeout_sec)) {
  5920. #if defined __linux__ && !defined __ANDROID__
  5921. res_init();
  5922. #endif
  5923. return INVALID_SOCKET;
  5924. }
  5925. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5926. for (auto rp = result; rp; rp = rp->ai_next) {
  5927. // Create a socket
  5928. #ifdef _WIN32
  5929. auto sock =
  5930. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5931. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5932. /**
  5933. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5934. * and above the socket creation fails on older Windows Systems.
  5935. *
  5936. * Let's try to create a socket the old way in this case.
  5937. *
  5938. * Reference:
  5939. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5940. *
  5941. * WSA_FLAG_NO_HANDLE_INHERIT:
  5942. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5943. * SP1, and later
  5944. *
  5945. */
  5946. if (sock == INVALID_SOCKET) {
  5947. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5948. }
  5949. #else
  5950. #ifdef SOCK_CLOEXEC
  5951. auto sock =
  5952. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5953. #else
  5954. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5955. #endif
  5956. #endif
  5957. if (sock == INVALID_SOCKET) { continue; }
  5958. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5959. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5960. close_socket(sock);
  5961. continue;
  5962. }
  5963. #endif
  5964. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5965. if (rp->ai_family == AF_INET6) {
  5966. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5967. }
  5968. if (socket_options) { socket_options(sock); }
  5969. // bind or connect
  5970. auto quit = false;
  5971. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5972. close_socket(sock);
  5973. if (quit) { break; }
  5974. }
  5975. return INVALID_SOCKET;
  5976. }
  5977. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5978. #ifdef _WIN32
  5979. auto flags = nonblocking ? 1UL : 0UL;
  5980. ioctlsocket(sock, FIONBIO, &flags);
  5981. #else
  5982. auto flags = fcntl(sock, F_GETFL, 0);
  5983. fcntl(sock, F_SETFL,
  5984. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5985. #endif
  5986. }
  5987. inline bool is_connection_error() {
  5988. #ifdef _WIN32
  5989. return WSAGetLastError() != WSAEWOULDBLOCK;
  5990. #else
  5991. return errno != EINPROGRESS;
  5992. #endif
  5993. }
  5994. // accept() failed because the process or the network stack is temporarily out
  5995. // of resources. The listening socket is still usable, so back off briefly and
  5996. // try again.
  5997. inline bool is_accept_resource_error() {
  5998. #ifdef _WIN32
  5999. auto err = WSAGetLastError();
  6000. return err == WSAEMFILE || err == WSAENOBUFS;
  6001. #else
  6002. auto err = errno;
  6003. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  6004. #endif
  6005. }
  6006. // accept() failed for a reason that says nothing about the listening socket:
  6007. // the pending connection went away before it could be accepted, or the call
  6008. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  6009. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  6010. // connection that way.
  6011. inline bool is_accept_transient_error() {
  6012. #ifdef _WIN32
  6013. auto err = WSAGetLastError();
  6014. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  6015. err == WSAECONNABORTED;
  6016. #else
  6017. auto err = errno;
  6018. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  6019. err == ECONNABORTED;
  6020. #endif
  6021. }
  6022. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  6023. struct addrinfo hints;
  6024. struct addrinfo *result;
  6025. memset(&hints, 0, sizeof(struct addrinfo));
  6026. hints.ai_family = AF_UNSPEC;
  6027. hints.ai_socktype = SOCK_STREAM;
  6028. hints.ai_protocol = 0;
  6029. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  6030. return false;
  6031. }
  6032. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  6033. auto ret = false;
  6034. for (auto rp = result; rp; rp = rp->ai_next) {
  6035. const auto &ai = *rp;
  6036. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6037. ret = true;
  6038. break;
  6039. }
  6040. }
  6041. return ret;
  6042. }
  6043. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6044. #define USE_IF2IP
  6045. #endif
  6046. #ifdef USE_IF2IP
  6047. inline std::string if2ip(int address_family, const std::string &ifn) {
  6048. struct ifaddrs *ifap;
  6049. getifaddrs(&ifap);
  6050. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6051. std::string addr_candidate;
  6052. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6053. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6054. (AF_UNSPEC == address_family ||
  6055. ifa->ifa_addr->sa_family == address_family)) {
  6056. if (ifa->ifa_addr->sa_family == AF_INET) {
  6057. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6058. char buf[INET_ADDRSTRLEN];
  6059. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6060. return std::string(buf, INET_ADDRSTRLEN);
  6061. }
  6062. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6063. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6064. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6065. char buf[INET6_ADDRSTRLEN] = {};
  6066. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6067. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6068. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6069. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6070. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6071. } else {
  6072. return std::string(buf, INET6_ADDRSTRLEN);
  6073. }
  6074. }
  6075. }
  6076. }
  6077. }
  6078. }
  6079. return addr_candidate;
  6080. }
  6081. #endif
  6082. inline socket_t create_client_socket(
  6083. const std::string &host, const std::string &ip, int port,
  6084. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6085. SocketOptions socket_options, time_t connection_timeout_sec,
  6086. time_t connection_timeout_usec, time_t read_timeout_sec,
  6087. time_t read_timeout_usec, time_t write_timeout_sec,
  6088. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6089. auto sock = create_socket(
  6090. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6091. std::move(socket_options),
  6092. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6093. if (!intf.empty()) {
  6094. #ifdef USE_IF2IP
  6095. auto ip_from_if = if2ip(address_family, intf);
  6096. if (ip_from_if.empty()) { ip_from_if = intf; }
  6097. if (!bind_ip_address(sock2, ip_from_if)) {
  6098. error = Error::BindIPAddress;
  6099. return false;
  6100. }
  6101. #endif
  6102. }
  6103. set_nonblocking(sock2, true);
  6104. auto ret =
  6105. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6106. if (ret < 0) {
  6107. if (is_connection_error()) {
  6108. error = Error::Connection;
  6109. return false;
  6110. }
  6111. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6112. connection_timeout_usec);
  6113. if (error != Error::Success) {
  6114. if (error == Error::ConnectionTimeout) { quit = true; }
  6115. return false;
  6116. }
  6117. }
  6118. set_nonblocking(sock2, false);
  6119. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6120. read_timeout_usec);
  6121. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6122. write_timeout_usec);
  6123. error = Error::Success;
  6124. return true;
  6125. },
  6126. connection_timeout_sec); // Pass DNS timeout
  6127. if (sock != INVALID_SOCKET) {
  6128. error = Error::Success;
  6129. } else {
  6130. if (error == Error::Success) { error = Error::Connection; }
  6131. }
  6132. return sock;
  6133. }
  6134. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6135. socklen_t addr_len, std::string &ip, int &port) {
  6136. if (addr.ss_family == AF_INET) {
  6137. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6138. } else if (addr.ss_family == AF_INET6) {
  6139. port =
  6140. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6141. } else {
  6142. return false;
  6143. }
  6144. std::array<char, NI_MAXHOST> ipstr{};
  6145. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6146. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6147. 0, NI_NUMERICHOST)) {
  6148. return false;
  6149. }
  6150. ip = ipstr.data();
  6151. return true;
  6152. }
  6153. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6154. struct sockaddr_storage addr;
  6155. socklen_t addr_len = sizeof(addr);
  6156. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6157. &addr_len)) {
  6158. get_ip_and_port(addr, addr_len, ip, port);
  6159. }
  6160. }
  6161. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6162. struct sockaddr_storage addr;
  6163. socklen_t addr_len = sizeof(addr);
  6164. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6165. &addr_len)) {
  6166. #ifndef _WIN32
  6167. if (addr.ss_family == AF_UNIX) {
  6168. #if defined(__linux__)
  6169. struct ucred ucred;
  6170. socklen_t len = sizeof(ucred);
  6171. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6172. port = ucred.pid;
  6173. }
  6174. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6175. pid_t pid;
  6176. socklen_t len = sizeof(pid);
  6177. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6178. port = pid;
  6179. }
  6180. #endif
  6181. return;
  6182. }
  6183. #endif
  6184. get_ip_and_port(addr, addr_len, ip, port);
  6185. }
  6186. }
  6187. // Recursive form retained so operator""_t below can compute hashes for
  6188. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6189. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6190. // instead, which is iterative and stack-safe.
  6191. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6192. unsigned int h) {
  6193. return (l == 0)
  6194. ? h
  6195. : str2tag_core(
  6196. s + 1, l - 1,
  6197. // Unsets the 6 high bits of h, therefore no overflow happens
  6198. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6199. h * 33) ^
  6200. static_cast<unsigned char>(*s));
  6201. }
  6202. inline unsigned int str2tag(const std::string &s) {
  6203. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6204. // for compile-time UDL evaluation of short string literals, but at runtime
  6205. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6206. // would blow the stack with one frame per character.
  6207. unsigned int h = 0;
  6208. for (auto c : s) {
  6209. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6210. static_cast<unsigned char>(c);
  6211. }
  6212. return h;
  6213. }
  6214. namespace udl {
  6215. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6216. return str2tag_core(s, l, 0);
  6217. }
  6218. } // namespace udl
  6219. inline std::string
  6220. find_content_type(const std::string &path,
  6221. const std::map<std::string, std::string> &user_data,
  6222. const std::string &default_content_type) {
  6223. auto ext = file_extension(path);
  6224. auto it = user_data.find(ext);
  6225. if (it != user_data.end()) { return it->second; }
  6226. using udl::operator""_t;
  6227. switch (str2tag(ext)) {
  6228. default: return default_content_type;
  6229. case "css"_t: return "text/css";
  6230. case "csv"_t: return "text/csv";
  6231. case "htm"_t:
  6232. case "html"_t: return "text/html";
  6233. case "js"_t:
  6234. case "mjs"_t: return "text/javascript";
  6235. case "txt"_t: return "text/plain";
  6236. case "vtt"_t: return "text/vtt";
  6237. case "apng"_t: return "image/apng";
  6238. case "avif"_t: return "image/avif";
  6239. case "bmp"_t: return "image/bmp";
  6240. case "gif"_t: return "image/gif";
  6241. case "png"_t: return "image/png";
  6242. case "svg"_t: return "image/svg+xml";
  6243. case "webp"_t: return "image/webp";
  6244. case "ico"_t: return "image/x-icon";
  6245. case "tif"_t: return "image/tiff";
  6246. case "tiff"_t: return "image/tiff";
  6247. case "jpg"_t:
  6248. case "jpeg"_t: return "image/jpeg";
  6249. case "mp4"_t: return "video/mp4";
  6250. case "mpeg"_t: return "video/mpeg";
  6251. case "webm"_t: return "video/webm";
  6252. case "mp3"_t: return "audio/mp3";
  6253. case "mpga"_t: return "audio/mpeg";
  6254. case "weba"_t: return "audio/webm";
  6255. case "wav"_t: return "audio/wave";
  6256. case "otf"_t: return "font/otf";
  6257. case "ttf"_t: return "font/ttf";
  6258. case "woff"_t: return "font/woff";
  6259. case "woff2"_t: return "font/woff2";
  6260. case "7z"_t: return "application/x-7z-compressed";
  6261. case "atom"_t: return "application/atom+xml";
  6262. case "pdf"_t: return "application/pdf";
  6263. case "json"_t: return "application/json";
  6264. case "rss"_t: return "application/rss+xml";
  6265. case "tar"_t: return "application/x-tar";
  6266. case "xht"_t:
  6267. case "xhtml"_t: return "application/xhtml+xml";
  6268. case "xslt"_t: return "application/xslt+xml";
  6269. case "xml"_t: return "application/xml";
  6270. case "gz"_t: return "application/gzip";
  6271. case "zip"_t: return "application/zip";
  6272. case "wasm"_t: return "application/wasm";
  6273. }
  6274. }
  6275. inline std::string
  6276. extract_media_type(const std::string &content_type,
  6277. std::map<std::string, std::string> *params = nullptr) {
  6278. // Extract type/subtype from Content-Type value (RFC 2045)
  6279. // e.g. "application/json; charset=utf-8" -> "application/json"
  6280. auto media_type = content_type;
  6281. auto semicolon_pos = media_type.find(';');
  6282. if (semicolon_pos != std::string::npos) {
  6283. auto param_str = media_type.substr(semicolon_pos + 1);
  6284. media_type = media_type.substr(0, semicolon_pos);
  6285. if (params) {
  6286. // Parse parameters: key=value pairs separated by ';'
  6287. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6288. [&](const char *b, const char *e) {
  6289. std::string key;
  6290. std::string val;
  6291. divide_param_pair(b, e, key, val);
  6292. if (!key.empty()) {
  6293. params->emplace(trim_copy(key),
  6294. trim_double_quotes_copy(val));
  6295. }
  6296. });
  6297. }
  6298. }
  6299. // Trim whitespace from media type
  6300. return trim_copy(media_type);
  6301. }
  6302. inline bool can_compress_content_type(const std::string &content_type) {
  6303. using udl::operator""_t;
  6304. auto mime_type = extract_media_type(content_type);
  6305. auto tag = str2tag(mime_type);
  6306. switch (tag) {
  6307. case "image/svg+xml"_t:
  6308. case "application/javascript"_t:
  6309. case "application/x-javascript"_t:
  6310. case "application/json"_t:
  6311. case "application/ld+json"_t:
  6312. case "application/xml"_t:
  6313. case "application/xhtml+xml"_t:
  6314. case "application/rss+xml"_t:
  6315. case "application/atom+xml"_t:
  6316. case "application/xslt+xml"_t:
  6317. case "application/protobuf"_t: return true;
  6318. case "text/event-stream"_t: return false;
  6319. default: return !mime_type.rfind("text/", 0);
  6320. }
  6321. }
  6322. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6323. double &quality) {
  6324. quality = 1.0;
  6325. token.clear();
  6326. // Split on first ';': left = token name, right = parameters
  6327. const char *params_b = nullptr;
  6328. std::size_t params_len = 0;
  6329. divide(
  6330. b, static_cast<std::size_t>(e - b), ';',
  6331. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6332. auto r = trim(lb, lb + llen, 0, llen);
  6333. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6334. params_b = rb;
  6335. params_len = rlen;
  6336. });
  6337. if (token.empty()) { return false; }
  6338. if (params_len == 0) { return true; }
  6339. // Scan parameters for q= (stops on first match)
  6340. bool invalid = false;
  6341. split_find(params_b, params_b + params_len, ';',
  6342. (std::numeric_limits<size_t>::max)(),
  6343. [&](const char *pb, const char *pe) -> bool {
  6344. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6345. auto len = static_cast<size_t>(pe - pb);
  6346. if (len < 2) { return false; }
  6347. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6348. return false;
  6349. }
  6350. // Trim the value portion
  6351. auto r = trim(pb, pe, 2, len);
  6352. if (r.first >= r.second) {
  6353. invalid = true;
  6354. return true;
  6355. }
  6356. double v = 0.0;
  6357. auto res = from_chars(pb + r.first, pb + r.second, v);
  6358. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6359. invalid = true;
  6360. return true;
  6361. }
  6362. quality = v;
  6363. return true;
  6364. });
  6365. return !invalid;
  6366. }
  6367. inline EncodingType encoding_type(const Request &req,
  6368. const std::string &content_type) {
  6369. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6370. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6371. if (s.empty()) { return EncodingType::None; }
  6372. // Single-pass: iterate tokens and track the best supported encoding.
  6373. // Server preference breaks ties (br > gzip > zstd).
  6374. EncodingType best = EncodingType::None;
  6375. double best_q = 0.0; // q=0 means "not acceptable"
  6376. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6377. auto priority = [](EncodingType t) -> int {
  6378. switch (t) {
  6379. case EncodingType::Brotli: return 0;
  6380. case EncodingType::Gzip: return 1;
  6381. case EncodingType::Zstd: return 2;
  6382. default: return 3;
  6383. }
  6384. };
  6385. std::string name;
  6386. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6387. double quality = 1.0;
  6388. if (!parse_quality(b, e, name, quality)) { return; }
  6389. if (quality <= 0.0) { return; }
  6390. EncodingType type = EncodingType::None;
  6391. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6392. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6393. #endif
  6394. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6395. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6396. type = EncodingType::Gzip;
  6397. }
  6398. #endif
  6399. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6400. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6401. type = EncodingType::Zstd;
  6402. }
  6403. #endif
  6404. if (type == EncodingType::None) { return; }
  6405. // Higher q-value wins; for equal q, server preference breaks ties
  6406. if (quality > best_q ||
  6407. (quality == best_q && priority(type) < priority(best))) {
  6408. best_q = quality;
  6409. best = type;
  6410. }
  6411. });
  6412. return best;
  6413. }
  6414. // `content_type` is taken separately because a file-backed response has not
  6415. // been given one yet when its coding has to be decided.
  6416. inline EncodingType encoding_type(const Request &req, const Response &res,
  6417. const std::string &content_type) {
  6418. // The response already names a content coding of its own: a handler serving
  6419. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6420. // point whose headers name the coding its files are stored in. Applying one
  6421. // on top of that would double-encode the body and append a second
  6422. // `Content-Encoding` field line.
  6423. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6424. return encoding_type(req, content_type);
  6425. }
  6426. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6427. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6428. }
  6429. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6430. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6431. if (type == EncodingType::Gzip) {
  6432. return detail::make_unique<gzip_compressor>();
  6433. }
  6434. #endif
  6435. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6436. if (type == EncodingType::Brotli) {
  6437. return detail::make_unique<brotli_compressor>();
  6438. }
  6439. #endif
  6440. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6441. if (type == EncodingType::Zstd) {
  6442. return detail::make_unique<zstd_compressor>();
  6443. }
  6444. #endif
  6445. (void)type;
  6446. return nullptr;
  6447. }
  6448. inline const char *encoding_name(EncodingType type) {
  6449. switch (type) {
  6450. case EncodingType::Gzip: return "gzip";
  6451. case EncodingType::Brotli: return "br";
  6452. case EncodingType::Zstd: return "zstd";
  6453. default: return "";
  6454. }
  6455. }
  6456. inline bool nocompressor::compress(const char *data, size_t data_length,
  6457. bool /*last*/, Callback callback) {
  6458. if (!data_length) { return true; }
  6459. return callback(data, data_length);
  6460. }
  6461. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6462. inline gzip_compressor::gzip_compressor() {
  6463. std::memset(&strm_, 0, sizeof(strm_));
  6464. strm_.zalloc = Z_NULL;
  6465. strm_.zfree = Z_NULL;
  6466. strm_.opaque = Z_NULL;
  6467. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6468. Z_DEFAULT_STRATEGY) == Z_OK;
  6469. }
  6470. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6471. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6472. bool last, Callback callback) {
  6473. assert(is_valid_);
  6474. do {
  6475. constexpr size_t max_avail_in =
  6476. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6477. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6478. (std::min)(data_length, max_avail_in));
  6479. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6480. data_length -= strm_.avail_in;
  6481. data += strm_.avail_in;
  6482. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6483. auto ret = Z_OK;
  6484. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6485. do {
  6486. strm_.avail_out = static_cast<uInt>(buff.size());
  6487. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6488. ret = deflate(&strm_, flush);
  6489. if (ret == Z_STREAM_ERROR) { return false; }
  6490. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6491. return false;
  6492. }
  6493. } while (strm_.avail_out == 0);
  6494. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6495. (flush == Z_NO_FLUSH && ret == Z_OK));
  6496. assert(strm_.avail_in == 0);
  6497. } while (data_length > 0);
  6498. return true;
  6499. }
  6500. inline gzip_decompressor::gzip_decompressor() {
  6501. std::memset(&strm_, 0, sizeof(strm_));
  6502. strm_.zalloc = Z_NULL;
  6503. strm_.zfree = Z_NULL;
  6504. strm_.opaque = Z_NULL;
  6505. // 15 is the value of wbits, which should be at the maximum possible value
  6506. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6507. // that the stream type should be automatically detected either gzip or
  6508. // deflate.
  6509. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6510. }
  6511. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6512. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6513. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6514. Callback callback) {
  6515. assert(is_valid_);
  6516. auto ret = Z_OK;
  6517. do {
  6518. constexpr size_t max_avail_in =
  6519. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6520. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6521. (std::min)(data_length, max_avail_in));
  6522. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6523. data_length -= strm_.avail_in;
  6524. data += strm_.avail_in;
  6525. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6526. while (strm_.avail_in > 0 && ret == Z_OK) {
  6527. strm_.avail_out = static_cast<uInt>(buff.size());
  6528. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6529. ret = inflate(&strm_, Z_NO_FLUSH);
  6530. assert(ret != Z_STREAM_ERROR);
  6531. switch (ret) {
  6532. case Z_NEED_DICT:
  6533. case Z_DATA_ERROR:
  6534. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6535. }
  6536. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6537. return false;
  6538. }
  6539. }
  6540. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6541. } while (data_length > 0);
  6542. return true;
  6543. }
  6544. #endif
  6545. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6546. inline brotli_compressor::brotli_compressor() {
  6547. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6548. }
  6549. inline brotli_compressor::~brotli_compressor() {
  6550. BrotliEncoderDestroyInstance(state_);
  6551. }
  6552. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6553. bool last, Callback callback) {
  6554. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6555. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6556. auto available_in = data_length;
  6557. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6558. for (;;) {
  6559. if (last) {
  6560. if (BrotliEncoderIsFinished(state_)) { break; }
  6561. } else {
  6562. if (!available_in) { break; }
  6563. }
  6564. auto available_out = buff.size();
  6565. auto next_out = buff.data();
  6566. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6567. &available_out, &next_out, nullptr)) {
  6568. return false;
  6569. }
  6570. auto output_bytes = buff.size() - available_out;
  6571. if (output_bytes) {
  6572. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6573. }
  6574. }
  6575. return true;
  6576. }
  6577. inline brotli_decompressor::brotli_decompressor() {
  6578. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6579. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6580. : BROTLI_DECODER_RESULT_ERROR;
  6581. }
  6582. inline brotli_decompressor::~brotli_decompressor() {
  6583. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6584. }
  6585. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6586. inline bool brotli_decompressor::decompress(const char *data,
  6587. size_t data_length,
  6588. Callback callback) {
  6589. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6590. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6591. return 0;
  6592. }
  6593. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6594. size_t avail_in = data_length;
  6595. size_t total_out;
  6596. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6597. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6598. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6599. char *next_out = buff.data();
  6600. size_t avail_out = buff.size();
  6601. decoder_r = BrotliDecoderDecompressStream(
  6602. decoder_s, &avail_in, &next_in, &avail_out,
  6603. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6604. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6605. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6606. }
  6607. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6608. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6609. }
  6610. #endif
  6611. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6612. inline zstd_compressor::zstd_compressor() {
  6613. ctx_ = ZSTD_createCCtx();
  6614. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6615. }
  6616. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6617. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6618. bool last, Callback callback) {
  6619. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6620. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6621. ZSTD_inBuffer input = {data, data_length, 0};
  6622. bool finished;
  6623. do {
  6624. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6625. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6626. if (ZSTD_isError(remaining)) { return false; }
  6627. if (!callback(buff.data(), output.pos)) { return false; }
  6628. finished = last ? (remaining == 0) : (input.pos == input.size);
  6629. } while (!finished);
  6630. return true;
  6631. }
  6632. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6633. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6634. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6635. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6636. Callback callback) {
  6637. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6638. ZSTD_inBuffer input = {data, data_length, 0};
  6639. while (input.pos < input.size) {
  6640. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6641. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6642. if (ZSTD_isError(remaining)) { return false; }
  6643. if (!callback(buff.data(), output.pos)) { return false; }
  6644. }
  6645. return true;
  6646. }
  6647. #endif
  6648. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6649. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6650. // unknown coding, and its payload would be handed back still compressed.
  6651. inline bool is_zlib_encoding(const std::string &encoding) {
  6652. return case_ignore::equal(encoding, "gzip") ||
  6653. case_ignore::equal(encoding, "deflate");
  6654. }
  6655. inline bool is_brotli_encoding(const std::string &encoding) {
  6656. return case_ignore::equal(encoding, "br");
  6657. }
  6658. inline bool is_zstd_encoding(const std::string &encoding) {
  6659. return case_ignore::equal(encoding, "zstd");
  6660. }
  6661. // Returns true if the content coding is one cpp-httplib is able to decompress
  6662. // when the corresponding support is compiled in.
  6663. inline bool is_known_content_encoding(const std::string &encoding) {
  6664. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6665. is_zstd_encoding(encoding);
  6666. }
  6667. inline std::unique_ptr<decompressor>
  6668. create_decompressor(const std::string &encoding) {
  6669. std::unique_ptr<decompressor> decompressor;
  6670. if (is_zlib_encoding(encoding)) {
  6671. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6672. decompressor = detail::make_unique<gzip_decompressor>();
  6673. #endif
  6674. } else if (is_brotli_encoding(encoding)) {
  6675. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6676. decompressor = detail::make_unique<brotli_decompressor>();
  6677. #endif
  6678. } else if (is_zstd_encoding(encoding)) {
  6679. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6680. decompressor = detail::make_unique<zstd_decompressor>();
  6681. #endif
  6682. }
  6683. return decompressor;
  6684. }
  6685. // Returns the best available compressor and its Content-Encoding name.
  6686. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6687. inline std::pair<std::unique_ptr<compressor>, const char *>
  6688. create_compressor() {
  6689. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6690. return {detail::make_unique<brotli_compressor>(), "br"};
  6691. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6692. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6693. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6694. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6695. #else
  6696. return {nullptr, nullptr};
  6697. #endif
  6698. }
  6699. inline bool is_prohibited_header_name(const std::string &name) {
  6700. using udl::operator""_t;
  6701. switch (str2tag(name)) {
  6702. case "REMOTE_ADDR"_t:
  6703. case "REMOTE_PORT"_t:
  6704. case "LOCAL_ADDR"_t:
  6705. case "LOCAL_PORT"_t: return true;
  6706. default: return false;
  6707. }
  6708. }
  6709. inline bool has_header(const Headers &headers, const std::string &key) {
  6710. if (is_prohibited_header_name(key)) { return false; }
  6711. return headers.find(key) != headers.end();
  6712. }
  6713. inline const char *get_header_value(const Headers &headers,
  6714. const std::string &key, const char *def,
  6715. size_t id) {
  6716. if (is_prohibited_header_name(key)) {
  6717. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6718. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6719. throw std::invalid_argument(msg);
  6720. #else
  6721. return "";
  6722. #endif
  6723. }
  6724. auto rng = headers.equal_range(key);
  6725. auto it = rng.first;
  6726. std::advance(it, static_cast<ssize_t>(id));
  6727. if (it != rng.second) { return it->second.c_str(); }
  6728. return def;
  6729. }
  6730. inline size_t get_header_value_count(const Headers &headers,
  6731. const std::string &key) {
  6732. return headers.count(key);
  6733. }
  6734. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6735. // list may be sent as several field lines, and the combined field value is
  6736. // those values joined by commas in the order they were received. Callers that
  6737. // parse such a list must work on the combined value; reading only the first
  6738. // occurrence silently drops whatever the later field lines carry.
  6739. inline std::string get_combined_header_value(const Headers &headers,
  6740. const std::string &key) {
  6741. std::string combined;
  6742. auto rng = headers.equal_range(key);
  6743. for (auto it = rng.first; it != rng.second; ++it) {
  6744. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6745. // elements, so an empty field line must not contribute a bare comma to the
  6746. // combined value.
  6747. if (it->second.empty()) { continue; }
  6748. if (!combined.empty()) { combined += ", "; }
  6749. combined += it->second;
  6750. }
  6751. return combined;
  6752. }
  6753. inline bool has_header_token(const Headers &headers, const std::string &key,
  6754. const std::string &token) {
  6755. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6756. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6757. // several lines. Match complete tokens rather than searching the raw value,
  6758. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6759. auto rng = headers.equal_range(key);
  6760. for (auto it = rng.first; it != rng.second; ++it) {
  6761. const auto &value = it->second;
  6762. if (split_find(value.data(), value.data() + value.size(), ',',
  6763. [&](const char *b, const char *e) {
  6764. return case_ignore::equal(std::string(b, e), token);
  6765. })) {
  6766. return true;
  6767. }
  6768. }
  6769. return false;
  6770. }
  6771. template <typename Map>
  6772. inline typename Map::mapped_type
  6773. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6774. auto rng = m.equal_range(key);
  6775. auto it = rng.first;
  6776. std::advance(it, static_cast<ssize_t>(id));
  6777. if (it != rng.second) { return it->second; }
  6778. return typename Map::mapped_type();
  6779. }
  6780. inline void set_header(Headers &headers, const std::string &key,
  6781. const std::string &val) {
  6782. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6783. }
  6784. inline bool read_headers(Stream &strm, Headers &headers) {
  6785. const auto bufsiz = 2048;
  6786. char buf[bufsiz];
  6787. stream_line_reader line_reader(strm, buf, bufsiz);
  6788. size_t header_count = 0;
  6789. for (;;) {
  6790. if (!line_reader.getline()) { return false; }
  6791. // Check if the line ends with CRLF.
  6792. auto line_terminator_len = 2;
  6793. if (line_reader.end_with_crlf()) {
  6794. // Blank line indicates end of headers.
  6795. if (line_reader.size() == 2) { break; }
  6796. } else {
  6797. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6798. // Blank line indicates end of headers.
  6799. if (line_reader.size() == 1) { break; }
  6800. line_terminator_len = 1;
  6801. #else
  6802. continue; // Skip invalid line.
  6803. #endif
  6804. }
  6805. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6806. // Check header count limit
  6807. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6808. // Exclude line terminator
  6809. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6810. if (!parse_header(line_reader.ptr(), end,
  6811. [&](const std::string &key, const std::string &val) {
  6812. headers.emplace(key, val);
  6813. })) {
  6814. return false;
  6815. }
  6816. header_count++;
  6817. }
  6818. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6819. // headers that have different values to prevent request smuggling.
  6820. auto cl_range = headers.equal_range("Content-Length");
  6821. if (cl_range.first != cl_range.second) {
  6822. const auto &first_val = cl_range.first->second;
  6823. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6824. if (it->second != first_val) { return false; }
  6825. }
  6826. }
  6827. return true;
  6828. }
  6829. inline bool parse_status_line(const char *line, std::string &version,
  6830. int &status, std::string &reason) {
  6831. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6832. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6833. #else
  6834. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6835. #endif
  6836. std::cmatch m;
  6837. if (!std::regex_match(line, m, re)) { return false; }
  6838. version = std::string(m[1]);
  6839. status = std::stoi(std::string(m[2]));
  6840. reason = std::string(m[3]);
  6841. return true;
  6842. }
  6843. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6844. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6845. struct WebSocketUpgradeResponse {
  6846. Error error = Error::Success;
  6847. int status = -1;
  6848. Headers headers;
  6849. std::string selected_subprotocol;
  6850. };
  6851. inline bool read_websocket_upgrade_response(Stream &strm,
  6852. const std::string &expected_accept,
  6853. WebSocketUpgradeResponse &upgrade) {
  6854. // Read status line
  6855. const auto bufsiz = 2048;
  6856. char buf[bufsiz];
  6857. stream_line_reader line_reader(strm, buf, bufsiz);
  6858. if (!line_reader.getline()) {
  6859. upgrade.error = Error::Read;
  6860. return false;
  6861. }
  6862. std::string version;
  6863. std::string reason;
  6864. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6865. upgrade.error = Error::WebSocketHandshake;
  6866. return false;
  6867. }
  6868. // Read the headers even for a rejection so the caller can see why the
  6869. // server refused the upgrade. A non-101 response may carry a body; it is
  6870. // deliberately left unread since the caller closes the socket right away.
  6871. if (!read_headers(strm, upgrade.headers)) {
  6872. upgrade.error = Error::Read;
  6873. return false;
  6874. }
  6875. const auto &headers = upgrade.headers;
  6876. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6877. upgrade.error = Error::WebSocketHandshake;
  6878. return false;
  6879. }
  6880. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6881. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6882. upgrade.error = Error::WebSocketHandshake;
  6883. return false;
  6884. }
  6885. // Verify Connection: Upgrade
  6886. if (!has_header_token(headers, "Connection", "upgrade")) {
  6887. upgrade.error = Error::WebSocketHandshake;
  6888. return false;
  6889. }
  6890. // Verify Sec-WebSocket-Accept header value
  6891. auto it = headers.find("Sec-WebSocket-Accept");
  6892. if (it == headers.end() || it->second != expected_accept) {
  6893. upgrade.error = Error::WebSocketHandshake;
  6894. return false;
  6895. }
  6896. // Extract negotiated subprotocol
  6897. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6898. if (proto_it != headers.end()) {
  6899. upgrade.selected_subprotocol = proto_it->second;
  6900. }
  6901. return true;
  6902. }
  6903. enum class ReadContentResult {
  6904. Success, // Successfully read the content
  6905. PayloadTooLarge, // The content exceeds the specified payload limit
  6906. Error // An error occurred while reading the content
  6907. };
  6908. inline ReadContentResult read_content_with_length(
  6909. Stream &strm, size_t len, DownloadProgress progress,
  6910. ContentReceiverWithProgress out,
  6911. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6912. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6913. detail::BodyReader br;
  6914. br.stream = &strm;
  6915. br.has_content_length = true;
  6916. br.content_length = len;
  6917. br.payload_max_length = payload_max_length;
  6918. br.chunked = false;
  6919. br.bytes_read = 0;
  6920. br.last_error = Error::Success;
  6921. size_t r = 0;
  6922. while (r < len) {
  6923. auto read_len = static_cast<size_t>(len - r);
  6924. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6925. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6926. if (n <= 0) {
  6927. // Check if it was a payload size error
  6928. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6929. return ReadContentResult::PayloadTooLarge;
  6930. }
  6931. return ReadContentResult::Error;
  6932. }
  6933. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6934. return ReadContentResult::Error;
  6935. }
  6936. r += static_cast<size_t>(n);
  6937. if (progress) {
  6938. if (!progress(r, len)) { return ReadContentResult::Error; }
  6939. }
  6940. }
  6941. return ReadContentResult::Success;
  6942. }
  6943. inline ReadContentResult
  6944. read_content_without_length(Stream &strm, size_t payload_max_length,
  6945. ContentReceiverWithProgress out) {
  6946. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6947. size_t r = 0;
  6948. for (;;) {
  6949. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6950. if (n == 0) { return ReadContentResult::Success; }
  6951. if (n < 0) { return ReadContentResult::Error; }
  6952. // Check if adding this data would exceed the payload limit
  6953. if (r > payload_max_length ||
  6954. payload_max_length - r < static_cast<size_t>(n)) {
  6955. return ReadContentResult::PayloadTooLarge;
  6956. }
  6957. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6958. return ReadContentResult::Error;
  6959. }
  6960. r += static_cast<size_t>(n);
  6961. }
  6962. return ReadContentResult::Success;
  6963. }
  6964. template <typename T>
  6965. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6966. size_t payload_max_length,
  6967. ContentReceiverWithProgress out) {
  6968. detail::ChunkedDecoder dec(strm);
  6969. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6970. size_t total_len = 0;
  6971. for (;;) {
  6972. size_t chunk_offset = 0;
  6973. size_t chunk_total = 0;
  6974. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6975. if (n < 0) { return ReadContentResult::Error; }
  6976. if (n == 0) {
  6977. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6978. return ReadContentResult::Error;
  6979. }
  6980. return ReadContentResult::Success;
  6981. }
  6982. if (total_len > payload_max_length ||
  6983. payload_max_length - total_len < static_cast<size_t>(n)) {
  6984. return ReadContentResult::PayloadTooLarge;
  6985. }
  6986. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6987. return ReadContentResult::Error;
  6988. }
  6989. total_len += static_cast<size_t>(n);
  6990. }
  6991. }
  6992. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6993. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6994. // is the final transfer coding. A single field value may list several
  6995. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6996. // several Transfer-Encoding lines, which combine into one comma-separated
  6997. // list in the order the lines were received. Headers preserves that order,
  6998. // so the final coding is the last token of the last line. Match it
  6999. // case-insensitively rather than comparing the whole value against
  7000. // "chunked".
  7001. //
  7002. // Security: reading a chunked message as unframed leaves its body in the
  7003. // socket, where a keep-alive connection parses it as a smuggled request.
  7004. // Server::process_request() answers 400 and closes when the final coding is
  7005. // not chunked, so a request whose framing cannot be determined never
  7006. // reaches the "no body" path.
  7007. auto rng = headers.equal_range("Transfer-Encoding");
  7008. if (rng.first == rng.second) { return false; }
  7009. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7010. // combined list ending in nothing rather than inheriting the line before it.
  7011. std::string last_coding;
  7012. for (auto it = rng.first; it != rng.second; ++it) {
  7013. const auto &value = it->second;
  7014. last_coding.clear();
  7015. split(value.data(), value.data() + value.size(), ',',
  7016. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7017. }
  7018. return case_ignore::equal(last_coding, "chunked");
  7019. }
  7020. inline bool has_conflicting_content_length(const Headers &headers) {
  7021. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7022. // Content-Length is framed ambiguously. The body readers here delimit it by
  7023. // the transfer coding and drop Content-Length, while an intermediary may do
  7024. // the reverse, so the two disagree on where the body ends and a reused
  7025. // connection is desynchronised (request/response smuggling). Content-Length:
  7026. // 0 is tolerated for compatibility with existing peers.
  7027. return has_header(headers, "Transfer-Encoding") &&
  7028. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7029. }
  7030. template <typename T, typename U>
  7031. bool prepare_content_receiver(T &x, int &status,
  7032. ContentReceiverWithProgress receiver,
  7033. bool decompress, size_t payload_max_length,
  7034. bool &exceed_payload_max_length, U callback) {
  7035. if (decompress) {
  7036. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7037. std::unique_ptr<decompressor> decompressor;
  7038. if (!encoding.empty()) {
  7039. // A coding we know about but were not built with is an error. An
  7040. // unrecognized coding (including "identity") is left alone and the
  7041. // payload is passed through as-is, since some servers misuse the header,
  7042. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7043. decompressor = detail::create_decompressor(encoding);
  7044. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7045. status = StatusCode::UnsupportedMediaType_415;
  7046. return false;
  7047. }
  7048. }
  7049. if (decompressor) {
  7050. if (decompressor->is_valid()) {
  7051. size_t decompressed_size = 0;
  7052. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7053. size_t off, size_t len) {
  7054. return decompressor->decompress(
  7055. buf, n, [&](const char *buf2, size_t n2) {
  7056. // Guard against zip-bomb: check
  7057. // decompressed size against limit.
  7058. if (payload_max_length > 0 &&
  7059. (decompressed_size >= payload_max_length ||
  7060. n2 > payload_max_length - decompressed_size)) {
  7061. exceed_payload_max_length = true;
  7062. return false;
  7063. }
  7064. decompressed_size += n2;
  7065. return receiver(buf2, n2, off, len);
  7066. });
  7067. };
  7068. return callback(std::move(out));
  7069. } else {
  7070. status = StatusCode::InternalServerError_500;
  7071. return false;
  7072. }
  7073. }
  7074. }
  7075. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7076. size_t len) {
  7077. return receiver(buf, n, off, len);
  7078. };
  7079. return callback(std::move(out));
  7080. }
  7081. template <typename T>
  7082. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7083. DownloadProgress progress,
  7084. ContentReceiverWithProgress receiver, bool decompress) {
  7085. bool exceed_payload_max_length = false;
  7086. return prepare_content_receiver(
  7087. x, status, std::move(receiver), decompress, payload_max_length,
  7088. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7089. auto ret = true;
  7090. // Note: exceed_payload_max_length may also be set by the decompressor
  7091. // wrapper in prepare_content_receiver when the decompressed payload
  7092. // size exceeds the limit.
  7093. if (is_chunked_transfer_encoding(x.headers)) {
  7094. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7095. if (result == ReadContentResult::Success) {
  7096. ret = true;
  7097. } else if (result == ReadContentResult::PayloadTooLarge) {
  7098. exceed_payload_max_length = true;
  7099. ret = false;
  7100. } else {
  7101. ret = false;
  7102. }
  7103. } else if (!has_header(x.headers, "Content-Length")) {
  7104. auto result =
  7105. read_content_without_length(strm, payload_max_length, out);
  7106. if (result == ReadContentResult::Success) {
  7107. ret = true;
  7108. } else if (result == ReadContentResult::PayloadTooLarge) {
  7109. exceed_payload_max_length = true;
  7110. ret = false;
  7111. } else {
  7112. ret = false;
  7113. }
  7114. } else {
  7115. auto is_invalid_value = false;
  7116. auto len = get_header_value_u64(x.headers, "Content-Length",
  7117. (std::numeric_limits<size_t>::max)(),
  7118. 0, is_invalid_value);
  7119. if (is_invalid_value) {
  7120. ret = false;
  7121. } else if (len > 0) {
  7122. auto result = read_content_with_length(
  7123. strm, len, std::move(progress), out, payload_max_length);
  7124. ret = (result == ReadContentResult::Success);
  7125. if (result == ReadContentResult::PayloadTooLarge) {
  7126. exceed_payload_max_length = true;
  7127. }
  7128. }
  7129. }
  7130. if (!ret) {
  7131. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7132. : StatusCode::BadRequest_400;
  7133. }
  7134. return ret;
  7135. });
  7136. }
  7137. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7138. const std::string &path) {
  7139. // Neither the method nor the request target may carry CR/LF (or other
  7140. // control octets); otherwise a value smuggled into either splits the request
  7141. // line and injects headers or a whole request. The method must be a token
  7142. // (RFC 9110 Section 9.1), which also rejects an empty method and embedded
  7143. // spaces. The target gets the same field-value check that already guards
  7144. // header values in check_and_write_headers.
  7145. if (!fields::is_token(method)) { return -1; }
  7146. if (!fields::is_field_value(path)) { return -1; }
  7147. std::string s = method;
  7148. s += ' ';
  7149. s += path;
  7150. s += " HTTP/1.1\r\n";
  7151. return strm.write(s.data(), s.size());
  7152. }
  7153. inline ssize_t write_response_line(Stream &strm, int status) {
  7154. std::string s = "HTTP/1.1 ";
  7155. s += std::to_string(status);
  7156. s += ' ';
  7157. s += httplib::status_message(status);
  7158. s += "\r\n";
  7159. return strm.write(s.data(), s.size());
  7160. }
  7161. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7162. ssize_t write_len = 0;
  7163. for (const auto &x : headers) {
  7164. // Skip fields with invalid names or values to prevent response splitting
  7165. // via CR/LF injection, matching set_header(). The client validates request
  7166. // headers up front in check_and_write_headers, but the server passes
  7167. // res.headers straight to this writer, and res.headers is a public field
  7168. // an application can populate directly with request-derived values.
  7169. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7170. std::string s;
  7171. s = x.first;
  7172. s += ": ";
  7173. s += x.second;
  7174. s += "\r\n";
  7175. auto len = strm.write(s.data(), s.size());
  7176. if (len < 0) { return len; }
  7177. write_len += len;
  7178. }
  7179. auto len = strm.write("\r\n");
  7180. if (len < 0) { return len; }
  7181. write_len += len;
  7182. return write_len;
  7183. }
  7184. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7185. size_t offset = 0;
  7186. while (offset < l) {
  7187. auto length = strm.write(d + offset, l - offset);
  7188. if (length < 0) { return false; }
  7189. offset += static_cast<size_t>(length);
  7190. }
  7191. return true;
  7192. }
  7193. template <typename T>
  7194. inline bool write_content_with_progress(Stream &strm,
  7195. const ContentProvider &content_provider,
  7196. size_t offset, size_t length,
  7197. T is_shutting_down,
  7198. const UploadProgress &upload_progress,
  7199. Error &error) {
  7200. size_t end_offset = offset + length;
  7201. size_t start_offset = offset;
  7202. auto ok = true;
  7203. auto finished = false;
  7204. DataSink data_sink;
  7205. data_sink.write = [&](const char *d, size_t l) -> bool {
  7206. if (ok) {
  7207. if (write_data(strm, d, l)) {
  7208. offset += l;
  7209. if (upload_progress && length > 0) {
  7210. size_t current_written = offset - start_offset;
  7211. if (!upload_progress(current_written, length)) {
  7212. ok = false;
  7213. return false;
  7214. }
  7215. }
  7216. } else {
  7217. ok = false;
  7218. }
  7219. }
  7220. return ok;
  7221. };
  7222. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7223. // The body is framed by `length`, so a provider that reports itself done
  7224. // early has truncated it. Record that and let the short-body check below
  7225. // fail the write, rather than calling the provider again forever.
  7226. data_sink.done = [&]() { finished = true; };
  7227. while (offset < end_offset && !finished && !is_shutting_down()) {
  7228. auto last_offset = offset;
  7229. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7230. error = Error::Write;
  7231. return false;
  7232. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7233. error = Error::Canceled;
  7234. return false;
  7235. } else if (!ok) {
  7236. error = Error::Write;
  7237. return false;
  7238. }
  7239. // A provider that reports success without writing anything and without
  7240. // reporting itself done gets handed the same offset and length again on
  7241. // the next pass, so it would spin here for as long as the peer stays
  7242. // connected. Treat making no progress as a short body, like done() early.
  7243. if (!finished && offset == last_offset) {
  7244. error = Error::Write;
  7245. return false;
  7246. }
  7247. }
  7248. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7249. error = Error::Write;
  7250. return false;
  7251. }
  7252. error = Error::Success;
  7253. return true;
  7254. }
  7255. template <typename T>
  7256. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7257. size_t offset, size_t length, T is_shutting_down,
  7258. Error &error) {
  7259. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7260. is_shutting_down, nullptr, error);
  7261. }
  7262. template <typename T>
  7263. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7264. size_t offset, size_t length,
  7265. const T &is_shutting_down) {
  7266. auto error = Error::Success;
  7267. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7268. error);
  7269. }
  7270. template <typename T>
  7271. inline bool
  7272. write_content_without_length(Stream &strm,
  7273. const ContentProvider &content_provider,
  7274. const T &is_shutting_down) {
  7275. size_t offset = 0;
  7276. auto data_available = true;
  7277. auto ok = true;
  7278. DataSink data_sink;
  7279. data_sink.write = [&](const char *d, size_t l) -> bool {
  7280. if (ok) {
  7281. offset += l;
  7282. if (!write_data(strm, d, l)) { ok = false; }
  7283. }
  7284. return ok;
  7285. };
  7286. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7287. data_sink.done = [&](void) { data_available = false; };
  7288. while (data_available && !is_shutting_down()) {
  7289. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7290. return false;
  7291. } else if (!content_provider(offset, 0, data_sink)) {
  7292. return false;
  7293. } else if (!ok) {
  7294. return false;
  7295. }
  7296. }
  7297. return !data_available; // true only if done() was called, false if shutting
  7298. // down
  7299. }
  7300. // Runs a known-length content provider to completion and compresses what it
  7301. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7302. // by an mmap hands the compressor a pointer straight into the mapping.
  7303. inline bool compress_content_provider(const ContentProvider &content_provider,
  7304. size_t length, compressor &cmp,
  7305. std::string &out) {
  7306. size_t offset = 0;
  7307. auto ok = true;
  7308. auto finished = false;
  7309. DataSink data_sink;
  7310. auto append = [&](const char *data, size_t data_len) {
  7311. out.append(data, data_len);
  7312. return true;
  7313. };
  7314. data_sink.write = [&](const char *d, size_t l) -> bool {
  7315. if (!ok) { return false; }
  7316. offset += l;
  7317. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7318. return ok;
  7319. };
  7320. // The body is framed by `length`, so a provider that reports itself done
  7321. // early has truncated it; the short-body check below turns that into a
  7322. // failure rather than calling the provider again forever.
  7323. data_sink.done = [&]() { finished = true; };
  7324. while (offset < length && !finished) {
  7325. auto prev_offset = offset;
  7326. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7327. return false;
  7328. }
  7329. // No Stream to block on here, so a provider that keeps returning true
  7330. // without writing would spin. Treat a pass that made no progress as a
  7331. // failure.
  7332. if (offset == prev_offset) { return false; }
  7333. }
  7334. if (offset != length) { return false; }
  7335. return cmp.compress(nullptr, 0, true, append);
  7336. }
  7337. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7338. // and the file flag, so recording them has to come after; keeping all of it
  7339. // here means a third file-serving path cannot get that order wrong.
  7340. inline void set_file_content_provider(Response &res,
  7341. const std::shared_ptr<mmap> &m,
  7342. const std::string &content_type,
  7343. EncodingType encoding) {
  7344. res.set_content_provider(
  7345. m->size(), content_type,
  7346. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7347. sink.write(m->data() + offset, length);
  7348. return true;
  7349. });
  7350. res.is_file_content_provider_ = true;
  7351. res.content_coding_ = encoding;
  7352. }
  7353. template <typename T, typename U>
  7354. inline bool
  7355. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7356. const T &is_shutting_down, U &compressor, Error &error) {
  7357. size_t offset = 0;
  7358. auto data_available = true;
  7359. auto ok = true;
  7360. DataSink data_sink;
  7361. data_sink.write = [&](const char *d, size_t l) -> bool {
  7362. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7363. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7364. // zero-length chunk is the terminator, so it must not be emitted here.
  7365. if (ok && l > 0) {
  7366. offset += l;
  7367. std::string payload;
  7368. if (compressor.compress(d, l, false,
  7369. [&](const char *data, size_t data_len) {
  7370. payload.append(data, data_len);
  7371. return true;
  7372. })) {
  7373. if (!payload.empty()) {
  7374. // Emit chunked response header and footer for each chunk
  7375. auto chunk =
  7376. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7377. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7378. }
  7379. } else {
  7380. ok = false;
  7381. }
  7382. }
  7383. return ok;
  7384. };
  7385. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7386. auto done_with_trailer = [&](const Headers *trailer) {
  7387. if (!ok) { return; }
  7388. data_available = false;
  7389. std::string payload;
  7390. if (!compressor.compress(nullptr, 0, true,
  7391. [&](const char *data, size_t data_len) {
  7392. payload.append(data, data_len);
  7393. return true;
  7394. })) {
  7395. ok = false;
  7396. return;
  7397. }
  7398. if (!payload.empty()) {
  7399. // Emit chunked response header and footer for each chunk
  7400. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7401. if (!write_data(strm, chunk.data(), chunk.size())) {
  7402. ok = false;
  7403. return;
  7404. }
  7405. }
  7406. constexpr const char done_marker[] = "0\r\n";
  7407. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7408. // Trailer
  7409. if (trailer) {
  7410. for (const auto &kv : *trailer) {
  7411. // Skip fields with invalid names or values to prevent response
  7412. // splitting via CR/LF injection, matching set_header().
  7413. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7414. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7415. if (!write_data(strm, field_line.data(), field_line.size())) {
  7416. ok = false;
  7417. }
  7418. }
  7419. }
  7420. constexpr const char crlf[] = "\r\n";
  7421. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7422. };
  7423. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7424. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7425. done_with_trailer(&trailer);
  7426. };
  7427. while (data_available && !is_shutting_down()) {
  7428. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7429. error = Error::Write;
  7430. return false;
  7431. } else if (!content_provider(offset, 0, data_sink)) {
  7432. error = Error::Canceled;
  7433. return false;
  7434. } else if (!ok) {
  7435. error = Error::Write;
  7436. return false;
  7437. }
  7438. }
  7439. if (data_available) { // exited due to is_shutting_down(), not done()
  7440. error = Error::Write;
  7441. return false;
  7442. }
  7443. error = Error::Success;
  7444. return true;
  7445. }
  7446. template <typename T, typename U>
  7447. inline bool write_content_chunked(Stream &strm,
  7448. const ContentProvider &content_provider,
  7449. const T &is_shutting_down, U &compressor) {
  7450. auto error = Error::Success;
  7451. return write_content_chunked(strm, content_provider, is_shutting_down,
  7452. compressor, error);
  7453. }
  7454. template <typename T>
  7455. inline bool redirect(T &cli, Request &req, Response &res,
  7456. const std::string &path, const std::string &location,
  7457. Error &error) {
  7458. Request new_req = req;
  7459. new_req.path = path;
  7460. new_req.redirect_count_ -= 1;
  7461. if (res.status == StatusCode::SeeOther_303 &&
  7462. (req.method != "GET" && req.method != "HEAD")) {
  7463. new_req.method = "GET";
  7464. new_req.body.clear();
  7465. new_req.headers.clear();
  7466. }
  7467. Response new_res;
  7468. auto ret = cli.send(new_req, new_res, error);
  7469. if (ret) {
  7470. req = std::move(new_req);
  7471. res = std::move(new_res);
  7472. if (res.location.empty()) { res.location = location; }
  7473. }
  7474. return ret;
  7475. }
  7476. inline std::string params_to_query_str(const Params &params) {
  7477. std::string query;
  7478. for (auto it = params.begin(); it != params.end(); ++it) {
  7479. if (it != params.begin()) { query += '&'; }
  7480. query += encode_query_component(it->first);
  7481. query += '=';
  7482. query += encode_query_component(it->second);
  7483. }
  7484. return query;
  7485. }
  7486. // Splits one "key=value" span of a query string at its first '='. A span with
  7487. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7488. // "?flag" keeps its name.
  7489. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7490. std::string &val) {
  7491. divide(b, static_cast<std::size_t>(e - b), '=',
  7492. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7493. std::size_t rhs_size) {
  7494. key.assign(lhs_data, lhs_size);
  7495. val.assign(rhs_data, rhs_size);
  7496. });
  7497. }
  7498. inline void parse_query_text(const char *data, std::size_t size,
  7499. Params &params) {
  7500. std::set<std::string> cache;
  7501. split(data, data + size, '&', [&](const char *b, const char *e) {
  7502. std::string kv(b, e);
  7503. if (cache.find(kv) != cache.end()) { return; }
  7504. cache.insert(std::move(kv));
  7505. std::string key;
  7506. std::string val;
  7507. divide_query_pair(b, e, key, val);
  7508. if (!key.empty()) {
  7509. params.emplace(decode_query_component(key), decode_query_component(val));
  7510. }
  7511. });
  7512. }
  7513. inline void parse_query_text(const std::string &s, Params &params) {
  7514. parse_query_text(s.data(), s.size(), params);
  7515. }
  7516. // Normalize a query string by decoding and re-encoding each key/value pair
  7517. // while preserving the original parameter order. This avoids double-encoding
  7518. // and ensures consistent encoding. It works on the raw string rather than
  7519. // parsing into Params and re-serializing, because that round trip cannot
  7520. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7521. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7522. // duplicated pairs.
  7523. inline std::string normalize_query_string(const std::string &query) {
  7524. std::string result;
  7525. split(query.data(), query.data() + query.size(), '&',
  7526. [&](const char *b, const char *e) {
  7527. std::string key;
  7528. std::string val;
  7529. divide_query_pair(b, e, key, val);
  7530. if (!key.empty()) {
  7531. auto dec_key = decode_query_component(key);
  7532. auto dec_val = decode_query_component(val);
  7533. if (!result.empty()) { result += '&'; }
  7534. result += encode_query_component(dec_key);
  7535. if (!val.empty() || std::find(b, e, '=') != e) {
  7536. result += '=';
  7537. result += encode_query_component(dec_val);
  7538. }
  7539. }
  7540. });
  7541. return result;
  7542. }
  7543. // Build the request target that goes on the wire from a caller-supplied path.
  7544. // Shared by the buffered send path and the streaming API so that both put the
  7545. // same bytes in the request line for the same input.
  7546. inline std::string encode_request_target(const std::string &target,
  7547. bool path_encode) {
  7548. // `substr(0, npos)` yields the whole string, which is what the no-query
  7549. // case needs.
  7550. auto query_pos = target.find('?');
  7551. auto path_part = target.substr(0, query_pos);
  7552. std::string query_part;
  7553. if (query_pos != std::string::npos) {
  7554. query_part = target.substr(query_pos + 1);
  7555. }
  7556. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7557. if (!query_part.empty()) {
  7558. // When path encoding is disabled the caller has supplied an already-encoded
  7559. // target and expects the exact bytes to be sent on the wire, so skip
  7560. // normalization for the query too. Normalizing would decode-then-re-encode
  7561. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7562. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7563. if (path_encode) {
  7564. auto normalized = normalize_query_string(query_part);
  7565. if (!normalized.empty()) {
  7566. result += '?';
  7567. result += normalized;
  7568. }
  7569. } else {
  7570. result += '?';
  7571. result += query_part;
  7572. }
  7573. }
  7574. return result;
  7575. }
  7576. inline bool parse_multipart_boundary(const std::string &content_type,
  7577. std::string &boundary) {
  7578. std::map<std::string, std::string> params;
  7579. extract_media_type(content_type, &params);
  7580. auto it = params.find("boundary");
  7581. if (it == params.end()) { return false; }
  7582. boundary = it->second;
  7583. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7584. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7585. // bytes costs a nearly full comparison at nearly every position: the
  7586. // boundary's length multiplies the worst-case cost of scanning a body.
  7587. return !boundary.empty() && boundary.size() <= 70;
  7588. }
  7589. inline void parse_disposition_params(const std::string &s, Params &params) {
  7590. std::set<std::string> cache;
  7591. split_unquoted(s.data(), s.data() + s.size(), ';',
  7592. [&](const char *b, const char *e) {
  7593. std::string kv(b, e);
  7594. if (cache.find(kv) != cache.end()) { return; }
  7595. cache.insert(kv);
  7596. std::string key;
  7597. std::string val;
  7598. divide_param_pair(b, e, key, val);
  7599. if (!key.empty()) {
  7600. params.emplace(trim_double_quotes_copy(key),
  7601. trim_double_quotes_copy(val));
  7602. }
  7603. });
  7604. }
  7605. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7606. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7607. #else
  7608. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7609. #endif
  7610. auto is_valid = [](const std::string &str) {
  7611. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7612. };
  7613. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7614. const auto pos = static_cast<size_t>(6);
  7615. const auto len = static_cast<size_t>(s.size() - 6);
  7616. auto all_valid_ranges = true;
  7617. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7618. if (!all_valid_ranges) { return; }
  7619. const auto it = std::find(b, e, '-');
  7620. if (it == e) {
  7621. all_valid_ranges = false;
  7622. return;
  7623. }
  7624. const auto lhs = std::string(b, it);
  7625. const auto rhs = std::string(it + 1, e);
  7626. if (!is_valid(lhs) || !is_valid(rhs)) {
  7627. all_valid_ranges = false;
  7628. return;
  7629. }
  7630. ssize_t first = -1;
  7631. if (!lhs.empty()) {
  7632. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7633. // would turn the range into a suffix range.
  7634. auto res =
  7635. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7636. if (res.ec != std::errc{}) {
  7637. all_valid_ranges = false;
  7638. return;
  7639. }
  7640. }
  7641. ssize_t last = -1;
  7642. if (!rhs.empty()) {
  7643. // An overflowing last-byte-pos is past any content length, so keeping
  7644. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7645. ssize_t v;
  7646. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7647. if (res.ec == std::errc{}) { last = v; }
  7648. }
  7649. if ((first == -1 && last == -1) ||
  7650. (first != -1 && last != -1 && first > last)) {
  7651. all_valid_ranges = false;
  7652. return;
  7653. }
  7654. ranges.emplace_back(first, last);
  7655. });
  7656. return all_valid_ranges && !ranges.empty();
  7657. }
  7658. return false;
  7659. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7660. }
  7661. #else
  7662. } catch (...) { return false; }
  7663. #endif
  7664. inline bool parse_accept_header(const std::string &s,
  7665. std::vector<std::string> &content_types) {
  7666. content_types.clear();
  7667. // Empty string is considered valid (no preference)
  7668. if (s.empty()) { return true; }
  7669. struct AcceptEntry {
  7670. std::string media_type;
  7671. double quality;
  7672. int order;
  7673. };
  7674. std::vector<AcceptEntry> entries;
  7675. int order = 0;
  7676. bool has_invalid_entry = false;
  7677. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7678. // has to parse and ignore empty list elements, so a leading, trailing or
  7679. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7680. // split() skips them, and the header length limit bounds how many a sender
  7681. // can send, so ignoring all of them cannot be used as a denial-of-service
  7682. // vector.
  7683. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7684. std::string entry(b, e);
  7685. entry = trim_copy(entry);
  7686. AcceptEntry accept_entry;
  7687. accept_entry.order = order++;
  7688. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7689. accept_entry.media_type, accept_entry.quality)) {
  7690. has_invalid_entry = true;
  7691. return;
  7692. }
  7693. // Remove additional parameters from media type
  7694. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7695. // Basic validation of media type format
  7696. if (accept_entry.media_type.empty()) {
  7697. has_invalid_entry = true;
  7698. return;
  7699. }
  7700. // Check for basic media type format (should contain '/' or be '*')
  7701. if (accept_entry.media_type != "*" &&
  7702. accept_entry.media_type.find('/') == std::string::npos) {
  7703. has_invalid_entry = true;
  7704. return;
  7705. }
  7706. entries.push_back(std::move(accept_entry));
  7707. });
  7708. // Return false if any invalid entry was found
  7709. if (has_invalid_entry) { return false; }
  7710. // Sort by quality (descending), then by original order (ascending)
  7711. std::sort(entries.begin(), entries.end(),
  7712. [](const AcceptEntry &a, const AcceptEntry &b) {
  7713. if (a.quality != b.quality) {
  7714. return a.quality > b.quality; // Higher quality first
  7715. }
  7716. return a.order < b.order; // Earlier order first for same quality
  7717. });
  7718. // Extract sorted media types
  7719. content_types.reserve(entries.size());
  7720. for (auto &entry : entries) {
  7721. content_types.push_back(std::move(entry.media_type));
  7722. }
  7723. return true;
  7724. }
  7725. class FormDataParser {
  7726. public:
  7727. FormDataParser() = default;
  7728. void set_boundary(std::string &&boundary) {
  7729. boundary_ = std::move(boundary);
  7730. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7731. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7732. }
  7733. bool is_valid() const { return is_valid_; }
  7734. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7735. const ContentReceiver &content_callback) {
  7736. // Once the close delimiter has been seen the rest of the body is epilogue
  7737. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7738. // spread across reads is not copied in only to be erased right away.
  7739. if (state_ == 5) { return true; }
  7740. buf_append(buf, n);
  7741. while (buf_size() > 0) {
  7742. switch (state_) {
  7743. case 0: { // Initial boundary
  7744. auto pos = buf_find(dash_boundary_crlf_);
  7745. if (pos == buf_size()) {
  7746. // Not found yet: keep only a possible partial boundary at the tail so
  7747. // that a body which never contains the boundary cannot grow the
  7748. // buffer (and get rescanned from the start) without bound.
  7749. auto keep = dash_boundary_crlf_.size() - 1;
  7750. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7751. return true;
  7752. }
  7753. buf_erase(pos + dash_boundary_crlf_.size());
  7754. state_ = 1;
  7755. break;
  7756. }
  7757. case 1: { // New entry
  7758. clear_file_info();
  7759. state_ = 2;
  7760. break;
  7761. }
  7762. case 2: { // Headers
  7763. auto pos = buf_find(crlf_);
  7764. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7765. while (pos < buf_size()) {
  7766. // Empty line
  7767. if (pos == 0) {
  7768. if (!header_callback(file_)) {
  7769. is_valid_ = false;
  7770. return false;
  7771. }
  7772. buf_erase(crlf_.size());
  7773. state_ = 3;
  7774. break;
  7775. }
  7776. // Check header count limit
  7777. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7778. is_valid_ = false;
  7779. return false;
  7780. }
  7781. header_count_++;
  7782. const auto header = buf_head(pos);
  7783. if (!parse_header(header.data(), header.data() + header.size(),
  7784. [&](const std::string &, const std::string &) {})) {
  7785. is_valid_ = false;
  7786. return false;
  7787. }
  7788. // Parse and emplace space trimmed headers into a map
  7789. if (!parse_header(
  7790. header.data(), header.data() + header.size(),
  7791. [&](const std::string &key, const std::string &val) {
  7792. file_.headers.emplace(key, val);
  7793. })) {
  7794. is_valid_ = false;
  7795. return false;
  7796. }
  7797. constexpr const char header_content_type[] = "Content-Type:";
  7798. if (start_with_case_ignore(header, header_content_type)) {
  7799. file_.content_type =
  7800. trim_copy(header.substr(str_len(header_content_type)));
  7801. } else {
  7802. std::string disposition_params;
  7803. if (parse_content_disposition(header, disposition_params)) {
  7804. Params params;
  7805. parse_disposition_params(disposition_params, params);
  7806. auto it = params.find("name");
  7807. if (it != params.end()) {
  7808. file_.name = it->second;
  7809. } else {
  7810. is_valid_ = false;
  7811. return false;
  7812. }
  7813. it = params.find("filename");
  7814. if (it != params.end()) { file_.filename = it->second; }
  7815. it = params.find("filename*");
  7816. if (it != params.end()) {
  7817. // RFC 5987: only UTF-8 encoding is allowed
  7818. const auto &val = it->second;
  7819. constexpr const char utf8_prefix[] = "UTF-8''";
  7820. constexpr size_t prefix_len = str_len(utf8_prefix);
  7821. if (val.size() > prefix_len &&
  7822. start_with_case_ignore(val, utf8_prefix)) {
  7823. file_.filename = decode_path_component(
  7824. val.substr(prefix_len)); // override...
  7825. } else {
  7826. is_valid_ = false;
  7827. return false;
  7828. }
  7829. }
  7830. }
  7831. }
  7832. buf_erase(pos + crlf_.size());
  7833. pos = buf_find(crlf_);
  7834. }
  7835. if (state_ != 3) { return true; }
  7836. break;
  7837. }
  7838. case 3: { // Body
  7839. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7840. auto pos = buf_find(crlf_dash_boundary_);
  7841. if (pos < buf_size()) {
  7842. if (!content_callback(buf_data(), pos)) {
  7843. is_valid_ = false;
  7844. return false;
  7845. }
  7846. buf_erase(pos + crlf_dash_boundary_.size());
  7847. state_ = 4;
  7848. } else {
  7849. auto len = buf_size() - crlf_dash_boundary_.size();
  7850. if (len > 0) {
  7851. if (!content_callback(buf_data(), len)) {
  7852. is_valid_ = false;
  7853. return false;
  7854. }
  7855. buf_erase(len);
  7856. }
  7857. return true;
  7858. }
  7859. break;
  7860. }
  7861. case 4: { // Boundary
  7862. if (crlf_.size() > buf_size()) { return true; }
  7863. if (buf_start_with(crlf_)) {
  7864. buf_erase(crlf_.size());
  7865. state_ = 1;
  7866. } else if (buf_start_with(dash_)) {
  7867. buf_erase(dash_.size());
  7868. is_valid_ = true;
  7869. state_ = 5;
  7870. } else {
  7871. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7872. // accepted after a boundary; RFC 2046 allows transport-padding in
  7873. // between, but this parser has never supported it. Either way the
  7874. // body is already destined to be rejected, so fail now instead of
  7875. // buffering the rest of it. Both are two bytes, so the check above
  7876. // already guarantees enough buffered data to decide.
  7877. is_valid_ = false;
  7878. return false;
  7879. }
  7880. break;
  7881. }
  7882. case 5: { // Epilogue
  7883. buf_erase(buf_size());
  7884. break;
  7885. }
  7886. }
  7887. }
  7888. return true;
  7889. }
  7890. private:
  7891. void clear_file_info() {
  7892. file_.name.clear();
  7893. file_.filename.clear();
  7894. file_.content_type.clear();
  7895. file_.headers.clear();
  7896. header_count_ = 0;
  7897. }
  7898. bool start_with_case_ignore(const std::string &a, const char *b,
  7899. size_t offset = 0) const {
  7900. const auto b_len = strlen(b);
  7901. if (a.size() < offset + b_len) { return false; }
  7902. for (size_t i = 0; i < b_len; i++) {
  7903. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7904. return false;
  7905. }
  7906. }
  7907. return true;
  7908. }
  7909. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7910. // Returns true if header matches, with the params portion in `params_out`.
  7911. bool parse_content_disposition(const std::string &header,
  7912. std::string &params_out) const {
  7913. constexpr const char prefix[] = "Content-Disposition:";
  7914. constexpr size_t prefix_len = str_len(prefix);
  7915. if (!start_with_case_ignore(header, prefix)) { return false; }
  7916. // Skip whitespace after "Content-Disposition:"
  7917. auto pos = prefix_len;
  7918. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7919. pos++;
  7920. }
  7921. // Match "form-data;" (case-insensitive)
  7922. constexpr const char form_data[] = "form-data;";
  7923. constexpr size_t form_data_len = str_len(form_data);
  7924. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7925. pos += form_data_len;
  7926. // Skip whitespace after "form-data;"
  7927. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7928. pos++;
  7929. }
  7930. params_out = header.substr(pos);
  7931. return true;
  7932. }
  7933. const std::string dash_ = "--";
  7934. const std::string crlf_ = "\r\n";
  7935. std::string boundary_;
  7936. std::string dash_boundary_crlf_;
  7937. std::string crlf_dash_boundary_;
  7938. size_t state_ = 0;
  7939. bool is_valid_ = false;
  7940. FormData file_;
  7941. size_t header_count_ = 0;
  7942. // Buffer
  7943. bool start_with(const std::string &a, size_t spos, size_t epos,
  7944. const std::string &b) const {
  7945. if (epos - spos < b.size()) { return false; }
  7946. for (size_t i = 0; i < b.size(); i++) {
  7947. if (a[i + spos] != b[i]) { return false; }
  7948. }
  7949. return true;
  7950. }
  7951. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7952. const char *buf_data() const { return &buf_[buf_spos_]; }
  7953. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7954. bool buf_start_with(const std::string &s) const {
  7955. return start_with(buf_, buf_spos_, buf_epos_, s);
  7956. }
  7957. size_t buf_find(const std::string &s) const {
  7958. auto c = s.front();
  7959. size_t off = buf_spos_;
  7960. while (off < buf_epos_) {
  7961. auto pos = off;
  7962. while (true) {
  7963. if (pos == buf_epos_) { return buf_size(); }
  7964. if (buf_[pos] == c) { break; }
  7965. pos++;
  7966. }
  7967. auto remaining_size = buf_epos_ - pos;
  7968. if (s.size() > remaining_size) { return buf_size(); }
  7969. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7970. off = pos + 1;
  7971. }
  7972. return buf_size();
  7973. }
  7974. void buf_append(const char *data, size_t n) {
  7975. auto remaining_size = buf_size();
  7976. if (remaining_size > 0 && buf_spos_ > 0) {
  7977. for (size_t i = 0; i < remaining_size; i++) {
  7978. buf_[i] = buf_[buf_spos_ + i];
  7979. }
  7980. }
  7981. buf_spos_ = 0;
  7982. buf_epos_ = remaining_size;
  7983. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7984. for (size_t i = 0; i < n; i++) {
  7985. buf_[buf_epos_ + i] = data[i];
  7986. }
  7987. buf_epos_ += n;
  7988. }
  7989. void buf_erase(size_t size) { buf_spos_ += size; }
  7990. std::string buf_;
  7991. size_t buf_spos_ = 0;
  7992. size_t buf_epos_ = 0;
  7993. };
  7994. inline std::string random_string(size_t length) {
  7995. constexpr const char data[] =
  7996. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7997. thread_local auto engine([]() {
  7998. // std::random_device might actually be deterministic on some
  7999. // platforms, but due to lack of support in the c++ standard library,
  8000. // doing better requires either some ugly hacks or breaking portability.
  8001. std::random_device seed_gen;
  8002. // Request 128 bits of entropy for initialization
  8003. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8004. return std::mt19937(seed_sequence);
  8005. }());
  8006. std::string result;
  8007. for (size_t i = 0; i < length; i++) {
  8008. result += data[engine() % (sizeof(data) - 1)];
  8009. }
  8010. return result;
  8011. }
  8012. inline std::string make_multipart_data_boundary() {
  8013. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8014. }
  8015. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8016. auto valid = true;
  8017. for (size_t i = 0; i < boundary.size(); i++) {
  8018. auto c = boundary[i];
  8019. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8020. valid = false;
  8021. break;
  8022. }
  8023. }
  8024. return valid;
  8025. }
  8026. // Escape a multipart field name/filename following the WHATWG HTML standard
  8027. // ("escape a multipart form-data name"), which is what browsers send:
  8028. // '"' -> %22, CR -> %0D, LF -> %0A
  8029. // With escape_quote = false, only CR and LF are escaped; this is for header
  8030. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8031. inline std::string escape_multipart_field(const std::string &s,
  8032. bool escape_quote = true) {
  8033. std::string result;
  8034. result.reserve(s.size());
  8035. for (auto c : s) {
  8036. switch (c) {
  8037. case '"':
  8038. if (escape_quote) {
  8039. result += "%22";
  8040. } else {
  8041. result += c;
  8042. }
  8043. break;
  8044. case '\r': result += "%0D"; break;
  8045. case '\n': result += "%0A"; break;
  8046. default: result += c; break;
  8047. }
  8048. }
  8049. return result;
  8050. }
  8051. template <typename T>
  8052. inline std::string
  8053. serialize_multipart_formdata_item_begin(const T &item,
  8054. const std::string &boundary) {
  8055. std::string body = "--" + boundary + "\r\n";
  8056. body += "Content-Disposition: form-data; name=\"" +
  8057. escape_multipart_field(item.name) + "\"";
  8058. if (!item.filename.empty()) {
  8059. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8060. }
  8061. body += "\r\n";
  8062. if (!item.content_type.empty()) {
  8063. body +=
  8064. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8065. "\r\n";
  8066. }
  8067. body += "\r\n";
  8068. return body;
  8069. }
  8070. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8071. inline std::string
  8072. serialize_multipart_formdata_finish(const std::string &boundary) {
  8073. return "--" + boundary + "--\r\n";
  8074. }
  8075. inline std::string
  8076. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8077. return "multipart/form-data; boundary=" + boundary;
  8078. }
  8079. inline std::string
  8080. serialize_multipart_formdata(const UploadFormDataItems &items,
  8081. const std::string &boundary, bool finish = true) {
  8082. std::string body;
  8083. for (const auto &item : items) {
  8084. body += serialize_multipart_formdata_item_begin(item, boundary);
  8085. body += item.content + serialize_multipart_formdata_item_end();
  8086. }
  8087. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8088. return body;
  8089. }
  8090. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8091. const std::string &boundary) {
  8092. size_t total = 0;
  8093. for (const auto &item : items) {
  8094. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8095. total += item.content.size();
  8096. total += serialize_multipart_formdata_item_end().size();
  8097. }
  8098. total += serialize_multipart_formdata_finish(boundary).size();
  8099. return total;
  8100. }
  8101. struct MultipartSegment {
  8102. const char *data;
  8103. size_t size;
  8104. };
  8105. // NOTE: items must outlive the returned ContentProvider
  8106. // (safe for synchronous use inside Post/Put/Patch)
  8107. inline ContentProvider
  8108. make_multipart_content_provider(const UploadFormDataItems &items,
  8109. const std::string &boundary) {
  8110. // Own the per-item header strings and the finish string
  8111. std::vector<std::string> owned;
  8112. owned.reserve(items.size() + 1);
  8113. for (const auto &item : items)
  8114. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8115. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8116. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8117. std::vector<MultipartSegment> segs;
  8118. segs.reserve(items.size() * 3 + 1);
  8119. static const char crlf[] = "\r\n";
  8120. for (size_t i = 0; i < items.size(); i++) {
  8121. segs.push_back({owned[i].data(), owned[i].size()});
  8122. segs.push_back({items[i].content.data(), items[i].content.size()});
  8123. segs.push_back({crlf, 2});
  8124. }
  8125. segs.push_back({owned.back().data(), owned.back().size()});
  8126. struct MultipartState {
  8127. std::vector<std::string> owned;
  8128. std::vector<MultipartSegment> segs;
  8129. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8130. };
  8131. auto state = std::make_shared<MultipartState>();
  8132. state->owned = std::move(owned);
  8133. // `segs` holds raw pointers into owned strings; std::string move preserves
  8134. // the data pointer, so these pointers remain valid after the move above.
  8135. state->segs = std::move(segs);
  8136. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8137. // Buffer multiple small segments into fewer, larger writes to avoid
  8138. // excessive TCP packets when there are many form data items (#2410)
  8139. auto &buf = state->buf;
  8140. auto buf_size = buf.size();
  8141. size_t buf_len = 0;
  8142. size_t remaining = length;
  8143. // Find the first segment containing 'offset'
  8144. size_t pos = 0;
  8145. size_t seg_idx = 0;
  8146. for (; seg_idx < state->segs.size(); seg_idx++) {
  8147. const auto &seg = state->segs[seg_idx];
  8148. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8149. pos += seg.size;
  8150. }
  8151. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8152. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8153. const auto &seg = state->segs[seg_idx];
  8154. size_t available = seg.size - seg_offset;
  8155. size_t to_copy = (std::min)(available, remaining);
  8156. const char *src = seg.data + seg_offset;
  8157. seg_offset = 0; // only the first segment has a non-zero offset
  8158. while (to_copy > 0) {
  8159. size_t space = buf_size - buf_len;
  8160. size_t chunk = (std::min)(to_copy, space);
  8161. std::memcpy(buf.data() + buf_len, src, chunk);
  8162. buf_len += chunk;
  8163. src += chunk;
  8164. to_copy -= chunk;
  8165. remaining -= chunk;
  8166. if (buf_len == buf_size) {
  8167. if (!sink.write(buf.data(), buf_len)) { return false; }
  8168. buf_len = 0;
  8169. }
  8170. }
  8171. }
  8172. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8173. return true;
  8174. };
  8175. }
  8176. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8177. if (ranges.size() <= 1) return;
  8178. // Sort ranges by start position
  8179. std::sort(ranges.begin(), ranges.end(),
  8180. [](const Range &a, const Range &b) { return a.first < b.first; });
  8181. Ranges coalesced;
  8182. coalesced.reserve(ranges.size());
  8183. for (auto &r : ranges) {
  8184. auto first_pos = r.first;
  8185. auto last_pos = r.second;
  8186. // Handle special cases like in range_error
  8187. if (first_pos == -1 && last_pos == -1) {
  8188. first_pos = 0;
  8189. last_pos = static_cast<ssize_t>(content_length);
  8190. }
  8191. if (first_pos == -1) {
  8192. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8193. last_pos = static_cast<ssize_t>(content_length) - 1;
  8194. }
  8195. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8196. last_pos = static_cast<ssize_t>(content_length) - 1;
  8197. }
  8198. // Skip invalid ranges
  8199. if (!(0 <= first_pos && first_pos <= last_pos &&
  8200. last_pos < static_cast<ssize_t>(content_length))) {
  8201. continue;
  8202. }
  8203. // Coalesce with previous range if overlapping or adjacent (but not
  8204. // identical)
  8205. if (!coalesced.empty()) {
  8206. auto &prev = coalesced.back();
  8207. // Check if current range overlaps or is adjacent to previous range
  8208. // but don't coalesce identical ranges (allow duplicates)
  8209. if (first_pos <= prev.second + 1 &&
  8210. !(first_pos == prev.first && last_pos == prev.second)) {
  8211. // Extend the previous range
  8212. prev.second = (std::max)(prev.second, last_pos);
  8213. continue;
  8214. }
  8215. }
  8216. // Add new range
  8217. coalesced.emplace_back(first_pos, last_pos);
  8218. }
  8219. ranges = std::move(coalesced);
  8220. }
  8221. inline bool range_error(Request &req, Response &res) {
  8222. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8223. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8224. req.ranges.clear();
  8225. if (res.status == StatusCode::PartialContent_206) {
  8226. res.status = StatusCode::OK_200;
  8227. }
  8228. return false;
  8229. }
  8230. ssize_t content_len = static_cast<ssize_t>(
  8231. res.content_length_ ? res.content_length_ : res.body.size());
  8232. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8233. size_t overwrapping_count = 0;
  8234. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8235. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8236. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8237. // Too many ranges
  8238. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8239. for (auto &r : req.ranges) {
  8240. auto &first_pos = r.first;
  8241. auto &last_pos = r.second;
  8242. if (first_pos == -1 && last_pos == -1) {
  8243. first_pos = 0;
  8244. last_pos = content_len;
  8245. }
  8246. if (first_pos == -1) {
  8247. first_pos = content_len - last_pos;
  8248. last_pos = content_len - 1;
  8249. }
  8250. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8251. // A client can limit the number of bytes requested without knowing the
  8252. // size of the selected representation. If the last-pos value is absent,
  8253. // or if the value is greater than or equal to the current length of the
  8254. // representation data, the byte range is interpreted as the remainder of
  8255. // the representation (i.e., the server replaces the value of last-pos
  8256. // with a value that is one less than the current length of the selected
  8257. // representation).
  8258. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8259. if (last_pos == -1 || last_pos >= content_len) {
  8260. last_pos = content_len - 1;
  8261. }
  8262. // Range must be within content length
  8263. if (!(0 <= first_pos && first_pos <= last_pos &&
  8264. last_pos <= content_len - 1)) {
  8265. return true;
  8266. }
  8267. // Request must not have more than two overlapping ranges
  8268. for (const auto &processed_range : processed_ranges) {
  8269. if (!(last_pos < processed_range.first ||
  8270. first_pos > processed_range.second)) {
  8271. overwrapping_count++;
  8272. if (overwrapping_count > 2) { return true; }
  8273. break; // Only count once per range
  8274. }
  8275. }
  8276. processed_ranges.emplace_back(first_pos, last_pos);
  8277. }
  8278. // After validation, coalesce overlapping ranges as per RFC 9110
  8279. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8280. }
  8281. return false;
  8282. }
  8283. inline std::pair<size_t, size_t>
  8284. get_range_offset_and_length(Range r, size_t content_length) {
  8285. assert(r.first != -1 && r.second != -1);
  8286. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8287. assert(r.first <= r.second &&
  8288. r.second < static_cast<ssize_t>(content_length));
  8289. (void)(content_length);
  8290. return std::make_pair(static_cast<size_t>(r.first),
  8291. static_cast<size_t>(r.second - r.first) + 1);
  8292. }
  8293. inline std::string make_content_range_header_field(
  8294. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8295. auto st = offset_and_length.first;
  8296. auto ed = st + offset_and_length.second - 1;
  8297. std::string field = "bytes ";
  8298. field += std::to_string(st);
  8299. field += '-';
  8300. field += std::to_string(ed);
  8301. field += '/';
  8302. field += std::to_string(content_length);
  8303. return field;
  8304. }
  8305. template <typename SToken, typename CToken, typename Content>
  8306. bool process_multipart_ranges_data(const Request &req,
  8307. const std::string &boundary,
  8308. const std::string &content_type,
  8309. size_t content_length, SToken stoken,
  8310. CToken ctoken, Content content) {
  8311. for (size_t i = 0; i < req.ranges.size(); i++) {
  8312. ctoken("--");
  8313. stoken(boundary);
  8314. ctoken("\r\n");
  8315. if (!content_type.empty()) {
  8316. ctoken("Content-Type: ");
  8317. stoken(content_type);
  8318. ctoken("\r\n");
  8319. }
  8320. auto offset_and_length =
  8321. get_range_offset_and_length(req.ranges[i], content_length);
  8322. ctoken("Content-Range: ");
  8323. stoken(make_content_range_header_field(offset_and_length, content_length));
  8324. ctoken("\r\n");
  8325. ctoken("\r\n");
  8326. if (!content(offset_and_length.first, offset_and_length.second)) {
  8327. return false;
  8328. }
  8329. ctoken("\r\n");
  8330. }
  8331. ctoken("--");
  8332. stoken(boundary);
  8333. ctoken("--");
  8334. return true;
  8335. }
  8336. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8337. const std::string &boundary,
  8338. const std::string &content_type,
  8339. size_t content_length,
  8340. std::string &data) {
  8341. process_multipart_ranges_data(
  8342. req, boundary, content_type, content_length,
  8343. [&](const std::string &token) { data += token; },
  8344. [&](const std::string &token) { data += token; },
  8345. [&](size_t offset, size_t length) {
  8346. assert(offset + length <= content_length);
  8347. data += res.body.substr(offset, length);
  8348. return true;
  8349. });
  8350. }
  8351. inline size_t get_multipart_ranges_data_length(const Request &req,
  8352. const std::string &boundary,
  8353. const std::string &content_type,
  8354. size_t content_length) {
  8355. size_t data_length = 0;
  8356. process_multipart_ranges_data(
  8357. req, boundary, content_type, content_length,
  8358. [&](const std::string &token) { data_length += token.size(); },
  8359. [&](const std::string &token) { data_length += token.size(); },
  8360. [&](size_t /*offset*/, size_t length) {
  8361. data_length += length;
  8362. return true;
  8363. });
  8364. return data_length;
  8365. }
  8366. template <typename T>
  8367. inline bool
  8368. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8369. const std::string &boundary,
  8370. const std::string &content_type,
  8371. size_t content_length, const T &is_shutting_down) {
  8372. return process_multipart_ranges_data(
  8373. req, boundary, content_type, content_length,
  8374. [&](const std::string &token) { strm.write(token); },
  8375. [&](const std::string &token) { strm.write(token); },
  8376. [&](size_t offset, size_t length) {
  8377. return write_content(strm, res.content_provider_, offset, length,
  8378. is_shutting_down);
  8379. });
  8380. }
  8381. inline bool has_framed_body(const Request &req) {
  8382. return is_chunked_transfer_encoding(req.headers) ||
  8383. req.get_header_value_u64("Content-Length") > 0;
  8384. }
  8385. inline bool is_connection_persistent(const Request &req) {
  8386. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8387. if (req.version == "HTTP/1.0" &&
  8388. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8389. return false;
  8390. }
  8391. return true;
  8392. }
  8393. inline bool expect_content(const Request &req) {
  8394. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8395. req.method == "DELETE") {
  8396. return true;
  8397. }
  8398. return has_framed_body(req);
  8399. }
  8400. #ifdef _WIN32
  8401. class WSInit {
  8402. public:
  8403. WSInit() {
  8404. WSADATA wsaData;
  8405. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8406. }
  8407. ~WSInit() {
  8408. if (is_valid_) WSACleanup();
  8409. }
  8410. bool is_valid_ = false;
  8411. };
  8412. static WSInit wsinit_;
  8413. #endif
  8414. // RFC 9110 Section 11.6.1 defines a challenge list as
  8415. // WWW-Authenticate = #challenge
  8416. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8417. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8418. // so a server may offer several schemes, each with its own comma-separated
  8419. // auth-param list, in either order and either as separate field lines or
  8420. // packed into one. Splitting on every comma would break apart a challenge's
  8421. // own param list; splitting only on the first space would miss a Digest
  8422. // challenge that isn't first. Split on commas that aren't inside a
  8423. // quoted-string instead, then track which scheme each resulting segment
  8424. // belongs to: a segment whose text before "=" contains whitespace (or that
  8425. // has no "=" at all) starts a new challenge named by its leading token.
  8426. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8427. std::vector<std::string> segments;
  8428. size_t start = 0;
  8429. auto in_quotes = false;
  8430. for (size_t i = 0; i < s.size(); i++) {
  8431. auto c = s[i];
  8432. if (in_quotes) {
  8433. if (c == '\\' && i + 1 < s.size()) {
  8434. i++;
  8435. } else if (c == '"') {
  8436. in_quotes = false;
  8437. }
  8438. } else if (c == '"') {
  8439. in_quotes = true;
  8440. } else if (c == ',') {
  8441. segments.push_back(s.substr(start, i - start));
  8442. start = i + 1;
  8443. }
  8444. }
  8445. segments.push_back(s.substr(start));
  8446. return segments;
  8447. }
  8448. inline std::string unescape_quoted_pairs(const std::string &s) {
  8449. std::string out;
  8450. out.reserve(s.size());
  8451. for (size_t i = 0; i < s.size(); i++) {
  8452. if (s[i] == '\\' && i + 1 < s.size()) {
  8453. out += s[++i];
  8454. } else {
  8455. out += s[i];
  8456. }
  8457. }
  8458. return out;
  8459. }
  8460. inline bool parse_www_authenticate(const Response &res,
  8461. std::map<std::string, std::string> &auth,
  8462. bool is_proxy) {
  8463. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8464. auto combined = get_combined_header_value(res.headers, auth_key);
  8465. if (combined.empty()) { return false; }
  8466. auto found_digest = false;
  8467. auto in_digest_challenge = false;
  8468. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8469. auto segment = trim_copy(raw_segment);
  8470. if (segment.empty()) { continue; }
  8471. auto eq_pos = segment.find('=');
  8472. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8473. // for the first segment of a challenge, "<scheme> <key>") must be
  8474. // trimmed before its boundaries are inspected.
  8475. auto key_part = trim_copy(
  8476. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8477. auto space_pos = key_part.find_last_of(" \t");
  8478. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8479. // "<scheme>[ <key>]" starts a new challenge.
  8480. auto scheme_end =
  8481. space_pos == std::string::npos ? key_part.size() : space_pos;
  8482. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8483. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8484. // from one challenge is never paired with another's algorithm.
  8485. in_digest_challenge =
  8486. !found_digest &&
  8487. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8488. if (in_digest_challenge) { found_digest = true; }
  8489. if (space_pos == std::string::npos) {
  8490. // Bare scheme (or a token68), no auth-param on this segment.
  8491. continue;
  8492. }
  8493. key_part = key_part.substr(space_pos + 1);
  8494. }
  8495. if (!in_digest_challenge) { continue; }
  8496. auto val = trim_copy(segment.substr(eq_pos + 1));
  8497. auto unquoted = trim_double_quotes_copy(val);
  8498. if (unquoted.size() != val.size()) {
  8499. unquoted = unescape_quoted_pairs(unquoted);
  8500. }
  8501. auth[std::move(key_part)] = std::move(unquoted);
  8502. }
  8503. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8504. // make_digest_authentication_header() dereferences both unconditionally, so
  8505. // a challenge missing either can't produce a usable Authorization header.
  8506. // Treat it the same as no Digest challenge at all.
  8507. return found_digest && auth.find("realm") != auth.end() &&
  8508. auth.find("nonce") != auth.end();
  8509. }
  8510. class ContentProviderAdapter {
  8511. public:
  8512. explicit ContentProviderAdapter(
  8513. ContentProviderWithoutLength &&content_provider)
  8514. : content_provider_(std::move(content_provider)) {}
  8515. bool operator()(size_t offset, size_t, DataSink &sink) {
  8516. return content_provider_(offset, sink);
  8517. }
  8518. private:
  8519. ContentProviderWithoutLength content_provider_;
  8520. };
  8521. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8522. namespace fields {
  8523. inline bool is_token_char(char c) {
  8524. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8525. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8526. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8527. }
  8528. inline bool is_token(const std::string &s) {
  8529. if (s.empty()) { return false; }
  8530. for (auto c : s) {
  8531. if (!is_token_char(c)) { return false; }
  8532. }
  8533. return true;
  8534. }
  8535. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8536. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8537. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8538. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8539. inline bool is_field_content(const std::string &s) {
  8540. if (s.empty()) { return true; }
  8541. if (s.size() == 1) {
  8542. return is_field_vchar(s[0]);
  8543. } else if (s.size() == 2) {
  8544. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8545. } else {
  8546. size_t i = 0;
  8547. if (!is_field_vchar(s[i])) { return false; }
  8548. i++;
  8549. while (i < s.size() - 1) {
  8550. auto c = s[i++];
  8551. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8552. } else {
  8553. return false;
  8554. }
  8555. }
  8556. return is_field_vchar(s[i]);
  8557. }
  8558. }
  8559. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8560. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8561. return is_field_name(name) && is_field_value(value);
  8562. }
  8563. } // namespace fields
  8564. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8565. WebSocketUpgradeResponse &upgrade) {
  8566. // Generate random Sec-WebSocket-Key
  8567. thread_local std::mt19937 rng(std::random_device{}());
  8568. std::string key_bytes(16, '\0');
  8569. for (size_t i = 0; i < 16; i += 4) {
  8570. auto r = rng();
  8571. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8572. }
  8573. auto client_key = base64_encode(key_bytes);
  8574. req.headers.erase("Upgrade");
  8575. req.headers.erase("Connection");
  8576. req.headers.erase("Sec-WebSocket-Key");
  8577. req.headers.erase("Sec-WebSocket-Version");
  8578. req.headers.emplace("Upgrade", "websocket");
  8579. req.headers.emplace("Connection", "Upgrade");
  8580. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8581. req.headers.emplace("Sec-WebSocket-Version", "13");
  8582. // Build the request in memory first, like ClientImpl::write_request does.
  8583. // Writing straight to the socket would leak a request line onto the wire
  8584. // before check_and_write_headers gets a chance to reject an invalid header,
  8585. // and would emit one small write per header.
  8586. BufferStream bstrm;
  8587. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8588. upgrade.error = Error::Write;
  8589. return false;
  8590. }
  8591. auto error = Error::Success;
  8592. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8593. upgrade.error = error;
  8594. return false;
  8595. }
  8596. const auto &data = bstrm.get_buffer();
  8597. if (!write_data(strm, data.data(), data.size())) {
  8598. upgrade.error = Error::Write;
  8599. return false;
  8600. }
  8601. // Verify 101 response and Sec-WebSocket-Accept header
  8602. auto expected_accept = websocket_accept_key(client_key);
  8603. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8604. }
  8605. inline bool is_ip_address(const std::string &host) {
  8606. struct in_addr addr4;
  8607. struct in6_addr addr6;
  8608. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8609. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8610. }
  8611. // Resolve where a client should connect for `host`, honoring a user-supplied
  8612. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8613. // supplying the Host header and SNI; only the connection target changes.
  8614. //
  8615. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8616. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8617. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8618. // absent or empty mapping leaves `host` as the connection target; without the
  8619. // empty check the value would reach getaddrinfo as a null node and silently
  8620. // resolve to loopback.
  8621. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8622. const std::string &host, std::string &connect_host,
  8623. std::string &ip) {
  8624. connect_host = host;
  8625. ip.clear();
  8626. auto it = addr_map.find(host);
  8627. if (it == addr_map.end() || it->second.empty()) { return; }
  8628. if (is_ip_address(it->second)) {
  8629. ip = it->second;
  8630. } else {
  8631. connect_host = it->second;
  8632. }
  8633. }
  8634. } // namespace detail
  8635. /*
  8636. * Group 2: detail namespace - SSL common utilities
  8637. */
  8638. #ifdef CPPHTTPLIB_SSL_ENABLED
  8639. namespace detail {
  8640. class SSLSocketStream final : public Stream {
  8641. public:
  8642. SSLSocketStream(
  8643. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8644. time_t read_timeout_usec, time_t write_timeout_sec,
  8645. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8646. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8647. (std::chrono::steady_clock::time_point::min)());
  8648. ~SSLSocketStream() override;
  8649. bool is_readable() const override;
  8650. bool wait_readable() const override;
  8651. bool wait_writable() const override;
  8652. bool is_peer_alive() const override;
  8653. ssize_t read(char *ptr, size_t size) override;
  8654. ssize_t write(const char *ptr, size_t size) override;
  8655. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8656. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8657. socket_t socket() const override;
  8658. time_t duration() const override;
  8659. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8660. // See SocketStream::set_readable_hint().
  8661. void set_readable_hint() { readable_hint_ = true; }
  8662. private:
  8663. bool ensure_readable();
  8664. socket_t sock_;
  8665. tls::session_t session_;
  8666. time_t read_timeout_sec_;
  8667. time_t read_timeout_usec_;
  8668. time_t write_timeout_sec_;
  8669. time_t write_timeout_usec_;
  8670. time_t max_timeout_msec_;
  8671. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8672. bool readable_hint_ = false;
  8673. };
  8674. // A TLS stream for WebSocket connections, where the receive path and the
  8675. // send path (application send() plus the heartbeat ping thread) run on
  8676. // different threads. A single TLS session must never be entered
  8677. // concurrently, so every call into the session is serialized by one mutex.
  8678. //
  8679. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8680. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8681. // call under the lock, then waits for readiness with select() outside the
  8682. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8683. // blocked waiting for data never stalls a concurrent sender.
  8684. //
  8685. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8686. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8687. class WebSocketSSLStream final : public Stream {
  8688. public:
  8689. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8690. time_t read_timeout_sec, time_t read_timeout_usec,
  8691. time_t write_timeout_sec, time_t write_timeout_usec);
  8692. ~WebSocketSSLStream() override;
  8693. bool is_readable() const override;
  8694. bool wait_readable() const override;
  8695. bool wait_writable() const override;
  8696. ssize_t read(char *ptr, size_t size) override;
  8697. ssize_t write(const char *ptr, size_t size) override;
  8698. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8699. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8700. socket_t socket() const override;
  8701. time_t duration() const override;
  8702. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8703. private:
  8704. mutable std::mutex session_mutex_;
  8705. socket_t sock_;
  8706. tls::session_t session_;
  8707. // WebSocket::close() shortens the read timeout from the closing thread
  8708. // while the receive thread is inside wait_readable(), so these two are read
  8709. // and written concurrently. The write timeouts are never mutated.
  8710. std::atomic<time_t> read_timeout_sec_;
  8711. std::atomic<time_t> read_timeout_usec_;
  8712. time_t write_timeout_sec_;
  8713. time_t write_timeout_usec_;
  8714. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8715. };
  8716. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8717. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8718. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8719. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8720. unsigned int hash_length = 0;
  8721. unsigned char hash[EVP_MAX_MD_SIZE];
  8722. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8723. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8724. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8725. std::stringstream ss;
  8726. for (auto i = 0u; i < hash_length; ++i) {
  8727. ss << std::hex << std::setw(2) << std::setfill('0')
  8728. << static_cast<unsigned int>(hash[i]);
  8729. }
  8730. return ss.str();
  8731. }
  8732. inline std::string MD5(const std::string &s) {
  8733. return message_digest(s, EVP_md5());
  8734. }
  8735. inline std::string SHA_256(const std::string &s) {
  8736. return message_digest(s, EVP_sha256());
  8737. }
  8738. inline std::string SHA_512(const std::string &s) {
  8739. return message_digest(s, EVP_sha512());
  8740. }
  8741. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8742. namespace {
  8743. template <size_t N>
  8744. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8745. std::stringstream ss;
  8746. for (size_t i = 0; i < N; ++i) {
  8747. ss << std::hex << std::setw(2) << std::setfill('0')
  8748. << static_cast<unsigned int>(hash[i]);
  8749. }
  8750. return ss.str();
  8751. }
  8752. } // namespace
  8753. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8754. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8755. // initialized once. PSA state is process-global; do not free it.
  8756. inline bool ensure_mbedtls_psa_crypto() {
  8757. static std::once_flag once;
  8758. static bool ok = false;
  8759. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8760. return ok;
  8761. }
  8762. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8763. unsigned char *out, size_t out_size) {
  8764. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8765. size_t olen = 0;
  8766. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8767. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8768. olen == out_size;
  8769. }
  8770. #endif
  8771. inline std::string MD5(const std::string &s) {
  8772. unsigned char hash[16];
  8773. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8774. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8775. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8776. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8777. hash);
  8778. #else
  8779. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8780. hash);
  8781. #endif
  8782. return hash_to_hex(hash);
  8783. }
  8784. inline std::string SHA_256(const std::string &s) {
  8785. unsigned char hash[32];
  8786. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8787. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8788. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8789. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8790. hash, 0);
  8791. #else
  8792. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8793. s.size(), hash, 0);
  8794. #endif
  8795. return hash_to_hex(hash);
  8796. }
  8797. inline std::string SHA_512(const std::string &s) {
  8798. unsigned char hash[64];
  8799. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8800. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8801. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8802. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8803. hash, 0);
  8804. #else
  8805. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8806. s.size(), hash, 0);
  8807. #endif
  8808. return hash_to_hex(hash);
  8809. }
  8810. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8811. namespace {
  8812. template <size_t N>
  8813. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8814. std::stringstream ss;
  8815. for (size_t i = 0; i < N; ++i) {
  8816. ss << std::hex << std::setw(2) << std::setfill('0')
  8817. << static_cast<unsigned int>(hash[i]);
  8818. }
  8819. return ss.str();
  8820. }
  8821. } // namespace
  8822. inline std::string MD5(const std::string &s) {
  8823. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8824. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8825. static_cast<word32>(s.size()), hash);
  8826. return hash_to_hex(hash);
  8827. }
  8828. inline std::string SHA_256(const std::string &s) {
  8829. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8830. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8831. static_cast<word32>(s.size()), hash);
  8832. return hash_to_hex(hash);
  8833. }
  8834. inline std::string SHA_512(const std::string &s) {
  8835. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8836. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8837. static_cast<word32>(s.size()), hash);
  8838. return hash_to_hex(hash);
  8839. }
  8840. #endif
  8841. template <typename T>
  8842. inline bool process_server_socket_ssl(
  8843. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8844. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8845. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8846. time_t write_timeout_usec, T callback) {
  8847. return process_server_socket_core(
  8848. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8849. [&](bool close_connection, bool &connection_closed) {
  8850. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8851. write_timeout_sec, write_timeout_usec);
  8852. // See the non-TLS path in process_server_socket().
  8853. strm.set_readable_hint();
  8854. return callback(strm, close_connection, connection_closed);
  8855. });
  8856. }
  8857. template <typename T>
  8858. inline bool process_client_socket_ssl(
  8859. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8860. time_t read_timeout_usec, time_t write_timeout_sec,
  8861. time_t write_timeout_usec, time_t max_timeout_msec,
  8862. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8863. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8864. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8865. start_time);
  8866. return callback(strm);
  8867. }
  8868. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8869. const Request &req, const std::map<std::string, std::string> &auth,
  8870. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8871. const std::string &password, bool is_proxy = false) {
  8872. std::string nc;
  8873. {
  8874. std::stringstream ss;
  8875. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8876. nc = ss.str();
  8877. }
  8878. std::string qop;
  8879. if (auth.find("qop") != auth.end()) {
  8880. qop = auth.at("qop");
  8881. if (qop.find("auth-int") != std::string::npos) {
  8882. qop = "auth-int";
  8883. } else if (qop.find("auth") != std::string::npos) {
  8884. qop = "auth";
  8885. } else {
  8886. qop.clear();
  8887. }
  8888. }
  8889. std::string algo = "MD5";
  8890. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8891. std::string response;
  8892. {
  8893. auto H = algo == "SHA-256" ? detail::SHA_256
  8894. : algo == "SHA-512" ? detail::SHA_512
  8895. : detail::MD5;
  8896. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8897. auto A2 = req.method + ":" + req.path;
  8898. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8899. if (qop.empty()) {
  8900. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8901. } else {
  8902. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8903. ":" + qop + ":" + H(A2));
  8904. }
  8905. }
  8906. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8907. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8908. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8909. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8910. (qop.empty() ? ", response=\""
  8911. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8912. cnonce + "\", response=\"") +
  8913. response + "\"" +
  8914. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8915. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8916. return std::make_pair(key, field);
  8917. }
  8918. inline bool match_hostname(const std::string &pattern,
  8919. const std::string &hostname) {
  8920. // Exact match (case-insensitive)
  8921. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8922. // Split both pattern and hostname into components by '.'
  8923. std::vector<std::string> pattern_components;
  8924. if (!pattern.empty()) {
  8925. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8926. [&](const char *b, const char *e) {
  8927. pattern_components.emplace_back(b, e);
  8928. });
  8929. }
  8930. std::vector<std::string> host_components;
  8931. if (!hostname.empty()) {
  8932. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8933. [&](const char *b, const char *e) {
  8934. host_components.emplace_back(b, e);
  8935. });
  8936. }
  8937. // Component count must match
  8938. if (host_components.size() != pattern_components.size()) { return false; }
  8939. // Compare each component with wildcard support
  8940. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8941. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8942. auto itr = pattern_components.begin();
  8943. for (const auto &h : host_components) {
  8944. auto &p = *itr;
  8945. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8946. bool partial_match = false;
  8947. if (!p.empty() && p[p.size() - 1] == '*') {
  8948. const auto prefix_length = p.size() - 1;
  8949. if (prefix_length == 0) {
  8950. partial_match = true;
  8951. } else if (h.size() >= prefix_length) {
  8952. partial_match =
  8953. std::equal(p.begin(),
  8954. p.begin() + static_cast<std::string::difference_type>(
  8955. prefix_length),
  8956. h.begin(), [](const char ca, const char cb) {
  8957. return detail::case_ignore::to_lower(ca) ==
  8958. detail::case_ignore::to_lower(cb);
  8959. });
  8960. }
  8961. }
  8962. if (!partial_match) { return false; }
  8963. }
  8964. ++itr;
  8965. }
  8966. return true;
  8967. }
  8968. #ifdef _WIN32
  8969. // Verify certificate using Windows CertGetCertificateChain API.
  8970. // This provides real-time certificate validation with Windows Update
  8971. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8972. inline bool
  8973. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8974. const std::string &hostname,
  8975. bool verify_hostname, uint64_t &out_error) {
  8976. if (der_cert.empty()) { return false; }
  8977. out_error = 0;
  8978. // Create Windows certificate context from DER data
  8979. auto cert_context = CertCreateCertificateContext(
  8980. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8981. static_cast<DWORD>(der_cert.size()));
  8982. if (!cert_context) {
  8983. out_error = GetLastError();
  8984. return false;
  8985. }
  8986. auto cert_guard =
  8987. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8988. // Setup chain parameters
  8989. CERT_CHAIN_PARA chain_para = {};
  8990. chain_para.cbSize = sizeof(chain_para);
  8991. // Build certificate chain with revocation checking
  8992. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8993. auto chain_result = CertGetCertificateChain(
  8994. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8995. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8996. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8997. nullptr, &chain_context);
  8998. if (!chain_result || !chain_context) {
  8999. out_error = GetLastError();
  9000. return false;
  9001. }
  9002. auto chain_guard =
  9003. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9004. // Check if chain has errors
  9005. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9006. out_error = chain_context->TrustStatus.dwErrorStatus;
  9007. return false;
  9008. }
  9009. // Verify SSL policy
  9010. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9011. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9012. #ifdef AUTHTYPE_SERVER
  9013. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9014. #endif
  9015. std::wstring whost;
  9016. if (verify_hostname) {
  9017. whost = u8string_to_wstring(hostname.c_str());
  9018. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9019. }
  9020. CERT_CHAIN_POLICY_PARA policy_para = {};
  9021. policy_para.cbSize = sizeof(policy_para);
  9022. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9023. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9024. #else
  9025. policy_para.dwFlags = 0;
  9026. #endif
  9027. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9028. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9029. policy_status.cbSize = sizeof(policy_status);
  9030. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9031. &policy_para, &policy_status)) {
  9032. out_error = GetLastError();
  9033. return false;
  9034. }
  9035. if (policy_status.dwError != 0) {
  9036. out_error = policy_status.dwError;
  9037. return false;
  9038. }
  9039. return true;
  9040. }
  9041. #endif // _WIN32
  9042. // Loads CA file/dir configuration and applies the system CA policy to a
  9043. // client TLS context. PEM data and native stores are applied to the context
  9044. // directly at set time; has_custom_store reflects them for the Auto policy
  9045. // decision.
  9046. inline bool load_client_ca_config(tls::ctx_t ctx,
  9047. const std::string &ca_cert_file_path,
  9048. const std::string &ca_cert_dir_path,
  9049. bool has_custom_store, SystemCAMode mode,
  9050. uint64_t &backend_error) {
  9051. auto ret = true;
  9052. if (!ca_cert_file_path.empty()) {
  9053. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9054. backend_error = tls::get_error();
  9055. ret = false;
  9056. }
  9057. } else if (!ca_cert_dir_path.empty()) {
  9058. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9059. backend_error = tls::get_error();
  9060. ret = false;
  9061. }
  9062. }
  9063. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9064. !ca_cert_dir_path.empty() || has_custom_store;
  9065. if (mode == SystemCAMode::Enabled ||
  9066. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9067. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9068. }
  9069. return ret;
  9070. }
  9071. // The parts of session setup that only SSLClient needs, plus the handful
  9072. // WebSocketClient also exposes; everything else takes the defaults, which is
  9073. // what keeps the two clients on one implementation.
  9074. struct ClientTlsSessionOptions {
  9075. // Both SSLClient and WebSocketClient expose this independently of
  9076. // certificate verification.
  9077. bool server_hostname_verification = true;
  9078. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9079. // When non-null, guards session creation against concurrent use of the
  9080. // context. A WebSocketClient is not safe to use from several threads to
  9081. // begin with, so it passes nothing.
  9082. std::mutex *ctx_mutex = nullptr;
  9083. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9084. // The caller decides whether Schannel has anything to say about this
  9085. // connection; see SSLClient::initialize_ssl().
  9086. bool windows_cert_verification = false;
  9087. #endif
  9088. };
  9089. // Filled in on failure for callers that report error details.
  9090. struct ClientTlsSessionError {
  9091. Error error = Error::Success;
  9092. int ssl_error = 0;
  9093. uint64_t backend_error = 0;
  9094. };
  9095. // Establishes a client TLS session on an already connected socket. On failure
  9096. // the session is left for the caller to free: SSLClient frees it right away,
  9097. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9098. inline bool setup_client_tls_session(
  9099. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9100. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9101. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9102. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9103. using namespace tls;
  9104. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9105. if (out_error) {
  9106. out_error->error = error;
  9107. out_error->ssl_error = ssl_error;
  9108. out_error->backend_error = backend_error;
  9109. }
  9110. return false;
  9111. };
  9112. if (!ctx) {
  9113. session = nullptr;
  9114. return fail(Error::SSLConnection, 0, 0);
  9115. }
  9116. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9117. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9118. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9119. // verification happens during the handshake even for IP hosts; the
  9120. // certificate identity is verified post-handshake via verify_hostname().
  9121. set_verify_client(ctx, server_certificate_verification);
  9122. #endif
  9123. {
  9124. std::unique_lock<std::mutex> guard;
  9125. if (options.ctx_mutex) {
  9126. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9127. }
  9128. session = create_session(ctx, sock);
  9129. }
  9130. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9131. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9132. // their identity is checked post-handshake below instead. On Mbed TLS and
  9133. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9134. // options.server_hostname_verification is threaded through here.
  9135. if (!is_ip_address(host)) {
  9136. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9137. return fail(Error::SSLConnection, 0, get_error());
  9138. }
  9139. }
  9140. TlsError tls_err;
  9141. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9142. &tls_err)) {
  9143. auto error = Error::SSLConnection;
  9144. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9145. error = Error::SSLServerVerification;
  9146. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9147. error = Error::SSLServerHostnameVerification;
  9148. }
  9149. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9150. }
  9151. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9152. if (options.session_verifier) {
  9153. verification_status = options.session_verifier(session);
  9154. }
  9155. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9156. return fail(Error::SSLServerVerification, 0, get_error());
  9157. }
  9158. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9159. server_certificate_verification) {
  9160. auto verify_result = get_verify_result(session);
  9161. if (verify_result != 0) {
  9162. return fail(Error::SSLServerVerification, 0,
  9163. static_cast<uint64_t>(verify_result));
  9164. }
  9165. auto server_cert = get_peer_cert(session);
  9166. if (!server_cert) {
  9167. return fail(Error::SSLServerVerification, 0, get_error());
  9168. }
  9169. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9170. // Identity check against the peer certificate, post-handshake for all
  9171. // backends. For IP hosts this is the only identity verification, since no
  9172. // hostname is bound during the handshake.
  9173. if (options.server_hostname_verification) {
  9174. if (!verify_hostname(server_cert, host.c_str())) {
  9175. return fail(Error::SSLServerHostnameVerification, 0,
  9176. hostname_mismatch_code());
  9177. }
  9178. }
  9179. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9180. // Additional Windows Schannel verification.
  9181. // This provides real-time certificate validation with Windows Update
  9182. // integration, working with both OpenSSL and MbedTLS backends.
  9183. if (options.windows_cert_verification) {
  9184. std::vector<unsigned char> der;
  9185. if (get_cert_der(server_cert, der)) {
  9186. uint64_t wincrypt_error = 0;
  9187. if (!verify_cert_with_windows_schannel(
  9188. der, host, options.server_hostname_verification,
  9189. wincrypt_error)) {
  9190. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9191. }
  9192. }
  9193. }
  9194. #endif
  9195. }
  9196. return true;
  9197. }
  9198. } // namespace detail
  9199. #endif // CPPHTTPLIB_SSL_ENABLED
  9200. /*
  9201. * Group 3: httplib namespace - Non-SSL public API implementations
  9202. */
  9203. inline void default_socket_options(socket_t sock) {
  9204. set_socket_opt(sock, SOL_SOCKET,
  9205. #ifdef SO_REUSEPORT
  9206. SO_REUSEPORT,
  9207. #else
  9208. SO_REUSEADDR,
  9209. #endif
  9210. 1);
  9211. }
  9212. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9213. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9214. sizeof(optval));
  9215. }
  9216. inline std::string get_bearer_token_auth(const Request &req) {
  9217. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9218. // than the prefix carries no token.
  9219. constexpr const char bearer_prefix[] = "Bearer ";
  9220. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9221. auto value = req.get_header_value("Authorization");
  9222. if (value.size() >= bearer_prefix_len &&
  9223. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9224. bearer_prefix)) {
  9225. return value.substr(bearer_prefix_len);
  9226. }
  9227. return "";
  9228. }
  9229. inline const char *status_message(int status) {
  9230. switch (status) {
  9231. case StatusCode::Continue_100: return "Continue";
  9232. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9233. case StatusCode::Processing_102: return "Processing";
  9234. case StatusCode::EarlyHints_103: return "Early Hints";
  9235. case StatusCode::OK_200: return "OK";
  9236. case StatusCode::Created_201: return "Created";
  9237. case StatusCode::Accepted_202: return "Accepted";
  9238. case StatusCode::NonAuthoritativeInformation_203:
  9239. return "Non-Authoritative Information";
  9240. case StatusCode::NoContent_204: return "No Content";
  9241. case StatusCode::ResetContent_205: return "Reset Content";
  9242. case StatusCode::PartialContent_206: return "Partial Content";
  9243. case StatusCode::MultiStatus_207: return "Multi-Status";
  9244. case StatusCode::AlreadyReported_208: return "Already Reported";
  9245. case StatusCode::IMUsed_226: return "IM Used";
  9246. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9247. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9248. case StatusCode::Found_302: return "Found";
  9249. case StatusCode::SeeOther_303: return "See Other";
  9250. case StatusCode::NotModified_304: return "Not Modified";
  9251. case StatusCode::UseProxy_305: return "Use Proxy";
  9252. case StatusCode::unused_306: return "unused";
  9253. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9254. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9255. case StatusCode::BadRequest_400: return "Bad Request";
  9256. case StatusCode::Unauthorized_401: return "Unauthorized";
  9257. case StatusCode::PaymentRequired_402: return "Payment Required";
  9258. case StatusCode::Forbidden_403: return "Forbidden";
  9259. case StatusCode::NotFound_404: return "Not Found";
  9260. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9261. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9262. case StatusCode::ProxyAuthenticationRequired_407:
  9263. return "Proxy Authentication Required";
  9264. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9265. case StatusCode::Conflict_409: return "Conflict";
  9266. case StatusCode::Gone_410: return "Gone";
  9267. case StatusCode::LengthRequired_411: return "Length Required";
  9268. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9269. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9270. case StatusCode::UriTooLong_414: return "URI Too Long";
  9271. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9272. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9273. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9274. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9275. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9276. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9277. case StatusCode::Locked_423: return "Locked";
  9278. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9279. case StatusCode::TooEarly_425: return "Too Early";
  9280. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9281. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9282. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9283. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9284. return "Request Header Fields Too Large";
  9285. case StatusCode::UnavailableForLegalReasons_451:
  9286. return "Unavailable For Legal Reasons";
  9287. case StatusCode::NotImplemented_501: return "Not Implemented";
  9288. case StatusCode::BadGateway_502: return "Bad Gateway";
  9289. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9290. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9291. case StatusCode::HttpVersionNotSupported_505:
  9292. return "HTTP Version Not Supported";
  9293. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9294. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9295. case StatusCode::LoopDetected_508: return "Loop Detected";
  9296. case StatusCode::NotExtended_510: return "Not Extended";
  9297. case StatusCode::NetworkAuthenticationRequired_511:
  9298. return "Network Authentication Required";
  9299. default:
  9300. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9301. }
  9302. }
  9303. inline std::string to_string(const Error error) {
  9304. switch (error) {
  9305. case Error::Success: return "Success (no error)";
  9306. case Error::Unknown: return "Unknown";
  9307. case Error::Connection: return "Could not establish connection";
  9308. case Error::BindIPAddress: return "Failed to bind IP address";
  9309. case Error::Read: return "Failed to read connection";
  9310. case Error::Write: return "Failed to write connection";
  9311. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9312. case Error::Canceled: return "Connection handling canceled";
  9313. case Error::SSLConnection: return "SSL connection failed";
  9314. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9315. case Error::SSLServerVerification: return "SSL server verification failed";
  9316. case Error::SSLServerHostnameVerification:
  9317. return "SSL server hostname verification failed";
  9318. case Error::UnsupportedMultipartBoundaryChars:
  9319. return "Unsupported HTTP multipart boundary characters";
  9320. case Error::Compression: return "Compression failed";
  9321. case Error::ConnectionTimeout: return "Connection timed out";
  9322. case Error::ProxyConnection: return "Proxy connection failed";
  9323. case Error::ConnectionClosed: return "Connection closed by server";
  9324. case Error::Timeout: return "Read timeout";
  9325. case Error::ResourceExhaustion: return "Resource exhaustion";
  9326. case Error::TooManyFormDataFiles: return "Too many form data files";
  9327. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9328. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9329. case Error::ExceedMaxSocketDescriptorCount:
  9330. return "Exceeded maximum socket descriptor count";
  9331. case Error::InvalidRequestLine: return "Invalid request line";
  9332. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9333. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9334. case Error::InvalidHeaders: return "Invalid headers";
  9335. case Error::MultipartParsing: return "Multipart parsing failed";
  9336. case Error::OpenFile: return "Failed to open file";
  9337. case Error::Listen: return "Failed to listen on socket";
  9338. case Error::GetSockName: return "Failed to get socket name";
  9339. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9340. case Error::HTTPParsing: return "HTTP parsing failed";
  9341. case Error::InvalidRangeHeader: return "Invalid Range header";
  9342. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9343. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9344. case Error::UserCallbackException: return "User callback threw an exception";
  9345. default: break;
  9346. }
  9347. return "Invalid";
  9348. }
  9349. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9350. os << to_string(obj);
  9351. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9352. return os;
  9353. }
  9354. inline std::string hosted_at(const std::string &hostname) {
  9355. std::vector<std::string> addrs;
  9356. hosted_at(hostname, addrs);
  9357. if (addrs.empty()) { return std::string(); }
  9358. return addrs[0];
  9359. }
  9360. inline void hosted_at(const std::string &hostname,
  9361. std::vector<std::string> &addrs) {
  9362. struct addrinfo hints;
  9363. struct addrinfo *result;
  9364. memset(&hints, 0, sizeof(struct addrinfo));
  9365. hints.ai_family = AF_UNSPEC;
  9366. hints.ai_socktype = SOCK_STREAM;
  9367. hints.ai_protocol = 0;
  9368. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9369. &result, 0)) {
  9370. #if defined __linux__ && !defined __ANDROID__
  9371. res_init();
  9372. #endif
  9373. return;
  9374. }
  9375. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9376. for (auto rp = result; rp; rp = rp->ai_next) {
  9377. const auto &addr =
  9378. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9379. std::string ip;
  9380. auto dummy = -1;
  9381. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9382. dummy)) {
  9383. addrs.emplace_back(std::move(ip));
  9384. }
  9385. }
  9386. }
  9387. inline std::string encode_uri_component(const std::string &value) {
  9388. std::ostringstream escaped;
  9389. escaped.fill('0');
  9390. escaped << std::hex;
  9391. for (auto c : value) {
  9392. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9393. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9394. escaped << c;
  9395. } else {
  9396. escaped << std::uppercase;
  9397. escaped << '%' << std::setw(2)
  9398. << static_cast<int>(static_cast<unsigned char>(c));
  9399. escaped << std::nouppercase;
  9400. }
  9401. }
  9402. return escaped.str();
  9403. }
  9404. inline std::string encode_uri(const std::string &value) {
  9405. std::ostringstream escaped;
  9406. escaped.fill('0');
  9407. escaped << std::hex;
  9408. for (auto c : value) {
  9409. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9410. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9411. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9412. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9413. escaped << c;
  9414. } else {
  9415. escaped << std::uppercase;
  9416. escaped << '%' << std::setw(2)
  9417. << static_cast<int>(static_cast<unsigned char>(c));
  9418. escaped << std::nouppercase;
  9419. }
  9420. }
  9421. return escaped.str();
  9422. }
  9423. inline std::string decode_uri_component(const std::string &value) {
  9424. std::string result;
  9425. for (size_t i = 0; i < value.size(); i++) {
  9426. if (value[i] == '%' && i + 2 < value.size()) {
  9427. auto val = 0;
  9428. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9429. result += static_cast<char>(val);
  9430. i += 2;
  9431. } else {
  9432. result += value[i];
  9433. }
  9434. } else {
  9435. result += value[i];
  9436. }
  9437. }
  9438. return result;
  9439. }
  9440. inline std::string decode_uri(const std::string &value) {
  9441. std::string result;
  9442. for (size_t i = 0; i < value.size(); i++) {
  9443. if (value[i] == '%' && i + 2 < value.size()) {
  9444. auto val = 0;
  9445. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9446. auto c = static_cast<char>(val);
  9447. // Keep escapes of the reserved characters that encode_uri leaves
  9448. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9449. // delimiter is not promoted into a real one (as with JS decodeURI).
  9450. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9451. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9452. c == '#') {
  9453. result += value[i];
  9454. result += value[i + 1];
  9455. result += value[i + 2];
  9456. } else {
  9457. result += c;
  9458. }
  9459. i += 2;
  9460. } else {
  9461. result += value[i];
  9462. }
  9463. } else {
  9464. result += value[i];
  9465. }
  9466. }
  9467. return result;
  9468. }
  9469. inline std::string encode_path_component(const std::string &component) {
  9470. std::string result;
  9471. result.reserve(component.size() * 3);
  9472. for (size_t i = 0; i < component.size(); i++) {
  9473. auto c = static_cast<unsigned char>(component[i]);
  9474. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9475. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9476. c == '_' || c == '~') {
  9477. result += static_cast<char>(c);
  9478. }
  9479. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9480. // "," / ";" / "="
  9481. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9482. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9483. c == '=') {
  9484. result += static_cast<char>(c);
  9485. }
  9486. // Colon is allowed in path segments except first segment
  9487. else if (c == ':') {
  9488. result += static_cast<char>(c);
  9489. }
  9490. // @ is allowed in path
  9491. else if (c == '@') {
  9492. result += static_cast<char>(c);
  9493. } else {
  9494. result += '%';
  9495. char hex[3];
  9496. snprintf(hex, sizeof(hex), "%02X", c);
  9497. result.append(hex, 2);
  9498. }
  9499. }
  9500. return result;
  9501. }
  9502. inline std::string decode_path_component(const std::string &component) {
  9503. std::string result;
  9504. result.reserve(component.size());
  9505. for (size_t i = 0; i < component.size(); i++) {
  9506. if (component[i] == '%' && i + 1 < component.size()) {
  9507. if (component[i + 1] == 'u') {
  9508. // Unicode %uXXXX encoding
  9509. auto val = 0;
  9510. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9511. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9512. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9513. char buff[4];
  9514. size_t len = detail::to_utf8(val, buff);
  9515. if (len > 0) { result.append(buff, len); }
  9516. i += 5; // 'u0000'
  9517. } else {
  9518. result += component[i];
  9519. }
  9520. } else {
  9521. // Standard %XX encoding
  9522. auto val = 0;
  9523. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9524. // 2 digits hex codes
  9525. result += static_cast<char>(val);
  9526. i += 2; // 'XX'
  9527. } else {
  9528. result += component[i];
  9529. }
  9530. }
  9531. } else {
  9532. result += component[i];
  9533. }
  9534. }
  9535. return result;
  9536. }
  9537. inline std::string encode_query_component(const std::string &component,
  9538. bool space_as_plus) {
  9539. std::string result;
  9540. result.reserve(component.size() * 3);
  9541. for (size_t i = 0; i < component.size(); i++) {
  9542. auto c = static_cast<unsigned char>(component[i]);
  9543. // Unreserved characters per RFC 3986
  9544. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9545. c == '_' || c == '~') {
  9546. result += static_cast<char>(c);
  9547. }
  9548. // Space handling
  9549. else if (c == ' ') {
  9550. if (space_as_plus) {
  9551. result += '+';
  9552. } else {
  9553. result += "%20";
  9554. }
  9555. }
  9556. // Plus sign handling
  9557. else if (c == '+') {
  9558. if (space_as_plus) {
  9559. result += "%2B";
  9560. } else {
  9561. result += static_cast<char>(c);
  9562. }
  9563. }
  9564. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9565. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9566. c == '*' || c == ',' || c == ';') {
  9567. result += static_cast<char>(c);
  9568. }
  9569. // Colon and @ are allowed in query
  9570. else if (c == ':' || c == '@') {
  9571. result += static_cast<char>(c);
  9572. }
  9573. // Forward slash is allowed in query values
  9574. else if (c == '/') {
  9575. result += static_cast<char>(c);
  9576. }
  9577. // Question mark is allowed in query values (after first ?)
  9578. else if (c == '?') {
  9579. result += static_cast<char>(c);
  9580. } else {
  9581. result += '%';
  9582. char hex[3];
  9583. snprintf(hex, sizeof(hex), "%02X", c);
  9584. result.append(hex, 2);
  9585. }
  9586. }
  9587. return result;
  9588. }
  9589. inline std::string decode_query_component(const std::string &component,
  9590. bool plus_as_space) {
  9591. std::string result;
  9592. result.reserve(component.size());
  9593. for (size_t i = 0; i < component.size(); i++) {
  9594. if (component[i] == '%' && i + 2 < component.size()) {
  9595. auto val = 0;
  9596. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9597. result += static_cast<char>(val);
  9598. i += 2;
  9599. } else {
  9600. result += component[i];
  9601. }
  9602. } else if (component[i] == '+' && plus_as_space) {
  9603. result += ' '; // + becomes space in form-urlencoded
  9604. } else {
  9605. result += component[i];
  9606. }
  9607. }
  9608. return result;
  9609. }
  9610. inline std::string sanitize_filename(const std::string &filename) {
  9611. // Extract basename: find the last path separator (/ or \)
  9612. auto pos = filename.find_last_of("/\\");
  9613. auto result =
  9614. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9615. // Strip null bytes
  9616. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9617. // Trim whitespace
  9618. {
  9619. auto start = result.find_first_not_of(" \t");
  9620. auto end = result.find_last_not_of(" \t");
  9621. result = (start == std::string::npos)
  9622. ? ""
  9623. : result.substr(start, end - start + 1);
  9624. }
  9625. // Reject . and ..
  9626. if (result == "." || result == "..") { return ""; }
  9627. return result;
  9628. }
  9629. inline std::string append_query_params(const std::string &path,
  9630. const Params &params) {
  9631. std::string path_with_query = path;
  9632. thread_local const std::regex re("[^?]+\\?.*");
  9633. auto delm = std::regex_match(path, re) ? '&' : '?';
  9634. path_with_query += delm + detail::params_to_query_str(params);
  9635. return path_with_query;
  9636. }
  9637. // Header utilities
  9638. inline std::pair<std::string, std::string>
  9639. make_range_header(const Ranges &ranges) {
  9640. std::string field = "bytes=";
  9641. auto i = 0;
  9642. for (const auto &r : ranges) {
  9643. if (i != 0) { field += ", "; }
  9644. if (r.first != -1) { field += std::to_string(r.first); }
  9645. field += '-';
  9646. if (r.second != -1) { field += std::to_string(r.second); }
  9647. i++;
  9648. }
  9649. return std::make_pair("Range", std::move(field));
  9650. }
  9651. inline std::pair<std::string, std::string>
  9652. make_basic_authentication_header(const std::string &username,
  9653. const std::string &password, bool is_proxy) {
  9654. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9655. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9656. return std::make_pair(key, std::move(field));
  9657. }
  9658. inline std::pair<std::string, std::string>
  9659. make_bearer_token_authentication_header(const std::string &token,
  9660. bool is_proxy = false) {
  9661. auto field = "Bearer " + token;
  9662. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9663. return std::make_pair(key, std::move(field));
  9664. }
  9665. // Request implementation
  9666. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9667. size_t id) const {
  9668. return detail::get_header_value_u64(headers, key, def, id);
  9669. }
  9670. inline bool Request::has_header(const std::string &key) const {
  9671. return detail::has_header(headers, key);
  9672. }
  9673. inline std::string Request::get_header_value(const std::string &key,
  9674. const char *def, size_t id) const {
  9675. return detail::get_header_value(headers, key, def, id);
  9676. }
  9677. inline size_t Request::get_header_value_count(const std::string &key) const {
  9678. return detail::get_header_value_count(headers, key);
  9679. }
  9680. inline void Request::set_header(const std::string &key,
  9681. const std::string &val) {
  9682. detail::set_header(headers, key, val);
  9683. }
  9684. inline bool Request::has_trailer(const std::string &key) const {
  9685. return trailers.find(key) != trailers.end();
  9686. }
  9687. inline std::string Request::get_trailer_value(const std::string &key,
  9688. size_t id) const {
  9689. return detail::get_multimap_value(trailers, key, id);
  9690. }
  9691. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9692. return trailers.count(key);
  9693. }
  9694. inline bool Request::has_param(const std::string &key) const {
  9695. return params.find(key) != params.end();
  9696. }
  9697. inline std::string Request::get_param_value(const std::string &key,
  9698. size_t id) const {
  9699. return detail::get_multimap_value(params, key, id);
  9700. }
  9701. inline std::vector<std::string>
  9702. Request::get_param_values(const std::string &key) const {
  9703. auto rng = params.equal_range(key);
  9704. std::vector<std::string> values;
  9705. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9706. for (auto it = rng.first; it != rng.second; ++it) {
  9707. values.push_back(it->second);
  9708. }
  9709. return values;
  9710. }
  9711. inline size_t Request::get_param_value_count(const std::string &key) const {
  9712. return params.count(key);
  9713. }
  9714. inline bool Request::is_multipart_form_data() const {
  9715. const auto &content_type = get_header_value("Content-Type");
  9716. return detail::extract_media_type(content_type) == "multipart/form-data";
  9717. }
  9718. // Multipart FormData implementation
  9719. inline std::string MultipartFormData::get_field(const std::string &key,
  9720. size_t id) const {
  9721. auto rng = fields.equal_range(key);
  9722. auto it = rng.first;
  9723. std::advance(it, static_cast<ssize_t>(id));
  9724. if (it != rng.second) { return it->second.content; }
  9725. return std::string();
  9726. }
  9727. inline std::vector<std::string>
  9728. MultipartFormData::get_fields(const std::string &key) const {
  9729. std::vector<std::string> values;
  9730. auto rng = fields.equal_range(key);
  9731. for (auto it = rng.first; it != rng.second; it++) {
  9732. values.push_back(it->second.content);
  9733. }
  9734. return values;
  9735. }
  9736. inline bool MultipartFormData::has_field(const std::string &key) const {
  9737. return fields.find(key) != fields.end();
  9738. }
  9739. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9740. return fields.count(key);
  9741. }
  9742. inline FormData MultipartFormData::get_file(const std::string &key,
  9743. size_t id) const {
  9744. return detail::get_multimap_value(files, key, id);
  9745. }
  9746. inline std::vector<FormData>
  9747. MultipartFormData::get_files(const std::string &key) const {
  9748. std::vector<FormData> values;
  9749. auto rng = files.equal_range(key);
  9750. for (auto it = rng.first; it != rng.second; it++) {
  9751. values.push_back(it->second);
  9752. }
  9753. return values;
  9754. }
  9755. inline bool MultipartFormData::has_file(const std::string &key) const {
  9756. return files.find(key) != files.end();
  9757. }
  9758. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9759. return files.count(key);
  9760. }
  9761. // Multipart FormData writer implementation
  9762. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9763. return detail::is_multipart_boundary_chars_valid(boundary);
  9764. }
  9765. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9766. : boundary_(detail::make_multipart_data_boundary()) {}
  9767. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9768. : boundary_(std::move(boundary)) {}
  9769. inline const std::string &MultipartFormDataWriter::boundary() const {
  9770. return boundary_;
  9771. }
  9772. inline std::string MultipartFormDataWriter::content_type() const {
  9773. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9774. }
  9775. inline std::string
  9776. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9777. return detail::serialize_multipart_formdata(items, boundary_);
  9778. }
  9779. inline size_t MultipartFormDataWriter::content_length(
  9780. const UploadFormDataItems &items) const {
  9781. return detail::get_multipart_content_length(items, boundary_);
  9782. }
  9783. inline std::string
  9784. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9785. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9786. }
  9787. inline std::string MultipartFormDataWriter::item_end() {
  9788. return detail::serialize_multipart_formdata_item_end();
  9789. }
  9790. inline std::string MultipartFormDataWriter::finish() const {
  9791. return detail::serialize_multipart_formdata_finish(boundary_);
  9792. }
  9793. // Response implementation
  9794. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9795. size_t id) const {
  9796. return detail::get_header_value_u64(headers, key, def, id);
  9797. }
  9798. inline bool Response::has_header(const std::string &key) const {
  9799. return headers.find(key) != headers.end();
  9800. }
  9801. inline std::string Response::get_header_value(const std::string &key,
  9802. const char *def,
  9803. size_t id) const {
  9804. return detail::get_header_value(headers, key, def, id);
  9805. }
  9806. inline size_t Response::get_header_value_count(const std::string &key) const {
  9807. return detail::get_header_value_count(headers, key);
  9808. }
  9809. inline void Response::set_header(const std::string &key,
  9810. const std::string &val) {
  9811. detail::set_header(headers, key, val);
  9812. }
  9813. inline bool Response::has_trailer(const std::string &key) const {
  9814. return trailers.find(key) != trailers.end();
  9815. }
  9816. inline std::string Response::get_trailer_value(const std::string &key,
  9817. size_t id) const {
  9818. return detail::get_multimap_value(trailers, key, id);
  9819. }
  9820. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9821. return trailers.count(key);
  9822. }
  9823. inline void Response::set_redirect(const std::string &url, int stat) {
  9824. if (detail::fields::is_field_value(url)) {
  9825. set_header("Location", url);
  9826. if (300 <= stat && stat < 400) {
  9827. this->status = stat;
  9828. } else {
  9829. this->status = StatusCode::Found_302;
  9830. }
  9831. }
  9832. }
  9833. inline void Response::set_content(const char *s, size_t n,
  9834. const std::string &content_type) {
  9835. body.assign(s, n);
  9836. auto rng = headers.equal_range("Content-Type");
  9837. headers.erase(rng.first, rng.second);
  9838. set_header("Content-Type", content_type);
  9839. content_coding_ = detail::EncodingType::None;
  9840. }
  9841. inline void Response::set_content(const std::string &s,
  9842. const std::string &content_type) {
  9843. set_content(s.data(), s.size(), content_type);
  9844. }
  9845. inline void Response::set_content(std::string &&s,
  9846. const std::string &content_type) {
  9847. body = std::move(s);
  9848. auto rng = headers.equal_range("Content-Type");
  9849. headers.erase(rng.first, rng.second);
  9850. set_header("Content-Type", content_type);
  9851. content_coding_ = detail::EncodingType::None;
  9852. }
  9853. inline void Response::set_content_provider(
  9854. size_t in_length, const std::string &content_type, ContentProvider provider,
  9855. ContentProviderResourceReleaser resource_releaser) {
  9856. set_header("Content-Type", content_type);
  9857. content_length_ = in_length;
  9858. if (in_length > 0) { content_provider_ = std::move(provider); }
  9859. content_provider_resource_releaser_ = std::move(resource_releaser);
  9860. is_chunked_content_provider_ = false;
  9861. is_file_content_provider_ = false;
  9862. content_coding_ = detail::EncodingType::None;
  9863. }
  9864. inline void Response::set_content_provider(
  9865. const std::string &content_type, ContentProviderWithoutLength provider,
  9866. ContentProviderResourceReleaser resource_releaser) {
  9867. set_header("Content-Type", content_type);
  9868. content_length_ = 0;
  9869. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9870. content_provider_resource_releaser_ = std::move(resource_releaser);
  9871. is_chunked_content_provider_ = false;
  9872. is_file_content_provider_ = false;
  9873. content_coding_ = detail::EncodingType::None;
  9874. }
  9875. inline void Response::set_chunked_content_provider(
  9876. const std::string &content_type, ContentProviderWithoutLength provider,
  9877. ContentProviderResourceReleaser resource_releaser) {
  9878. set_header("Content-Type", content_type);
  9879. content_length_ = 0;
  9880. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9881. content_provider_resource_releaser_ = std::move(resource_releaser);
  9882. is_chunked_content_provider_ = true;
  9883. is_file_content_provider_ = false;
  9884. content_coding_ = detail::EncodingType::None;
  9885. }
  9886. inline void Response::set_file_content(const std::string &path,
  9887. const std::string &content_type) {
  9888. file_content_path_ = path;
  9889. file_content_content_type_ = content_type;
  9890. }
  9891. inline void Response::set_file_content(const std::string &path) {
  9892. file_content_path_ = path;
  9893. }
  9894. // Result implementation
  9895. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9896. size_t def,
  9897. size_t id) const {
  9898. return detail::get_header_value_u64(request_headers_, key, def, id);
  9899. }
  9900. inline bool Result::has_request_header(const std::string &key) const {
  9901. return request_headers_.find(key) != request_headers_.end();
  9902. }
  9903. inline std::string Result::get_request_header_value(const std::string &key,
  9904. const char *def,
  9905. size_t id) const {
  9906. return detail::get_header_value(request_headers_, key, def, id);
  9907. }
  9908. inline size_t
  9909. Result::get_request_header_value_count(const std::string &key) const {
  9910. return request_headers_.count(key);
  9911. }
  9912. // Stream implementation
  9913. inline ssize_t Stream::write(const char *ptr) {
  9914. return write(ptr, strlen(ptr));
  9915. }
  9916. inline ssize_t Stream::write(const std::string &s) {
  9917. return write(s.data(), s.size());
  9918. }
  9919. // BodyReader implementation
  9920. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9921. if (!stream) {
  9922. last_error = Error::Connection;
  9923. return -1;
  9924. }
  9925. if (eof) { return 0; }
  9926. if (!chunked) {
  9927. // Content-Length based reading
  9928. if (has_content_length && bytes_read >= content_length) {
  9929. eof = true;
  9930. return 0;
  9931. }
  9932. auto to_read = len;
  9933. if (has_content_length) {
  9934. auto remaining = content_length - bytes_read;
  9935. to_read = (std::min)(len, remaining);
  9936. }
  9937. auto n = stream->read(buf, to_read);
  9938. if (n < 0) {
  9939. last_error = stream->get_error();
  9940. if (last_error == Error::Success) { last_error = Error::Read; }
  9941. eof = true;
  9942. return n;
  9943. }
  9944. if (n == 0) {
  9945. // Unexpected EOF before content_length
  9946. last_error = stream->get_error();
  9947. if (last_error == Error::Success) { last_error = Error::Read; }
  9948. eof = true;
  9949. return 0;
  9950. }
  9951. bytes_read += static_cast<size_t>(n);
  9952. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9953. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9954. last_error = Error::ExceedMaxPayloadSize;
  9955. eof = true;
  9956. return -1;
  9957. }
  9958. return n;
  9959. }
  9960. // Chunked transfer encoding: delegate to shared decoder instance.
  9961. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9962. size_t chunk_offset = 0;
  9963. size_t chunk_total = 0;
  9964. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9965. if (n < 0) {
  9966. last_error = stream->get_error();
  9967. if (last_error == Error::Success) { last_error = Error::Read; }
  9968. eof = true;
  9969. return n;
  9970. }
  9971. if (n == 0) {
  9972. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9973. eof = true;
  9974. return 0;
  9975. }
  9976. bytes_read += static_cast<size_t>(n);
  9977. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9978. last_error = Error::ExceedMaxPayloadSize;
  9979. eof = true;
  9980. return -1;
  9981. }
  9982. return n;
  9983. }
  9984. // ThreadPool implementation
  9985. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9986. time_t idle_timeout_sec)
  9987. : base_thread_count_(n), max_queued_requests_(mqr),
  9988. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9989. shutdown_(false) {
  9990. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9991. if (max_n != 0 && max_n < n) {
  9992. std::string msg = "max_threads must be >= base_threads";
  9993. throw std::invalid_argument(msg);
  9994. }
  9995. #endif
  9996. max_thread_count_ = max_n == 0 ? n : max_n;
  9997. threads_.reserve(base_thread_count_);
  9998. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9999. try {
  10000. #endif
  10001. for (size_t i = 0; i < base_thread_count_; i++) {
  10002. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10003. }
  10004. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10005. } catch (...) {
  10006. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10007. // signal the workers we already spawned to exit and join them so the
  10008. // vector destructor does not see joinable threads (which would call
  10009. // std::terminate). Then rethrow so the caller learns of the failure.
  10010. {
  10011. std::unique_lock<std::mutex> lock(mutex_);
  10012. shutdown_ = true;
  10013. }
  10014. cond_.notify_all();
  10015. for (auto &t : threads_) {
  10016. if (t.joinable()) { t.join(); }
  10017. }
  10018. throw;
  10019. }
  10020. #endif
  10021. }
  10022. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10023. {
  10024. std::unique_lock<std::mutex> lock(mutex_);
  10025. if (shutdown_) { return false; }
  10026. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10027. return false;
  10028. }
  10029. jobs_.push_back(std::move(fn));
  10030. // Spawn a dynamic thread if no idle threads and under max
  10031. if (idle_thread_count_ == 0 &&
  10032. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10033. cleanup_finished_threads();
  10034. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10035. }
  10036. }
  10037. cond_.notify_one();
  10038. return true;
  10039. }
  10040. inline void ThreadPool::shutdown() {
  10041. {
  10042. std::unique_lock<std::mutex> lock(mutex_);
  10043. shutdown_ = true;
  10044. }
  10045. cond_.notify_all();
  10046. for (auto &t : threads_) {
  10047. if (t.joinable()) { t.join(); }
  10048. }
  10049. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10050. // with worker threads that call move_to_finished() concurrently.
  10051. std::list<std::thread> remaining_dynamic;
  10052. {
  10053. std::unique_lock<std::mutex> lock(mutex_);
  10054. remaining_dynamic = std::move(dynamic_threads_);
  10055. }
  10056. for (auto &t : remaining_dynamic) {
  10057. if (t.joinable()) { t.join(); }
  10058. }
  10059. std::unique_lock<std::mutex> lock(mutex_);
  10060. cleanup_finished_threads();
  10061. }
  10062. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10063. // Must be called with mutex_ held
  10064. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10065. if (it->get_id() == id) {
  10066. finished_threads_.push_back(std::move(*it));
  10067. dynamic_threads_.erase(it);
  10068. return;
  10069. }
  10070. }
  10071. }
  10072. inline void ThreadPool::cleanup_finished_threads() {
  10073. // Must be called with mutex_ held
  10074. for (auto &t : finished_threads_) {
  10075. if (t.joinable()) { t.join(); }
  10076. }
  10077. finished_threads_.clear();
  10078. }
  10079. inline void ThreadPool::worker(bool is_dynamic) {
  10080. for (;;) {
  10081. std::function<void()> fn;
  10082. {
  10083. std::unique_lock<std::mutex> lock(mutex_);
  10084. idle_thread_count_++;
  10085. if (is_dynamic) {
  10086. auto has_work =
  10087. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10088. [&] { return !jobs_.empty() || shutdown_; });
  10089. if (!has_work) {
  10090. // Timed out with no work - exit this dynamic thread
  10091. idle_thread_count_--;
  10092. move_to_finished(std::this_thread::get_id());
  10093. break;
  10094. }
  10095. } else {
  10096. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10097. }
  10098. idle_thread_count_--;
  10099. if (shutdown_ && jobs_.empty()) { break; }
  10100. fn = std::move(jobs_.front());
  10101. jobs_.pop_front();
  10102. }
  10103. assert(true == static_cast<bool>(fn));
  10104. fn();
  10105. }
  10106. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10107. !defined(LIBRESSL_VERSION_NUMBER)
  10108. OPENSSL_thread_stop();
  10109. #endif
  10110. }
  10111. /*
  10112. * Group 1 (continued): detail namespace - Stream implementations
  10113. */
  10114. namespace detail {
  10115. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10116. time_t timeout_sec, time_t timeout_usec,
  10117. time_t &actual_timeout_sec,
  10118. time_t &actual_timeout_usec) {
  10119. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10120. auto actual_timeout_msec =
  10121. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10122. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10123. actual_timeout_sec = actual_timeout_msec / 1000;
  10124. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10125. }
  10126. // Socket stream implementation
  10127. inline SocketStream::SocketStream(
  10128. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10129. time_t write_timeout_sec, time_t write_timeout_usec,
  10130. time_t max_timeout_msec,
  10131. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10132. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10133. read_timeout_usec_(read_timeout_usec),
  10134. write_timeout_sec_(write_timeout_sec),
  10135. write_timeout_usec_(write_timeout_usec),
  10136. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10137. read_buff_(read_buff_size_, 0) {}
  10138. inline SocketStream::~SocketStream() = default;
  10139. inline bool SocketStream::is_readable() const {
  10140. return read_buff_off_ < read_buff_content_size_;
  10141. }
  10142. inline bool SocketStream::wait_readable() const {
  10143. if (max_timeout_msec_ <= 0) {
  10144. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10145. }
  10146. time_t read_timeout_sec;
  10147. time_t read_timeout_usec;
  10148. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10149. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10150. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10151. }
  10152. inline bool SocketStream::wait_writable() const {
  10153. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10154. }
  10155. inline bool SocketStream::ensure_readable() {
  10156. if (readable_hint_) {
  10157. readable_hint_ = false;
  10158. return true;
  10159. }
  10160. return wait_readable();
  10161. }
  10162. inline const char *SocketStream::buffered_data(size_t &size) const {
  10163. size = read_buff_content_size_ - read_buff_off_;
  10164. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10165. }
  10166. inline void SocketStream::consume_buffered(size_t size) {
  10167. assert(size <= read_buff_content_size_ - read_buff_off_);
  10168. read_buff_off_ += size;
  10169. }
  10170. inline bool SocketStream::is_peer_alive() const {
  10171. return detail::is_socket_alive(sock_);
  10172. }
  10173. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10174. #ifdef _WIN32
  10175. size =
  10176. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10177. #else
  10178. size = (std::min)(size,
  10179. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10180. #endif
  10181. if (read_buff_off_ < read_buff_content_size_) {
  10182. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10183. if (size <= remaining_size) {
  10184. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10185. read_buff_off_ += size;
  10186. return static_cast<ssize_t>(size);
  10187. } else {
  10188. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10189. read_buff_off_ += remaining_size;
  10190. return static_cast<ssize_t>(remaining_size);
  10191. }
  10192. }
  10193. if (!ensure_readable()) {
  10194. error_ = Error::Timeout;
  10195. return -1;
  10196. }
  10197. read_buff_off_ = 0;
  10198. read_buff_content_size_ = 0;
  10199. if (size < read_buff_size_) {
  10200. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10201. CPPHTTPLIB_RECV_FLAGS);
  10202. if (n <= 0) {
  10203. if (n == 0) {
  10204. error_ = Error::ConnectionClosed;
  10205. } else {
  10206. error_ = Error::Read;
  10207. }
  10208. return n;
  10209. } else if (n <= static_cast<ssize_t>(size)) {
  10210. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10211. return n;
  10212. } else {
  10213. memcpy(ptr, read_buff_.data(), size);
  10214. read_buff_off_ = size;
  10215. read_buff_content_size_ = static_cast<size_t>(n);
  10216. return static_cast<ssize_t>(size);
  10217. }
  10218. } else {
  10219. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10220. if (n <= 0) {
  10221. if (n == 0) {
  10222. error_ = Error::ConnectionClosed;
  10223. } else {
  10224. error_ = Error::Read;
  10225. }
  10226. }
  10227. return n;
  10228. }
  10229. }
  10230. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10231. if (!wait_writable()) { return -1; }
  10232. #if defined(_WIN32) && !defined(_WIN64)
  10233. size =
  10234. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10235. #endif
  10236. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10237. }
  10238. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10239. int &port) const {
  10240. return detail::get_remote_ip_and_port(sock_, ip, port);
  10241. }
  10242. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10243. int &port) const {
  10244. return detail::get_local_ip_and_port(sock_, ip, port);
  10245. }
  10246. inline socket_t SocketStream::socket() const { return sock_; }
  10247. inline time_t SocketStream::duration() const {
  10248. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10249. std::chrono::steady_clock::now() - start_time_)
  10250. .count();
  10251. }
  10252. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10253. read_timeout_sec_ = sec;
  10254. read_timeout_usec_ = usec;
  10255. }
  10256. // Buffer stream implementation
  10257. inline bool BufferStream::is_readable() const { return true; }
  10258. inline bool BufferStream::wait_readable() const { return true; }
  10259. inline bool BufferStream::wait_writable() const { return true; }
  10260. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10261. #if defined(_MSC_VER) && _MSC_VER < 1910
  10262. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10263. #else
  10264. auto len_read = buffer.copy(ptr, size, position);
  10265. #endif
  10266. position += static_cast<size_t>(len_read);
  10267. return static_cast<ssize_t>(len_read);
  10268. }
  10269. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10270. buffer.append(ptr, size);
  10271. return static_cast<ssize_t>(size);
  10272. }
  10273. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10274. int & /*port*/) const {}
  10275. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10276. int & /*port*/) const {}
  10277. inline socket_t BufferStream::socket() const { return 0; }
  10278. inline time_t BufferStream::duration() const { return 0; }
  10279. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10280. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10281. : MatcherBase(pattern) {
  10282. constexpr const char marker[] = "/:";
  10283. // One past the last ending position of a path param substring
  10284. std::size_t last_param_end = 0;
  10285. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10286. // Needed to ensure that parameter names are unique during matcher
  10287. // construction
  10288. // If exceptions are disabled, only last duplicate path
  10289. // parameter will be set
  10290. std::unordered_set<std::string> param_name_set;
  10291. #endif
  10292. while (true) {
  10293. const auto marker_pos = pattern.find(
  10294. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10295. if (marker_pos == std::string::npos) { break; }
  10296. static_fragments_.push_back(
  10297. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10298. const auto param_name_start = marker_pos + str_len(marker);
  10299. auto sep_pos = pattern.find(separator, param_name_start);
  10300. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10301. auto param_name =
  10302. pattern.substr(param_name_start, sep_pos - param_name_start);
  10303. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10304. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10305. std::string msg = "Encountered path parameter '" + param_name +
  10306. "' multiple times in route pattern '" + pattern + "'.";
  10307. throw std::invalid_argument(msg);
  10308. }
  10309. #endif
  10310. param_names_.push_back(std::move(param_name));
  10311. last_param_end = sep_pos + 1;
  10312. }
  10313. if (last_param_end < pattern.length()) {
  10314. static_fragments_.push_back(pattern.substr(last_param_end));
  10315. }
  10316. }
  10317. inline bool PathParamsMatcher::match(Request &request) const {
  10318. request.matches = std::smatch();
  10319. request.path_params.clear();
  10320. // A pattern without parameters is just a literal path to compare against
  10321. if (param_names_.empty()) { return request.path == pattern(); }
  10322. request.path_params.reserve(param_names_.size());
  10323. // One past the position at which the path matched the pattern last time
  10324. std::size_t starting_pos = 0;
  10325. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10326. const auto &fragment = static_fragments_[i];
  10327. if (starting_pos + fragment.length() > request.path.length()) {
  10328. return false;
  10329. }
  10330. // Avoid unnecessary allocation by using strncmp instead of substr +
  10331. // comparison
  10332. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10333. fragment.length()) != 0) {
  10334. return false;
  10335. }
  10336. starting_pos += fragment.length();
  10337. // Should only happen when we have a static fragment after a param
  10338. // Example: '/users/:id/subscriptions'
  10339. // The 'subscriptions' fragment here does not have a corresponding param
  10340. if (i >= param_names_.size()) { continue; }
  10341. auto sep_pos = request.path.find(separator, starting_pos);
  10342. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10343. const auto &param_name = param_names_[i];
  10344. request.path_params.emplace(
  10345. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10346. // Mark everything up to '/' as matched
  10347. starting_pos = sep_pos + 1;
  10348. }
  10349. // Returns false if the path is longer than the pattern
  10350. return starting_pos >= request.path.length();
  10351. }
  10352. inline bool RegexMatcher::match(Request &request) const {
  10353. request.path_params.clear();
  10354. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10355. // a non-match rather than risking a stack overflow in std::regex_match.
  10356. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10357. return false;
  10358. }
  10359. return std::regex_match(request.path, request.matches, regex_);
  10360. }
  10361. // Enclose IPv6 address in brackets if needed
  10362. inline std::string prepare_host_string(const std::string &host) {
  10363. // Enclose IPv6 address in brackets (but not if already enclosed)
  10364. if (host.find(':') == std::string::npos ||
  10365. (!host.empty() && host[0] == '[')) {
  10366. // IPv4, hostname, or already bracketed IPv6
  10367. return host;
  10368. } else {
  10369. // IPv6 address without brackets
  10370. return "[" + host + "]";
  10371. }
  10372. }
  10373. inline std::string make_host_and_port_string(const std::string &host, int port,
  10374. bool is_ssl) {
  10375. auto result = prepare_host_string(host);
  10376. // Append port if not default
  10377. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10378. ; // do nothing
  10379. } else {
  10380. result += ":" + std::to_string(port);
  10381. }
  10382. return result;
  10383. }
  10384. // Create "host:port" string always including port number (for CONNECT method)
  10385. inline std::string
  10386. make_host_and_port_string_always_port(const std::string &host, int port) {
  10387. return prepare_host_string(host) + ":" + std::to_string(port);
  10388. }
  10389. // Value for the Host header a client sends when the caller supplied none.
  10390. // Only the value: callers decide where in their header list it goes.
  10391. inline std::string make_default_host_header_value(const std::string &host,
  10392. int port, bool is_ssl,
  10393. int address_family) {
  10394. if (address_family == AF_UNIX) { return "localhost"; }
  10395. return make_host_and_port_string(host, port, is_ssl);
  10396. }
  10397. inline void add_default_user_agent_header(Request &req) {
  10398. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10399. if (!req.has_header("User-Agent")) {
  10400. req.set_header("User-Agent",
  10401. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10402. }
  10403. #else
  10404. (void)req;
  10405. #endif
  10406. }
  10407. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10408. NormalizedTarget normalize_target(const std::string &host);
  10409. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10410. bool host_matches_no_proxy(const NormalizedTarget &target,
  10411. const std::vector<NoProxyEntry> &entries);
  10412. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10413. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10414. if (prefix_bits == 0) { return true; }
  10415. int full_bytes = prefix_bits / 8;
  10416. int rem_bits = prefix_bits % 8;
  10417. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10418. static_cast<size_t>(full_bytes)) != 0) {
  10419. return false;
  10420. }
  10421. if (rem_bits == 0) { return true; }
  10422. auto i = static_cast<size_t>(full_bytes);
  10423. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10424. return (ip[i] & mask) == (net[i] & mask);
  10425. }
  10426. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10427. if (token.empty()) { return false; }
  10428. if (token == "*") {
  10429. out.kind = NoProxyKind::Wildcard;
  10430. return true;
  10431. }
  10432. auto slash = token.find('/');
  10433. std::string addr_part =
  10434. (slash == std::string::npos) ? token : token.substr(0, slash);
  10435. std::string prefix_part =
  10436. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10437. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10438. // don't silently treat it as a /32 (or /128).
  10439. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10440. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10441. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10442. // when brackets are present.
  10443. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10444. addr_part.back() == ']';
  10445. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10446. if (!bracketed) {
  10447. struct in_addr v4;
  10448. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10449. int prefix = 32;
  10450. if (!prefix_part.empty()) {
  10451. auto r = from_chars(prefix_part.data(),
  10452. prefix_part.data() + prefix_part.size(), prefix);
  10453. if (r.ec != std::errc{} ||
  10454. r.ptr != prefix_part.data() + prefix_part.size()) {
  10455. return false;
  10456. }
  10457. if (prefix < 0 || prefix > 32) { return false; }
  10458. }
  10459. out.kind = NoProxyKind::IPv4Cidr;
  10460. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10461. out.prefix_bits = prefix;
  10462. return true;
  10463. }
  10464. }
  10465. struct in6_addr v6;
  10466. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10467. int prefix = 128;
  10468. if (!prefix_part.empty()) {
  10469. auto r = from_chars(prefix_part.data(),
  10470. prefix_part.data() + prefix_part.size(), prefix);
  10471. if (r.ec != std::errc{} ||
  10472. r.ptr != prefix_part.data() + prefix_part.size()) {
  10473. return false;
  10474. }
  10475. if (prefix < 0 || prefix > 128) { return false; }
  10476. }
  10477. out.kind = NoProxyKind::IPv6Cidr;
  10478. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10479. out.prefix_bits = prefix;
  10480. return true;
  10481. }
  10482. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10483. // the entry is malformed — don't fall through to the hostname branch.
  10484. if (bracketed) { return false; }
  10485. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10486. if (slash != std::string::npos) { return false; }
  10487. // Port-specific entries (host:port) are not supported.
  10488. if (token.find(':') != std::string::npos) { return false; }
  10489. std::string hostname = case_ignore::to_lower(token);
  10490. while (!hostname.empty() && hostname.front() == '.') {
  10491. hostname.erase(hostname.begin());
  10492. }
  10493. while (!hostname.empty() && hostname.back() == '.') {
  10494. hostname.pop_back();
  10495. }
  10496. if (hostname.empty()) { return false; }
  10497. out.kind = NoProxyKind::HostnameSuffix;
  10498. out.hostname_pattern = std::move(hostname);
  10499. return true;
  10500. }
  10501. inline NormalizedTarget normalize_target(const std::string &host) {
  10502. NormalizedTarget t;
  10503. std::string h = host;
  10504. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10505. h = h.substr(1, h.size() - 2);
  10506. }
  10507. // Strip a single trailing dot so "example.com." canonicalizes to
  10508. // "example.com".
  10509. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10510. t.hostname = case_ignore::to_lower(h);
  10511. if (!t.hostname.empty()) {
  10512. struct in_addr v4;
  10513. struct in6_addr v6;
  10514. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10515. t.is_ipv4 = true;
  10516. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10517. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10518. t.is_ipv6 = true;
  10519. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10520. }
  10521. }
  10522. return t;
  10523. }
  10524. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10525. const std::vector<NoProxyEntry> &entries) {
  10526. if (target.hostname.empty()) { return false; }
  10527. for (const auto &e : entries) {
  10528. switch (e.kind) {
  10529. case NoProxyKind::Wildcard: return true;
  10530. case NoProxyKind::IPv4Cidr:
  10531. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10532. return true;
  10533. }
  10534. break;
  10535. case NoProxyKind::IPv6Cidr:
  10536. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10537. return true;
  10538. }
  10539. break;
  10540. case NoProxyKind::HostnameSuffix:
  10541. if (target.is_ipv4 || target.is_ipv6) { break; }
  10542. if (target.hostname == e.hostname_pattern) { return true; }
  10543. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10544. // an entry of "example.com".
  10545. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10546. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10547. if (target.hostname[offset - 1] == '.' &&
  10548. target.hostname.compare(offset, e.hostname_pattern.size(),
  10549. e.hostname_pattern) == 0) {
  10550. return true;
  10551. }
  10552. }
  10553. break;
  10554. }
  10555. }
  10556. return false;
  10557. }
  10558. template <typename T>
  10559. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10560. T header_writer, Error &error) {
  10561. for (const auto &h : headers) {
  10562. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10563. error = Error::InvalidHeaders;
  10564. return false;
  10565. }
  10566. }
  10567. if (header_writer(strm, headers) <= 0) {
  10568. error = Error::Write;
  10569. return false;
  10570. }
  10571. return true;
  10572. }
  10573. } // namespace detail
  10574. /*
  10575. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10576. */
  10577. #ifdef CPPHTTPLIB_SSL_ENABLED
  10578. namespace detail {
  10579. // SSL socket stream implementation
  10580. inline SSLSocketStream::SSLSocketStream(
  10581. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10582. time_t read_timeout_usec, time_t write_timeout_sec,
  10583. time_t write_timeout_usec, time_t max_timeout_msec,
  10584. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10585. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10586. read_timeout_usec_(read_timeout_usec),
  10587. write_timeout_sec_(write_timeout_sec),
  10588. write_timeout_usec_(write_timeout_usec),
  10589. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10590. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10591. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10592. // Note: create_session() also clears this, but SSLClient currently
  10593. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10594. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10595. // SSL session was created.
  10596. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10597. #endif
  10598. }
  10599. inline SSLSocketStream::~SSLSocketStream() = default;
  10600. inline bool SSLSocketStream::is_readable() const {
  10601. return tls::pending(session_) > 0;
  10602. }
  10603. inline bool SSLSocketStream::wait_readable() const {
  10604. if (max_timeout_msec_ <= 0) {
  10605. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10606. }
  10607. time_t read_timeout_sec;
  10608. time_t read_timeout_usec;
  10609. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10610. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10611. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10612. }
  10613. inline bool SSLSocketStream::wait_writable() const {
  10614. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10615. !tls::is_peer_closed(session_, sock_);
  10616. }
  10617. inline bool SSLSocketStream::ensure_readable() {
  10618. if (readable_hint_) {
  10619. readable_hint_ = false;
  10620. return true;
  10621. }
  10622. return wait_readable();
  10623. }
  10624. inline bool SSLSocketStream::is_peer_alive() const {
  10625. return !tls::is_peer_closed(session_, sock_);
  10626. }
  10627. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10628. if (tls::pending(session_) > 0) {
  10629. tls::TlsError err;
  10630. auto ret = tls::read(session_, ptr, size, err);
  10631. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10632. error_ = Error::ConnectionClosed;
  10633. }
  10634. return ret;
  10635. } else if (ensure_readable()) {
  10636. tls::TlsError err;
  10637. auto ret = tls::read(session_, ptr, size, err);
  10638. if (ret < 0) {
  10639. auto n = 1000;
  10640. #ifdef _WIN32
  10641. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10642. (err.code == tls::ErrorCode::SyscallError &&
  10643. WSAGetLastError() == WSAETIMEDOUT))) {
  10644. #else
  10645. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10646. #endif
  10647. if (tls::pending(session_) > 0) {
  10648. return tls::read(session_, ptr, size, err);
  10649. } else if (wait_readable()) {
  10650. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10651. ret = tls::read(session_, ptr, size, err);
  10652. if (ret >= 0) { return ret; }
  10653. } else {
  10654. break;
  10655. }
  10656. }
  10657. assert(ret < 0);
  10658. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10659. error_ = Error::ConnectionClosed;
  10660. }
  10661. return ret;
  10662. } else {
  10663. error_ = Error::Timeout;
  10664. return -1;
  10665. }
  10666. }
  10667. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10668. if (wait_writable()) {
  10669. auto handle_size =
  10670. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10671. tls::TlsError err;
  10672. auto ret = tls::write(session_, ptr, handle_size, err);
  10673. if (ret < 0) {
  10674. auto n = 1000;
  10675. #ifdef _WIN32
  10676. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10677. (err.code == tls::ErrorCode::SyscallError &&
  10678. WSAGetLastError() == WSAETIMEDOUT))) {
  10679. #else
  10680. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10681. #endif
  10682. if (wait_writable()) {
  10683. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10684. ret = tls::write(session_, ptr, handle_size, err);
  10685. if (ret >= 0) { return ret; }
  10686. } else {
  10687. break;
  10688. }
  10689. }
  10690. assert(ret < 0);
  10691. }
  10692. return ret;
  10693. }
  10694. return -1;
  10695. }
  10696. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10697. int &port) const {
  10698. detail::get_remote_ip_and_port(sock_, ip, port);
  10699. }
  10700. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10701. int &port) const {
  10702. detail::get_local_ip_and_port(sock_, ip, port);
  10703. }
  10704. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10705. inline time_t SSLSocketStream::duration() const {
  10706. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10707. std::chrono::steady_clock::now() - start_time_)
  10708. .count();
  10709. }
  10710. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10711. read_timeout_sec_ = sec;
  10712. read_timeout_usec_ = usec;
  10713. }
  10714. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10715. tls::session_t session,
  10716. time_t read_timeout_sec,
  10717. time_t read_timeout_usec,
  10718. time_t write_timeout_sec,
  10719. time_t write_timeout_usec)
  10720. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10721. read_timeout_usec_(read_timeout_usec),
  10722. write_timeout_sec_(write_timeout_sec),
  10723. write_timeout_usec_(write_timeout_usec),
  10724. start_time_(std::chrono::steady_clock::now()) {
  10725. // The receive and send paths run on different threads, so each TLS call is
  10726. // driven in non-blocking mode and readiness is awaited with select()
  10727. // outside the session lock. Set the socket non-blocking once here; it is
  10728. // never flipped back, so no thread races on the flag.
  10729. detail::set_nonblocking(sock_, true);
  10730. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10731. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10732. #endif
  10733. }
  10734. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10735. inline bool WebSocketSSLStream::is_readable() const {
  10736. std::lock_guard<std::mutex> guard(session_mutex_);
  10737. return tls::pending(session_) > 0;
  10738. }
  10739. inline bool WebSocketSSLStream::wait_readable() const {
  10740. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10741. }
  10742. inline bool WebSocketSSLStream::wait_writable() const {
  10743. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10744. // that probe toggles the socket's blocking flag, which would race with the
  10745. // concurrent reader on a permanently non-blocking socket.
  10746. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10747. }
  10748. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10749. tls::TlsError err;
  10750. auto n = 1000;
  10751. while (--n >= 0) {
  10752. {
  10753. std::lock_guard<std::mutex> guard(session_mutex_);
  10754. auto ret = tls::read(session_, ptr, size, err);
  10755. if (ret > 0) { return ret; }
  10756. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10757. error_ = Error::ConnectionClosed;
  10758. return ret;
  10759. }
  10760. }
  10761. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10762. // direction: the send path shares this session, so output it left pending
  10763. // has to be flushed before more input can be decrypted. Anything else is
  10764. // a hard error.
  10765. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10766. #ifdef _WIN32
  10767. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10768. needs_readable =
  10769. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10770. WSAGetLastError() == WSAETIMEDOUT);
  10771. #endif
  10772. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10773. error_ = Error::Read;
  10774. return -1;
  10775. }
  10776. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10777. error_ = Error::Timeout;
  10778. return -1;
  10779. }
  10780. }
  10781. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10782. // to tell a timeout from a close would otherwise see whatever the previous
  10783. // failure left behind (error_ is never cleared on success).
  10784. error_ = Error::Read;
  10785. return -1;
  10786. }
  10787. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10788. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10789. tls::TlsError err;
  10790. auto n = 1000;
  10791. while (--n >= 0) {
  10792. {
  10793. std::lock_guard<std::mutex> guard(session_mutex_);
  10794. auto ret = tls::write(session_, ptr, handle_size, err);
  10795. if (ret >= 0) { return ret; }
  10796. }
  10797. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10798. // or a post-handshake message must be consumed before the record goes
  10799. // out. Anything else is a hard error.
  10800. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10801. #ifdef _WIN32
  10802. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10803. needs_writable =
  10804. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10805. WSAGetLastError() == WSAETIMEDOUT);
  10806. #endif
  10807. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10808. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10809. }
  10810. return -1;
  10811. }
  10812. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10813. int &port) const {
  10814. detail::get_remote_ip_and_port(sock_, ip, port);
  10815. }
  10816. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10817. int &port) const {
  10818. detail::get_local_ip_and_port(sock_, ip, port);
  10819. }
  10820. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10821. inline time_t WebSocketSSLStream::duration() const {
  10822. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10823. std::chrono::steady_clock::now() - start_time_)
  10824. .count();
  10825. }
  10826. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10827. read_timeout_sec_ = sec;
  10828. read_timeout_usec_ = usec;
  10829. }
  10830. } // namespace detail
  10831. #endif // CPPHTTPLIB_SSL_ENABLED
  10832. /*
  10833. * Group 4: Server implementation
  10834. */
  10835. // HTTP server implementation
  10836. inline Server::Server()
  10837. : new_task_queue([] {
  10838. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10839. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10840. }) {
  10841. #ifndef _WIN32
  10842. signal(SIGPIPE, SIG_IGN);
  10843. #endif
  10844. }
  10845. inline Server::~Server() = default;
  10846. inline std::unique_ptr<detail::MatcherBase>
  10847. Server::make_matcher(const std::string &pattern) {
  10848. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10849. // a path params pattern
  10850. if (pattern.find("/:") != std::string::npos) {
  10851. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10852. }
  10853. // A pattern with no regex metacharacter only has to be compared literally,
  10854. // which is what PathParamsMatcher already does when it captures no
  10855. // parameter, so std::regex is only worth building for the patterns that
  10856. // actually need it
  10857. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10858. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10859. }
  10860. return detail::make_unique<detail::RegexMatcher>(pattern);
  10861. }
  10862. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10863. return add_handler(get_handlers_, pattern, std::move(handler));
  10864. }
  10865. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10866. return add_handler(post_handlers_, pattern, std::move(handler));
  10867. }
  10868. inline Server &Server::Post(const std::string &pattern,
  10869. HandlerWithContentReader handler) {
  10870. return add_handler(post_handlers_for_content_reader_, pattern,
  10871. std::move(handler));
  10872. }
  10873. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10874. return add_handler(put_handlers_, pattern, std::move(handler));
  10875. }
  10876. inline Server &Server::Put(const std::string &pattern,
  10877. HandlerWithContentReader handler) {
  10878. return add_handler(put_handlers_for_content_reader_, pattern,
  10879. std::move(handler));
  10880. }
  10881. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10882. return add_handler(patch_handlers_, pattern, std::move(handler));
  10883. }
  10884. inline Server &Server::Patch(const std::string &pattern,
  10885. HandlerWithContentReader handler) {
  10886. return add_handler(patch_handlers_for_content_reader_, pattern,
  10887. std::move(handler));
  10888. }
  10889. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10890. return add_handler(delete_handlers_, pattern, std::move(handler));
  10891. }
  10892. inline Server &Server::Delete(const std::string &pattern,
  10893. HandlerWithContentReader handler) {
  10894. return add_handler(delete_handlers_for_content_reader_, pattern,
  10895. std::move(handler));
  10896. }
  10897. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10898. return add_handler(options_handlers_, pattern, std::move(handler));
  10899. }
  10900. inline const std::set<std::string> &Server::builtin_methods() {
  10901. thread_local const std::set<std::string> methods{
  10902. "GET", "HEAD", "POST", "PUT", "DELETE",
  10903. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10904. return methods;
  10905. }
  10906. inline Server::CustomHandlerEntry *
  10907. Server::custom_entry_for_registration(const std::string &method) {
  10908. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10909. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10910. // routing() before the custom tables are consulted, so a route registered
  10911. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10912. // there and would be reachable, but they carry protocol-level meaning
  10913. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10914. // library does not route.
  10915. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10916. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10917. has_invalid_registration_ = true;
  10918. return nullptr;
  10919. }
  10920. return &custom_handlers_[method];
  10921. }
  10922. inline Server &Server::CustomRoute(const std::string &method,
  10923. const std::string &pattern,
  10924. Handler handler) {
  10925. auto *entry = custom_entry_for_registration(method);
  10926. if (!entry) { return *this; }
  10927. return add_handler(entry->handlers, pattern, std::move(handler));
  10928. }
  10929. inline Server &Server::CustomRoute(const std::string &method,
  10930. const std::string &pattern,
  10931. HandlerWithContentReader handler) {
  10932. auto *entry = custom_entry_for_registration(method);
  10933. if (!entry) { return *this; }
  10934. return add_handler(entry->handlers_for_content_reader, pattern,
  10935. std::move(handler));
  10936. }
  10937. inline const Server::CustomHandlerEntry *
  10938. Server::find_custom_entry(const std::string &method) const {
  10939. // find() alone would be correct here. The empty() check is what keeps the
  10940. // per-request cost off servers that never call CustomRoute(), which is the
  10941. // overwhelmingly common case; keep it rather than walking into the tree.
  10942. if (custom_handlers_.empty()) { return nullptr; }
  10943. auto it = custom_handlers_.find(method);
  10944. return it == custom_handlers_.end() ? nullptr : &it->second;
  10945. }
  10946. inline Server &Server::WebSocket(const std::string &pattern,
  10947. WebSocketHandler handler) {
  10948. websocket_handlers_.push_back(
  10949. {make_matcher(pattern), std::move(handler), nullptr});
  10950. return *this;
  10951. }
  10952. inline Server &Server::WebSocket(const std::string &pattern,
  10953. WebSocketHandler handler,
  10954. SubProtocolSelector sub_protocol_selector) {
  10955. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10956. std::move(sub_protocol_selector)});
  10957. return *this;
  10958. }
  10959. inline bool Server::set_base_dir(const std::string &dir,
  10960. const std::string &mount_point) {
  10961. return set_mount_point(mount_point, dir);
  10962. }
  10963. inline bool Server::set_mount_point(const std::string &mount_point,
  10964. const std::string &dir, Headers headers) {
  10965. detail::FileStat stat(dir);
  10966. if (stat.is_dir()) {
  10967. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10968. if (!mnt.empty() && mnt[0] == '/') {
  10969. std::string resolved_base;
  10970. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10971. #if defined(_WIN32)
  10972. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10973. resolved_base += '\\';
  10974. }
  10975. #else
  10976. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10977. #endif
  10978. }
  10979. base_dirs_.push_back(
  10980. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10981. return true;
  10982. }
  10983. }
  10984. return false;
  10985. }
  10986. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10987. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10988. if (it->mount_point == mount_point) {
  10989. base_dirs_.erase(it);
  10990. return true;
  10991. }
  10992. }
  10993. return false;
  10994. }
  10995. inline Server &
  10996. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10997. const std::string &mime) {
  10998. file_extension_and_mimetype_map_[ext] = mime;
  10999. return *this;
  11000. }
  11001. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11002. default_file_mimetype_ = mime;
  11003. return *this;
  11004. }
  11005. inline Server &Server::set_file_request_handler(Handler handler) {
  11006. file_request_handler_ = std::move(handler);
  11007. return *this;
  11008. }
  11009. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11010. std::true_type) {
  11011. error_handler_ = std::move(handler);
  11012. return *this;
  11013. }
  11014. inline Server &Server::set_error_handler_core(Handler handler,
  11015. std::false_type) {
  11016. error_handler_ = [handler](const Request &req, Response &res) {
  11017. handler(req, res);
  11018. return HandlerResponse::Handled;
  11019. };
  11020. return *this;
  11021. }
  11022. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11023. exception_handler_ = std::move(handler);
  11024. return *this;
  11025. }
  11026. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11027. pre_routing_handler_ = std::move(handler);
  11028. return *this;
  11029. }
  11030. inline Server &Server::set_post_routing_handler(Handler handler) {
  11031. post_routing_handler_ = std::move(handler);
  11032. return *this;
  11033. }
  11034. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11035. pre_request_handler_ = std::move(handler);
  11036. return *this;
  11037. }
  11038. inline Server &Server::set_logger(Logger logger) {
  11039. logger_ = std::move(logger);
  11040. return *this;
  11041. }
  11042. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11043. error_logger_ = std::move(error_logger);
  11044. return *this;
  11045. }
  11046. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11047. pre_compression_logger_ = std::move(logger);
  11048. return *this;
  11049. }
  11050. inline Server &
  11051. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11052. expect_100_continue_handler_ = std::move(handler);
  11053. return *this;
  11054. }
  11055. inline Server &Server::set_start_handler(StartHandler handler) {
  11056. start_handler_ = std::move(handler);
  11057. return *this;
  11058. }
  11059. inline Server &Server::set_address_family(int family) {
  11060. address_family_ = family;
  11061. return *this;
  11062. }
  11063. inline Server &Server::set_tcp_nodelay(bool on) {
  11064. tcp_nodelay_ = on;
  11065. return *this;
  11066. }
  11067. inline Server &Server::set_ipv6_v6only(bool on) {
  11068. ipv6_v6only_ = on;
  11069. return *this;
  11070. }
  11071. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11072. socket_options_ = std::move(socket_options);
  11073. return *this;
  11074. }
  11075. inline Server &Server::set_default_headers(Headers headers) {
  11076. default_headers_ = std::move(headers);
  11077. return *this;
  11078. }
  11079. inline Server &Server::set_header_writer(
  11080. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11081. header_writer_ = writer;
  11082. return *this;
  11083. }
  11084. inline Server &
  11085. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11086. trusted_proxies_ = proxies;
  11087. return *this;
  11088. }
  11089. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11090. keep_alive_max_count_ = count;
  11091. return *this;
  11092. }
  11093. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11094. keep_alive_timeout_sec_ = sec;
  11095. return *this;
  11096. }
  11097. template <class Rep, class Period>
  11098. inline Server &Server::set_keep_alive_timeout(
  11099. const std::chrono::duration<Rep, Period> &duration) {
  11100. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11101. set_keep_alive_timeout(sec);
  11102. });
  11103. return *this;
  11104. }
  11105. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11106. read_timeout_sec_ = sec;
  11107. read_timeout_usec_ = usec;
  11108. return *this;
  11109. }
  11110. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11111. write_timeout_sec_ = sec;
  11112. write_timeout_usec_ = usec;
  11113. return *this;
  11114. }
  11115. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11116. idle_interval_sec_ = sec;
  11117. idle_interval_usec_ = usec;
  11118. return *this;
  11119. }
  11120. inline Server &Server::set_payload_max_length(size_t length) {
  11121. payload_max_length_ = length;
  11122. return *this;
  11123. }
  11124. inline Server &Server::set_static_file_compression(bool on) {
  11125. static_file_compression_ = on;
  11126. return *this;
  11127. }
  11128. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11129. static_file_compression_min_length_ = length;
  11130. return *this;
  11131. }
  11132. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11133. static_file_compression_max_length_ = length;
  11134. return *this;
  11135. }
  11136. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11137. websocket_max_missed_pongs_ = count;
  11138. return *this;
  11139. }
  11140. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11141. websocket_ping_interval_sec_ = sec;
  11142. return *this;
  11143. }
  11144. template <class Rep, class Period>
  11145. inline Server &Server::set_websocket_ping_interval(
  11146. const std::chrono::duration<Rep, Period> &duration) {
  11147. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11148. set_websocket_ping_interval(sec);
  11149. });
  11150. return *this;
  11151. }
  11152. inline bool Server::bind_to_port(const std::string &host, int port,
  11153. int socket_flags) {
  11154. auto ret = bind_internal(host, port, socket_flags);
  11155. if (ret == -1) { is_decommissioned = true; }
  11156. return ret >= 0;
  11157. }
  11158. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11159. auto ret = bind_internal(host, 0, socket_flags);
  11160. if (ret == -1) { is_decommissioned = true; }
  11161. return ret;
  11162. }
  11163. inline bool Server::listen_after_bind() { return listen_internal(); }
  11164. inline bool Server::listen(const std::string &host, int port,
  11165. int socket_flags) {
  11166. return bind_to_port(host, port, socket_flags) && listen_internal();
  11167. }
  11168. inline bool Server::is_running() const { return is_running_; }
  11169. inline void Server::wait_until_ready() const {
  11170. while (!is_running_ && !is_decommissioned) {
  11171. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11172. }
  11173. }
  11174. inline void Server::stop() noexcept {
  11175. // Release the listening socket whether or not the accept loop is running:
  11176. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11177. // exchange is what makes this safe to call concurrently with the accept loop.
  11178. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11179. if (sock != INVALID_SOCKET) {
  11180. detail::shutdown_socket(sock);
  11181. detail::close_socket(sock);
  11182. }
  11183. is_decommissioned = false;
  11184. }
  11185. inline void Server::decommission() { is_decommissioned = true; }
  11186. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11187. auto len = strlen(s);
  11188. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11189. len -= 2;
  11190. {
  11191. size_t count = 0;
  11192. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11193. switch (count) {
  11194. case 0: req.method = std::string(b, e); break;
  11195. case 1: req.target = std::string(b, e); break;
  11196. case 2: req.version = std::string(b, e); break;
  11197. default: break;
  11198. }
  11199. count++;
  11200. });
  11201. if (count != 3) { return false; }
  11202. }
  11203. // A method outside the built-in set is accepted only when a handler has been
  11204. // registered for it with CustomRoute().
  11205. const auto &methods = builtin_methods();
  11206. if (methods.find(req.method) == methods.end() &&
  11207. !find_custom_entry(req.method)) {
  11208. output_error_log(Error::InvalidHTTPMethod, &req);
  11209. return false;
  11210. }
  11211. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11212. output_error_log(Error::InvalidHTTPVersion, &req);
  11213. return false;
  11214. }
  11215. {
  11216. // Skip URL fragment
  11217. for (size_t i = 0; i < req.target.size(); i++) {
  11218. if (req.target[i] == '#') {
  11219. req.target.erase(i);
  11220. break;
  11221. }
  11222. }
  11223. detail::divide(req.target, '?',
  11224. [&](const char *lhs_data, std::size_t lhs_size,
  11225. const char *rhs_data, std::size_t rhs_size) {
  11226. req.path =
  11227. decode_path_component(std::string(lhs_data, lhs_size));
  11228. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11229. });
  11230. }
  11231. return true;
  11232. }
  11233. inline bool Server::write_response(Stream &strm, bool close_connection,
  11234. Request &req, Response &res) {
  11235. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11236. // incorrectly to the error content.
  11237. req.ranges.clear();
  11238. return write_response_core(strm, close_connection, req, res, false);
  11239. }
  11240. inline bool Server::write_response_with_content(Stream &strm,
  11241. bool close_connection,
  11242. const Request &req,
  11243. Response &res) {
  11244. return write_response_core(strm, close_connection, req, res, true);
  11245. }
  11246. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11247. const Request &req, Response &res,
  11248. bool need_apply_ranges) {
  11249. assert(res.status != -1);
  11250. if (400 <= res.status && error_handler_ &&
  11251. error_handler_(req, res) == HandlerResponse::Handled) {
  11252. need_apply_ranges = true;
  11253. }
  11254. std::string content_type;
  11255. std::string boundary;
  11256. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11257. // Prepare additional headers
  11258. if (close_connection ||
  11259. detail::has_header_token(req.headers, "Connection", "close") ||
  11260. 400 <= res.status || // Don't leave connections open after errors
  11261. // The client withholds the body until `100 Continue`, which was never
  11262. // sent, so whether and when the body follows is unknown.
  11263. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11264. res.set_header("Connection", "close");
  11265. } else {
  11266. std::string s = "timeout=";
  11267. s += std::to_string(keep_alive_timeout_sec_);
  11268. s += ", max=";
  11269. s += std::to_string(keep_alive_max_count_);
  11270. res.set_header("Keep-Alive", s);
  11271. }
  11272. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11273. !res.has_header("Content-Type")) {
  11274. res.set_header("Content-Type", "text/plain");
  11275. }
  11276. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11277. !res.has_header("Content-Length")) {
  11278. res.set_header("Content-Length", "0");
  11279. }
  11280. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11281. res.set_header("Accept-Ranges", "bytes");
  11282. }
  11283. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11284. // Response line and headers
  11285. detail::BufferStream bstrm;
  11286. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11287. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11288. // Combine a small body with the headers so the whole response leaves in a
  11289. // single write. A large body is written on its own instead: a copy of it
  11290. // costs more than the extra write saves.
  11291. auto send_body = req.method != "HEAD";
  11292. auto body_is_separate = false;
  11293. auto provider_done = false;
  11294. if (send_body && !res.body.empty() && !res.content_provider_) {
  11295. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11296. bstrm.write(res.body.data(), res.body.size());
  11297. } else {
  11298. body_is_separate = true;
  11299. }
  11300. } else if (send_body && res.content_provider_ &&
  11301. res.is_file_content_provider_ &&
  11302. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11303. // A small file is read into the same buffer. Other providers may produce
  11304. // their data over time, so they are never held back.
  11305. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11306. return false;
  11307. }
  11308. provider_done = true;
  11309. }
  11310. // Log before writing to avoid race condition with client-side code that
  11311. // accesses logger-captured data immediately after receiving the response.
  11312. output_log(req, res);
  11313. // Flush buffer
  11314. auto &data = bstrm.get_buffer();
  11315. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11316. if (body_is_separate) {
  11317. return detail::write_data(strm, res.body.data(), res.body.size());
  11318. }
  11319. // Streaming body
  11320. if (send_body && res.content_provider_) {
  11321. if (!provider_done &&
  11322. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11323. return false;
  11324. }
  11325. res.content_provider_success_ = true;
  11326. }
  11327. return true;
  11328. }
  11329. inline bool
  11330. Server::write_content_with_provider(Stream &strm, const Request &req,
  11331. Response &res, const std::string &boundary,
  11332. const std::string &content_type) {
  11333. auto is_shutting_down = [this]() {
  11334. return this->svr_sock_ == INVALID_SOCKET;
  11335. };
  11336. if (res.content_length_ > 0) {
  11337. // Only a 206 response is served as a partial representation, matching the
  11338. // condition `apply_ranges()` used to decide the Content-Length and the
  11339. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11340. // only for a 2xx status, slicing under any other status would write a body
  11341. // that disagrees with the header already sent, from an unchecked offset.
  11342. auto is_partial =
  11343. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11344. if (!is_partial) {
  11345. return detail::write_content(strm, res.content_provider_, 0,
  11346. res.content_length_, is_shutting_down);
  11347. } else if (req.ranges.size() == 1) {
  11348. auto offset_and_length = detail::get_range_offset_and_length(
  11349. req.ranges[0], res.content_length_);
  11350. return detail::write_content(strm, res.content_provider_,
  11351. offset_and_length.first,
  11352. offset_and_length.second, is_shutting_down);
  11353. } else {
  11354. return detail::write_multipart_ranges_data(
  11355. strm, req, res, boundary, content_type, res.content_length_,
  11356. is_shutting_down);
  11357. }
  11358. } else {
  11359. if (res.is_chunked_content_provider_) {
  11360. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11361. // re-negotiating here would disagree with them, e.g. once a handler's
  11362. // own Content-Encoding header suppresses the negotiation.
  11363. auto compressor = detail::make_compressor(res.content_coding_);
  11364. if (!compressor) {
  11365. compressor = detail::make_unique<detail::nocompressor>();
  11366. }
  11367. return detail::write_content_chunked(strm, res.content_provider_,
  11368. is_shutting_down, *compressor);
  11369. } else {
  11370. return detail::write_content_without_length(strm, res.content_provider_,
  11371. is_shutting_down);
  11372. }
  11373. }
  11374. }
  11375. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11376. FormFields::iterator cur_field;
  11377. FormFiles::iterator cur_file;
  11378. auto is_text_field = false;
  11379. size_t count = 0;
  11380. if (read_content_core(
  11381. strm, req, res,
  11382. // Regular
  11383. [&](const char *buf, size_t n) {
  11384. // Prevent arithmetic overflow when checking sizes.
  11385. // Avoid computing (req.body.size() + n) directly because
  11386. // adding two unsigned `size_t` values can wrap around and
  11387. // produce a small result instead of indicating overflow.
  11388. // Instead, check using subtraction: ensure `n` does not
  11389. // exceed the remaining capacity `max_size() - size()`.
  11390. if (req.body.size() >= req.body.max_size() ||
  11391. n > req.body.max_size() - req.body.size()) {
  11392. return false;
  11393. }
  11394. // Limit decompressed body size to payload_max_length_ to protect
  11395. // against "zip bomb" attacks where a small compressed payload
  11396. // decompresses to a massive size.
  11397. if (payload_max_length_ > 0 &&
  11398. (req.body.size() >= payload_max_length_ ||
  11399. n > payload_max_length_ - req.body.size())) {
  11400. return false;
  11401. }
  11402. req.body.append(buf, n);
  11403. return true;
  11404. },
  11405. // Multipart FormData
  11406. [&](const FormData &file) {
  11407. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11408. output_error_log(Error::TooManyFormDataFiles, &req);
  11409. return false;
  11410. }
  11411. if (file.filename.empty()) {
  11412. cur_field = req.form.fields.emplace(
  11413. file.name, FormField{file.name, file.content, file.headers});
  11414. is_text_field = true;
  11415. } else {
  11416. cur_file = req.form.files.emplace(file.name, file);
  11417. is_text_field = false;
  11418. }
  11419. return true;
  11420. },
  11421. [&](const char *buf, size_t n) {
  11422. if (is_text_field) {
  11423. auto &content = cur_field->second.content;
  11424. if (content.size() + n > content.max_size()) { return false; }
  11425. content.append(buf, n);
  11426. } else {
  11427. auto &content = cur_file->second.content;
  11428. if (content.size() + n > content.max_size()) { return false; }
  11429. content.append(buf, n);
  11430. }
  11431. return true;
  11432. })) {
  11433. const auto &content_type = req.get_header_value("Content-Type");
  11434. if (detail::extract_media_type(content_type) ==
  11435. "application/x-www-form-urlencoded") {
  11436. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11437. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11438. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11439. return false;
  11440. }
  11441. detail::parse_query_text(req.body, req.params);
  11442. }
  11443. return true;
  11444. }
  11445. return false;
  11446. }
  11447. inline bool Server::read_content_with_content_receiver(
  11448. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11449. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11450. return read_content_core(strm, req, res, std::move(receiver),
  11451. std::move(multipart_header),
  11452. std::move(multipart_receiver));
  11453. }
  11454. inline bool Server::read_content_core(
  11455. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11456. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11457. detail::FormDataParser multipart_form_data_parser;
  11458. ContentReceiverWithProgress out;
  11459. if (req.is_multipart_form_data()) {
  11460. const auto &content_type = req.get_header_value("Content-Type");
  11461. std::string boundary;
  11462. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11463. res.status = StatusCode::BadRequest_400;
  11464. output_error_log(Error::MultipartParsing, &req);
  11465. return false;
  11466. }
  11467. multipart_form_data_parser.set_boundary(std::move(boundary));
  11468. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11469. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11470. multipart_receiver);
  11471. };
  11472. } else {
  11473. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11474. size_t /*len*/) { return receiver(buf, n); };
  11475. }
  11476. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11477. // For non-SSL builds we still scan non-persistent connections for stray
  11478. // body bytes so the payload limit is enforced (413). On keep-alive,
  11479. // pending bytes may be the next request (issue #2450), so skip.
  11480. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11481. if (!req.has_header("Content-Length") &&
  11482. !detail::is_chunked_transfer_encoding(req.headers)) {
  11483. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11484. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11485. auto has_data = strm.is_readable();
  11486. if (!has_data) {
  11487. auto s = strm.socket();
  11488. if (s != INVALID_SOCKET) {
  11489. has_data = detail::select_read(s, 0, 0) > 0;
  11490. }
  11491. }
  11492. if (has_data) {
  11493. // Route through the same decompressing reader used by the
  11494. // length-framed and chunked paths below, so payload_max_length_ is
  11495. // enforced on the decompressed size here too instead of only on the
  11496. // compressed wire bytes.
  11497. return detail::read_content(strm, req, payload_max_length_, res.status,
  11498. nullptr, out, true);
  11499. }
  11500. }
  11501. return true;
  11502. }
  11503. #else
  11504. if (!req.has_header("Content-Length") &&
  11505. !detail::is_chunked_transfer_encoding(req.headers)) {
  11506. return true;
  11507. }
  11508. #endif
  11509. // The client is waiting for this before it sends the body.
  11510. if (req.expect_100_continue_pending_) {
  11511. req.expect_100_continue_pending_ = false;
  11512. detail::write_response_line(strm, StatusCode::Continue_100);
  11513. strm.write("\r\n");
  11514. }
  11515. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11516. out, true)) {
  11517. return false;
  11518. }
  11519. req.body_consumed_ = true;
  11520. if (req.is_multipart_form_data()) {
  11521. if (!multipart_form_data_parser.is_valid()) {
  11522. res.status = StatusCode::BadRequest_400;
  11523. output_error_log(Error::MultipartParsing, &req);
  11524. return false;
  11525. }
  11526. }
  11527. return true;
  11528. }
  11529. inline bool Server::handle_file_request(Request &req, Response &res) {
  11530. for (const auto &entry : base_dirs_) {
  11531. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11532. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11533. // One that already ends in '/' (the root mount among them) carries its own
  11534. // boundary; set_mount_point() guarantees the mount point is not empty.
  11535. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11536. (entry.mount_point.back() == '/' ||
  11537. req.path.size() == entry.mount_point.size() ||
  11538. req.path[entry.mount_point.size()] == '/')) {
  11539. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11540. if (detail::is_valid_path(sub_path)) {
  11541. auto path = entry.base_dir + sub_path;
  11542. if (path.back() == '/') { path += "index.html"; }
  11543. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11544. // but symlinks/junctions can still escape the base directory.
  11545. if (!entry.resolved_base_dir.empty()) {
  11546. std::string resolved_path;
  11547. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11548. !detail::is_path_within_base(resolved_path,
  11549. entry.resolved_base_dir)) {
  11550. res.status = StatusCode::Forbidden_403;
  11551. return true;
  11552. }
  11553. }
  11554. detail::FileStat stat(path);
  11555. if (stat.is_dir()) {
  11556. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11557. return true;
  11558. }
  11559. if (stat.is_file()) {
  11560. for (const auto &kv : entry.headers) {
  11561. res.set_header(kv.first, kv.second);
  11562. }
  11563. auto content_type_of = [&]() {
  11564. return detail::find_content_type(
  11565. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11566. };
  11567. // Only the ETag needs the content type this early, and only to name
  11568. // the coding. Deciding it here would otherwise put a regex in front
  11569. // of the 304 below, which serving a file never used to pay for.
  11570. std::string content_type;
  11571. auto encoding = detail::EncodingType::None;
  11572. if (static_file_compression_) {
  11573. content_type = content_type_of();
  11574. encoding =
  11575. static_file_encoding(req, res, content_type, stat.size());
  11576. }
  11577. // The ETag names the representation actually sent, so a client that
  11578. // cached the compressed form revalidates against the compressed ETag
  11579. // and still gets a 304, while one that took identity keeps the plain
  11580. // ETag.
  11581. auto etag = detail::compute_etag(
  11582. stat, encoding == detail::EncodingType::None
  11583. ? std::string()
  11584. : std::string("-") + detail::encoding_name(encoding));
  11585. if (!etag.empty()) { res.set_header("ETag", etag); }
  11586. auto mtime = stat.mtime();
  11587. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11588. if (!last_modified.empty()) {
  11589. res.set_header("Last-Modified", last_modified);
  11590. }
  11591. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11592. check_if_range(req, etag, mtime);
  11593. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11594. if (!mm->is_open()) {
  11595. output_error_log(Error::OpenFile, &req);
  11596. return false;
  11597. }
  11598. if (!static_file_compression_) { content_type = content_type_of(); }
  11599. detail::set_file_content_provider(res, mm, content_type, encoding);
  11600. if (req.method != "HEAD" && file_request_handler_) {
  11601. file_request_handler_(req, res);
  11602. }
  11603. return true;
  11604. } else {
  11605. output_error_log(Error::OpenFile, &req);
  11606. }
  11607. }
  11608. }
  11609. }
  11610. return false;
  11611. }
  11612. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11613. const std::string &etag,
  11614. time_t mtime) const {
  11615. // Handle conditional GET:
  11616. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11617. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11618. if (req.has_header("If-None-Match")) {
  11619. if (!etag.empty()) {
  11620. auto val =
  11621. detail::get_combined_header_value(req.headers, "If-None-Match");
  11622. // NOTE: We use exact string matching here. This works correctly
  11623. // because our server always generates weak ETags (W/"..."), and
  11624. // clients typically send back the same ETag they received.
  11625. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11626. // If-None-Match, where W/"x" and "x" would match, but this
  11627. // simplified implementation requires exact matches.
  11628. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11629. [&](const char *b, const char *e) {
  11630. auto seg_len = static_cast<size_t>(e - b);
  11631. return (seg_len == 1 && *b == '*') ||
  11632. (seg_len == etag.size() &&
  11633. std::equal(b, e, etag.begin()));
  11634. });
  11635. if (ret) {
  11636. res.status = StatusCode::NotModified_304;
  11637. return true;
  11638. }
  11639. }
  11640. } else if (req.has_header("If-Modified-Since")) {
  11641. auto val = req.get_header_value("If-Modified-Since");
  11642. auto t = detail::parse_http_date(val);
  11643. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11644. res.status = StatusCode::NotModified_304;
  11645. return true;
  11646. }
  11647. }
  11648. return false;
  11649. }
  11650. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11651. time_t mtime) const {
  11652. // Handle If-Range for partial content requests (RFC 9110
  11653. // Section 13.1.5). If-Range is only evaluated when Range header is
  11654. // present. If the validator matches, serve partial content; otherwise
  11655. // serve full content.
  11656. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11657. auto val = req.get_header_value("If-Range");
  11658. auto is_valid_range = [&]() {
  11659. if (detail::is_strong_etag(val)) {
  11660. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11661. // comparison.
  11662. return (!etag.empty() && val == etag);
  11663. } else if (detail::is_weak_etag(val)) {
  11664. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11665. return false;
  11666. } else {
  11667. // HTTP-date comparison
  11668. auto t = detail::parse_http_date(val);
  11669. return (t != static_cast<time_t>(-1) && mtime <= t);
  11670. }
  11671. };
  11672. if (!is_valid_range()) {
  11673. // Validator doesn't match: ignore Range and serve full content
  11674. req.ranges.clear();
  11675. return false;
  11676. }
  11677. }
  11678. return true;
  11679. }
  11680. inline socket_t
  11681. Server::create_server_socket(const std::string &host, int port,
  11682. int socket_flags,
  11683. SocketOptions socket_options) const {
  11684. return detail::create_socket(
  11685. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11686. ipv6_v6only_, std::move(socket_options),
  11687. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11688. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11689. output_error_log(Error::BindIPAddress, nullptr);
  11690. return false;
  11691. }
  11692. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11693. output_error_log(Error::Listen, nullptr);
  11694. return false;
  11695. }
  11696. return true;
  11697. });
  11698. }
  11699. inline int Server::bind_internal(const std::string &host, int port,
  11700. int socket_flags) {
  11701. if (is_decommissioned) { return -1; }
  11702. if (!is_valid()) { return -1; }
  11703. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11704. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11705. if (port == 0) {
  11706. struct sockaddr_storage addr;
  11707. socklen_t addr_len = sizeof(addr);
  11708. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11709. &addr_len) == -1) {
  11710. output_error_log(Error::GetSockName, nullptr);
  11711. return -1;
  11712. }
  11713. if (addr.ss_family == AF_INET) {
  11714. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11715. } else if (addr.ss_family == AF_INET6) {
  11716. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11717. } else {
  11718. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11719. return -1;
  11720. }
  11721. } else {
  11722. return port;
  11723. }
  11724. }
  11725. inline bool Server::listen_internal() {
  11726. // A stop() between bind and listen leaves nothing to accept on. Report
  11727. // failure instead of returning success without ever serving, and mark the
  11728. // server decommissioned the way any failed listen does so that a concurrent
  11729. // wait_until_ready() wakes up instead of spinning forever.
  11730. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11731. is_decommissioned = true;
  11732. return false;
  11733. }
  11734. auto ret = true;
  11735. is_running_ = true;
  11736. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11737. if (start_handler_) { start_handler_(); }
  11738. {
  11739. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11740. while (svr_sock_ != INVALID_SOCKET) {
  11741. #ifndef _WIN32
  11742. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11743. #endif
  11744. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11745. idle_interval_usec_);
  11746. if (val == 0) { // Timeout
  11747. task_queue->on_idle();
  11748. continue;
  11749. }
  11750. #ifndef _WIN32
  11751. }
  11752. #endif
  11753. #if defined _WIN32
  11754. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11755. // OVERLAPPED
  11756. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11757. #elif defined SOCK_CLOEXEC
  11758. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11759. #else
  11760. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11761. #endif
  11762. if (sock == INVALID_SOCKET) {
  11763. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11764. // touches the CRT errno, so the two have to be asked platform by
  11765. // platform rather than by testing errno here.
  11766. if (detail::is_accept_resource_error()) {
  11767. // The per-process descriptor limit or the network stack's buffer
  11768. // space has been reached. Try to accept new connections after a
  11769. // short sleep.
  11770. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11771. continue;
  11772. } else if (detail::is_accept_transient_error()) {
  11773. continue;
  11774. }
  11775. // Take the descriptor out of svr_sock_ before closing it: a later
  11776. // stop() would otherwise shutdown()/close() a value the OS may have
  11777. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11778. // gone. The exchange also settles the race with a concurrent stop(),
  11779. // since whichever side takes the descriptor closes it exactly once.
  11780. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11781. if (listen_sock != INVALID_SOCKET) {
  11782. detail::close_socket(listen_sock);
  11783. ret = false;
  11784. output_error_log(Error::Connection, nullptr);
  11785. } else {
  11786. ; // The server socket was closed by user.
  11787. }
  11788. break;
  11789. }
  11790. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11791. read_timeout_sec_, read_timeout_usec_);
  11792. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11793. write_timeout_sec_, write_timeout_usec_);
  11794. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11795. if (!task_queue->enqueue(
  11796. [this, sock]() { process_and_close_socket(sock); })) {
  11797. output_error_log(Error::ResourceExhaustion, nullptr);
  11798. detail::shutdown_socket(sock);
  11799. detail::close_socket(sock);
  11800. }
  11801. }
  11802. task_queue->shutdown();
  11803. }
  11804. is_decommissioned = !ret;
  11805. return ret;
  11806. }
  11807. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11808. if (pre_routing_handler_ &&
  11809. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11810. return true;
  11811. }
  11812. // File handler
  11813. if ((req.method == "GET" || req.method == "HEAD") &&
  11814. handle_file_request(req, res)) {
  11815. return true;
  11816. }
  11817. const auto *custom = find_custom_entry(req.method);
  11818. // The second clause mirrors what expect_content() does unconditionally for
  11819. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11820. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11821. // `allprop`) would skip its handler and fall through to 404.
  11822. if (detail::expect_content(req) ||
  11823. (custom && !custom->handlers_for_content_reader.empty())) {
  11824. // Content reader handler
  11825. {
  11826. // Track whether the ContentReader was aborted due to the decompressed
  11827. // payload exceeding `payload_max_length_`.
  11828. // The user handler runs after the lambda returns, so we must restore the
  11829. // 413 status if the handler overwrites it.
  11830. bool content_reader_payload_too_large = false;
  11831. ContentReader reader(
  11832. [&](ContentReceiver receiver) {
  11833. auto result = read_content_with_content_receiver(
  11834. strm, req, res, std::move(receiver), nullptr, nullptr);
  11835. if (!result) {
  11836. output_error_log(Error::Read, &req);
  11837. if (res.status == StatusCode::PayloadTooLarge_413) {
  11838. content_reader_payload_too_large = true;
  11839. }
  11840. }
  11841. return result;
  11842. },
  11843. [&](FormDataHeader header, ContentReceiver receiver) {
  11844. auto result = read_content_with_content_receiver(
  11845. strm, req, res, nullptr, std::move(header),
  11846. std::move(receiver));
  11847. if (!result) {
  11848. output_error_log(Error::Read, &req);
  11849. if (res.status == StatusCode::PayloadTooLarge_413) {
  11850. content_reader_payload_too_large = true;
  11851. }
  11852. }
  11853. return result;
  11854. });
  11855. bool dispatched = false;
  11856. if (req.method == "POST") {
  11857. dispatched = dispatch_request_for_content_reader(
  11858. req, res, std::move(reader), post_handlers_for_content_reader_);
  11859. } else if (req.method == "PUT") {
  11860. dispatched = dispatch_request_for_content_reader(
  11861. req, res, std::move(reader), put_handlers_for_content_reader_);
  11862. } else if (req.method == "PATCH") {
  11863. dispatched = dispatch_request_for_content_reader(
  11864. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11865. } else if (req.method == "DELETE") {
  11866. dispatched = dispatch_request_for_content_reader(
  11867. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11868. } else if (custom) {
  11869. dispatched = dispatch_request_for_content_reader(
  11870. req, res, std::move(reader), custom->handlers_for_content_reader);
  11871. }
  11872. if (dispatched) {
  11873. if (content_reader_payload_too_large) {
  11874. // Enforce the limit: override any status the handler may have set
  11875. // and return false so the error path sends a plain 413 response.
  11876. res.status = StatusCode::PayloadTooLarge_413;
  11877. res.body.clear();
  11878. res.content_length_ = 0;
  11879. res.content_provider_ = nullptr;
  11880. return false;
  11881. }
  11882. return true;
  11883. }
  11884. }
  11885. // NOTE: `req.body` is not read here. For a regular handler the body is
  11886. // read inside dispatch_request(), after the route has matched and the
  11887. // pre-request handler has approved the request, so that a rejected
  11888. // request (e.g. failed authentication) never forces us to buffer a
  11889. // potentially large body.
  11890. }
  11891. // Regular handler
  11892. if (req.method == "GET" || req.method == "HEAD") {
  11893. return dispatch_request(req, res, get_handlers_, strm);
  11894. } else if (req.method == "POST") {
  11895. return dispatch_request(req, res, post_handlers_, strm);
  11896. } else if (req.method == "PUT") {
  11897. return dispatch_request(req, res, put_handlers_, strm);
  11898. } else if (req.method == "DELETE") {
  11899. return dispatch_request(req, res, delete_handlers_, strm);
  11900. } else if (req.method == "OPTIONS") {
  11901. return dispatch_request(req, res, options_handlers_, strm);
  11902. } else if (req.method == "PATCH") {
  11903. return dispatch_request(req, res, patch_handlers_, strm);
  11904. } else if (custom) {
  11905. return dispatch_request(req, res, custom->handlers, strm);
  11906. }
  11907. res.status = StatusCode::BadRequest_400;
  11908. return false;
  11909. }
  11910. inline bool Server::dispatch_request(Request &req, Response &res,
  11911. const Handlers &handlers, Stream &strm) {
  11912. for (const auto &x : handlers) {
  11913. const auto &matcher = x.first;
  11914. const auto &handler = x.second;
  11915. if (matcher->match(req)) {
  11916. req.matched_route = matcher->pattern();
  11917. // Run the pre-request handler before reading the body so a rejected
  11918. // request (e.g. failed authentication) never forces us to buffer a
  11919. // potentially large body. `req.matched_route` is available here.
  11920. if (pre_request_handler_ &&
  11921. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11922. return true;
  11923. }
  11924. // The route matched and the request was approved; read the body now.
  11925. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11926. output_error_log(Error::Read, &req);
  11927. return false;
  11928. }
  11929. handler(req, res);
  11930. return true;
  11931. }
  11932. }
  11933. return false;
  11934. }
  11935. // Decides the content coding for a response served straight from a file. Both
  11936. // the ETag, which has to name the representation actually sent, and
  11937. // `apply_static_file_compression()` go through this, so the two cannot drift
  11938. // apart.
  11939. inline detail::EncodingType
  11940. Server::static_file_encoding(const Request &req, const Response &res,
  11941. const std::string &content_type,
  11942. size_t length) const {
  11943. if (!static_file_compression_) { return detail::EncodingType::None; }
  11944. // Nothing to compress, and an empty file already answers with
  11945. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11946. // turn an empty body into a 20-byte gzip stream.
  11947. if (length == 0) { return detail::EncodingType::None; }
  11948. // A file that already fits in a single packet gains nothing from being made
  11949. // smaller, since it still travels in that one segment, and a file of a few
  11950. // bytes comes out larger than it went in.
  11951. if (length < static_file_compression_min_length_) {
  11952. return detail::EncodingType::None;
  11953. }
  11954. // RFC 9110 applies Range to the representation after content coding, so a
  11955. // compressed 206 would mean compressing the whole file and then slicing it.
  11956. // Serve ranges from the identity representation instead.
  11957. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11958. if (static_file_compression_max_length_ > 0 &&
  11959. length > static_file_compression_max_length_) {
  11960. return detail::EncodingType::None;
  11961. }
  11962. return detail::encoding_type(req, res, content_type);
  11963. }
  11964. // Compresses a file-backed content provider into `res.body` and takes over the
  11965. // framing headers. Returns false when the response is left untouched.
  11966. inline bool Server::apply_static_file_compression(const Request &req,
  11967. Response &res) const {
  11968. auto type = res.content_coding_;
  11969. if (type == detail::EncodingType::None || !res.content_provider_) {
  11970. return false;
  11971. }
  11972. auto compressor = detail::make_compressor(type);
  11973. if (!compressor) { return false; }
  11974. output_pre_compression_log(req, res);
  11975. std::string compressed;
  11976. if (!detail::compress_content_provider(res.content_provider_,
  11977. res.content_length_, *compressor,
  11978. compressed)) {
  11979. return false;
  11980. }
  11981. res.body.swap(compressed);
  11982. // The provider was consumed in full, so a resource releaser registered with
  11983. // it should hear about a success when the response goes away.
  11984. res.content_provider_success_ = true;
  11985. res.content_provider_ = nullptr;
  11986. res.content_length_ = 0;
  11987. res.content_coding_ = detail::EncodingType::None;
  11988. res.set_header("Content-Encoding", detail::encoding_name(type));
  11989. res.set_header("Vary", "Accept-Encoding");
  11990. res.set_header("Content-Length", std::to_string(res.body.size()));
  11991. return true;
  11992. }
  11993. inline void Server::apply_ranges(const Request &req, Response &res,
  11994. std::string &content_type,
  11995. std::string &boundary) const {
  11996. // A known-length content provider leaves `res.body` empty, so the compressor
  11997. // at the end of this function never runs for one (issue #2545). A file-backed
  11998. // provider is fully readable right here, so compress it and answer with an
  11999. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12000. // takes the same path as `set_content()` from here on. Range requests never
  12001. // get a content coding, so `Content-Range` still names identity bytes and
  12002. // none of the framing below applies.
  12003. if (apply_static_file_compression(req, res)) { return; }
  12004. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12005. auto it = res.headers.find("Content-Type");
  12006. if (it != res.headers.end()) {
  12007. content_type = it->second;
  12008. res.headers.erase(it);
  12009. }
  12010. boundary = detail::make_multipart_data_boundary();
  12011. res.set_header("Content-Type",
  12012. "multipart/byteranges; boundary=" + boundary);
  12013. }
  12014. auto type = detail::encoding_type(req, res);
  12015. if (res.body.empty()) {
  12016. if (res.content_length_ > 0) {
  12017. size_t length = 0;
  12018. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12019. length = res.content_length_;
  12020. } else if (req.ranges.size() == 1) {
  12021. auto offset_and_length = detail::get_range_offset_and_length(
  12022. req.ranges[0], res.content_length_);
  12023. length = offset_and_length.second;
  12024. auto content_range = detail::make_content_range_header_field(
  12025. offset_and_length, res.content_length_);
  12026. res.set_header("Content-Range", content_range);
  12027. } else {
  12028. length = detail::get_multipart_ranges_data_length(
  12029. req, boundary, content_type, res.content_length_);
  12030. }
  12031. res.set_header("Content-Length", std::to_string(length));
  12032. } else {
  12033. if (res.content_provider_) {
  12034. if (res.is_chunked_content_provider_) {
  12035. res.set_header("Transfer-Encoding", "chunked");
  12036. res.content_coding_ = type;
  12037. if (type != detail::EncodingType::None) {
  12038. res.set_header("Content-Encoding", detail::encoding_name(type));
  12039. res.set_header("Vary", "Accept-Encoding");
  12040. }
  12041. }
  12042. }
  12043. }
  12044. } else {
  12045. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12046. ;
  12047. } else if (req.ranges.size() == 1) {
  12048. auto offset_and_length =
  12049. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12050. auto offset = offset_and_length.first;
  12051. auto length = offset_and_length.second;
  12052. auto content_range = detail::make_content_range_header_field(
  12053. offset_and_length, res.body.size());
  12054. res.set_header("Content-Range", content_range);
  12055. assert(offset + length <= res.body.size());
  12056. res.body = res.body.substr(offset, length);
  12057. } else {
  12058. std::string data;
  12059. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12060. res.body.size(), data);
  12061. res.body.swap(data);
  12062. }
  12063. if (type != detail::EncodingType::None) {
  12064. output_pre_compression_log(req, res);
  12065. if (auto compressor = detail::make_compressor(type)) {
  12066. std::string compressed;
  12067. if (compressor->compress(res.body.data(), res.body.size(), true,
  12068. [&](const char *data, size_t data_len) {
  12069. compressed.append(data, data_len);
  12070. return true;
  12071. })) {
  12072. res.body.swap(compressed);
  12073. res.set_header("Content-Encoding", detail::encoding_name(type));
  12074. res.set_header("Vary", "Accept-Encoding");
  12075. }
  12076. }
  12077. }
  12078. res.content_length_ = res.body.size();
  12079. res.set_header("Content-Length", std::to_string(res.content_length_));
  12080. }
  12081. }
  12082. inline bool Server::dispatch_request_for_content_reader(
  12083. Request &req, Response &res, ContentReader content_reader,
  12084. const HandlersForContentReader &handlers) const {
  12085. for (const auto &x : handlers) {
  12086. const auto &matcher = x.first;
  12087. const auto &handler = x.second;
  12088. if (matcher->match(req)) {
  12089. req.matched_route = matcher->pattern();
  12090. if (!pre_request_handler_ ||
  12091. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12092. handler(req, res, content_reader);
  12093. }
  12094. return true;
  12095. }
  12096. }
  12097. return false;
  12098. }
  12099. inline std::string
  12100. get_client_ip(const std::string &x_forwarded_for,
  12101. const std::vector<std::string> &trusted_proxies) {
  12102. // X-Forwarded-For is a comma-separated list per RFC 7239
  12103. std::vector<std::string> ip_list;
  12104. detail::split(x_forwarded_for.data(),
  12105. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12106. [&](const char *b, const char *e) {
  12107. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12108. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12109. });
  12110. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12111. // no segments. Signal "no client IP derived" with an empty string so the
  12112. // caller can fall back to the connection-level remote address.
  12113. if (ip_list.empty()) { return std::string(); }
  12114. // Each hop appends the address it received the request from, so the rightmost
  12115. // entries are the ones written by our own infrastructure while the leftmost
  12116. // are whatever the original client chose to send. Walk from the right and
  12117. // skip trusted proxies; the first address that is not a trusted proxy is the
  12118. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12119. // from the left instead lets a client forge an arbitrary address by following
  12120. // it with a trusted proxy's address, which the left-to-right scan then
  12121. // returned as the client.
  12122. for (size_t i = ip_list.size(); i-- > 0;) {
  12123. const auto &ip = ip_list[i];
  12124. auto is_trusted_proxy =
  12125. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12126. [&](const std::string &proxy) { return ip == proxy; });
  12127. if (!is_trusted_proxy) { return ip; }
  12128. }
  12129. // Every hop was a trusted proxy; fall back to the first entry.
  12130. return ip_list.front();
  12131. }
  12132. inline bool
  12133. Server::process_request(Stream &strm, const std::string &remote_addr,
  12134. int remote_port, const std::string &local_addr,
  12135. int local_port, bool close_connection,
  12136. bool &connection_closed,
  12137. const std::function<void(Request &)> &setup_request,
  12138. bool *websocket_upgraded) {
  12139. std::array<char, 2048> buf{};
  12140. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12141. // Connection has been closed on client
  12142. if (!line_reader.getline()) { return false; }
  12143. Request req;
  12144. req.start_time_ = std::chrono::steady_clock::now();
  12145. req.remote_addr = remote_addr;
  12146. req.remote_port = remote_port;
  12147. req.local_addr = local_addr;
  12148. req.local_port = local_port;
  12149. Response res;
  12150. res.version = "HTTP/1.1";
  12151. res.headers = default_headers_;
  12152. // Request line and headers
  12153. if (!parse_request_line(line_reader.ptr(), req)) {
  12154. res.status = StatusCode::BadRequest_400;
  12155. output_error_log(Error::InvalidRequestLine, &req);
  12156. return write_response(strm, close_connection, req, res);
  12157. }
  12158. // Request headers
  12159. if (!detail::read_headers(strm, req.headers)) {
  12160. res.status = StatusCode::BadRequest_400;
  12161. output_error_log(Error::InvalidHeaders, &req);
  12162. return write_response(strm, close_connection, req, res);
  12163. }
  12164. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  12165. // otherwise let an intermediary and this parser disagree on where the body
  12166. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  12167. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  12168. // compatibility with existing clients), and a Transfer-Encoding whose final
  12169. // coding is not chunked, which leaves the body length undeterminable. The
  12170. // latter must not fall through to the "no body" path, or the body bytes are
  12171. // parsed as the next request on a persistent connection.
  12172. if (detail::has_conflicting_content_length(req.headers) ||
  12173. (req.has_header("Transfer-Encoding") &&
  12174. !detail::is_chunked_transfer_encoding(req.headers))) {
  12175. connection_closed = true;
  12176. res.status = StatusCode::BadRequest_400;
  12177. return write_response(strm, close_connection, req, res);
  12178. }
  12179. // Check if the request URI doesn't exceed the limit
  12180. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12181. connection_closed = true;
  12182. res.status = StatusCode::UriTooLong_414;
  12183. output_error_log(Error::ExceedUriMaxLength, &req);
  12184. return write_response(strm, close_connection, req, res);
  12185. }
  12186. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12187. connection_closed = true;
  12188. }
  12189. if (req.version == "HTTP/1.0" &&
  12190. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12191. connection_closed = true;
  12192. }
  12193. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12194. // itself a trusted proxy. Otherwise any direct client could spoof
  12195. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12196. auto is_trusted_peer = std::any_of(
  12197. trusted_proxies_.begin(), trusted_proxies_.end(),
  12198. [&](const std::string &proxy) { return proxy == remote_addr; });
  12199. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12200. // Some proxies append the address they observed as a separate
  12201. // X-Forwarded-For field line instead of extending the one the client sent
  12202. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12203. // be scanned. Reading only the first occurrence would hand back the
  12204. // client-supplied, and therefore forgeable, value.
  12205. auto x_forwarded_for =
  12206. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12207. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12208. req.remote_addr = derived.empty() ? remote_addr : derived;
  12209. } else {
  12210. req.remote_addr = remote_addr;
  12211. }
  12212. req.remote_port = remote_port;
  12213. req.local_addr = local_addr;
  12214. req.local_port = local_port;
  12215. if (req.has_header("Accept")) {
  12216. auto accept_header =
  12217. detail::get_combined_header_value(req.headers, "Accept");
  12218. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12219. connection_closed = true;
  12220. res.status = StatusCode::BadRequest_400;
  12221. output_error_log(Error::HTTPParsing, &req);
  12222. return write_response(strm, close_connection, req, res);
  12223. }
  12224. }
  12225. if (req.has_header("Range")) {
  12226. const auto &range_header_value = req.get_header_value("Range");
  12227. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12228. connection_closed = true;
  12229. res.status = StatusCode::RangeNotSatisfiable_416;
  12230. output_error_log(Error::InvalidRangeHeader, &req);
  12231. return write_response(strm, close_connection, req, res);
  12232. }
  12233. }
  12234. if (setup_request) { setup_request(req); }
  12235. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12236. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12237. // must be ignored. An expectation we do not recognize is left alone; the
  12238. // 417 the section allows for one is a MAY, not a requirement.
  12239. //
  12240. // `100 Continue` itself is deferred until the body is actually read (see
  12241. // read_content_core), so a request rejected by a later handler never
  12242. // invites the client to send a body nobody will read.
  12243. if (req.version != "HTTP/1.0" &&
  12244. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12245. int status = StatusCode::Continue_100;
  12246. if (expect_100_continue_handler_) {
  12247. status = expect_100_continue_handler_(req, res);
  12248. }
  12249. if (status == StatusCode::Continue_100) {
  12250. req.expect_100_continue_pending_ = true;
  12251. } else {
  12252. if (res.status == -1) { res.status = status; }
  12253. connection_closed = true;
  12254. return write_response(strm, true, req, res);
  12255. }
  12256. }
  12257. // Setup `is_connection_closed` method
  12258. auto sock = strm.socket();
  12259. req.is_connection_closed = [sock]() {
  12260. return !detail::is_socket_alive(sock);
  12261. };
  12262. // WebSocket upgrade
  12263. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12264. // that authentication and other middleware can reject the request with an
  12265. // HTTP response (e.g., 401) before the protocol switches.
  12266. if (detail::is_websocket_upgrade(req)) {
  12267. if (pre_routing_handler_ &&
  12268. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12269. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12270. return write_response_with_content(strm, close_connection, req, res);
  12271. }
  12272. // Find matching WebSocket handler
  12273. for (const auto &entry : websocket_handlers_) {
  12274. if (entry.matcher->match(req)) {
  12275. req.matched_route = entry.matcher->pattern();
  12276. if (pre_request_handler_ &&
  12277. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12278. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12279. return write_response_with_content(strm, close_connection, req, res);
  12280. }
  12281. // Compute accept key
  12282. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12283. auto accept_key = detail::websocket_accept_key(client_key);
  12284. // Negotiate subprotocol
  12285. std::string selected_subprotocol;
  12286. if (entry.sub_protocol_selector) {
  12287. auto protocol_header = detail::get_combined_header_value(
  12288. req.headers, "Sec-WebSocket-Protocol");
  12289. if (!protocol_header.empty()) {
  12290. std::vector<std::string> protocols;
  12291. detail::split(protocol_header.data(),
  12292. protocol_header.data() + protocol_header.size(), ',',
  12293. [&](const char *b, const char *e) {
  12294. protocols.emplace_back(b, e);
  12295. });
  12296. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12297. }
  12298. }
  12299. // Send 101 Switching Protocols
  12300. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12301. "Upgrade: websocket\r\n"
  12302. "Connection: Upgrade\r\n"
  12303. "Sec-WebSocket-Accept: " +
  12304. accept_key + "\r\n";
  12305. if (!selected_subprotocol.empty()) {
  12306. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12307. return false;
  12308. }
  12309. handshake_response +=
  12310. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12311. }
  12312. handshake_response += "\r\n";
  12313. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12314. 0) {
  12315. return false;
  12316. }
  12317. connection_closed = true;
  12318. if (websocket_upgraded) { *websocket_upgraded = true; }
  12319. {
  12320. #ifdef CPPHTTPLIB_SSL_ENABLED
  12321. if (req.ssl) {
  12322. // wss: the heartbeat ping thread and the read path enter the same
  12323. // TLS session from different threads. Hand the WebSocket a stream
  12324. // that serializes every TLS call, so the shared SSLSocketStream on
  12325. // the plain HTTP/HTTPS paths stays untouched.
  12326. auto ws_strm =
  12327. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12328. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12329. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12330. write_timeout_sec_, write_timeout_usec_));
  12331. ws::WebSocket ws(std::move(ws_strm), req, true,
  12332. websocket_ping_interval_sec_,
  12333. websocket_max_missed_pongs_);
  12334. entry.handler(req, ws);
  12335. return true;
  12336. }
  12337. #endif
  12338. // Use WebSocket-specific read timeout instead of HTTP timeout
  12339. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12340. 0);
  12341. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12342. websocket_max_missed_pongs_);
  12343. entry.handler(req, ws);
  12344. }
  12345. return true;
  12346. }
  12347. }
  12348. // No matching handler - fall through to 404
  12349. }
  12350. // Routing
  12351. auto routed = false;
  12352. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12353. routed = routing(req, res, strm);
  12354. #else
  12355. try {
  12356. routed = routing(req, res, strm);
  12357. } catch (std::exception &) {
  12358. if (exception_handler_) {
  12359. auto ep = std::current_exception();
  12360. exception_handler_(req, res, ep);
  12361. routed = true;
  12362. } else {
  12363. res.status = StatusCode::InternalServerError_500;
  12364. }
  12365. } catch (...) {
  12366. if (exception_handler_) {
  12367. auto ep = std::current_exception();
  12368. exception_handler_(req, res, ep);
  12369. routed = true;
  12370. } else {
  12371. res.status = StatusCode::InternalServerError_500;
  12372. }
  12373. }
  12374. #endif
  12375. auto ret = false;
  12376. if (routed) {
  12377. if (res.status == -1) {
  12378. res.status = req.ranges.empty() ? StatusCode::OK_200
  12379. : StatusCode::PartialContent_206;
  12380. }
  12381. // Serve file content by using a content provider
  12382. auto file_open_error = false;
  12383. if (!res.file_content_path_.empty()) {
  12384. const auto &path = res.file_content_path_;
  12385. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12386. if (!mm->is_open()) {
  12387. res.body.clear();
  12388. res.content_length_ = 0;
  12389. res.content_provider_ = nullptr;
  12390. res.status = StatusCode::NotFound_404;
  12391. output_error_log(Error::OpenFile, &req);
  12392. file_open_error = true;
  12393. } else {
  12394. auto content_type = res.file_content_content_type_;
  12395. if (content_type.empty()) {
  12396. content_type = detail::find_content_type(
  12397. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12398. }
  12399. detail::set_file_content_provider(
  12400. res, mm, content_type,
  12401. static_file_encoding(req, res, content_type, mm->size()));
  12402. }
  12403. }
  12404. if (file_open_error) {
  12405. ret = write_response(strm, close_connection, req, res);
  12406. } else if (detail::range_error(req, res)) {
  12407. res.body.clear();
  12408. res.content_length_ = 0;
  12409. res.content_provider_ = nullptr;
  12410. res.status = StatusCode::RangeNotSatisfiable_416;
  12411. ret = write_response(strm, close_connection, req, res);
  12412. } else {
  12413. ret = write_response_with_content(strm, close_connection, req, res);
  12414. }
  12415. } else {
  12416. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12417. ret = write_response(strm, close_connection, req, res);
  12418. }
  12419. // Drain any unconsumed framed body to prevent request smuggling on
  12420. // keep-alive. Without framing there is no body to drain — reading would
  12421. // consume the next request (issue #2450). If the response has committed the
  12422. // connection to close, there is no next request to protect.
  12423. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12424. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12425. connection_closed = true;
  12426. } else {
  12427. int dummy_status;
  12428. if (!detail::read_content(
  12429. strm, req, payload_max_length_, dummy_status, nullptr,
  12430. [](const char *, size_t, size_t, size_t) { return true; },
  12431. false)) {
  12432. connection_closed = true;
  12433. }
  12434. }
  12435. }
  12436. return ret;
  12437. }
  12438. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12439. inline bool Server::process_and_close_socket(socket_t sock) {
  12440. std::string remote_addr;
  12441. int remote_port = 0;
  12442. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12443. std::string local_addr;
  12444. int local_port = 0;
  12445. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12446. bool websocket_upgraded = false;
  12447. auto ret = serve_guarded([&]() {
  12448. return detail::process_server_socket(
  12449. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12450. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12451. write_timeout_usec_,
  12452. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12453. return process_request(strm, remote_addr, remote_port, local_addr,
  12454. local_port, close_connection,
  12455. connection_closed, nullptr,
  12456. &websocket_upgraded);
  12457. });
  12458. });
  12459. detail::drain_and_close_socket(sock);
  12460. return ret;
  12461. }
  12462. inline void Server::output_log(const Request &req, const Response &res) const {
  12463. if (logger_) {
  12464. std::lock_guard<std::mutex> guard(logger_mutex_);
  12465. logger_(req, res);
  12466. }
  12467. }
  12468. inline void Server::output_pre_compression_log(const Request &req,
  12469. const Response &res) const {
  12470. if (pre_compression_logger_) {
  12471. std::lock_guard<std::mutex> guard(logger_mutex_);
  12472. pre_compression_logger_(req, res);
  12473. }
  12474. }
  12475. inline void Server::output_error_log(const Error &err,
  12476. const Request *req) const {
  12477. if (error_logger_) {
  12478. std::lock_guard<std::mutex> guard(logger_mutex_);
  12479. error_logger_(err, req);
  12480. }
  12481. }
  12482. /*
  12483. * Group 5: ClientImpl and Client (Universal) implementation
  12484. */
  12485. // HTTP client implementation
  12486. inline ClientImpl::ClientImpl(const std::string &host)
  12487. : ClientImpl(host, 80, std::string(), std::string()) {}
  12488. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12489. : ClientImpl(host, port, std::string(), std::string()) {}
  12490. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12491. const std::string &client_cert_path,
  12492. const std::string &client_key_path)
  12493. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12494. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12495. inline ClientImpl::~ClientImpl() {
  12496. // Wait until all the requests in flight are handled.
  12497. size_t retry_count = 10;
  12498. while (retry_count-- > 0) {
  12499. {
  12500. std::lock_guard<std::mutex> guard(socket_mutex_);
  12501. if (socket_requests_in_flight_ == 0) { break; }
  12502. }
  12503. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12504. }
  12505. std::lock_guard<std::mutex> guard(socket_mutex_);
  12506. shutdown_socket(socket_);
  12507. close_socket(socket_);
  12508. }
  12509. inline bool ClientImpl::is_valid() const { return true; }
  12510. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12511. client_cert_path_ = rhs.client_cert_path_;
  12512. client_key_path_ = rhs.client_key_path_;
  12513. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12514. read_timeout_sec_ = rhs.read_timeout_sec_;
  12515. read_timeout_usec_ = rhs.read_timeout_usec_;
  12516. write_timeout_sec_ = rhs.write_timeout_sec_;
  12517. write_timeout_usec_ = rhs.write_timeout_usec_;
  12518. max_timeout_msec_ = rhs.max_timeout_msec_;
  12519. basic_auth_username_ = rhs.basic_auth_username_;
  12520. basic_auth_password_ = rhs.basic_auth_password_;
  12521. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12522. keep_alive_ = rhs.keep_alive_;
  12523. follow_location_ = rhs.follow_location_;
  12524. path_encode_ = rhs.path_encode_;
  12525. address_family_ = rhs.address_family_;
  12526. tcp_nodelay_ = rhs.tcp_nodelay_;
  12527. ipv6_v6only_ = rhs.ipv6_v6only_;
  12528. socket_options_ = rhs.socket_options_;
  12529. compress_ = rhs.compress_;
  12530. decompress_ = rhs.decompress_;
  12531. payload_max_length_ = rhs.payload_max_length_;
  12532. has_payload_max_length_ = rhs.has_payload_max_length_;
  12533. interface_ = rhs.interface_;
  12534. proxy_host_ = rhs.proxy_host_;
  12535. proxy_port_ = rhs.proxy_port_;
  12536. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12537. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12538. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12539. no_proxy_entries_ = rhs.no_proxy_entries_;
  12540. logger_ = rhs.logger_;
  12541. error_logger_ = rhs.error_logger_;
  12542. #ifdef CPPHTTPLIB_SSL_ENABLED
  12543. digest_auth_username_ = rhs.digest_auth_username_;
  12544. digest_auth_password_ = rhs.digest_auth_password_;
  12545. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12546. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12547. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12548. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12549. server_certificate_verification_ = rhs.server_certificate_verification_;
  12550. server_hostname_verification_ = rhs.server_hostname_verification_;
  12551. system_ca_mode_ = rhs.system_ca_mode_;
  12552. #endif
  12553. }
  12554. inline bool
  12555. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12556. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12557. if (no_proxy_entries_.empty()) { return true; }
  12558. // host_ is const so its normalized form is invariant; cache it. The
  12559. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12560. if (host == host_) {
  12561. if (!host_normalized_valid_) {
  12562. host_normalized_ = detail::normalize_target(host_);
  12563. host_normalized_valid_ = true;
  12564. }
  12565. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12566. }
  12567. auto target = detail::normalize_target(host);
  12568. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12569. }
  12570. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12571. if (is_proxy_enabled_for_host(host_)) {
  12572. return detail::create_client_socket(
  12573. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12574. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12575. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12576. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12577. }
  12578. // Check is custom IP or hostname specified for host_
  12579. std::string connect_host;
  12580. std::string ip;
  12581. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12582. return detail::create_client_socket(
  12583. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12584. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12585. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12586. write_timeout_usec_, interface_, error);
  12587. }
  12588. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12589. Error &error) {
  12590. auto sock = create_client_socket(error);
  12591. if (sock == INVALID_SOCKET) { return false; }
  12592. socket.sock = sock;
  12593. return true;
  12594. }
  12595. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12596. return create_and_connect_socket(socket, error);
  12597. }
  12598. inline bool ClientImpl::setup_proxy_connection(
  12599. Socket & /*socket*/,
  12600. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12601. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12602. return true;
  12603. }
  12604. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12605. bool /*shutdown_gracefully*/) {
  12606. // If there are any requests in flight from threads other than us, then it's
  12607. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12608. assert(socket_requests_in_flight_ == 0 ||
  12609. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12610. }
  12611. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12612. if (socket.sock == INVALID_SOCKET) { return; }
  12613. detail::shutdown_socket(socket.sock);
  12614. }
  12615. inline void ClientImpl::close_socket(Socket &socket) {
  12616. // If there are requests in flight in another thread, usually closing
  12617. // the socket will be fine and they will simply receive an error when
  12618. // using the closed socket, but it is still a bug since rarely the OS
  12619. // may reassign the socket id to be used for a new socket, and then
  12620. // suddenly they will be operating on a live socket that is different
  12621. // than the one they intended!
  12622. assert(socket_requests_in_flight_ == 0 ||
  12623. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12624. // It is also a bug if this happens while SSL is still active
  12625. #ifdef CPPHTTPLIB_SSL_ENABLED
  12626. assert(socket.ssl == nullptr);
  12627. #endif
  12628. if (socket.sock == INVALID_SOCKET) { return; }
  12629. detail::close_socket(socket.sock);
  12630. socket.sock = INVALID_SOCKET;
  12631. }
  12632. inline void ClientImpl::disconnect(bool gracefully) {
  12633. shutdown_ssl(socket_, gracefully);
  12634. shutdown_socket(socket_);
  12635. close_socket(socket_);
  12636. }
  12637. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12638. Response &res,
  12639. bool skip_100_continue) const {
  12640. std::array<char, 2048> buf{};
  12641. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12642. if (!line_reader.getline()) { return false; }
  12643. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12644. res.reason)) {
  12645. return req.method == "CONNECT";
  12646. }
  12647. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12648. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12649. if (!line_reader.getline()) { return false; } // CRLF
  12650. if (!line_reader.getline()) { return false; } // next response line
  12651. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12652. res.reason)) {
  12653. return false;
  12654. }
  12655. }
  12656. return true;
  12657. }
  12658. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12659. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12660. auto ret = send_(req, res, error);
  12661. if (error == Error::SSLPeerCouldBeClosed_) {
  12662. assert(!ret);
  12663. ret = send_(req, res, error);
  12664. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12665. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12666. }
  12667. return ret;
  12668. }
  12669. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12670. {
  12671. std::lock_guard<std::mutex> guard(socket_mutex_);
  12672. // Set this to false immediately - if it ever gets set to true by the end
  12673. // of the request, we know another thread instructed us to close the
  12674. // socket.
  12675. socket_should_be_closed_when_request_is_done_ = false;
  12676. auto is_alive = false;
  12677. if (socket_.is_open()) {
  12678. is_alive = detail::is_socket_alive(socket_.sock);
  12679. #ifdef CPPHTTPLIB_SSL_ENABLED
  12680. if (is_alive && is_ssl()) {
  12681. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12682. is_alive = false;
  12683. }
  12684. }
  12685. #endif
  12686. if (!is_alive) {
  12687. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12688. disconnect(/*gracefully=*/false);
  12689. }
  12690. }
  12691. if (!is_alive) {
  12692. if (!ensure_socket_connection(socket_, error)) {
  12693. output_error_log(error, &req);
  12694. return false;
  12695. }
  12696. {
  12697. auto success = true;
  12698. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12699. error)) {
  12700. if (!success) { output_error_log(error, &req); }
  12701. return success;
  12702. }
  12703. }
  12704. }
  12705. // Mark the current socket as being in use so that it cannot be closed by
  12706. // anyone else while this request is ongoing, even though we will be
  12707. // releasing the mutex.
  12708. if (socket_requests_in_flight_ > 1) {
  12709. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12710. }
  12711. socket_requests_in_flight_ += 1;
  12712. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12713. }
  12714. for (const auto &header : default_headers_) {
  12715. if (req.headers.find(header.first) == req.headers.end()) {
  12716. req.headers.insert(header);
  12717. }
  12718. }
  12719. auto ret = false;
  12720. auto close_connection = !keep_alive_;
  12721. auto se = detail::scope_exit([&]() {
  12722. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12723. std::lock_guard<std::mutex> guard(socket_mutex_);
  12724. socket_requests_in_flight_ -= 1;
  12725. if (socket_requests_in_flight_ <= 0) {
  12726. assert(socket_requests_in_flight_ == 0);
  12727. socket_requests_are_from_thread_ = std::thread::id();
  12728. }
  12729. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12730. !ret) {
  12731. disconnect(/*gracefully=*/true);
  12732. }
  12733. });
  12734. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12735. return handle_request(strm, req, res, close_connection, error);
  12736. });
  12737. if (!ret) {
  12738. if (error == Error::Success) {
  12739. error = Error::Unknown;
  12740. output_error_log(error, &req);
  12741. }
  12742. }
  12743. return ret;
  12744. }
  12745. inline Result ClientImpl::send(const Request &req) {
  12746. auto req2 = req;
  12747. return send_(std::move(req2));
  12748. }
  12749. inline Result ClientImpl::send_(Request &&req) {
  12750. auto res = detail::make_unique<Response>();
  12751. auto error = Error::Success;
  12752. auto ret = send(req, *res, error);
  12753. #ifdef CPPHTTPLIB_SSL_ENABLED
  12754. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12755. last_ssl_error_, last_backend_error_};
  12756. #else
  12757. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12758. #endif
  12759. }
  12760. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12761. const std::string &ct) {
  12762. (void)for_stream;
  12763. // Default headers are meant for the origin and may carry its credentials, so
  12764. // keep them off the CONNECT request the proxy reads.
  12765. if (r.method != "CONNECT") {
  12766. for (const auto &header : default_headers_) {
  12767. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12768. }
  12769. }
  12770. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12771. // prepend it rather than appending it after the caller's own fields.
  12772. if (!r.has_header("Host")) {
  12773. r.headers.emplace_front(
  12774. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12775. address_family_));
  12776. }
  12777. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12778. if (!r.content_receiver) {
  12779. if (!r.has_header("Accept-Encoding")) {
  12780. std::string accept_encoding;
  12781. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12782. accept_encoding = "br";
  12783. #endif
  12784. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12785. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12786. accept_encoding += "gzip, deflate";
  12787. #endif
  12788. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12789. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12790. accept_encoding += "zstd";
  12791. #endif
  12792. r.set_header("Accept-Encoding", accept_encoding);
  12793. }
  12794. detail::add_default_user_agent_header(r);
  12795. }
  12796. if (!r.body.empty()) {
  12797. if (!ct.empty() && !r.has_header("Content-Type")) {
  12798. r.headers.emplace("Content-Type", ct);
  12799. }
  12800. if (!r.has_header("Content-Length")) {
  12801. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12802. }
  12803. }
  12804. }
  12805. inline ClientImpl::StreamHandle
  12806. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12807. const Params &params, const Headers &headers,
  12808. const std::string &body,
  12809. const std::string &content_type) {
  12810. StreamHandle handle;
  12811. handle.response = detail::make_unique<Response>();
  12812. handle.error = Error::Success;
  12813. // Encode the target exactly like the buffered send path does, so that the
  12814. // same `path` produces the same request line through either API.
  12815. auto raw_query_path =
  12816. params.empty() ? path : append_query_params(path, params);
  12817. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12818. handle.connection_ = detail::make_unique<ClientConnection>();
  12819. {
  12820. std::lock_guard<std::mutex> guard(socket_mutex_);
  12821. auto is_alive = false;
  12822. if (socket_.is_open()) {
  12823. is_alive = detail::is_socket_alive(socket_.sock);
  12824. #ifdef CPPHTTPLIB_SSL_ENABLED
  12825. if (is_alive && is_ssl()) {
  12826. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12827. is_alive = false;
  12828. }
  12829. }
  12830. #endif
  12831. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12832. }
  12833. if (!is_alive) {
  12834. if (!ensure_socket_connection(socket_, handle.error)) {
  12835. handle.response.reset();
  12836. return handle;
  12837. }
  12838. {
  12839. auto success = true;
  12840. auto start_time = std::chrono::steady_clock::now();
  12841. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12842. success, handle.error)) {
  12843. if (!success) { handle.response.reset(); }
  12844. return handle;
  12845. }
  12846. }
  12847. }
  12848. transfer_socket_ownership_to_handle(handle);
  12849. }
  12850. #ifdef CPPHTTPLIB_SSL_ENABLED
  12851. if (is_ssl() && handle.connection_->session) {
  12852. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12853. handle.connection_->sock, handle.connection_->session,
  12854. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12855. write_timeout_usec_);
  12856. } else {
  12857. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12858. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12859. write_timeout_sec_, write_timeout_usec_);
  12860. }
  12861. #else
  12862. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12863. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12864. write_timeout_sec_, write_timeout_usec_);
  12865. #endif
  12866. handle.stream_ = handle.socket_stream_.get();
  12867. Request req;
  12868. req.method = method;
  12869. req.path = query_path;
  12870. req.headers = headers;
  12871. req.body = body;
  12872. prepare_default_headers(req, true, content_type);
  12873. auto &strm = *handle.stream_;
  12874. // Build the request line and headers in memory first, like write_request()
  12875. // does, so that a rejected header leaves nothing on the wire.
  12876. {
  12877. detail::BufferStream bstrm;
  12878. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12879. handle.error = Error::Write;
  12880. handle.response.reset();
  12881. return handle;
  12882. }
  12883. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12884. handle.error)) {
  12885. handle.response.reset();
  12886. return handle;
  12887. }
  12888. const auto &data = bstrm.get_buffer();
  12889. if (!detail::write_data(strm, data.data(), data.size())) {
  12890. handle.error = Error::Write;
  12891. handle.response.reset();
  12892. return handle;
  12893. }
  12894. }
  12895. if (!body.empty()) {
  12896. if (strm.write(body.data(), body.size()) < 0) {
  12897. handle.error = Error::Write;
  12898. handle.response.reset();
  12899. return handle;
  12900. }
  12901. }
  12902. if (!read_response_line(strm, req, *handle.response) ||
  12903. !detail::read_headers(strm, handle.response->headers)) {
  12904. handle.error = Error::Read;
  12905. handle.response.reset();
  12906. return handle;
  12907. }
  12908. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12909. // (204/304) response legitimately carries framing headers with no body.
  12910. if (method != "HEAD" &&
  12911. handle.response->status != StatusCode::NoContent_204 &&
  12912. handle.response->status != StatusCode::NotModified_304 &&
  12913. detail::has_conflicting_content_length(handle.response->headers)) {
  12914. handle.error = Error::Read;
  12915. handle.response.reset();
  12916. return handle;
  12917. }
  12918. handle.body_reader_.stream = handle.stream_;
  12919. handle.body_reader_.payload_max_length = payload_max_length_;
  12920. if (handle.response->has_header("Content-Length")) {
  12921. bool is_invalid = false;
  12922. auto content_length = detail::get_header_value_u64(
  12923. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12924. if (is_invalid) {
  12925. handle.error = Error::Read;
  12926. handle.response.reset();
  12927. return handle;
  12928. }
  12929. handle.body_reader_.has_content_length = true;
  12930. handle.body_reader_.content_length = content_length;
  12931. }
  12932. handle.body_reader_.chunked =
  12933. detail::is_chunked_transfer_encoding(handle.response->headers);
  12934. auto content_encoding = detail::get_combined_header_value(
  12935. handle.response->headers, "Content-Encoding");
  12936. if (!content_encoding.empty()) {
  12937. // Same policy as prepare_content_receiver(): reject a coding we know about
  12938. // but were not built with, pass an unrecognized one through as-is.
  12939. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12940. if (!handle.decompressor_) {
  12941. if (detail::is_known_content_encoding(content_encoding)) {
  12942. handle.error = Error::UnsupportedContentEncoding;
  12943. handle.response.reset();
  12944. return handle;
  12945. }
  12946. } else if (!handle.decompressor_->is_valid()) {
  12947. handle.error = Error::Compression;
  12948. handle.response.reset();
  12949. return handle;
  12950. }
  12951. }
  12952. return handle;
  12953. }
  12954. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12955. if (!is_valid() || !response) { return -1; }
  12956. if (decompressor_) { return read_with_decompression(buf, len); }
  12957. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12958. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12959. trailers_parsed_ = true;
  12960. if (body_reader_.chunked_decoder) {
  12961. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12962. response->trailers, response->headers)) {
  12963. return n;
  12964. }
  12965. } else {
  12966. detail::ChunkedDecoder dec(*stream_);
  12967. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12968. return n;
  12969. }
  12970. }
  12971. }
  12972. return n;
  12973. }
  12974. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12975. size_t len) {
  12976. if (decompress_offset_ < decompress_buffer_.size()) {
  12977. auto available = decompress_buffer_.size() - decompress_offset_;
  12978. auto to_copy = (std::min)(len, available);
  12979. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12980. decompress_offset_ += to_copy;
  12981. decompressed_bytes_read_ += to_copy;
  12982. return static_cast<ssize_t>(to_copy);
  12983. }
  12984. decompress_buffer_.clear();
  12985. decompress_offset_ = 0;
  12986. constexpr size_t kDecompressionBufferSize = 8192;
  12987. char compressed_buf[kDecompressionBufferSize];
  12988. while (true) {
  12989. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12990. sizeof(compressed_buf));
  12991. if (n <= 0) { return n; }
  12992. bool decompress_ok = decompressor_->decompress(
  12993. compressed_buf, static_cast<size_t>(n),
  12994. [this](const char *data, size_t data_len) {
  12995. decompress_buffer_.append(data, data_len);
  12996. auto limit = body_reader_.payload_max_length;
  12997. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12998. return false;
  12999. }
  13000. return true;
  13001. });
  13002. if (!decompress_ok) {
  13003. body_reader_.last_error = Error::Read;
  13004. return -1;
  13005. }
  13006. if (!decompress_buffer_.empty()) { break; }
  13007. }
  13008. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13009. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13010. decompress_offset_ = to_copy;
  13011. decompressed_bytes_read_ += to_copy;
  13012. return static_cast<ssize_t>(to_copy);
  13013. }
  13014. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13015. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13016. return;
  13017. }
  13018. trailers_parsed_ = true;
  13019. const auto bufsiz = 128;
  13020. char line_buf[bufsiz];
  13021. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13022. if (!line_reader.getline()) { return; }
  13023. if (!detail::parse_trailers(line_reader, response->trailers,
  13024. response->headers)) {
  13025. return;
  13026. }
  13027. }
  13028. namespace detail {
  13029. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13030. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13031. size_t &out_chunk_offset,
  13032. size_t &out_chunk_total) {
  13033. if (finished) { return 0; }
  13034. if (chunk_remaining == 0) {
  13035. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13036. if (!lr.getline()) { return -1; }
  13037. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13038. // the line terminator is never mistaken for line content.
  13039. const char *eol = lr.ptr() + lr.size();
  13040. if (lr.end_with_crlf()) {
  13041. eol -= 2;
  13042. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13043. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13044. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13045. // has to come off here or the check below would reject the line.
  13046. eol -= 1;
  13047. }
  13048. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13049. const char *p = lr.ptr();
  13050. int v = 0;
  13051. if (p == eol || !is_hex(*p, v)) { return -1; }
  13052. size_t chunk_len = 0;
  13053. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13054. for (; p < eol && is_hex(*p, v); ++p) {
  13055. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13056. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13057. }
  13058. while (p < eol && is_space_or_tab(*p)) {
  13059. ++p;
  13060. }
  13061. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13062. // terminator, and it is built from tokens and quoted-strings, so it never
  13063. // holds a CR, LF or any other control character. getline() reads up to the
  13064. // CRLF, so a bare LF left in here would be swallowed as extension text
  13065. // while an intermediary that ends the line on it delimits the chunks
  13066. // differently, and the two disagree on where the body ends (request
  13067. // smuggling).
  13068. if (p < eol && *p != ';') { return -1; }
  13069. for (; p < eol; ++p) {
  13070. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13071. }
  13072. if (chunk_len == 0) {
  13073. chunk_remaining = 0;
  13074. finished = true;
  13075. out_chunk_offset = 0;
  13076. out_chunk_total = 0;
  13077. return 0;
  13078. }
  13079. chunk_remaining = chunk_len;
  13080. last_chunk_total = chunk_remaining;
  13081. last_chunk_offset = 0;
  13082. }
  13083. auto to_read = (std::min)(chunk_remaining, len);
  13084. auto n = strm.read(buf, to_read);
  13085. if (n <= 0) { return -1; }
  13086. auto offset_before = last_chunk_offset;
  13087. last_chunk_offset += static_cast<size_t>(n);
  13088. chunk_remaining -= static_cast<size_t>(n);
  13089. out_chunk_offset = offset_before;
  13090. out_chunk_total = last_chunk_total;
  13091. if (chunk_remaining == 0) {
  13092. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13093. if (!lr.getline()) { return -1; }
  13094. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13095. }
  13096. return n;
  13097. }
  13098. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13099. const Headers &src_headers) {
  13100. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13101. if (!lr.getline()) { return false; }
  13102. return parse_trailers(lr, dest, src_headers);
  13103. }
  13104. } // namespace detail
  13105. inline void
  13106. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13107. handle.connection_->sock = socket_.sock;
  13108. #ifdef CPPHTTPLIB_SSL_ENABLED
  13109. handle.connection_->session = socket_.ssl;
  13110. socket_.ssl = nullptr;
  13111. #endif
  13112. socket_.sock = INVALID_SOCKET;
  13113. }
  13114. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13115. Response &res, bool close_connection,
  13116. Error &error) {
  13117. if (req.path.empty()) {
  13118. error = Error::Connection;
  13119. output_error_log(error, &req);
  13120. return false;
  13121. }
  13122. auto req_save = req;
  13123. bool ret;
  13124. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13125. auto req2 = req;
  13126. req2.path = "http://" +
  13127. detail::make_host_and_port_string(host_, port_, false) +
  13128. req.path;
  13129. ret = process_request(strm, req2, res, close_connection, error);
  13130. req = std::move(req2);
  13131. req.path = req_save.path;
  13132. } else {
  13133. ret = process_request(strm, req, res, close_connection, error);
  13134. }
  13135. if (!ret) { return false; }
  13136. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13137. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13138. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13139. // for this to be safe.
  13140. // This is safe to call because handle_request is only called by send_
  13141. // which locks the request mutex during the process. It would be a bug
  13142. // to call it from a different thread since it's a thread-safety issue
  13143. // to do these things to the socket if another thread is using the socket.
  13144. std::lock_guard<std::mutex> guard(socket_mutex_);
  13145. disconnect(/*gracefully=*/true);
  13146. }
  13147. if (300 < res.status && res.status < 400 && follow_location_) {
  13148. req = std::move(req_save);
  13149. ret = redirect(req, res, error);
  13150. }
  13151. #ifdef CPPHTTPLIB_SSL_ENABLED
  13152. if ((res.status == StatusCode::Unauthorized_401 ||
  13153. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13154. req.authorization_count_ < 5) {
  13155. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13156. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13157. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13158. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13159. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13160. return ret;
  13161. }
  13162. const auto &username =
  13163. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13164. const auto &password =
  13165. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13166. if (!username.empty() && !password.empty()) {
  13167. std::map<std::string, std::string> auth;
  13168. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13169. Request new_req = req;
  13170. new_req.authorization_count_ += 1;
  13171. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13172. : "Authorization");
  13173. new_req.headers.insert(detail::make_digest_authentication_header(
  13174. req, auth, new_req.authorization_count_, detail::random_string(10),
  13175. username, password, is_proxy));
  13176. Response new_res;
  13177. ret = send(new_req, new_res, error);
  13178. if (ret) { res = std::move(new_res); }
  13179. }
  13180. }
  13181. }
  13182. #endif
  13183. return ret;
  13184. }
  13185. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13186. if (req.redirect_count_ == 0) {
  13187. error = Error::ExceedRedirectCount;
  13188. output_error_log(error, &req);
  13189. return false;
  13190. }
  13191. auto location = res.get_header_value("location");
  13192. if (location.empty()) { return false; }
  13193. detail::UrlComponents uc;
  13194. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13195. uc)) {
  13196. return false;
  13197. }
  13198. // Only follow http/https redirects
  13199. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13200. return false;
  13201. }
  13202. auto scheme = is_ssl() ? "https" : "http";
  13203. auto next_scheme = std::move(uc.scheme);
  13204. auto next_host = std::move(uc.host);
  13205. auto port_str = std::move(uc.port);
  13206. auto next_path = std::move(uc.path);
  13207. auto next_query = std::move(uc.query);
  13208. auto next_port = port_;
  13209. if (!port_str.empty()) {
  13210. if (!detail::parse_port(port_str, next_port)) { return false; }
  13211. } else if (!next_scheme.empty()) {
  13212. next_port = next_scheme == "https" ? 443 : 80;
  13213. }
  13214. if (next_scheme.empty()) { next_scheme = scheme; }
  13215. if (next_host.empty()) { next_host = host_; }
  13216. if (next_path.empty()) { next_path = "/"; }
  13217. auto path = decode_path_component(next_path) + next_query;
  13218. // Same host redirect - use current client
  13219. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13220. return detail::redirect(*this, req, res, path, location, error);
  13221. }
  13222. // Cross-host/scheme redirect - create new client with robust setup
  13223. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13224. path, location, error);
  13225. }
  13226. // New method for robust redirect client creation
  13227. inline bool ClientImpl::create_redirect_client(
  13228. const std::string &scheme, const std::string &host, int port, Request &req,
  13229. Response &res, const std::string &path, const std::string &location,
  13230. Error &error) {
  13231. // Determine if we need SSL
  13232. auto need_ssl = (scheme == "https");
  13233. // Clean up request headers that are host/client specific
  13234. // Remove headers that should not be carried over to new host
  13235. auto headers_to_remove = std::vector<std::string>{
  13236. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13237. for (const auto &header_name : headers_to_remove) {
  13238. auto it = req.headers.find(header_name);
  13239. while (it != req.headers.end()) {
  13240. it = req.headers.erase(it);
  13241. it = req.headers.find(header_name);
  13242. }
  13243. }
  13244. // Create appropriate client type and handle redirect
  13245. if (need_ssl) {
  13246. #ifdef CPPHTTPLIB_SSL_ENABLED
  13247. // Create SSL client for HTTPS redirect
  13248. SSLClient redirect_client(host, port);
  13249. // Setup basic client configuration first
  13250. setup_redirect_client(redirect_client);
  13251. redirect_client.enable_server_certificate_verification(
  13252. server_certificate_verification_);
  13253. redirect_client.enable_server_hostname_verification(
  13254. server_hostname_verification_);
  13255. redirect_client.system_ca_mode_ = system_ca_mode_;
  13256. // Transfer CA certificate to redirect client
  13257. if (!ca_cert_pem_.empty()) {
  13258. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13259. ca_cert_pem_.size());
  13260. }
  13261. if (!ca_cert_file_path_.empty()) {
  13262. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13263. }
  13264. // Client certificates are set through constructor for SSLClient
  13265. // NOTE: SSLClient constructor already takes client_cert_path and
  13266. // client_key_path so we need to create it properly if client certs are
  13267. // needed
  13268. // Execute the redirect
  13269. return detail::redirect(redirect_client, req, res, path, location, error);
  13270. #else
  13271. // SSL not supported - set appropriate error
  13272. error = Error::SSLConnection;
  13273. output_error_log(error, &req);
  13274. return false;
  13275. #endif
  13276. } else {
  13277. // HTTP redirect
  13278. ClientImpl redirect_client(host, port);
  13279. // Setup client with robust configuration
  13280. setup_redirect_client(redirect_client);
  13281. // Execute the redirect
  13282. return detail::redirect(redirect_client, req, res, path, location, error);
  13283. }
  13284. }
  13285. // New method for robust client setup (based on basic_manual_redirect.cpp
  13286. // logic)
  13287. template <typename ClientType>
  13288. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13289. // Copy basic settings first
  13290. client.set_connection_timeout(connection_timeout_sec_);
  13291. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13292. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13293. client.set_keep_alive(keep_alive_);
  13294. client.set_follow_location(
  13295. true); // Enable redirects to handle multi-step redirects
  13296. client.set_path_encode(path_encode_);
  13297. client.set_compress(compress_);
  13298. client.set_decompress(decompress_);
  13299. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13300. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13301. // 15.4, credentials must not be forwarded when redirecting to a different
  13302. // host. This function is only called for cross-host redirects; same-host
  13303. // redirects are handled directly in ClientImpl::redirect().
  13304. // Copy the proxy configuration unconditionally; the per-target bypass is
  13305. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13306. // still use the proxy.
  13307. client.no_proxy_entries_ = no_proxy_entries_;
  13308. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13309. client.set_proxy(proxy_host_, proxy_port_);
  13310. if (!proxy_basic_auth_username_.empty()) {
  13311. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13312. proxy_basic_auth_password_);
  13313. }
  13314. if (!proxy_bearer_token_auth_token_.empty()) {
  13315. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13316. }
  13317. #ifdef CPPHTTPLIB_SSL_ENABLED
  13318. if (!proxy_digest_auth_username_.empty()) {
  13319. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13320. proxy_digest_auth_password_);
  13321. }
  13322. #endif
  13323. }
  13324. // Copy network and socket settings
  13325. client.set_address_family(address_family_);
  13326. client.set_tcp_nodelay(tcp_nodelay_);
  13327. client.set_ipv6_v6only(ipv6_v6only_);
  13328. if (socket_options_) { client.set_socket_options(socket_options_); }
  13329. if (!interface_.empty()) { client.set_interface(interface_); }
  13330. // Copy logging and headers
  13331. if (logger_) { client.set_logger(logger_); }
  13332. if (error_logger_) { client.set_error_logger(error_logger_); }
  13333. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13334. // Each new client should generate its own headers based on its target host
  13335. }
  13336. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13337. const Request &req,
  13338. Error &error) const {
  13339. auto is_shutting_down = []() { return false; };
  13340. if (req.is_chunked_content_provider_) {
  13341. auto compressor = compress_ ? detail::create_compressor().first
  13342. : std::unique_ptr<detail::compressor>();
  13343. if (!compressor) {
  13344. compressor = detail::make_unique<detail::nocompressor>();
  13345. }
  13346. return detail::write_content_chunked(strm, req.content_provider_,
  13347. is_shutting_down, *compressor, error);
  13348. } else {
  13349. return detail::write_content_with_progress(
  13350. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13351. req.upload_progress, error);
  13352. }
  13353. }
  13354. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13355. bool close_connection, Error &error,
  13356. bool skip_body, bool &rejected_locally) {
  13357. rejected_locally = false;
  13358. // Prepare additional headers
  13359. if (close_connection) {
  13360. if (!req.has_header("Connection")) {
  13361. req.set_header("Connection", "close");
  13362. }
  13363. }
  13364. std::string ct_for_defaults;
  13365. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13366. ct_for_defaults = "text/plain";
  13367. }
  13368. prepare_default_headers(req, false, ct_for_defaults);
  13369. if (req.body.empty()) {
  13370. if (req.content_provider_) {
  13371. if (!req.is_chunked_content_provider_) {
  13372. if (!req.has_header("Content-Length")) {
  13373. auto length = std::to_string(req.content_length_);
  13374. req.set_header("Content-Length", length);
  13375. }
  13376. }
  13377. } else {
  13378. if (req.method == "POST" || req.method == "PUT" ||
  13379. req.method == "PATCH") {
  13380. req.set_header("Content-Length", "0");
  13381. }
  13382. }
  13383. }
  13384. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13385. // it opens is read by the origin. Each credential goes only to its own hop.
  13386. auto is_connect = req.method == "CONNECT";
  13387. if (!is_connect && !req.has_header("Authorization")) {
  13388. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13389. req.headers.insert(make_basic_authentication_header(
  13390. basic_auth_username_, basic_auth_password_, false));
  13391. } else if (!bearer_token_auth_token_.empty()) {
  13392. req.headers.insert(make_bearer_token_authentication_header(
  13393. bearer_token_auth_token_, false));
  13394. }
  13395. }
  13396. // Proxy-Authorization is only sent when the proxy reads this message —
  13397. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13398. // would leak proxy credentials to the destination server.
  13399. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13400. if (!proxy_basic_auth_username_.empty() &&
  13401. !proxy_basic_auth_password_.empty() &&
  13402. !req.has_header("Proxy-Authorization")) {
  13403. req.headers.insert(make_basic_authentication_header(
  13404. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13405. }
  13406. if (!proxy_bearer_token_auth_token_.empty() &&
  13407. !req.has_header("Proxy-Authorization")) {
  13408. req.headers.insert(make_bearer_token_authentication_header(
  13409. proxy_bearer_token_auth_token_, true));
  13410. }
  13411. }
  13412. // Request line and headers
  13413. {
  13414. detail::BufferStream bstrm;
  13415. // Extract the query from req.path. The encoding itself is delegated to
  13416. // `encode_request_target`; the raw query is still needed here to decide
  13417. // between populating `req.params` from it and falling back to building a
  13418. // query out of caller-supplied `req.params`.
  13419. auto query_pos = req.path.find('?');
  13420. auto query_part = query_pos == std::string::npos
  13421. ? std::string()
  13422. : req.path.substr(query_pos + 1);
  13423. auto path_with_query =
  13424. detail::encode_request_target(req.path, path_encode_);
  13425. if (!query_part.empty()) {
  13426. // The query already came in through `req.path`; still populate
  13427. // `req.params` for handlers/users who read them.
  13428. detail::parse_query_text(query_part, req.params);
  13429. } else if (!req.params.empty()) {
  13430. // No query in `req.path`; build one from `req.params` so existing
  13431. // callers that pass `Params` separately continue to work.
  13432. path_with_query = append_query_params(path_with_query, req.params);
  13433. }
  13434. // Write request line and headers
  13435. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13436. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13437. // CR/LF smuggled in via a decoded redirect Location under
  13438. // set_path_encode(false)) must fail the request cleanly instead of
  13439. // emitting a request-line-less, header-injecting request.
  13440. error = Error::Write;
  13441. rejected_locally = true;
  13442. output_error_log(error, &req);
  13443. return false;
  13444. }
  13445. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13446. error)) {
  13447. rejected_locally = true;
  13448. output_error_log(error, &req);
  13449. return false;
  13450. }
  13451. // Flush buffer
  13452. auto &data = bstrm.get_buffer();
  13453. if (!detail::write_data(strm, data.data(), data.size())) {
  13454. error = Error::Write;
  13455. output_error_log(error, &req);
  13456. return false;
  13457. }
  13458. }
  13459. // After sending request line and headers, wait briefly for an early server
  13460. // response (e.g. 4xx) and avoid sending a potentially large request body
  13461. // unnecessarily. This workaround is only enabled on Windows because Unix
  13462. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13463. // buffering can accept large writes even when the peer already responded.
  13464. // Check the stream first (which covers SSL via `is_readable()`), then
  13465. // fall back to select on the socket. Only perform the wait for very large
  13466. // request bodies to avoid interfering with normal small requests and
  13467. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13468. // response. Skip this check when using Expect: 100-continue, as the protocol
  13469. // handles early responses properly.
  13470. #if defined(_WIN32)
  13471. if (!skip_body &&
  13472. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13473. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13474. auto start = std::chrono::high_resolution_clock::now();
  13475. for (;;) {
  13476. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13477. // from SSL internals. If the underlying socket is readable, assume an
  13478. // early response may be present.
  13479. auto sock = strm.socket();
  13480. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13481. return false;
  13482. }
  13483. // Fallback to stream-level check for non-socket streams or when the
  13484. // socket isn't reporting readable. Avoid using `is_readable()` for
  13485. // SSL, since `SSL_pending()` may report buffered records that do not
  13486. // indicate a complete application-level response yet.
  13487. if (!is_ssl() && strm.is_readable()) { return false; }
  13488. auto now = std::chrono::high_resolution_clock::now();
  13489. auto elapsed =
  13490. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13491. .count();
  13492. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13493. break;
  13494. }
  13495. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13496. }
  13497. }
  13498. #endif
  13499. // Body
  13500. if (skip_body) { return true; }
  13501. return write_request_body(strm, req, error);
  13502. }
  13503. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13504. Error &error) {
  13505. if (req.body.empty()) {
  13506. return write_content_with_provider(strm, req, error);
  13507. }
  13508. if (req.upload_progress) {
  13509. auto body_size = req.body.size();
  13510. size_t written = 0;
  13511. auto data = req.body.data();
  13512. while (written < body_size) {
  13513. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13514. if (!detail::write_data(strm, data + written, to_write)) {
  13515. error = Error::Write;
  13516. output_error_log(error, &req);
  13517. return false;
  13518. }
  13519. written += to_write;
  13520. if (!req.upload_progress(written, body_size)) {
  13521. error = Error::Canceled;
  13522. output_error_log(error, &req);
  13523. return false;
  13524. }
  13525. }
  13526. } else {
  13527. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13528. error = Error::Write;
  13529. output_error_log(error, &req);
  13530. return false;
  13531. }
  13532. }
  13533. return true;
  13534. }
  13535. inline std::unique_ptr<Response>
  13536. ClientImpl::send_with_content_provider_and_receiver(
  13537. Request &req, const char *body, size_t content_length,
  13538. ContentProvider content_provider,
  13539. ContentProviderWithoutLength content_provider_without_length,
  13540. const std::string &content_type, ContentReceiver content_receiver,
  13541. Error &error) {
  13542. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13543. auto enc = compress_
  13544. ? detail::create_compressor()
  13545. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13546. nullptr, nullptr);
  13547. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13548. if (enc.first && !content_provider_without_length) {
  13549. auto &compressor = enc.first;
  13550. if (content_provider) {
  13551. auto ok = true;
  13552. auto finished = false;
  13553. size_t offset = 0;
  13554. DataSink data_sink;
  13555. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13556. if (ok) {
  13557. auto last = offset + data_len == content_length;
  13558. auto ret = compressor->compress(
  13559. data, data_len, last,
  13560. [&](const char *compressed_data, size_t compressed_data_len) {
  13561. req.body.append(compressed_data, compressed_data_len);
  13562. return true;
  13563. });
  13564. if (ret) {
  13565. offset += data_len;
  13566. } else {
  13567. ok = false;
  13568. }
  13569. }
  13570. return ok;
  13571. };
  13572. // As in detail::write_content_with_progress(): the body is framed by
  13573. // content_length, so a provider that finishes early has truncated it.
  13574. // Stop and report that instead of calling the provider forever.
  13575. data_sink.done = [&]() { finished = true; };
  13576. while (ok && !finished && offset < content_length) {
  13577. if (!content_provider(offset, content_length - offset, data_sink)) {
  13578. error = Error::Canceled;
  13579. output_error_log(error, &req);
  13580. return nullptr;
  13581. }
  13582. }
  13583. // A short body here means either the provider stopped early or the
  13584. // compressor gave up. The branch below reports a failing compressor as
  13585. // Error::Compression, so keep the two distinguishable.
  13586. if (offset < content_length) {
  13587. error = ok ? Error::Write : Error::Compression;
  13588. output_error_log(error, &req);
  13589. return nullptr;
  13590. }
  13591. } else {
  13592. if (!compressor->compress(body, content_length, true,
  13593. [&](const char *data, size_t data_len) {
  13594. req.body.append(data, data_len);
  13595. return true;
  13596. })) {
  13597. error = Error::Compression;
  13598. output_error_log(error, &req);
  13599. return nullptr;
  13600. }
  13601. }
  13602. } else {
  13603. if (content_provider) {
  13604. req.content_length_ = content_length;
  13605. req.content_provider_ = std::move(content_provider);
  13606. req.is_chunked_content_provider_ = false;
  13607. } else if (content_provider_without_length) {
  13608. req.content_length_ = 0;
  13609. req.content_provider_ = detail::ContentProviderAdapter(
  13610. std::move(content_provider_without_length));
  13611. req.is_chunked_content_provider_ = true;
  13612. req.set_header("Transfer-Encoding", "chunked");
  13613. } else {
  13614. req.body.assign(body, content_length);
  13615. }
  13616. }
  13617. if (content_receiver) {
  13618. req.content_receiver =
  13619. [content_receiver](const char *data, size_t data_length,
  13620. size_t /*offset*/, size_t /*total_length*/) {
  13621. return content_receiver(data, data_length);
  13622. };
  13623. }
  13624. auto res = detail::make_unique<Response>();
  13625. return send(req, *res, error) ? std::move(res) : nullptr;
  13626. }
  13627. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13628. const std::string &method, const std::string &path, const Headers &headers,
  13629. const char *body, size_t content_length, ContentProvider content_provider,
  13630. ContentProviderWithoutLength content_provider_without_length,
  13631. const std::string &content_type, ContentReceiver content_receiver,
  13632. UploadProgress progress) {
  13633. Request req;
  13634. req.method = method;
  13635. req.headers = headers;
  13636. req.path = path;
  13637. req.upload_progress = std::move(progress);
  13638. if (max_timeout_msec_ > 0) {
  13639. req.start_time_ = std::chrono::steady_clock::now();
  13640. }
  13641. auto error = Error::Success;
  13642. auto res = send_with_content_provider_and_receiver(
  13643. req, body, content_length, std::move(content_provider),
  13644. std::move(content_provider_without_length), content_type,
  13645. std::move(content_receiver), error);
  13646. #ifdef CPPHTTPLIB_SSL_ENABLED
  13647. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13648. last_backend_error_};
  13649. #else
  13650. return Result{std::move(res), error, std::move(req.headers)};
  13651. #endif
  13652. }
  13653. inline void ClientImpl::output_log(const Request &req,
  13654. const Response &res) const {
  13655. if (logger_) {
  13656. std::lock_guard<std::mutex> guard(logger_mutex_);
  13657. logger_(req, res);
  13658. }
  13659. }
  13660. inline void ClientImpl::output_error_log(const Error &err,
  13661. const Request *req) const {
  13662. if (error_logger_) {
  13663. std::lock_guard<std::mutex> guard(logger_mutex_);
  13664. error_logger_(err, req);
  13665. }
  13666. }
  13667. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13668. Response &res, bool close_connection,
  13669. Error &error) {
  13670. // Auto-add Expect: 100-continue for large bodies
  13671. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13672. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13673. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13674. req.set_header("Expect", "100-continue");
  13675. }
  13676. }
  13677. // Check for Expect: 100-continue
  13678. auto expect_100_continue =
  13679. detail::has_header_token(req.headers, "Expect", "100-continue");
  13680. // Send request (skip body if using Expect: 100-continue)
  13681. auto rejected_locally = false;
  13682. auto write_request_success =
  13683. write_request(strm, req, close_connection, error, expect_100_continue,
  13684. rejected_locally);
  13685. // A failed write normally still reads the response below, since the server
  13686. // may have answered early (e.g. 413/414) and closed while the body was being
  13687. // sent. A request rejected before any byte reached the socket gets no such
  13688. // response, and waiting for one would block until the read timeout.
  13689. if (rejected_locally) { return false; }
  13690. #ifdef CPPHTTPLIB_SSL_ENABLED
  13691. if (is_ssl() && !expect_100_continue) {
  13692. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13693. if (!is_proxy_enabled) {
  13694. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13695. error = Error::SSLPeerCouldBeClosed_;
  13696. output_error_log(error, &req);
  13697. return false;
  13698. }
  13699. }
  13700. }
  13701. #endif
  13702. // Handle Expect: 100-continue.
  13703. //
  13704. // Wait for an interim/early response by attempting to read the status line
  13705. // under a short timeout, instead of trusting raw socket readability. Over
  13706. // TLS, post-handshake records (e.g. session tickets) make the socket
  13707. // readable without any HTTP response being available; relying on
  13708. // `select_read` there caused the body to be withheld forever and the
  13709. // request to fail with `Read` (#2458). If no status line arrives within the
  13710. // timeout, send the body anyway (matching curl's behavior).
  13711. auto status_line_read = false;
  13712. if (expect_100_continue && write_request_success) {
  13713. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13714. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13715. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13716. strm.set_read_timeout(sec, usec);
  13717. status_line_read = read_response_line(strm, req, res, false);
  13718. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13719. }
  13720. if (!status_line_read) {
  13721. // No interim response within the timeout: send the body and handle the
  13722. // response as usual.
  13723. if (!write_request_body(strm, req, error)) { return false; }
  13724. expect_100_continue = false; // Switch to normal response handling
  13725. }
  13726. }
  13727. // Receive response and headers
  13728. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13729. if ((!status_line_read &&
  13730. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13731. !detail::read_headers(strm, res.headers)) {
  13732. if (write_request_success) { error = Error::Read; }
  13733. output_error_log(error, &req);
  13734. return false;
  13735. }
  13736. if (!write_request_success) { return false; }
  13737. // Handle Expect: 100-continue response
  13738. if (expect_100_continue) {
  13739. if (res.status == StatusCode::Continue_100) {
  13740. // Server accepted, send the body
  13741. if (!write_request_body(strm, req, error)) { return false; }
  13742. // Read the actual response
  13743. res.headers.clear();
  13744. res.body.clear();
  13745. if (!read_response_line(strm, req, res) ||
  13746. !detail::read_headers(strm, res.headers)) {
  13747. error = Error::Read;
  13748. output_error_log(error, &req);
  13749. return false;
  13750. }
  13751. }
  13752. // If not 100 Continue, server returned an error; proceed with that response
  13753. }
  13754. // Body
  13755. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13756. req.method != "CONNECT") {
  13757. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13758. // whose final transfer coding is not chunked is not ambiguous: its body
  13759. // runs until the server closes the connection, so it is not rejected.
  13760. // HEAD/204 are excluded above and a 304 carries no body.
  13761. if (res.status != StatusCode::NotModified_304 &&
  13762. detail::has_conflicting_content_length(res.headers)) {
  13763. error = Error::Read;
  13764. output_error_log(error, &req);
  13765. return false;
  13766. }
  13767. auto redirect = 300 < res.status && res.status < 400 &&
  13768. res.status != StatusCode::NotModified_304 &&
  13769. follow_location_;
  13770. if (req.response_handler && !redirect) {
  13771. if (!req.response_handler(res)) {
  13772. error = Error::Canceled;
  13773. output_error_log(error, &req);
  13774. return false;
  13775. }
  13776. }
  13777. auto out =
  13778. req.content_receiver
  13779. ? static_cast<ContentReceiverWithProgress>(
  13780. [&](const char *buf, size_t n, size_t off, size_t len) {
  13781. if (redirect) { return true; }
  13782. auto ret = req.content_receiver(buf, n, off, len);
  13783. if (!ret) {
  13784. error = Error::Canceled;
  13785. output_error_log(error, &req);
  13786. }
  13787. return ret;
  13788. })
  13789. : static_cast<ContentReceiverWithProgress>(
  13790. [&](const char *buf, size_t n, size_t /*off*/,
  13791. size_t /*len*/) {
  13792. assert(res.body.size() + n <= res.body.max_size());
  13793. if (payload_max_length_ > 0 &&
  13794. (res.body.size() >= payload_max_length_ ||
  13795. n > payload_max_length_ - res.body.size())) {
  13796. return false;
  13797. }
  13798. res.body.append(buf, n);
  13799. return true;
  13800. });
  13801. auto progress = [&](size_t current, size_t total) {
  13802. if (!req.download_progress || redirect) { return true; }
  13803. auto ret = req.download_progress(current, total);
  13804. if (!ret) {
  13805. error = Error::Canceled;
  13806. output_error_log(error, &req);
  13807. }
  13808. return ret;
  13809. };
  13810. if (res.has_header("Content-Length")) {
  13811. if (!req.content_receiver) {
  13812. auto len = res.get_header_value_u64("Content-Length");
  13813. if (len > res.body.max_size()) {
  13814. error = Error::Read;
  13815. output_error_log(error, &req);
  13816. return false;
  13817. }
  13818. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13819. // hostile or malformed server sends an enormous Content-Length.
  13820. // The actual body read below is bounded by payload_max_length_,
  13821. // so reserving more than that is never useful.
  13822. auto reserve_len = static_cast<size_t>(len);
  13823. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13824. reserve_len = payload_max_length_;
  13825. }
  13826. res.body.reserve(reserve_len);
  13827. }
  13828. }
  13829. if (res.status != StatusCode::NotModified_304) {
  13830. auto content_status = 0;
  13831. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13832. ? (std::numeric_limits<size_t>::max)()
  13833. : payload_max_length_;
  13834. if (!detail::read_content(strm, res, max_length, content_status,
  13835. std::move(progress), std::move(out),
  13836. decompress_)) {
  13837. if (error != Error::Canceled) {
  13838. // Tell the caller apart from a plain read failure when the body could
  13839. // not be decoded because of its Content-Encoding.
  13840. switch (content_status) {
  13841. case StatusCode::UnsupportedMediaType_415:
  13842. error = Error::UnsupportedContentEncoding;
  13843. break;
  13844. case StatusCode::InternalServerError_500:
  13845. error = Error::Compression;
  13846. break;
  13847. default: error = Error::Read; break;
  13848. }
  13849. }
  13850. output_error_log(error, &req);
  13851. return false;
  13852. }
  13853. }
  13854. }
  13855. // Log
  13856. output_log(req, res);
  13857. return true;
  13858. }
  13859. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13860. const std::string &boundary, const UploadFormDataItems &items,
  13861. const FormDataProviderItems &provider_items) const {
  13862. size_t cur_item = 0;
  13863. size_t cur_start = 0;
  13864. // cur_item and cur_start are copied to within the std::function and
  13865. // maintain state between successive calls
  13866. return [&, cur_item, cur_start](size_t offset,
  13867. DataSink &sink) mutable -> bool {
  13868. if (!offset && !items.empty()) {
  13869. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13870. return true;
  13871. } else if (cur_item < provider_items.size()) {
  13872. if (!cur_start) {
  13873. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13874. provider_items[cur_item], boundary);
  13875. offset += begin.size();
  13876. cur_start = offset;
  13877. sink.os << begin;
  13878. }
  13879. DataSink cur_sink;
  13880. auto has_data = true;
  13881. cur_sink.write = sink.write;
  13882. // Forward is_writable so a provider item asking whether it may keep
  13883. // going gets the outer sink's answer rather than the default `true`.
  13884. cur_sink.is_writable = sink.is_writable;
  13885. cur_sink.done = [&]() { has_data = false; };
  13886. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13887. return false;
  13888. }
  13889. if (!has_data) {
  13890. sink.os << detail::serialize_multipart_formdata_item_end();
  13891. cur_item++;
  13892. cur_start = 0;
  13893. }
  13894. return true;
  13895. } else {
  13896. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13897. sink.done();
  13898. return true;
  13899. }
  13900. };
  13901. }
  13902. inline bool ClientImpl::process_socket(
  13903. const Socket &socket,
  13904. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13905. std::function<bool(Stream &strm)> callback) {
  13906. return detail::process_client_socket(
  13907. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13908. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13909. }
  13910. inline bool ClientImpl::is_ssl() const { return false; }
  13911. inline Result ClientImpl::Get(const std::string &path,
  13912. DownloadProgress progress) {
  13913. return Get(path, Headers(), std::move(progress));
  13914. }
  13915. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13916. DownloadProgress progress) {
  13917. return Get(path, params, Headers(), std::move(progress));
  13918. }
  13919. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13920. const Headers &headers,
  13921. DownloadProgress progress) {
  13922. if (params.empty()) { return Get(path, headers); }
  13923. std::string path_with_query = append_query_params(path, params);
  13924. return Get(path_with_query, headers, std::move(progress));
  13925. }
  13926. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13927. DownloadProgress progress) {
  13928. Request req;
  13929. req.method = "GET";
  13930. req.path = path;
  13931. req.headers = headers;
  13932. req.download_progress = std::move(progress);
  13933. if (max_timeout_msec_ > 0) {
  13934. req.start_time_ = std::chrono::steady_clock::now();
  13935. }
  13936. return send_(std::move(req));
  13937. }
  13938. inline Result ClientImpl::Get(const std::string &path,
  13939. ContentReceiver content_receiver,
  13940. DownloadProgress progress) {
  13941. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13942. std::move(progress));
  13943. }
  13944. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13945. ContentReceiver content_receiver,
  13946. DownloadProgress progress) {
  13947. return Get(path, headers, nullptr, std::move(content_receiver),
  13948. std::move(progress));
  13949. }
  13950. inline Result ClientImpl::Get(const std::string &path,
  13951. ResponseHandler response_handler,
  13952. ContentReceiver content_receiver,
  13953. DownloadProgress progress) {
  13954. return Get(path, Headers(), std::move(response_handler),
  13955. std::move(content_receiver), std::move(progress));
  13956. }
  13957. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13958. ResponseHandler response_handler,
  13959. ContentReceiver content_receiver,
  13960. DownloadProgress progress) {
  13961. Request req;
  13962. req.method = "GET";
  13963. req.path = path;
  13964. req.headers = headers;
  13965. req.response_handler = std::move(response_handler);
  13966. req.content_receiver =
  13967. [content_receiver](const char *data, size_t data_length,
  13968. size_t /*offset*/, size_t /*total_length*/) {
  13969. return content_receiver(data, data_length);
  13970. };
  13971. req.download_progress = std::move(progress);
  13972. if (max_timeout_msec_ > 0) {
  13973. req.start_time_ = std::chrono::steady_clock::now();
  13974. }
  13975. return send_(std::move(req));
  13976. }
  13977. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13978. const Headers &headers,
  13979. ContentReceiver content_receiver,
  13980. DownloadProgress progress) {
  13981. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13982. std::move(progress));
  13983. }
  13984. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13985. const Headers &headers,
  13986. ResponseHandler response_handler,
  13987. ContentReceiver content_receiver,
  13988. DownloadProgress progress) {
  13989. if (params.empty()) {
  13990. return Get(path, headers, std::move(response_handler),
  13991. std::move(content_receiver), std::move(progress));
  13992. }
  13993. std::string path_with_query = append_query_params(path, params);
  13994. return Get(path_with_query, headers, std::move(response_handler),
  13995. std::move(content_receiver), std::move(progress));
  13996. }
  13997. inline Result ClientImpl::Head(const std::string &path) {
  13998. return Head(path, Headers());
  13999. }
  14000. inline Result ClientImpl::Head(const std::string &path,
  14001. const Headers &headers) {
  14002. Request req;
  14003. req.method = "HEAD";
  14004. req.headers = headers;
  14005. req.path = path;
  14006. if (max_timeout_msec_ > 0) {
  14007. req.start_time_ = std::chrono::steady_clock::now();
  14008. }
  14009. return send_(std::move(req));
  14010. }
  14011. inline Result ClientImpl::Post(const std::string &path) {
  14012. return Post(path, std::string(), std::string());
  14013. }
  14014. inline Result ClientImpl::Post(const std::string &path,
  14015. const Headers &headers) {
  14016. return Post(path, headers, nullptr, 0, std::string());
  14017. }
  14018. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14019. size_t content_length,
  14020. const std::string &content_type,
  14021. UploadProgress progress) {
  14022. return Post(path, Headers(), body, content_length, content_type, progress);
  14023. }
  14024. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14025. const std::string &content_type,
  14026. UploadProgress progress) {
  14027. return Post(path, Headers(), body, content_type, progress);
  14028. }
  14029. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14030. return Post(path, Headers(), params);
  14031. }
  14032. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14033. ContentProvider content_provider,
  14034. const std::string &content_type,
  14035. UploadProgress progress) {
  14036. return Post(path, Headers(), content_length, std::move(content_provider),
  14037. content_type, progress);
  14038. }
  14039. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14040. ContentProvider content_provider,
  14041. const std::string &content_type,
  14042. ContentReceiver content_receiver,
  14043. UploadProgress progress) {
  14044. return Post(path, Headers(), content_length, std::move(content_provider),
  14045. content_type, std::move(content_receiver), progress);
  14046. }
  14047. inline Result ClientImpl::Post(const std::string &path,
  14048. ContentProviderWithoutLength content_provider,
  14049. const std::string &content_type,
  14050. UploadProgress progress) {
  14051. return Post(path, Headers(), std::move(content_provider), content_type,
  14052. progress);
  14053. }
  14054. inline Result ClientImpl::Post(const std::string &path,
  14055. ContentProviderWithoutLength content_provider,
  14056. const std::string &content_type,
  14057. ContentReceiver content_receiver,
  14058. UploadProgress progress) {
  14059. return Post(path, Headers(), std::move(content_provider), content_type,
  14060. std::move(content_receiver), progress);
  14061. }
  14062. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14063. const Params &params) {
  14064. auto query = detail::params_to_query_str(params);
  14065. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14066. }
  14067. inline Result ClientImpl::Post(const std::string &path,
  14068. const UploadFormDataItems &items,
  14069. UploadProgress progress) {
  14070. return Post(path, Headers(), items, progress);
  14071. }
  14072. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14073. const UploadFormDataItems &items,
  14074. UploadProgress progress) {
  14075. const auto &boundary = detail::make_multipart_data_boundary();
  14076. const auto &content_type =
  14077. detail::serialize_multipart_formdata_get_content_type(boundary);
  14078. auto content_length = detail::get_multipart_content_length(items, boundary);
  14079. return Post(path, headers, content_length,
  14080. detail::make_multipart_content_provider(items, boundary),
  14081. content_type, progress);
  14082. }
  14083. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14084. const UploadFormDataItems &items,
  14085. const std::string &boundary,
  14086. UploadProgress progress) {
  14087. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14088. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14089. }
  14090. const auto &content_type =
  14091. detail::serialize_multipart_formdata_get_content_type(boundary);
  14092. auto content_length = detail::get_multipart_content_length(items, boundary);
  14093. return Post(path, headers, content_length,
  14094. detail::make_multipart_content_provider(items, boundary),
  14095. content_type, progress);
  14096. }
  14097. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14098. const char *body, size_t content_length,
  14099. const std::string &content_type,
  14100. UploadProgress progress) {
  14101. return send_with_content_provider_and_receiver(
  14102. "POST", path, headers, body, content_length, nullptr, nullptr,
  14103. content_type, nullptr, progress);
  14104. }
  14105. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14106. const std::string &body,
  14107. const std::string &content_type,
  14108. UploadProgress progress) {
  14109. return send_with_content_provider_and_receiver(
  14110. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14111. content_type, nullptr, progress);
  14112. }
  14113. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14114. size_t content_length,
  14115. ContentProvider content_provider,
  14116. const std::string &content_type,
  14117. UploadProgress progress) {
  14118. return send_with_content_provider_and_receiver(
  14119. "POST", path, headers, nullptr, content_length,
  14120. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14121. }
  14122. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14123. size_t content_length,
  14124. ContentProvider content_provider,
  14125. const std::string &content_type,
  14126. ContentReceiver content_receiver,
  14127. DownloadProgress progress) {
  14128. return send_with_content_provider_and_receiver(
  14129. "POST", path, headers, nullptr, content_length,
  14130. std::move(content_provider), nullptr, content_type,
  14131. std::move(content_receiver), std::move(progress));
  14132. }
  14133. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14134. ContentProviderWithoutLength content_provider,
  14135. const std::string &content_type,
  14136. UploadProgress progress) {
  14137. return send_with_content_provider_and_receiver(
  14138. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14139. content_type, nullptr, progress);
  14140. }
  14141. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14142. ContentProviderWithoutLength content_provider,
  14143. const std::string &content_type,
  14144. ContentReceiver content_receiver,
  14145. DownloadProgress progress) {
  14146. return send_with_content_provider_and_receiver(
  14147. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14148. content_type, std::move(content_receiver), std::move(progress));
  14149. }
  14150. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14151. const UploadFormDataItems &items,
  14152. const FormDataProviderItems &provider_items,
  14153. UploadProgress progress) {
  14154. const auto &boundary = detail::make_multipart_data_boundary();
  14155. const auto &content_type =
  14156. detail::serialize_multipart_formdata_get_content_type(boundary);
  14157. return send_with_content_provider_and_receiver(
  14158. "POST", path, headers, nullptr, 0, nullptr,
  14159. get_multipart_content_provider(boundary, items, provider_items),
  14160. content_type, nullptr, progress);
  14161. }
  14162. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14163. const std::string &body,
  14164. const std::string &content_type,
  14165. ContentReceiver content_receiver,
  14166. DownloadProgress progress) {
  14167. Request req;
  14168. req.method = "POST";
  14169. req.path = path;
  14170. req.headers = headers;
  14171. req.body = body;
  14172. req.content_receiver =
  14173. [content_receiver](const char *data, size_t data_length,
  14174. size_t /*offset*/, size_t /*total_length*/) {
  14175. return content_receiver(data, data_length);
  14176. };
  14177. req.download_progress = std::move(progress);
  14178. if (max_timeout_msec_ > 0) {
  14179. req.start_time_ = std::chrono::steady_clock::now();
  14180. }
  14181. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14182. return send_(std::move(req));
  14183. }
  14184. inline Result ClientImpl::Put(const std::string &path) {
  14185. return Put(path, std::string(), std::string());
  14186. }
  14187. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14188. return Put(path, headers, nullptr, 0, std::string());
  14189. }
  14190. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14191. size_t content_length,
  14192. const std::string &content_type,
  14193. UploadProgress progress) {
  14194. return Put(path, Headers(), body, content_length, content_type, progress);
  14195. }
  14196. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14197. const std::string &content_type,
  14198. UploadProgress progress) {
  14199. return Put(path, Headers(), body, content_type, progress);
  14200. }
  14201. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14202. return Put(path, Headers(), params);
  14203. }
  14204. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14205. ContentProvider content_provider,
  14206. const std::string &content_type,
  14207. UploadProgress progress) {
  14208. return Put(path, Headers(), content_length, std::move(content_provider),
  14209. content_type, progress);
  14210. }
  14211. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14212. ContentProvider content_provider,
  14213. const std::string &content_type,
  14214. ContentReceiver content_receiver,
  14215. UploadProgress progress) {
  14216. return Put(path, Headers(), content_length, std::move(content_provider),
  14217. content_type, std::move(content_receiver), progress);
  14218. }
  14219. inline Result ClientImpl::Put(const std::string &path,
  14220. ContentProviderWithoutLength content_provider,
  14221. const std::string &content_type,
  14222. UploadProgress progress) {
  14223. return Put(path, Headers(), std::move(content_provider), content_type,
  14224. progress);
  14225. }
  14226. inline Result ClientImpl::Put(const std::string &path,
  14227. ContentProviderWithoutLength content_provider,
  14228. const std::string &content_type,
  14229. ContentReceiver content_receiver,
  14230. UploadProgress progress) {
  14231. return Put(path, Headers(), std::move(content_provider), content_type,
  14232. std::move(content_receiver), progress);
  14233. }
  14234. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14235. const Params &params) {
  14236. auto query = detail::params_to_query_str(params);
  14237. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14238. }
  14239. inline Result ClientImpl::Put(const std::string &path,
  14240. const UploadFormDataItems &items,
  14241. UploadProgress progress) {
  14242. return Put(path, Headers(), items, progress);
  14243. }
  14244. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14245. const UploadFormDataItems &items,
  14246. UploadProgress progress) {
  14247. const auto &boundary = detail::make_multipart_data_boundary();
  14248. const auto &content_type =
  14249. detail::serialize_multipart_formdata_get_content_type(boundary);
  14250. auto content_length = detail::get_multipart_content_length(items, boundary);
  14251. return Put(path, headers, content_length,
  14252. detail::make_multipart_content_provider(items, boundary),
  14253. content_type, progress);
  14254. }
  14255. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14256. const UploadFormDataItems &items,
  14257. const std::string &boundary,
  14258. UploadProgress progress) {
  14259. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14260. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14261. }
  14262. const auto &content_type =
  14263. detail::serialize_multipart_formdata_get_content_type(boundary);
  14264. auto content_length = detail::get_multipart_content_length(items, boundary);
  14265. return Put(path, headers, content_length,
  14266. detail::make_multipart_content_provider(items, boundary),
  14267. content_type, progress);
  14268. }
  14269. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14270. const char *body, size_t content_length,
  14271. const std::string &content_type,
  14272. UploadProgress progress) {
  14273. return send_with_content_provider_and_receiver(
  14274. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14275. content_type, nullptr, progress);
  14276. }
  14277. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14278. const std::string &body,
  14279. const std::string &content_type,
  14280. UploadProgress progress) {
  14281. return send_with_content_provider_and_receiver(
  14282. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14283. content_type, nullptr, progress);
  14284. }
  14285. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14286. size_t content_length,
  14287. ContentProvider content_provider,
  14288. const std::string &content_type,
  14289. UploadProgress progress) {
  14290. return send_with_content_provider_and_receiver(
  14291. "PUT", path, headers, nullptr, content_length,
  14292. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14293. }
  14294. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14295. size_t content_length,
  14296. ContentProvider content_provider,
  14297. const std::string &content_type,
  14298. ContentReceiver content_receiver,
  14299. UploadProgress progress) {
  14300. return send_with_content_provider_and_receiver(
  14301. "PUT", path, headers, nullptr, content_length,
  14302. std::move(content_provider), nullptr, content_type,
  14303. std::move(content_receiver), progress);
  14304. }
  14305. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14306. ContentProviderWithoutLength content_provider,
  14307. const std::string &content_type,
  14308. UploadProgress progress) {
  14309. return send_with_content_provider_and_receiver(
  14310. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14311. content_type, nullptr, progress);
  14312. }
  14313. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14314. ContentProviderWithoutLength content_provider,
  14315. const std::string &content_type,
  14316. ContentReceiver content_receiver,
  14317. UploadProgress progress) {
  14318. return send_with_content_provider_and_receiver(
  14319. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14320. content_type, std::move(content_receiver), progress);
  14321. }
  14322. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14323. const UploadFormDataItems &items,
  14324. const FormDataProviderItems &provider_items,
  14325. UploadProgress progress) {
  14326. const auto &boundary = detail::make_multipart_data_boundary();
  14327. const auto &content_type =
  14328. detail::serialize_multipart_formdata_get_content_type(boundary);
  14329. return send_with_content_provider_and_receiver(
  14330. "PUT", path, headers, nullptr, 0, nullptr,
  14331. get_multipart_content_provider(boundary, items, provider_items),
  14332. content_type, nullptr, progress);
  14333. }
  14334. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14335. const std::string &body,
  14336. const std::string &content_type,
  14337. ContentReceiver content_receiver,
  14338. DownloadProgress progress) {
  14339. Request req;
  14340. req.method = "PUT";
  14341. req.path = path;
  14342. req.headers = headers;
  14343. req.body = body;
  14344. req.content_receiver =
  14345. [content_receiver](const char *data, size_t data_length,
  14346. size_t /*offset*/, size_t /*total_length*/) {
  14347. return content_receiver(data, data_length);
  14348. };
  14349. req.download_progress = std::move(progress);
  14350. if (max_timeout_msec_ > 0) {
  14351. req.start_time_ = std::chrono::steady_clock::now();
  14352. }
  14353. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14354. return send_(std::move(req));
  14355. }
  14356. inline Result ClientImpl::Patch(const std::string &path) {
  14357. return Patch(path, std::string(), std::string());
  14358. }
  14359. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14360. UploadProgress progress) {
  14361. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14362. }
  14363. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14364. size_t content_length,
  14365. const std::string &content_type,
  14366. UploadProgress progress) {
  14367. return Patch(path, Headers(), body, content_length, content_type, progress);
  14368. }
  14369. inline Result ClientImpl::Patch(const std::string &path,
  14370. const std::string &body,
  14371. const std::string &content_type,
  14372. UploadProgress progress) {
  14373. return Patch(path, Headers(), body, content_type, progress);
  14374. }
  14375. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14376. return Patch(path, Headers(), params);
  14377. }
  14378. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14379. ContentProvider content_provider,
  14380. const std::string &content_type,
  14381. UploadProgress progress) {
  14382. return Patch(path, Headers(), content_length, std::move(content_provider),
  14383. content_type, progress);
  14384. }
  14385. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14386. ContentProvider content_provider,
  14387. const std::string &content_type,
  14388. ContentReceiver content_receiver,
  14389. UploadProgress progress) {
  14390. return Patch(path, Headers(), content_length, std::move(content_provider),
  14391. content_type, std::move(content_receiver), progress);
  14392. }
  14393. inline Result ClientImpl::Patch(const std::string &path,
  14394. ContentProviderWithoutLength content_provider,
  14395. const std::string &content_type,
  14396. UploadProgress progress) {
  14397. return Patch(path, Headers(), std::move(content_provider), content_type,
  14398. progress);
  14399. }
  14400. inline Result ClientImpl::Patch(const std::string &path,
  14401. ContentProviderWithoutLength content_provider,
  14402. const std::string &content_type,
  14403. ContentReceiver content_receiver,
  14404. UploadProgress progress) {
  14405. return Patch(path, Headers(), std::move(content_provider), content_type,
  14406. std::move(content_receiver), progress);
  14407. }
  14408. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14409. const Params &params) {
  14410. auto query = detail::params_to_query_str(params);
  14411. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14412. }
  14413. inline Result ClientImpl::Patch(const std::string &path,
  14414. const UploadFormDataItems &items,
  14415. UploadProgress progress) {
  14416. return Patch(path, Headers(), items, progress);
  14417. }
  14418. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14419. const UploadFormDataItems &items,
  14420. UploadProgress progress) {
  14421. const auto &boundary = detail::make_multipart_data_boundary();
  14422. const auto &content_type =
  14423. detail::serialize_multipart_formdata_get_content_type(boundary);
  14424. auto content_length = detail::get_multipart_content_length(items, boundary);
  14425. return Patch(path, headers, content_length,
  14426. detail::make_multipart_content_provider(items, boundary),
  14427. content_type, progress);
  14428. }
  14429. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14430. const UploadFormDataItems &items,
  14431. const std::string &boundary,
  14432. UploadProgress progress) {
  14433. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14434. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14435. }
  14436. const auto &content_type =
  14437. detail::serialize_multipart_formdata_get_content_type(boundary);
  14438. auto content_length = detail::get_multipart_content_length(items, boundary);
  14439. return Patch(path, headers, content_length,
  14440. detail::make_multipart_content_provider(items, boundary),
  14441. content_type, progress);
  14442. }
  14443. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14444. const char *body, size_t content_length,
  14445. const std::string &content_type,
  14446. UploadProgress progress) {
  14447. return send_with_content_provider_and_receiver(
  14448. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14449. content_type, nullptr, progress);
  14450. }
  14451. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14452. const std::string &body,
  14453. const std::string &content_type,
  14454. UploadProgress progress) {
  14455. return send_with_content_provider_and_receiver(
  14456. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14457. content_type, nullptr, progress);
  14458. }
  14459. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14460. size_t content_length,
  14461. ContentProvider content_provider,
  14462. const std::string &content_type,
  14463. UploadProgress progress) {
  14464. return send_with_content_provider_and_receiver(
  14465. "PATCH", path, headers, nullptr, content_length,
  14466. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14467. }
  14468. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14469. size_t content_length,
  14470. ContentProvider content_provider,
  14471. const std::string &content_type,
  14472. ContentReceiver content_receiver,
  14473. UploadProgress progress) {
  14474. return send_with_content_provider_and_receiver(
  14475. "PATCH", path, headers, nullptr, content_length,
  14476. std::move(content_provider), nullptr, content_type,
  14477. std::move(content_receiver), progress);
  14478. }
  14479. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14480. ContentProviderWithoutLength content_provider,
  14481. const std::string &content_type,
  14482. UploadProgress progress) {
  14483. return send_with_content_provider_and_receiver(
  14484. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14485. content_type, nullptr, progress);
  14486. }
  14487. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14488. ContentProviderWithoutLength content_provider,
  14489. const std::string &content_type,
  14490. ContentReceiver content_receiver,
  14491. UploadProgress progress) {
  14492. return send_with_content_provider_and_receiver(
  14493. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14494. content_type, std::move(content_receiver), progress);
  14495. }
  14496. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14497. const UploadFormDataItems &items,
  14498. const FormDataProviderItems &provider_items,
  14499. UploadProgress progress) {
  14500. const auto &boundary = detail::make_multipart_data_boundary();
  14501. const auto &content_type =
  14502. detail::serialize_multipart_formdata_get_content_type(boundary);
  14503. return send_with_content_provider_and_receiver(
  14504. "PATCH", path, headers, nullptr, 0, nullptr,
  14505. get_multipart_content_provider(boundary, items, provider_items),
  14506. content_type, nullptr, progress);
  14507. }
  14508. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14509. const std::string &body,
  14510. const std::string &content_type,
  14511. ContentReceiver content_receiver,
  14512. DownloadProgress progress) {
  14513. Request req;
  14514. req.method = "PATCH";
  14515. req.path = path;
  14516. req.headers = headers;
  14517. req.body = body;
  14518. req.content_receiver =
  14519. [content_receiver](const char *data, size_t data_length,
  14520. size_t /*offset*/, size_t /*total_length*/) {
  14521. return content_receiver(data, data_length);
  14522. };
  14523. req.download_progress = std::move(progress);
  14524. if (max_timeout_msec_ > 0) {
  14525. req.start_time_ = std::chrono::steady_clock::now();
  14526. }
  14527. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14528. return send_(std::move(req));
  14529. }
  14530. inline Result ClientImpl::Delete(const std::string &path,
  14531. DownloadProgress progress) {
  14532. return Delete(path, Headers(), std::string(), std::string(), progress);
  14533. }
  14534. inline Result ClientImpl::Delete(const std::string &path,
  14535. const Headers &headers,
  14536. DownloadProgress progress) {
  14537. return Delete(path, headers, std::string(), std::string(), progress);
  14538. }
  14539. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14540. size_t content_length,
  14541. const std::string &content_type,
  14542. DownloadProgress progress) {
  14543. return Delete(path, Headers(), body, content_length, content_type, progress);
  14544. }
  14545. inline Result ClientImpl::Delete(const std::string &path,
  14546. const std::string &body,
  14547. const std::string &content_type,
  14548. DownloadProgress progress) {
  14549. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14550. progress);
  14551. }
  14552. inline Result ClientImpl::Delete(const std::string &path,
  14553. const Headers &headers,
  14554. const std::string &body,
  14555. const std::string &content_type,
  14556. DownloadProgress progress) {
  14557. return Delete(path, headers, body.data(), body.size(), content_type,
  14558. progress);
  14559. }
  14560. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14561. DownloadProgress progress) {
  14562. return Delete(path, Headers(), params, progress);
  14563. }
  14564. inline Result ClientImpl::Delete(const std::string &path,
  14565. const Headers &headers, const Params &params,
  14566. DownloadProgress progress) {
  14567. auto query = detail::params_to_query_str(params);
  14568. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14569. progress);
  14570. }
  14571. inline Result ClientImpl::Delete(const std::string &path,
  14572. const Headers &headers, const char *body,
  14573. size_t content_length,
  14574. const std::string &content_type,
  14575. DownloadProgress progress) {
  14576. Request req;
  14577. req.method = "DELETE";
  14578. req.headers = headers;
  14579. req.path = path;
  14580. req.download_progress = std::move(progress);
  14581. if (max_timeout_msec_ > 0) {
  14582. req.start_time_ = std::chrono::steady_clock::now();
  14583. }
  14584. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14585. req.body.assign(body, content_length);
  14586. return send_(std::move(req));
  14587. }
  14588. inline Result ClientImpl::Options(const std::string &path) {
  14589. return Options(path, Headers());
  14590. }
  14591. inline Result ClientImpl::Options(const std::string &path,
  14592. const Headers &headers) {
  14593. Request req;
  14594. req.method = "OPTIONS";
  14595. req.headers = headers;
  14596. req.path = path;
  14597. if (max_timeout_msec_ > 0) {
  14598. req.start_time_ = std::chrono::steady_clock::now();
  14599. }
  14600. return send_(std::move(req));
  14601. }
  14602. inline void ClientImpl::stop() {
  14603. std::lock_guard<std::mutex> guard(socket_mutex_);
  14604. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14605. // do is to shutdown_socket, so that threads using this socket suddenly
  14606. // discover they can't read/write any more and error out. Everything else
  14607. // (closing the socket, shutting ssl down) is unsafe because these actions
  14608. // are not thread-safe.
  14609. if (socket_requests_in_flight_ > 0) {
  14610. shutdown_socket(socket_);
  14611. // Aside from that, we set a flag for the socket to be closed when we're
  14612. // done.
  14613. socket_should_be_closed_when_request_is_done_ = true;
  14614. return;
  14615. }
  14616. disconnect(/*gracefully=*/true);
  14617. }
  14618. inline std::string ClientImpl::host() const { return host_; }
  14619. inline int ClientImpl::port() const { return port_; }
  14620. inline size_t ClientImpl::is_socket_open() const {
  14621. std::lock_guard<std::mutex> guard(socket_mutex_);
  14622. return socket_.is_open();
  14623. }
  14624. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14625. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14626. connection_timeout_sec_ = sec;
  14627. connection_timeout_usec_ = usec;
  14628. }
  14629. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14630. read_timeout_sec_ = sec;
  14631. read_timeout_usec_ = usec;
  14632. }
  14633. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14634. write_timeout_sec_ = sec;
  14635. write_timeout_usec_ = usec;
  14636. }
  14637. inline void ClientImpl::set_max_timeout(time_t msec) {
  14638. max_timeout_msec_ = msec;
  14639. }
  14640. inline void ClientImpl::set_basic_auth(const std::string &username,
  14641. const std::string &password) {
  14642. basic_auth_username_ = username;
  14643. basic_auth_password_ = password;
  14644. }
  14645. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14646. bearer_token_auth_token_ = token;
  14647. }
  14648. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14649. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14650. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14651. inline void
  14652. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14653. addr_map_ = std::move(addr_map);
  14654. }
  14655. inline void ClientImpl::set_default_headers(Headers headers) {
  14656. default_headers_ = std::move(headers);
  14657. }
  14658. inline void ClientImpl::set_header_writer(
  14659. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14660. header_writer_ = writer;
  14661. }
  14662. inline void ClientImpl::set_address_family(int family) {
  14663. address_family_ = family;
  14664. }
  14665. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14666. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14667. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14668. socket_options_ = std::move(socket_options);
  14669. }
  14670. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14671. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14672. inline void ClientImpl::set_payload_max_length(size_t length) {
  14673. payload_max_length_ = length;
  14674. has_payload_max_length_ = true;
  14675. }
  14676. inline void ClientImpl::set_interface(const std::string &intf) {
  14677. interface_ = intf;
  14678. }
  14679. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14680. proxy_host_ = host;
  14681. proxy_port_ = port;
  14682. std::lock_guard<std::mutex> guard(socket_mutex_);
  14683. disconnect(/*gracefully=*/true);
  14684. }
  14685. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14686. const std::string &password) {
  14687. proxy_basic_auth_username_ = username;
  14688. proxy_basic_auth_password_ = password;
  14689. }
  14690. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14691. proxy_bearer_token_auth_token_ = token;
  14692. }
  14693. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14694. std::vector<detail::NoProxyEntry> parsed;
  14695. parsed.reserve(patterns.size());
  14696. for (const auto &p : patterns) {
  14697. auto trimmed = detail::trim_copy(p);
  14698. if (trimmed.empty()) { continue; }
  14699. detail::NoProxyEntry entry;
  14700. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14701. parsed.push_back(std::move(entry));
  14702. }
  14703. }
  14704. no_proxy_entries_ = std::move(parsed);
  14705. std::lock_guard<std::mutex> guard(socket_mutex_);
  14706. disconnect(/*gracefully=*/true);
  14707. }
  14708. #ifdef CPPHTTPLIB_SSL_ENABLED
  14709. inline void ClientImpl::set_digest_auth(const std::string &username,
  14710. const std::string &password) {
  14711. digest_auth_username_ = username;
  14712. digest_auth_password_ = password;
  14713. }
  14714. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14715. const std::string &ca_cert_dir_path) {
  14716. ca_cert_file_path_ = ca_cert_file_path;
  14717. ca_cert_dir_path_ = ca_cert_dir_path;
  14718. }
  14719. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14720. const std::string &password) {
  14721. proxy_digest_auth_username_ = username;
  14722. proxy_digest_auth_password_ = password;
  14723. }
  14724. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14725. server_certificate_verification_ = enabled;
  14726. }
  14727. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14728. server_hostname_verification_ = enabled;
  14729. }
  14730. inline void ClientImpl::enable_system_ca(bool enabled) {
  14731. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14732. }
  14733. #endif
  14734. inline void ClientImpl::set_logger(Logger logger) {
  14735. logger_ = std::move(logger);
  14736. }
  14737. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14738. error_logger_ = std::move(error_logger);
  14739. }
  14740. /*
  14741. * SSL/TLS Common Implementation
  14742. */
  14743. inline ClientConnection::~ClientConnection() {
  14744. #ifdef CPPHTTPLIB_SSL_ENABLED
  14745. if (session) {
  14746. tls::shutdown(session, true);
  14747. tls::free_session(session);
  14748. session = nullptr;
  14749. }
  14750. #endif
  14751. if (sock != INVALID_SOCKET) {
  14752. detail::close_socket(sock);
  14753. sock = INVALID_SOCKET;
  14754. }
  14755. }
  14756. // Universal client implementation
  14757. inline Client::Client(const std::string &scheme_host_port)
  14758. : Client(scheme_host_port, std::string(), std::string()) {}
  14759. inline Client::Client(const std::string &scheme_host_port,
  14760. const std::string &client_cert_path,
  14761. const std::string &client_key_path) {
  14762. detail::UrlComponents uc;
  14763. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14764. auto &scheme = uc.scheme;
  14765. #ifdef CPPHTTPLIB_SSL_ENABLED
  14766. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14767. #else
  14768. if (!scheme.empty() && scheme != "http") {
  14769. #endif
  14770. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14771. std::string msg = "'" + scheme + "' scheme is not supported.";
  14772. throw std::invalid_argument(msg);
  14773. #endif
  14774. return;
  14775. }
  14776. auto is_ssl = scheme == "https";
  14777. auto host = std::move(uc.host);
  14778. auto port = is_ssl ? 443 : 80;
  14779. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14780. if (is_ssl) {
  14781. #ifdef CPPHTTPLIB_SSL_ENABLED
  14782. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14783. client_key_path);
  14784. is_ssl_ = is_ssl;
  14785. #endif
  14786. } else {
  14787. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14788. client_key_path);
  14789. }
  14790. } else {
  14791. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14792. // if port param below changes.
  14793. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14794. client_cert_path, client_key_path);
  14795. }
  14796. }
  14797. inline Client::Client(const std::string &host, int port)
  14798. : Client(host, port, std::string(), std::string()) {}
  14799. inline Client::Client(const std::string &host, int port,
  14800. const std::string &client_cert_path,
  14801. const std::string &client_key_path)
  14802. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14803. client_key_path)) {}
  14804. inline Client::~Client() = default;
  14805. inline bool Client::is_valid() const {
  14806. return cli_ != nullptr && cli_->is_valid();
  14807. }
  14808. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14809. return cli_->Get(path, std::move(progress));
  14810. }
  14811. inline Result Client::Get(const std::string &path, const Headers &headers,
  14812. DownloadProgress progress) {
  14813. return cli_->Get(path, headers, std::move(progress));
  14814. }
  14815. inline Result Client::Get(const std::string &path,
  14816. ContentReceiver content_receiver,
  14817. DownloadProgress progress) {
  14818. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14819. }
  14820. inline Result Client::Get(const std::string &path, const Headers &headers,
  14821. ContentReceiver content_receiver,
  14822. DownloadProgress progress) {
  14823. return cli_->Get(path, headers, std::move(content_receiver),
  14824. std::move(progress));
  14825. }
  14826. inline Result Client::Get(const std::string &path,
  14827. ResponseHandler response_handler,
  14828. ContentReceiver content_receiver,
  14829. DownloadProgress progress) {
  14830. return cli_->Get(path, std::move(response_handler),
  14831. std::move(content_receiver), std::move(progress));
  14832. }
  14833. inline Result Client::Get(const std::string &path, const Headers &headers,
  14834. ResponseHandler response_handler,
  14835. ContentReceiver content_receiver,
  14836. DownloadProgress progress) {
  14837. return cli_->Get(path, headers, std::move(response_handler),
  14838. std::move(content_receiver), std::move(progress));
  14839. }
  14840. inline Result Client::Get(const std::string &path, const Params &params,
  14841. DownloadProgress progress) {
  14842. return cli_->Get(path, params, std::move(progress));
  14843. }
  14844. inline Result Client::Get(const std::string &path, const Params &params,
  14845. const Headers &headers, DownloadProgress progress) {
  14846. return cli_->Get(path, params, headers, std::move(progress));
  14847. }
  14848. inline Result Client::Get(const std::string &path, const Params &params,
  14849. const Headers &headers,
  14850. ContentReceiver content_receiver,
  14851. DownloadProgress progress) {
  14852. return cli_->Get(path, params, headers, std::move(content_receiver),
  14853. std::move(progress));
  14854. }
  14855. inline Result Client::Get(const std::string &path, const Params &params,
  14856. const Headers &headers,
  14857. ResponseHandler response_handler,
  14858. ContentReceiver content_receiver,
  14859. DownloadProgress progress) {
  14860. return cli_->Get(path, params, headers, std::move(response_handler),
  14861. std::move(content_receiver), std::move(progress));
  14862. }
  14863. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14864. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14865. return cli_->Head(path, headers);
  14866. }
  14867. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14868. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14869. return cli_->Post(path, headers);
  14870. }
  14871. inline Result Client::Post(const std::string &path, const char *body,
  14872. size_t content_length,
  14873. const std::string &content_type,
  14874. UploadProgress progress) {
  14875. return cli_->Post(path, body, content_length, content_type, progress);
  14876. }
  14877. inline Result Client::Post(const std::string &path, const Headers &headers,
  14878. const char *body, size_t content_length,
  14879. const std::string &content_type,
  14880. UploadProgress progress) {
  14881. return cli_->Post(path, headers, body, content_length, content_type,
  14882. progress);
  14883. }
  14884. inline Result Client::Post(const std::string &path, const std::string &body,
  14885. const std::string &content_type,
  14886. UploadProgress progress) {
  14887. return cli_->Post(path, body, content_type, progress);
  14888. }
  14889. inline Result Client::Post(const std::string &path, const Headers &headers,
  14890. const std::string &body,
  14891. const std::string &content_type,
  14892. UploadProgress progress) {
  14893. return cli_->Post(path, headers, body, content_type, progress);
  14894. }
  14895. inline Result Client::Post(const std::string &path, size_t content_length,
  14896. ContentProvider content_provider,
  14897. const std::string &content_type,
  14898. UploadProgress progress) {
  14899. return cli_->Post(path, content_length, std::move(content_provider),
  14900. content_type, progress);
  14901. }
  14902. inline Result Client::Post(const std::string &path, size_t content_length,
  14903. ContentProvider content_provider,
  14904. const std::string &content_type,
  14905. ContentReceiver content_receiver,
  14906. UploadProgress progress) {
  14907. return cli_->Post(path, content_length, std::move(content_provider),
  14908. content_type, std::move(content_receiver), progress);
  14909. }
  14910. inline Result Client::Post(const std::string &path,
  14911. ContentProviderWithoutLength content_provider,
  14912. const std::string &content_type,
  14913. UploadProgress progress) {
  14914. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14915. }
  14916. inline Result Client::Post(const std::string &path,
  14917. ContentProviderWithoutLength content_provider,
  14918. const std::string &content_type,
  14919. ContentReceiver content_receiver,
  14920. UploadProgress progress) {
  14921. return cli_->Post(path, std::move(content_provider), content_type,
  14922. std::move(content_receiver), progress);
  14923. }
  14924. inline Result Client::Post(const std::string &path, const Headers &headers,
  14925. size_t content_length,
  14926. ContentProvider content_provider,
  14927. const std::string &content_type,
  14928. UploadProgress progress) {
  14929. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14930. content_type, progress);
  14931. }
  14932. inline Result Client::Post(const std::string &path, const Headers &headers,
  14933. size_t content_length,
  14934. ContentProvider content_provider,
  14935. const std::string &content_type,
  14936. ContentReceiver content_receiver,
  14937. DownloadProgress progress) {
  14938. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14939. content_type, std::move(content_receiver), progress);
  14940. }
  14941. inline Result Client::Post(const std::string &path, const Headers &headers,
  14942. ContentProviderWithoutLength content_provider,
  14943. const std::string &content_type,
  14944. UploadProgress progress) {
  14945. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14946. progress);
  14947. }
  14948. inline Result Client::Post(const std::string &path, const Headers &headers,
  14949. ContentProviderWithoutLength content_provider,
  14950. const std::string &content_type,
  14951. ContentReceiver content_receiver,
  14952. DownloadProgress progress) {
  14953. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14954. std::move(content_receiver), progress);
  14955. }
  14956. inline Result Client::Post(const std::string &path, const Params &params) {
  14957. return cli_->Post(path, params);
  14958. }
  14959. inline Result Client::Post(const std::string &path, const Headers &headers,
  14960. const Params &params) {
  14961. return cli_->Post(path, headers, params);
  14962. }
  14963. inline Result Client::Post(const std::string &path,
  14964. const UploadFormDataItems &items,
  14965. UploadProgress progress) {
  14966. return cli_->Post(path, items, progress);
  14967. }
  14968. inline Result Client::Post(const std::string &path, const Headers &headers,
  14969. const UploadFormDataItems &items,
  14970. UploadProgress progress) {
  14971. return cli_->Post(path, headers, items, progress);
  14972. }
  14973. inline Result Client::Post(const std::string &path, const Headers &headers,
  14974. const UploadFormDataItems &items,
  14975. const std::string &boundary,
  14976. UploadProgress progress) {
  14977. return cli_->Post(path, headers, items, boundary, progress);
  14978. }
  14979. inline Result Client::Post(const std::string &path, const Headers &headers,
  14980. const UploadFormDataItems &items,
  14981. const FormDataProviderItems &provider_items,
  14982. UploadProgress progress) {
  14983. return cli_->Post(path, headers, items, provider_items, progress);
  14984. }
  14985. inline Result Client::Post(const std::string &path, const Headers &headers,
  14986. const std::string &body,
  14987. const std::string &content_type,
  14988. ContentReceiver content_receiver,
  14989. DownloadProgress progress) {
  14990. return cli_->Post(path, headers, body, content_type,
  14991. std::move(content_receiver), progress);
  14992. }
  14993. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14994. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14995. return cli_->Put(path, headers);
  14996. }
  14997. inline Result Client::Put(const std::string &path, const char *body,
  14998. size_t content_length,
  14999. const std::string &content_type,
  15000. UploadProgress progress) {
  15001. return cli_->Put(path, body, content_length, content_type, progress);
  15002. }
  15003. inline Result Client::Put(const std::string &path, const Headers &headers,
  15004. const char *body, size_t content_length,
  15005. const std::string &content_type,
  15006. UploadProgress progress) {
  15007. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15008. }
  15009. inline Result Client::Put(const std::string &path, const std::string &body,
  15010. const std::string &content_type,
  15011. UploadProgress progress) {
  15012. return cli_->Put(path, body, content_type, progress);
  15013. }
  15014. inline Result Client::Put(const std::string &path, const Headers &headers,
  15015. const std::string &body,
  15016. const std::string &content_type,
  15017. UploadProgress progress) {
  15018. return cli_->Put(path, headers, body, content_type, progress);
  15019. }
  15020. inline Result Client::Put(const std::string &path, size_t content_length,
  15021. ContentProvider content_provider,
  15022. const std::string &content_type,
  15023. UploadProgress progress) {
  15024. return cli_->Put(path, content_length, std::move(content_provider),
  15025. content_type, progress);
  15026. }
  15027. inline Result Client::Put(const std::string &path, size_t content_length,
  15028. ContentProvider content_provider,
  15029. const std::string &content_type,
  15030. ContentReceiver content_receiver,
  15031. UploadProgress progress) {
  15032. return cli_->Put(path, content_length, std::move(content_provider),
  15033. content_type, std::move(content_receiver), progress);
  15034. }
  15035. inline Result Client::Put(const std::string &path,
  15036. ContentProviderWithoutLength content_provider,
  15037. const std::string &content_type,
  15038. UploadProgress progress) {
  15039. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15040. }
  15041. inline Result Client::Put(const std::string &path,
  15042. ContentProviderWithoutLength content_provider,
  15043. const std::string &content_type,
  15044. ContentReceiver content_receiver,
  15045. UploadProgress progress) {
  15046. return cli_->Put(path, std::move(content_provider), content_type,
  15047. std::move(content_receiver), progress);
  15048. }
  15049. inline Result Client::Put(const std::string &path, const Headers &headers,
  15050. size_t content_length,
  15051. ContentProvider content_provider,
  15052. const std::string &content_type,
  15053. UploadProgress progress) {
  15054. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15055. content_type, progress);
  15056. }
  15057. inline Result Client::Put(const std::string &path, const Headers &headers,
  15058. size_t content_length,
  15059. ContentProvider content_provider,
  15060. const std::string &content_type,
  15061. ContentReceiver content_receiver,
  15062. UploadProgress progress) {
  15063. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15064. content_type, std::move(content_receiver), progress);
  15065. }
  15066. inline Result Client::Put(const std::string &path, const Headers &headers,
  15067. ContentProviderWithoutLength content_provider,
  15068. const std::string &content_type,
  15069. UploadProgress progress) {
  15070. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15071. progress);
  15072. }
  15073. inline Result Client::Put(const std::string &path, const Headers &headers,
  15074. ContentProviderWithoutLength content_provider,
  15075. const std::string &content_type,
  15076. ContentReceiver content_receiver,
  15077. UploadProgress progress) {
  15078. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15079. std::move(content_receiver), progress);
  15080. }
  15081. inline Result Client::Put(const std::string &path, const Params &params) {
  15082. return cli_->Put(path, params);
  15083. }
  15084. inline Result Client::Put(const std::string &path, const Headers &headers,
  15085. const Params &params) {
  15086. return cli_->Put(path, headers, params);
  15087. }
  15088. inline Result Client::Put(const std::string &path,
  15089. const UploadFormDataItems &items,
  15090. UploadProgress progress) {
  15091. return cli_->Put(path, items, progress);
  15092. }
  15093. inline Result Client::Put(const std::string &path, const Headers &headers,
  15094. const UploadFormDataItems &items,
  15095. UploadProgress progress) {
  15096. return cli_->Put(path, headers, items, progress);
  15097. }
  15098. inline Result Client::Put(const std::string &path, const Headers &headers,
  15099. const UploadFormDataItems &items,
  15100. const std::string &boundary,
  15101. UploadProgress progress) {
  15102. return cli_->Put(path, headers, items, boundary, progress);
  15103. }
  15104. inline Result Client::Put(const std::string &path, const Headers &headers,
  15105. const UploadFormDataItems &items,
  15106. const FormDataProviderItems &provider_items,
  15107. UploadProgress progress) {
  15108. return cli_->Put(path, headers, items, provider_items, progress);
  15109. }
  15110. inline Result Client::Put(const std::string &path, const Headers &headers,
  15111. const std::string &body,
  15112. const std::string &content_type,
  15113. ContentReceiver content_receiver,
  15114. DownloadProgress progress) {
  15115. return cli_->Put(path, headers, body, content_type, content_receiver,
  15116. progress);
  15117. }
  15118. inline Result Client::Patch(const std::string &path) {
  15119. return cli_->Patch(path);
  15120. }
  15121. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15122. return cli_->Patch(path, headers);
  15123. }
  15124. inline Result Client::Patch(const std::string &path, const char *body,
  15125. size_t content_length,
  15126. const std::string &content_type,
  15127. UploadProgress progress) {
  15128. return cli_->Patch(path, body, content_length, content_type, progress);
  15129. }
  15130. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15131. const char *body, size_t content_length,
  15132. const std::string &content_type,
  15133. UploadProgress progress) {
  15134. return cli_->Patch(path, headers, body, content_length, content_type,
  15135. progress);
  15136. }
  15137. inline Result Client::Patch(const std::string &path, const std::string &body,
  15138. const std::string &content_type,
  15139. UploadProgress progress) {
  15140. return cli_->Patch(path, body, content_type, progress);
  15141. }
  15142. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15143. const std::string &body,
  15144. const std::string &content_type,
  15145. UploadProgress progress) {
  15146. return cli_->Patch(path, headers, body, content_type, progress);
  15147. }
  15148. inline Result Client::Patch(const std::string &path, size_t content_length,
  15149. ContentProvider content_provider,
  15150. const std::string &content_type,
  15151. UploadProgress progress) {
  15152. return cli_->Patch(path, content_length, std::move(content_provider),
  15153. content_type, progress);
  15154. }
  15155. inline Result Client::Patch(const std::string &path, size_t content_length,
  15156. ContentProvider content_provider,
  15157. const std::string &content_type,
  15158. ContentReceiver content_receiver,
  15159. UploadProgress progress) {
  15160. return cli_->Patch(path, content_length, std::move(content_provider),
  15161. content_type, std::move(content_receiver), progress);
  15162. }
  15163. inline Result Client::Patch(const std::string &path,
  15164. ContentProviderWithoutLength content_provider,
  15165. const std::string &content_type,
  15166. UploadProgress progress) {
  15167. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15168. }
  15169. inline Result Client::Patch(const std::string &path,
  15170. ContentProviderWithoutLength content_provider,
  15171. const std::string &content_type,
  15172. ContentReceiver content_receiver,
  15173. UploadProgress progress) {
  15174. return cli_->Patch(path, std::move(content_provider), content_type,
  15175. std::move(content_receiver), progress);
  15176. }
  15177. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15178. size_t content_length,
  15179. ContentProvider content_provider,
  15180. const std::string &content_type,
  15181. UploadProgress progress) {
  15182. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15183. content_type, progress);
  15184. }
  15185. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15186. size_t content_length,
  15187. ContentProvider content_provider,
  15188. const std::string &content_type,
  15189. ContentReceiver content_receiver,
  15190. UploadProgress progress) {
  15191. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15192. content_type, std::move(content_receiver), progress);
  15193. }
  15194. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15195. ContentProviderWithoutLength content_provider,
  15196. const std::string &content_type,
  15197. UploadProgress progress) {
  15198. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15199. progress);
  15200. }
  15201. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15202. ContentProviderWithoutLength content_provider,
  15203. const std::string &content_type,
  15204. ContentReceiver content_receiver,
  15205. UploadProgress progress) {
  15206. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15207. std::move(content_receiver), progress);
  15208. }
  15209. inline Result Client::Patch(const std::string &path, const Params &params) {
  15210. return cli_->Patch(path, params);
  15211. }
  15212. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15213. const Params &params) {
  15214. return cli_->Patch(path, headers, params);
  15215. }
  15216. inline Result Client::Patch(const std::string &path,
  15217. const UploadFormDataItems &items,
  15218. UploadProgress progress) {
  15219. return cli_->Patch(path, items, progress);
  15220. }
  15221. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15222. const UploadFormDataItems &items,
  15223. UploadProgress progress) {
  15224. return cli_->Patch(path, headers, items, progress);
  15225. }
  15226. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15227. const UploadFormDataItems &items,
  15228. const std::string &boundary,
  15229. UploadProgress progress) {
  15230. return cli_->Patch(path, headers, items, boundary, progress);
  15231. }
  15232. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15233. const UploadFormDataItems &items,
  15234. const FormDataProviderItems &provider_items,
  15235. UploadProgress progress) {
  15236. return cli_->Patch(path, headers, items, provider_items, progress);
  15237. }
  15238. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15239. const std::string &body,
  15240. const std::string &content_type,
  15241. ContentReceiver content_receiver,
  15242. DownloadProgress progress) {
  15243. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15244. progress);
  15245. }
  15246. inline Result Client::Delete(const std::string &path,
  15247. DownloadProgress progress) {
  15248. return cli_->Delete(path, progress);
  15249. }
  15250. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15251. DownloadProgress progress) {
  15252. return cli_->Delete(path, headers, progress);
  15253. }
  15254. inline Result Client::Delete(const std::string &path, const char *body,
  15255. size_t content_length,
  15256. const std::string &content_type,
  15257. DownloadProgress progress) {
  15258. return cli_->Delete(path, body, content_length, content_type, progress);
  15259. }
  15260. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15261. const char *body, size_t content_length,
  15262. const std::string &content_type,
  15263. DownloadProgress progress) {
  15264. return cli_->Delete(path, headers, body, content_length, content_type,
  15265. progress);
  15266. }
  15267. inline Result Client::Delete(const std::string &path, const std::string &body,
  15268. const std::string &content_type,
  15269. DownloadProgress progress) {
  15270. return cli_->Delete(path, body, content_type, progress);
  15271. }
  15272. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15273. const std::string &body,
  15274. const std::string &content_type,
  15275. DownloadProgress progress) {
  15276. return cli_->Delete(path, headers, body, content_type, progress);
  15277. }
  15278. inline Result Client::Delete(const std::string &path, const Params &params,
  15279. DownloadProgress progress) {
  15280. return cli_->Delete(path, params, progress);
  15281. }
  15282. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15283. const Params &params, DownloadProgress progress) {
  15284. return cli_->Delete(path, headers, params, progress);
  15285. }
  15286. inline Result Client::Options(const std::string &path) {
  15287. return cli_->Options(path);
  15288. }
  15289. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15290. return cli_->Options(path, headers);
  15291. }
  15292. inline ClientImpl::StreamHandle
  15293. Client::open_stream(const std::string &method, const std::string &path,
  15294. const Params &params, const Headers &headers,
  15295. const std::string &body, const std::string &content_type) {
  15296. return cli_->open_stream(method, path, params, headers, body, content_type);
  15297. }
  15298. inline bool Client::send(Request &req, Response &res, Error &error) {
  15299. return cli_->send(req, res, error);
  15300. }
  15301. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15302. inline void Client::stop() { cli_->stop(); }
  15303. inline std::string Client::host() const { return cli_->host(); }
  15304. inline int Client::port() const { return cli_->port(); }
  15305. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15306. inline socket_t Client::socket() const { return cli_->socket(); }
  15307. inline void
  15308. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15309. cli_->set_hostname_addr_map(std::move(addr_map));
  15310. }
  15311. inline void Client::set_default_headers(Headers headers) {
  15312. cli_->set_default_headers(std::move(headers));
  15313. }
  15314. inline void Client::set_header_writer(
  15315. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15316. cli_->set_header_writer(writer);
  15317. }
  15318. inline void Client::set_address_family(int family) {
  15319. cli_->set_address_family(family);
  15320. }
  15321. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15322. inline void Client::set_socket_options(SocketOptions socket_options) {
  15323. cli_->set_socket_options(std::move(socket_options));
  15324. }
  15325. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15326. cli_->set_connection_timeout(sec, usec);
  15327. }
  15328. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15329. cli_->set_read_timeout(sec, usec);
  15330. }
  15331. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15332. cli_->set_write_timeout(sec, usec);
  15333. }
  15334. inline void Client::set_basic_auth(const std::string &username,
  15335. const std::string &password) {
  15336. cli_->set_basic_auth(username, password);
  15337. }
  15338. inline void Client::set_bearer_token_auth(const std::string &token) {
  15339. cli_->set_bearer_token_auth(token);
  15340. }
  15341. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15342. inline void Client::set_follow_location(bool on) {
  15343. cli_->set_follow_location(on);
  15344. }
  15345. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15346. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15347. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15348. inline void Client::set_payload_max_length(size_t length) {
  15349. cli_->set_payload_max_length(length);
  15350. }
  15351. inline void Client::set_interface(const std::string &intf) {
  15352. cli_->set_interface(intf);
  15353. }
  15354. inline void Client::set_proxy(const std::string &host, int port) {
  15355. cli_->set_proxy(host, port);
  15356. }
  15357. inline void Client::set_proxy_basic_auth(const std::string &username,
  15358. const std::string &password) {
  15359. cli_->set_proxy_basic_auth(username, password);
  15360. }
  15361. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15362. cli_->set_proxy_bearer_token_auth(token);
  15363. }
  15364. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15365. cli_->set_no_proxy(patterns);
  15366. }
  15367. inline void Client::set_logger(Logger logger) {
  15368. cli_->set_logger(std::move(logger));
  15369. }
  15370. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15371. cli_->set_error_logger(std::move(error_logger));
  15372. }
  15373. /*
  15374. * Group 6: SSL Server and Client implementation
  15375. */
  15376. #ifdef CPPHTTPLIB_SSL_ENABLED
  15377. // SSL HTTP server implementation
  15378. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15379. const char *client_ca_cert_file_path,
  15380. const char *client_ca_cert_dir_path,
  15381. const char *private_key_password) {
  15382. using namespace tls;
  15383. ctx_ = create_server_context();
  15384. if (!ctx_) { return; }
  15385. // Load server certificate and private key
  15386. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15387. private_key_password)) {
  15388. last_ssl_error_ = static_cast<int>(get_error());
  15389. free_context(ctx_);
  15390. ctx_ = nullptr;
  15391. return;
  15392. }
  15393. // Load client CA certificates for client authentication
  15394. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15395. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15396. client_ca_cert_dir_path)) {
  15397. last_ssl_error_ = static_cast<int>(get_error());
  15398. free_context(ctx_);
  15399. ctx_ = nullptr;
  15400. return;
  15401. }
  15402. // Enable client certificate verification
  15403. set_verify_client(ctx_, true);
  15404. }
  15405. }
  15406. inline SSLServer::SSLServer(const PemMemory &pem) {
  15407. using namespace tls;
  15408. ctx_ = create_server_context();
  15409. if (ctx_) {
  15410. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15411. pem.private_key_password)) {
  15412. last_ssl_error_ = static_cast<int>(get_error());
  15413. free_context(ctx_);
  15414. ctx_ = nullptr;
  15415. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15416. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15417. last_ssl_error_ = static_cast<int>(get_error());
  15418. free_context(ctx_);
  15419. ctx_ = nullptr;
  15420. } else {
  15421. set_verify_client(ctx_, true);
  15422. }
  15423. }
  15424. }
  15425. }
  15426. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15427. using namespace tls;
  15428. ctx_ = create_server_context();
  15429. if (ctx_) {
  15430. if (!setup_callback(ctx_)) {
  15431. free_context(ctx_);
  15432. ctx_ = nullptr;
  15433. }
  15434. }
  15435. }
  15436. inline SSLServer::~SSLServer() {
  15437. if (ctx_) { tls::free_context(ctx_); }
  15438. }
  15439. inline bool SSLServer::is_valid() const {
  15440. return ctx_ != nullptr && Server::is_valid();
  15441. }
  15442. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15443. using namespace tls;
  15444. // Create TLS session with mutex protection
  15445. session_t session = nullptr;
  15446. {
  15447. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15448. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15449. }
  15450. if (!session) {
  15451. last_ssl_error_ = static_cast<int>(get_error());
  15452. detail::shutdown_socket(sock);
  15453. detail::close_socket(sock);
  15454. return false;
  15455. }
  15456. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15457. bool handshake_done = false;
  15458. bool ret = false;
  15459. bool websocket_upgraded = false;
  15460. auto cleanup = detail::scope_exit([&] {
  15461. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15462. free_session(session);
  15463. detail::shutdown_socket(sock);
  15464. detail::close_socket(sock);
  15465. });
  15466. // Perform TLS accept handshake with timeout
  15467. TlsError tls_err;
  15468. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15469. &tls_err)) {
  15470. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15471. // Map TlsError to legacy ssl_error for backward compatibility
  15472. if (tls_err.code == ErrorCode::WantRead) {
  15473. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15474. } else if (tls_err.code == ErrorCode::WantWrite) {
  15475. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15476. } else {
  15477. last_ssl_error_ = SSL_ERROR_SSL;
  15478. }
  15479. #else
  15480. last_ssl_error_ = static_cast<int>(get_error());
  15481. #endif
  15482. return false;
  15483. }
  15484. handshake_done = true;
  15485. std::string remote_addr;
  15486. int remote_port = 0;
  15487. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15488. std::string local_addr;
  15489. int local_port = 0;
  15490. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15491. ret = serve_guarded([&]() {
  15492. return detail::process_server_socket_ssl(
  15493. svr_sock_, session, sock, keep_alive_max_count_,
  15494. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15495. write_timeout_sec_, write_timeout_usec_,
  15496. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15497. return process_request(
  15498. strm, remote_addr, remote_port, local_addr, local_port,
  15499. close_connection, connection_closed,
  15500. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15501. });
  15502. });
  15503. return ret;
  15504. }
  15505. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15506. const char *key_pem,
  15507. const char *client_ca_pem,
  15508. const char *password) {
  15509. if (!ctx_) { return false; }
  15510. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15511. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15512. return false;
  15513. }
  15514. if (client_ca_pem) {
  15515. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15516. }
  15517. return true;
  15518. }
  15519. // SSL HTTP client implementation
  15520. inline SSLClient::~SSLClient() {
  15521. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15522. // base function rather than the derived function once we get to the
  15523. // base class destructor, and won't free the SSL (causing a leak).
  15524. // This must happen before the context is freed below: some backends
  15525. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15526. // context, so freeing the context first leaves close_notify reading
  15527. // freed memory.
  15528. shutdown_ssl_impl(socket_, true);
  15529. if (ctx_) {
  15530. tls::free_context(ctx_);
  15531. ctx_ = nullptr;
  15532. }
  15533. }
  15534. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15535. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15536. shutdown_ssl_impl(socket, shutdown_gracefully);
  15537. }
  15538. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15539. bool shutdown_gracefully) {
  15540. if (socket.sock == INVALID_SOCKET) {
  15541. assert(socket.ssl == nullptr);
  15542. return;
  15543. }
  15544. if (socket.ssl) {
  15545. tls::shutdown(socket.ssl, shutdown_gracefully);
  15546. {
  15547. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15548. tls::free_session(socket.ssl);
  15549. }
  15550. socket.ssl = nullptr;
  15551. }
  15552. assert(socket.ssl == nullptr);
  15553. }
  15554. inline bool SSLClient::process_socket(
  15555. const Socket &socket,
  15556. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15557. std::function<bool(Stream &strm)> callback) {
  15558. assert(socket.ssl);
  15559. return detail::process_client_socket_ssl(
  15560. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15561. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15562. std::move(callback));
  15563. }
  15564. inline bool SSLClient::is_ssl() const { return true; }
  15565. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15566. if (!is_valid()) {
  15567. error = Error::SSLConnection;
  15568. return false;
  15569. }
  15570. return ClientImpl::create_and_connect_socket(socket, error);
  15571. }
  15572. inline bool SSLClient::setup_proxy_connection(
  15573. Socket &socket,
  15574. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15575. Response &res, bool &success, Error &error) {
  15576. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15577. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15578. return false;
  15579. }
  15580. if (!initialize_ssl(socket, error)) {
  15581. success = false;
  15582. return false;
  15583. }
  15584. return true;
  15585. }
  15586. // Assumes that socket_mutex_ is locked and that there are no requests in
  15587. // flight
  15588. inline bool SSLClient::connect_with_proxy(
  15589. Socket &socket,
  15590. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15591. Response &res, bool &success, Error &error) {
  15592. success = true;
  15593. Response proxy_res;
  15594. if (!detail::process_client_socket(
  15595. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15596. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15597. start_time, [&](Stream &strm) {
  15598. Request req2;
  15599. req2.method = "CONNECT";
  15600. req2.path =
  15601. detail::make_host_and_port_string_always_port(host_, port_);
  15602. if (max_timeout_msec_ > 0) {
  15603. req2.start_time_ = std::chrono::steady_clock::now();
  15604. }
  15605. return process_request(strm, req2, proxy_res, false, error);
  15606. })) {
  15607. // Thread-safe to close everything because we are assuming there are no
  15608. // requests in flight
  15609. shutdown_ssl(socket, true);
  15610. shutdown_socket(socket);
  15611. close_socket(socket);
  15612. success = false;
  15613. return false;
  15614. }
  15615. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15616. if (!proxy_digest_auth_username_.empty() &&
  15617. !proxy_digest_auth_password_.empty()) {
  15618. std::map<std::string, std::string> auth;
  15619. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15620. // Close the current socket and create a new one for the authenticated
  15621. // request
  15622. shutdown_ssl(socket, true);
  15623. shutdown_socket(socket);
  15624. close_socket(socket);
  15625. // Create a new socket for the authenticated CONNECT request
  15626. if (!ensure_socket_connection(socket, error)) {
  15627. success = false;
  15628. output_error_log(error, nullptr);
  15629. return false;
  15630. }
  15631. proxy_res = Response();
  15632. if (!detail::process_client_socket(
  15633. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15634. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15635. start_time, [&](Stream &strm) {
  15636. Request req3;
  15637. req3.method = "CONNECT";
  15638. req3.path = detail::make_host_and_port_string_always_port(
  15639. host_, port_);
  15640. req3.headers.insert(detail::make_digest_authentication_header(
  15641. req3, auth, 1, detail::random_string(10),
  15642. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15643. true));
  15644. if (max_timeout_msec_ > 0) {
  15645. req3.start_time_ = std::chrono::steady_clock::now();
  15646. }
  15647. return process_request(strm, req3, proxy_res, false, error);
  15648. })) {
  15649. // Thread-safe to close everything because we are assuming there are
  15650. // no requests in flight
  15651. shutdown_ssl(socket, true);
  15652. shutdown_socket(socket);
  15653. close_socket(socket);
  15654. success = false;
  15655. return false;
  15656. }
  15657. }
  15658. }
  15659. }
  15660. // If status code is not 200, proxy request is failed.
  15661. // Set error to ProxyConnection and return proxy response
  15662. // as the response of the request
  15663. if (proxy_res.status != StatusCode::OK_200) {
  15664. error = Error::ProxyConnection;
  15665. output_error_log(error, nullptr);
  15666. res = std::move(proxy_res);
  15667. // Thread-safe to close everything because we are assuming there are
  15668. // no requests in flight
  15669. shutdown_ssl(socket, true);
  15670. shutdown_socket(socket);
  15671. close_socket(socket);
  15672. return false;
  15673. }
  15674. return true;
  15675. }
  15676. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15677. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15678. if (is_proxy_enabled_for_host(host_)) { return true; }
  15679. if (!initialize_ssl(socket, error)) {
  15680. shutdown_socket(socket);
  15681. close_socket(socket);
  15682. return false;
  15683. }
  15684. return true;
  15685. }
  15686. // SSL HTTP client implementation
  15687. inline SSLClient::SSLClient(const std::string &host)
  15688. : SSLClient(host, 443, std::string(), std::string()) {}
  15689. inline SSLClient::SSLClient(const std::string &host, int port)
  15690. : SSLClient(host, port, std::string(), std::string()) {}
  15691. inline void SSLClient::init_ctx() {
  15692. ctx_ = tls::create_client_context();
  15693. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15694. }
  15695. inline void SSLClient::reset_ctx_on_error() {
  15696. last_backend_error_ = tls::get_error();
  15697. tls::free_context(ctx_);
  15698. ctx_ = nullptr;
  15699. }
  15700. inline SSLClient::SSLClient(const std::string &host, int port,
  15701. const std::string &client_cert_path,
  15702. const std::string &client_key_path,
  15703. const std::string &private_key_password)
  15704. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15705. init_ctx();
  15706. if (!ctx_) { return; }
  15707. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15708. const char *password =
  15709. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15710. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15711. client_key_path.c_str(), password)) {
  15712. reset_ctx_on_error();
  15713. }
  15714. }
  15715. }
  15716. inline SSLClient::SSLClient(const std::string &host, int port,
  15717. const PemMemory &pem)
  15718. : ClientImpl(host, port) {
  15719. init_ctx();
  15720. if (!ctx_) { return; }
  15721. if (pem.cert_pem && pem.key_pem) {
  15722. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15723. pem.private_key_password)) {
  15724. reset_ctx_on_error();
  15725. }
  15726. }
  15727. }
  15728. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15729. if (ca_cert_store && ctx_) {
  15730. // set_ca_store takes ownership of ca_cert_store
  15731. tls::set_ca_store(ctx_, ca_cert_store);
  15732. ca_cert_store_set_ = true;
  15733. } else if (ca_cert_store) {
  15734. tls::free_ca_store(ca_cert_store);
  15735. }
  15736. }
  15737. inline void
  15738. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15739. if (!ctx_) { return; }
  15740. tls::set_verify_callback(ctx_, verifier);
  15741. }
  15742. inline void SSLClient::set_session_verifier(
  15743. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15744. session_verifier_ = std::move(verifier);
  15745. }
  15746. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15747. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15748. enable_windows_cert_verification_ = enabled;
  15749. }
  15750. #endif
  15751. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15752. std::size_t size) {
  15753. if (ctx_ && ca_cert && size > 0) {
  15754. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15755. tls::load_ca_pem(ctx_, ca_cert, size);
  15756. }
  15757. }
  15758. inline bool SSLClient::load_certs() {
  15759. auto ret = true;
  15760. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15761. // one client is shared across concurrent requests here.
  15762. std::call_once(initialize_cert_, [&]() {
  15763. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15764. ret = detail::load_client_ca_config(
  15765. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15766. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15767. last_backend_error_);
  15768. });
  15769. return ret;
  15770. }
  15771. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15772. // Load CA certificates if server verification is enabled
  15773. if (server_certificate_verification_) {
  15774. if (!load_certs()) {
  15775. error = Error::SSLLoadingCerts;
  15776. output_error_log(error, nullptr);
  15777. return false;
  15778. }
  15779. }
  15780. detail::ClientTlsSessionOptions options;
  15781. options.server_hostname_verification = server_hostname_verification_;
  15782. options.session_verifier = session_verifier_;
  15783. options.ctx_mutex = &ctx_mutex_;
  15784. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15785. // Skip Schannel when a custom CA cert is specified, as the Windows
  15786. // certificate store would not know about user-provided CA certificates.
  15787. // Also skip when system CA trust is explicitly disabled.
  15788. options.windows_cert_verification =
  15789. enable_windows_cert_verification_ &&
  15790. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15791. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15792. #endif
  15793. tls::session_t session = nullptr;
  15794. // Use scope_exit to ensure session is freed on error paths
  15795. bool success = false;
  15796. auto session_guard = detail::scope_exit([&] {
  15797. if (!success) { tls::free_session(session); }
  15798. });
  15799. detail::ClientTlsSessionError tls_error;
  15800. if (!detail::setup_client_tls_session(
  15801. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15802. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15803. options)) {
  15804. error = tls_error.error;
  15805. last_ssl_error_ = tls_error.ssl_error;
  15806. last_backend_error_ = tls_error.backend_error;
  15807. output_error_log(error, nullptr);
  15808. return false;
  15809. }
  15810. success = true;
  15811. socket.ssl = session;
  15812. return true;
  15813. }
  15814. inline void Client::set_digest_auth(const std::string &username,
  15815. const std::string &password) {
  15816. cli_->set_digest_auth(username, password);
  15817. }
  15818. inline void Client::set_proxy_digest_auth(const std::string &username,
  15819. const std::string &password) {
  15820. cli_->set_proxy_digest_auth(username, password);
  15821. }
  15822. inline void Client::enable_server_certificate_verification(bool enabled) {
  15823. cli_->enable_server_certificate_verification(enabled);
  15824. }
  15825. inline void Client::enable_server_hostname_verification(bool enabled) {
  15826. cli_->enable_server_hostname_verification(enabled);
  15827. }
  15828. inline void Client::enable_system_ca(bool enabled) {
  15829. cli_->enable_system_ca(enabled);
  15830. }
  15831. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15832. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15833. if (is_ssl_) {
  15834. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15835. enabled);
  15836. }
  15837. }
  15838. #endif
  15839. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15840. const std::string &ca_cert_dir_path) {
  15841. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15842. }
  15843. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15844. if (is_ssl_) {
  15845. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15846. } else if (ca_cert_store) {
  15847. tls::free_ca_store(ca_cert_store);
  15848. }
  15849. }
  15850. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15851. if (is_ssl_) {
  15852. // Use the PEM-based path so the CA data is retained for redirect transfer
  15853. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15854. }
  15855. }
  15856. inline void
  15857. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15858. if (is_ssl_) {
  15859. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15860. std::move(verifier));
  15861. }
  15862. }
  15863. inline void Client::set_session_verifier(
  15864. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15865. if (is_ssl_) {
  15866. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15867. }
  15868. }
  15869. inline tls::ctx_t Client::tls_context() const {
  15870. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15871. return nullptr;
  15872. }
  15873. #endif // CPPHTTPLIB_SSL_ENABLED
  15874. /*
  15875. * Group 7: TLS abstraction layer - Common API
  15876. */
  15877. #ifdef CPPHTTPLIB_SSL_ENABLED
  15878. namespace tls {
  15879. // Helper for PeerCert construction
  15880. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15881. return PeerCert(get_peer_cert(session));
  15882. }
  15883. namespace impl {
  15884. inline VerifyCallback &get_verify_callback() {
  15885. static thread_local VerifyCallback callback;
  15886. return callback;
  15887. }
  15888. inline VerifyCallback &get_mbedtls_verify_callback() {
  15889. static thread_local VerifyCallback callback;
  15890. return callback;
  15891. }
  15892. // Check if a string is an IPv4 address
  15893. inline bool is_ipv4_address(const std::string &str) {
  15894. int dots = 0;
  15895. for (char c : str) {
  15896. if (c == '.') {
  15897. dots++;
  15898. } else if (!detail::is_ascii_digit(c)) {
  15899. return false;
  15900. }
  15901. }
  15902. return dots == 3;
  15903. }
  15904. // Parse IPv4 address string to bytes
  15905. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15906. const char *p = str.c_str();
  15907. for (int i = 0; i < 4; i++) {
  15908. if (i > 0) {
  15909. if (*p != '.') { return false; }
  15910. p++;
  15911. }
  15912. int val = 0;
  15913. int digits = 0;
  15914. while (detail::is_ascii_digit(*p)) {
  15915. val = val * 10 + (*p - '0');
  15916. if (val > 255) { return false; }
  15917. p++;
  15918. digits++;
  15919. }
  15920. if (digits == 0) { return false; }
  15921. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15922. if (digits > 1 && *(p - digits) == '0') { return false; }
  15923. out[i] = static_cast<unsigned char>(val);
  15924. }
  15925. return *p == '\0';
  15926. }
  15927. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15928. // `out` must have room for at least 16 bytes. Returns the address length
  15929. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15930. // literal. Used to match a host against iPAddress SANs the same way the
  15931. // OpenSSL backend does via X509_check_ip.
  15932. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15933. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15934. struct in6_addr addr6 = {};
  15935. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15936. memcpy(out, &addr6, 16);
  15937. return 16;
  15938. }
  15939. return 0;
  15940. }
  15941. #ifdef _WIN32
  15942. // Enumerate Windows system certificates and call callback with DER data
  15943. template <typename Callback>
  15944. inline bool enumerate_windows_system_certs(Callback cb) {
  15945. bool loaded = false;
  15946. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15947. for (auto store_name : store_names) {
  15948. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15949. if (hStore) {
  15950. PCCERT_CONTEXT pContext = nullptr;
  15951. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15952. nullptr) {
  15953. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15954. loaded = true;
  15955. }
  15956. }
  15957. CertCloseStore(hStore, 0);
  15958. }
  15959. }
  15960. return loaded;
  15961. }
  15962. #endif
  15963. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15964. // Enumerate macOS Keychain certificates and call callback with DER data
  15965. template <typename Callback>
  15966. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15967. bool loaded = false;
  15968. const SecTrustSettingsDomain domains[] = {
  15969. kSecTrustSettingsDomainSystem,
  15970. kSecTrustSettingsDomainAdmin,
  15971. kSecTrustSettingsDomainUser,
  15972. };
  15973. for (auto domain : domains) {
  15974. CFArrayRef certs = nullptr;
  15975. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15976. if (status != errSecSuccess || !certs) {
  15977. if (certs) CFRelease(certs);
  15978. continue;
  15979. }
  15980. CFIndex count = CFArrayGetCount(certs);
  15981. for (CFIndex i = 0; i < count; i++) {
  15982. SecCertificateRef cert =
  15983. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15984. CFDataRef data = SecCertificateCopyData(cert);
  15985. if (data) {
  15986. if (cb(CFDataGetBytePtr(data),
  15987. static_cast<size_t>(CFDataGetLength(data)))) {
  15988. loaded = true;
  15989. }
  15990. CFRelease(data);
  15991. }
  15992. }
  15993. CFRelease(certs);
  15994. }
  15995. return loaded;
  15996. }
  15997. #endif
  15998. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15999. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16000. // Common CA certificate file paths on Linux/Unix
  16001. inline const char **system_ca_paths() {
  16002. static const char *paths[] = {
  16003. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16004. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16005. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16006. "/etc/pki/tls/cacert.pem", // OpenELEC
  16007. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16008. nullptr};
  16009. return paths;
  16010. }
  16011. // Common CA certificate directory paths on Linux/Unix
  16012. inline const char **system_ca_dirs() {
  16013. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16014. "/etc/pki/tls/certs", // RHEL/CentOS
  16015. "/usr/share/ca-certificates", // Other
  16016. nullptr};
  16017. return dirs;
  16018. }
  16019. #endif
  16020. } // namespace impl
  16021. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16022. const char *ca_dir) {
  16023. if (!ctx) { return false; }
  16024. bool success = true;
  16025. if (ca_file && *ca_file) {
  16026. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16027. }
  16028. if (ca_dir && *ca_dir) {
  16029. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16030. }
  16031. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16032. // Set CA list for client certificate request (CertificateRequest message)
  16033. if (ca_file && *ca_file) {
  16034. auto list = SSL_load_client_CA_file(ca_file);
  16035. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16036. }
  16037. #endif
  16038. return success;
  16039. }
  16040. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16041. const char *password) {
  16042. return set_client_cert_pem(ctx, cert, key, password);
  16043. }
  16044. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16045. const char *key_path, const char *password) {
  16046. return set_client_cert_file(ctx, cert_path, key_path, password);
  16047. }
  16048. // PeerCert implementation
  16049. inline PeerCert::PeerCert() = default;
  16050. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16051. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16052. other.cert_ = nullptr;
  16053. }
  16054. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16055. if (this != &other) {
  16056. if (cert_) { free_cert(cert_); }
  16057. cert_ = other.cert_;
  16058. other.cert_ = nullptr;
  16059. }
  16060. return *this;
  16061. }
  16062. inline PeerCert::~PeerCert() {
  16063. if (cert_) { free_cert(cert_); }
  16064. }
  16065. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16066. inline std::string PeerCert::subject_cn() const {
  16067. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16068. }
  16069. inline std::string PeerCert::issuer_name() const {
  16070. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16071. }
  16072. inline bool PeerCert::check_hostname(const char *hostname) const {
  16073. return cert_ ? verify_hostname(cert_, hostname) : false;
  16074. }
  16075. inline std::vector<SanEntry> PeerCert::sans() const {
  16076. std::vector<SanEntry> result;
  16077. if (cert_) { get_cert_sans(cert_, result); }
  16078. return result;
  16079. }
  16080. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16081. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16082. }
  16083. inline std::string PeerCert::serial() const {
  16084. return cert_ ? get_cert_serial(cert_) : std::string();
  16085. }
  16086. // VerifyContext method implementations
  16087. inline std::string VerifyContext::subject_cn() const {
  16088. return cert ? get_cert_subject_cn(cert) : std::string();
  16089. }
  16090. inline std::string VerifyContext::issuer_name() const {
  16091. return cert ? get_cert_issuer_name(cert) : std::string();
  16092. }
  16093. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16094. return cert ? verify_hostname(cert, hostname) : false;
  16095. }
  16096. inline std::vector<SanEntry> VerifyContext::sans() const {
  16097. std::vector<SanEntry> result;
  16098. if (cert) { get_cert_sans(cert, result); }
  16099. return result;
  16100. }
  16101. inline bool VerifyContext::validity(time_t &not_before,
  16102. time_t &not_after) const {
  16103. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16104. }
  16105. inline std::string VerifyContext::serial() const {
  16106. return cert ? get_cert_serial(cert) : std::string();
  16107. }
  16108. // TlsError static method implementation
  16109. inline std::string TlsError::verify_error_to_string(long error_code) {
  16110. return verify_error_string(error_code);
  16111. }
  16112. } // namespace tls
  16113. // Request::peer_cert() implementation
  16114. inline tls::PeerCert Request::peer_cert() const {
  16115. return tls::get_peer_cert_from_session(ssl);
  16116. }
  16117. // Request::sni() implementation
  16118. inline std::string Request::sni() const {
  16119. if (!ssl) { return std::string(); }
  16120. const char *s = tls::get_sni(ssl);
  16121. return s ? std::string(s) : std::string();
  16122. }
  16123. #endif // CPPHTTPLIB_SSL_ENABLED
  16124. /*
  16125. * Group 8: TLS abstraction layer - OpenSSL backend
  16126. */
  16127. /*
  16128. * OpenSSL Backend Implementation
  16129. */
  16130. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16131. namespace tls {
  16132. namespace impl {
  16133. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16134. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16135. switch (ssl_error) {
  16136. case SSL_ERROR_NONE: return ErrorCode::Success;
  16137. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16138. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16139. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16140. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16141. case SSL_ERROR_SSL:
  16142. default: return ErrorCode::Fatal;
  16143. }
  16144. }
  16145. // Helper: Create client CA list from PEM string
  16146. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16147. // Caller takes ownership of returned list
  16148. inline STACK_OF(X509_NAME) *
  16149. create_client_ca_list_from_pem(const char *ca_pem) {
  16150. if (!ca_pem) { return nullptr; }
  16151. auto ca_list = sk_X509_NAME_new_null();
  16152. if (!ca_list) { return nullptr; }
  16153. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16154. if (!bio) {
  16155. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16156. return nullptr;
  16157. }
  16158. X509 *cert = nullptr;
  16159. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16160. nullptr) {
  16161. const X509_NAME *name = X509_get_subject_name(cert);
  16162. if (name) {
  16163. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16164. }
  16165. X509_free(cert);
  16166. }
  16167. BIO_free(bio);
  16168. return ca_list;
  16169. }
  16170. // OpenSSL verify callback wrapper
  16171. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16172. auto &callback = get_verify_callback();
  16173. if (!callback) { return preverify_ok; }
  16174. // Get SSL object from X509_STORE_CTX
  16175. auto ssl = static_cast<SSL *>(
  16176. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16177. if (!ssl) { return preverify_ok; }
  16178. // Get current certificate and depth
  16179. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16180. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16181. int error = X509_STORE_CTX_get_error(ctx);
  16182. // Build context
  16183. VerifyContext verify_ctx;
  16184. verify_ctx.session = static_cast<session_t>(ssl);
  16185. verify_ctx.cert = static_cast<cert_t>(cert);
  16186. verify_ctx.depth = depth;
  16187. verify_ctx.preverify_ok = (preverify_ok != 0);
  16188. verify_ctx.error_code = error;
  16189. verify_ctx.error_string =
  16190. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16191. return callback(verify_ctx) ? 1 : 0;
  16192. }
  16193. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16194. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16195. // that must be released with release_store_objects
  16196. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16197. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16198. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16199. #endif
  16200. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16201. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16202. return X509_STORE_get1_objects(store);
  16203. #else
  16204. return X509_STORE_get0_objects(store);
  16205. #endif
  16206. }
  16207. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16208. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16209. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16210. #else
  16211. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16212. #endif
  16213. }
  16214. } // namespace impl
  16215. inline ctx_t create_client_context() {
  16216. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16217. if (ctx) {
  16218. // Disable auto-retry to properly handle non-blocking I/O
  16219. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16220. // Set minimum TLS version
  16221. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16222. }
  16223. return static_cast<ctx_t>(ctx);
  16224. }
  16225. inline void free_context(ctx_t ctx) {
  16226. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16227. }
  16228. inline bool set_min_version(ctx_t ctx, Version version) {
  16229. if (!ctx) return false;
  16230. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16231. static_cast<int>(version)) == 1;
  16232. }
  16233. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16234. if (!ctx || !pem || len == 0) return false;
  16235. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16236. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16237. if (!store) return false;
  16238. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16239. if (!bio) return false;
  16240. bool ok = true;
  16241. X509 *cert = nullptr;
  16242. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16243. nullptr) {
  16244. if (X509_STORE_add_cert(store, cert) != 1) {
  16245. // Ignore duplicate errors
  16246. auto err = ERR_peek_last_error();
  16247. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16248. ok = false;
  16249. }
  16250. }
  16251. X509_free(cert);
  16252. if (!ok) break;
  16253. }
  16254. BIO_free(bio);
  16255. // Clear any "no more certificates" errors
  16256. ERR_clear_error();
  16257. return ok;
  16258. }
  16259. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16260. if (!ctx || !file_path) return false;
  16261. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16262. nullptr) == 1;
  16263. }
  16264. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16265. if (!ctx || !dir_path) return false;
  16266. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16267. dir_path) == 1;
  16268. }
  16269. inline bool load_system_certs(ctx_t ctx) {
  16270. if (!ctx) return false;
  16271. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16272. #ifdef _WIN32
  16273. // Windows: Load from system certificate store (ROOT and CA)
  16274. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16275. if (!store) return false;
  16276. bool loaded_any = false;
  16277. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16278. for (auto store_name : store_names) {
  16279. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16280. if (!hStore) continue;
  16281. PCCERT_CONTEXT pContext = nullptr;
  16282. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16283. nullptr) {
  16284. const unsigned char *data = pContext->pbCertEncoded;
  16285. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16286. if (x509) {
  16287. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16288. X509_free(x509);
  16289. }
  16290. }
  16291. CertCloseStore(hStore, 0);
  16292. }
  16293. return loaded_any;
  16294. #elif defined(__APPLE__)
  16295. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16296. // macOS: Load from Keychain
  16297. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16298. if (!store) return false;
  16299. bool loaded_any = false;
  16300. const SecTrustSettingsDomain domains[] = {
  16301. kSecTrustSettingsDomainSystem,
  16302. kSecTrustSettingsDomainAdmin,
  16303. kSecTrustSettingsDomainUser,
  16304. };
  16305. for (auto domain : domains) {
  16306. CFArrayRef certs = nullptr;
  16307. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16308. !certs) {
  16309. if (certs) CFRelease(certs);
  16310. continue;
  16311. }
  16312. auto count = CFArrayGetCount(certs);
  16313. for (CFIndex i = 0; i < count; i++) {
  16314. auto cert = reinterpret_cast<SecCertificateRef>(
  16315. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16316. CFDataRef der = SecCertificateCopyData(cert);
  16317. if (der) {
  16318. const unsigned char *data = CFDataGetBytePtr(der);
  16319. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16320. if (x509) {
  16321. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16322. X509_free(x509);
  16323. }
  16324. CFRelease(der);
  16325. }
  16326. }
  16327. CFRelease(certs);
  16328. }
  16329. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16330. #else
  16331. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16332. #endif
  16333. #else
  16334. // Other Unix: use default verify paths
  16335. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16336. #endif
  16337. }
  16338. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16339. const char *password) {
  16340. if (!ctx || !cert || !key) return false;
  16341. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16342. // Load certificate
  16343. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16344. if (!cert_bio) return false;
  16345. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16346. BIO_free(cert_bio);
  16347. if (!x509) return false;
  16348. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16349. X509_free(x509);
  16350. if (!cert_ok) return false;
  16351. // Load private key
  16352. auto key_bio = BIO_new_mem_buf(key, -1);
  16353. if (!key_bio) return false;
  16354. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16355. password ? const_cast<char *>(password)
  16356. : nullptr);
  16357. BIO_free(key_bio);
  16358. if (!pkey) return false;
  16359. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16360. EVP_PKEY_free(pkey);
  16361. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16362. }
  16363. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16364. const char *key_path, const char *password) {
  16365. if (!ctx || !cert_path || !key_path) return false;
  16366. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16367. if (password && password[0] != '\0') {
  16368. SSL_CTX_set_default_passwd_cb_userdata(
  16369. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16370. }
  16371. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16372. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16373. }
  16374. inline ctx_t create_server_context() {
  16375. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16376. if (ctx) {
  16377. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16378. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16379. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16380. }
  16381. return static_cast<ctx_t>(ctx);
  16382. }
  16383. inline void set_verify_client(ctx_t ctx, bool require) {
  16384. if (!ctx) return;
  16385. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16386. require
  16387. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16388. : SSL_VERIFY_NONE,
  16389. nullptr);
  16390. }
  16391. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16392. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16393. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16394. SSL *ssl = SSL_new(ssl_ctx);
  16395. if (!ssl) return nullptr;
  16396. // Disable auto-retry for proper non-blocking I/O handling
  16397. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16398. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16399. if (!bio) {
  16400. SSL_free(ssl);
  16401. return nullptr;
  16402. }
  16403. SSL_set_bio(ssl, bio, bio);
  16404. return static_cast<session_t>(ssl);
  16405. }
  16406. inline void free_session(session_t session) {
  16407. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16408. }
  16409. inline bool set_sni(session_t session, const char *hostname,
  16410. bool /*verify_hostname*/) {
  16411. if (!session || !hostname) return false;
  16412. auto ssl = static_cast<SSL *>(session);
  16413. // Set SNI (Server Name Indication) only - does not enable verification.
  16414. // OpenSSL never binds identity checking to SNI (that happens post-
  16415. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16416. #if defined(OPENSSL_IS_BORINGSSL)
  16417. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16418. #else
  16419. // Direct call instead of macro to suppress -Wold-style-cast warning
  16420. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16421. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16422. #endif
  16423. }
  16424. inline TlsError connect(session_t session) {
  16425. if (!session) { return TlsError(); }
  16426. auto ssl = static_cast<SSL *>(session);
  16427. auto ret = SSL_connect(ssl);
  16428. TlsError err;
  16429. if (ret == 1) {
  16430. err.code = ErrorCode::Success;
  16431. } else {
  16432. auto ssl_err = SSL_get_error(ssl, ret);
  16433. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16434. err.backend_code = ERR_get_error();
  16435. }
  16436. return err;
  16437. }
  16438. inline TlsError accept(session_t session) {
  16439. if (!session) { return TlsError(); }
  16440. auto ssl = static_cast<SSL *>(session);
  16441. auto ret = SSL_accept(ssl);
  16442. TlsError err;
  16443. if (ret == 1) {
  16444. err.code = ErrorCode::Success;
  16445. } else {
  16446. auto ssl_err = SSL_get_error(ssl, ret);
  16447. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16448. err.backend_code = ERR_get_error();
  16449. }
  16450. return err;
  16451. }
  16452. inline bool connect_nonblocking(session_t session, socket_t sock,
  16453. time_t timeout_sec, time_t timeout_usec,
  16454. TlsError *err) {
  16455. if (!session) {
  16456. if (err) { err->code = ErrorCode::Fatal; }
  16457. return false;
  16458. }
  16459. auto ssl = static_cast<SSL *>(session);
  16460. auto bio = SSL_get_rbio(ssl);
  16461. // Set non-blocking mode for handshake
  16462. detail::set_nonblocking(sock, true);
  16463. if (bio) { BIO_set_nbio(bio, 1); }
  16464. auto cleanup = detail::scope_exit([&]() {
  16465. // Restore blocking mode after handshake
  16466. if (bio) { BIO_set_nbio(bio, 0); }
  16467. detail::set_nonblocking(sock, false);
  16468. });
  16469. auto res = 0;
  16470. while ((res = SSL_connect(ssl)) != 1) {
  16471. auto ssl_err = SSL_get_error(ssl, res);
  16472. switch (ssl_err) {
  16473. case SSL_ERROR_WANT_READ:
  16474. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16475. continue;
  16476. }
  16477. break;
  16478. case SSL_ERROR_WANT_WRITE:
  16479. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16480. continue;
  16481. }
  16482. break;
  16483. default: break;
  16484. }
  16485. if (err) {
  16486. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16487. err->backend_code = ERR_get_error();
  16488. }
  16489. return false;
  16490. }
  16491. if (err) { err->code = ErrorCode::Success; }
  16492. return true;
  16493. }
  16494. inline bool accept_nonblocking(session_t session, socket_t sock,
  16495. time_t timeout_sec, time_t timeout_usec,
  16496. TlsError *err) {
  16497. if (!session) {
  16498. if (err) { err->code = ErrorCode::Fatal; }
  16499. return false;
  16500. }
  16501. auto ssl = static_cast<SSL *>(session);
  16502. auto bio = SSL_get_rbio(ssl);
  16503. // Set non-blocking mode for handshake
  16504. detail::set_nonblocking(sock, true);
  16505. if (bio) { BIO_set_nbio(bio, 1); }
  16506. auto cleanup = detail::scope_exit([&]() {
  16507. // Restore blocking mode after handshake
  16508. if (bio) { BIO_set_nbio(bio, 0); }
  16509. detail::set_nonblocking(sock, false);
  16510. });
  16511. auto res = 0;
  16512. while ((res = SSL_accept(ssl)) != 1) {
  16513. auto ssl_err = SSL_get_error(ssl, res);
  16514. switch (ssl_err) {
  16515. case SSL_ERROR_WANT_READ:
  16516. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16517. continue;
  16518. }
  16519. break;
  16520. case SSL_ERROR_WANT_WRITE:
  16521. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16522. continue;
  16523. }
  16524. break;
  16525. default: break;
  16526. }
  16527. if (err) {
  16528. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16529. err->backend_code = ERR_get_error();
  16530. }
  16531. return false;
  16532. }
  16533. if (err) { err->code = ErrorCode::Success; }
  16534. return true;
  16535. }
  16536. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16537. if (!session || !buf) {
  16538. err.code = ErrorCode::Fatal;
  16539. return -1;
  16540. }
  16541. auto ssl = static_cast<SSL *>(session);
  16542. constexpr auto max_len =
  16543. static_cast<size_t>((std::numeric_limits<int>::max)());
  16544. if (len > max_len) { len = max_len; }
  16545. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16546. if (ret > 0) {
  16547. err.code = ErrorCode::Success;
  16548. return ret;
  16549. }
  16550. auto ssl_err = SSL_get_error(ssl, ret);
  16551. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16552. if (err.code == ErrorCode::PeerClosed) {
  16553. return 0;
  16554. } // Gracefully handle the peer closed state.
  16555. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16556. return -1;
  16557. }
  16558. inline ssize_t write(session_t session, const void *buf, size_t len,
  16559. TlsError &err) {
  16560. if (!session || !buf) {
  16561. err.code = ErrorCode::Fatal;
  16562. return -1;
  16563. }
  16564. auto ssl = static_cast<SSL *>(session);
  16565. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16566. if (ret > 0) {
  16567. err.code = ErrorCode::Success;
  16568. return ret;
  16569. }
  16570. auto ssl_err = SSL_get_error(ssl, ret);
  16571. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16572. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16573. return -1;
  16574. }
  16575. inline int pending(const_session_t session) {
  16576. if (!session) return 0;
  16577. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16578. }
  16579. inline void shutdown(session_t session, bool graceful) {
  16580. if (!session) return;
  16581. auto ssl = static_cast<SSL *>(session);
  16582. if (graceful) {
  16583. // Send close_notify without waiting for the peer's. The connection is
  16584. // closed right after this, so a unidirectional shutdown is enough, and an
  16585. // idle peer that never answers would otherwise hold this thread until the
  16586. // read timeout. The other backends do not wait either.
  16587. SSL_shutdown(ssl);
  16588. }
  16589. }
  16590. inline bool is_peer_closed(session_t session, socket_t sock) {
  16591. if (!session) return true;
  16592. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16593. detail::set_nonblocking(sock, true);
  16594. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16595. auto ssl = static_cast<SSL *>(session);
  16596. char buf;
  16597. auto ret = SSL_peek(ssl, &buf, 1);
  16598. if (ret > 0) return false;
  16599. auto err = SSL_get_error(ssl, ret);
  16600. return err == SSL_ERROR_ZERO_RETURN;
  16601. }
  16602. inline cert_t get_peer_cert(const_session_t session) {
  16603. if (!session) return nullptr;
  16604. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16605. static_cast<SSL *>(const_cast<void *>(session))));
  16606. }
  16607. inline void free_cert(cert_t cert) {
  16608. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16609. }
  16610. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16611. if (!cert || !hostname) return false;
  16612. auto x509 = static_cast<X509 *>(cert);
  16613. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16614. if (detail::is_ip_address(hostname)) {
  16615. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16616. }
  16617. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16618. }
  16619. inline uint64_t hostname_mismatch_code() {
  16620. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16621. }
  16622. inline long get_verify_result(const_session_t session) {
  16623. if (!session) return X509_V_ERR_UNSPECIFIED;
  16624. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16625. }
  16626. inline std::string get_cert_subject_cn(cert_t cert) {
  16627. if (!cert) return "";
  16628. auto x509 = static_cast<X509 *>(cert);
  16629. auto subject_name = X509_get_subject_name(x509);
  16630. if (!subject_name) return "";
  16631. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16632. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16633. if (idx < 0) return "";
  16634. auto entry = X509_NAME_get_entry(subject_name, idx);
  16635. if (!entry) return "";
  16636. auto data = X509_NAME_ENTRY_get_data(entry);
  16637. if (!data) return "";
  16638. return std::string(
  16639. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16640. static_cast<size_t>(ASN1_STRING_length(data)));
  16641. }
  16642. inline std::string get_cert_issuer_name(cert_t cert) {
  16643. if (!cert) return "";
  16644. auto x509 = static_cast<X509 *>(cert);
  16645. auto issuer_name = X509_get_issuer_name(x509);
  16646. if (!issuer_name) return "";
  16647. char buf[256];
  16648. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16649. return std::string(buf);
  16650. }
  16651. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16652. sans.clear();
  16653. if (!cert) return false;
  16654. auto x509 = static_cast<X509 *>(cert);
  16655. auto names = static_cast<GENERAL_NAMES *>(
  16656. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16657. if (!names) return true; // No SANs is valid
  16658. auto count = sk_GENERAL_NAME_num(names);
  16659. for (decltype(count) i = 0; i < count; i++) {
  16660. auto gen = sk_GENERAL_NAME_value(names, i);
  16661. if (!gen) continue;
  16662. SanEntry entry;
  16663. switch (gen->type) {
  16664. case GEN_DNS:
  16665. entry.type = SanType::DNS;
  16666. if (gen->d.dNSName) {
  16667. entry.value = std::string(
  16668. reinterpret_cast<const char *>(
  16669. ASN1_STRING_get0_data(gen->d.dNSName)),
  16670. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16671. }
  16672. break;
  16673. case GEN_IPADD:
  16674. entry.type = SanType::IP;
  16675. if (gen->d.iPAddress) {
  16676. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16677. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16678. if (len == 4) {
  16679. // IPv4
  16680. char buf[INET_ADDRSTRLEN];
  16681. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16682. entry.value = buf;
  16683. } else if (len == 16) {
  16684. // IPv6
  16685. char buf[INET6_ADDRSTRLEN];
  16686. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16687. entry.value = buf;
  16688. }
  16689. }
  16690. break;
  16691. case GEN_EMAIL:
  16692. entry.type = SanType::EMAIL;
  16693. if (gen->d.rfc822Name) {
  16694. entry.value = std::string(
  16695. reinterpret_cast<const char *>(
  16696. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16697. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16698. }
  16699. break;
  16700. case GEN_URI:
  16701. entry.type = SanType::URI;
  16702. if (gen->d.uniformResourceIdentifier) {
  16703. entry.value = std::string(
  16704. reinterpret_cast<const char *>(
  16705. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16706. static_cast<size_t>(
  16707. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16708. }
  16709. break;
  16710. default: entry.type = SanType::OTHER; break;
  16711. }
  16712. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16713. }
  16714. GENERAL_NAMES_free(names);
  16715. return true;
  16716. }
  16717. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16718. time_t &not_after) {
  16719. if (!cert) return false;
  16720. auto x509 = static_cast<X509 *>(cert);
  16721. auto nb = X509_get0_notBefore(x509);
  16722. auto na = X509_get0_notAfter(x509);
  16723. if (!nb || !na) return false;
  16724. ASN1_TIME *epoch = ASN1_TIME_new();
  16725. if (!epoch) return false;
  16726. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16727. if (!ASN1_TIME_set(epoch, 0)) return false;
  16728. int pday, psec;
  16729. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16730. not_before = 86400 * (time_t)pday + psec;
  16731. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16732. not_after = 86400 * (time_t)pday + psec;
  16733. return true;
  16734. }
  16735. inline std::string get_cert_serial(cert_t cert) {
  16736. if (!cert) return "";
  16737. auto x509 = static_cast<X509 *>(cert);
  16738. auto serial = X509_get_serialNumber(x509);
  16739. if (!serial) return "";
  16740. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16741. if (!bn) return "";
  16742. auto hex = BN_bn2hex(bn);
  16743. BN_free(bn);
  16744. if (!hex) return "";
  16745. std::string result(hex);
  16746. OPENSSL_free(hex);
  16747. return result;
  16748. }
  16749. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16750. if (!cert) return false;
  16751. auto x509 = static_cast<X509 *>(cert);
  16752. auto len = i2d_X509(x509, nullptr);
  16753. if (len < 0) return false;
  16754. der.resize(static_cast<size_t>(len));
  16755. auto p = der.data();
  16756. i2d_X509(x509, &p);
  16757. return true;
  16758. }
  16759. inline const char *get_sni(const_session_t session) {
  16760. if (!session) return nullptr;
  16761. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16762. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16763. }
  16764. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16765. inline uint64_t get_error() { return ERR_get_error(); }
  16766. inline std::string error_string(uint64_t code) {
  16767. char buf[256];
  16768. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16769. return std::string(buf);
  16770. }
  16771. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16772. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16773. if (!mem) { return nullptr; }
  16774. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16775. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16776. if (!inf) { return nullptr; }
  16777. auto store = X509_STORE_new();
  16778. if (store) {
  16779. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16780. auto itmp = sk_X509_INFO_value(inf, i);
  16781. if (!itmp) { continue; }
  16782. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16783. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16784. }
  16785. }
  16786. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16787. return static_cast<ca_store_t>(store);
  16788. }
  16789. inline void free_ca_store(ca_store_t store) {
  16790. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16791. }
  16792. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16793. if (!ctx || !store) { return false; }
  16794. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16795. auto x509_store = static_cast<X509_STORE *>(store);
  16796. // Check if same store is already set
  16797. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16798. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16799. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16800. return true;
  16801. }
  16802. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16803. certs.clear();
  16804. if (!ctx) { return 0; }
  16805. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16806. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16807. if (!store) { return 0; }
  16808. auto objs = impl::get_store_objects(store);
  16809. if (!objs) { return 0; }
  16810. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16811. auto count = sk_X509_OBJECT_num(objs);
  16812. for (decltype(count) i = 0; i < count; i++) {
  16813. auto obj = sk_X509_OBJECT_value(objs, i);
  16814. if (!obj) { continue; }
  16815. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16816. auto x509 = X509_OBJECT_get0_X509(obj);
  16817. if (x509) {
  16818. // Increment reference count so caller can free it
  16819. X509_up_ref(x509);
  16820. certs.push_back(static_cast<cert_t>(x509));
  16821. }
  16822. }
  16823. }
  16824. return certs.size();
  16825. }
  16826. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16827. std::vector<std::string> names;
  16828. if (!ctx) { return names; }
  16829. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16830. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16831. if (!store) { return names; }
  16832. auto objs = impl::get_store_objects(store);
  16833. if (!objs) { return names; }
  16834. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16835. auto count = sk_X509_OBJECT_num(objs);
  16836. for (decltype(count) i = 0; i < count; i++) {
  16837. auto obj = sk_X509_OBJECT_value(objs, i);
  16838. if (!obj) { continue; }
  16839. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16840. auto x509 = X509_OBJECT_get0_X509(obj);
  16841. if (x509) {
  16842. auto subject = X509_get_subject_name(x509);
  16843. if (subject) {
  16844. char buf[512];
  16845. X509_NAME_oneline(subject, buf, sizeof(buf));
  16846. names.push_back(buf);
  16847. }
  16848. }
  16849. }
  16850. }
  16851. return names;
  16852. }
  16853. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16854. const char *key_pem, const char *password) {
  16855. if (!ctx || !cert_pem || !key_pem) { return false; }
  16856. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16857. // Load certificate from PEM
  16858. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16859. if (!cert_bio) { return false; }
  16860. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16861. BIO_free(cert_bio);
  16862. if (!cert) { return false; }
  16863. // Load private key from PEM
  16864. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16865. if (!key_bio) {
  16866. X509_free(cert);
  16867. return false;
  16868. }
  16869. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16870. password ? const_cast<char *>(password)
  16871. : nullptr);
  16872. BIO_free(key_bio);
  16873. if (!key) {
  16874. X509_free(cert);
  16875. return false;
  16876. }
  16877. // Update certificate and key
  16878. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16879. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16880. X509_free(cert);
  16881. EVP_PKEY_free(key);
  16882. return ret;
  16883. }
  16884. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16885. if (!ctx || !ca_pem) { return false; }
  16886. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16887. // Create new X509_STORE from PEM
  16888. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16889. if (!store) { return false; }
  16890. // SSL_CTX_set_cert_store takes ownership
  16891. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16892. // Set client CA list for client certificate request
  16893. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16894. if (ca_list) {
  16895. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16896. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16897. }
  16898. return true;
  16899. }
  16900. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16901. if (!ctx) { return false; }
  16902. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16903. impl::get_verify_callback() = std::move(callback);
  16904. if (impl::get_verify_callback()) {
  16905. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16906. } else {
  16907. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16908. }
  16909. return true;
  16910. }
  16911. inline long get_verify_error(const_session_t session) {
  16912. if (!session) { return -1; }
  16913. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16914. return SSL_get_verify_result(ssl);
  16915. }
  16916. inline std::string verify_error_string(long error_code) {
  16917. if (error_code == X509_V_OK) { return ""; }
  16918. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16919. return str ? str : "unknown error";
  16920. }
  16921. } // namespace tls
  16922. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16923. /*
  16924. * Group 9: TLS abstraction layer - Mbed TLS backend
  16925. */
  16926. /*
  16927. * Mbed TLS Backend Implementation
  16928. */
  16929. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16930. namespace tls {
  16931. namespace impl {
  16932. // Mbed TLS session wrapper
  16933. struct MbedTlsSession {
  16934. mbedtls_ssl_context ssl;
  16935. socket_t sock = INVALID_SOCKET;
  16936. std::string hostname; // For client: set via set_sni
  16937. std::string sni_hostname; // For server: received from client via SNI callback
  16938. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16939. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16940. // (e.g. a response that arrived while this side was still in its post-write
  16941. // check), the byte is pushed back here and served by the next read().
  16942. unsigned char peeked_byte = 0;
  16943. bool has_peeked_byte = false;
  16944. // Set by set_sni() when the caller disabled hostname verification, so the
  16945. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16946. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16947. // OpenSSL and wolfSSL keep them independent).
  16948. bool suppress_hostname_mismatch = false;
  16949. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16950. // decide which verify callback to install when hostname verification is
  16951. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16952. // wired for this context, or a self-contained one otherwise, so a session
  16953. // that never opted into a callback never consults the process-wide
  16954. // set_verify_callback() slot (which some other, unrelated client may have
  16955. // populated).
  16956. bool has_verify_callback = false;
  16957. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16958. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16959. MbedTlsSession(const MbedTlsSession &) = delete;
  16960. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16961. };
  16962. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16963. // queue)
  16964. inline int &mbedtls_last_error() {
  16965. static thread_local int err = 0;
  16966. return err;
  16967. }
  16968. // Helper to map Mbed TLS error to ErrorCode
  16969. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16970. uint32_t verify_flags) {
  16971. if (ret == 0) { return ErrorCode::Success; }
  16972. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16973. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16974. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16975. return ErrorCode::PeerClosed;
  16976. }
  16977. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16978. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16979. out_errno = errno;
  16980. return ErrorCode::SyscallError;
  16981. }
  16982. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16983. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16984. // the handshake's chain verification (see set_sni()); a mismatch there
  16985. // is reported the same way as any other verify_flags bit. Report it as
  16986. // HostnameMismatch, matching the other backends and the post-handshake
  16987. // identity check below, but only when naming is the sole problem -
  16988. // if the chain itself is also untrusted/expired/etc., that takes
  16989. // priority over the naming detail.
  16990. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16991. return ErrorCode::HostnameMismatch;
  16992. }
  16993. return ErrorCode::CertVerifyFailed;
  16994. }
  16995. return ErrorCode::Fatal;
  16996. }
  16997. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16998. // return value, including the verify-flags-dependent HostnameMismatch
  16999. // mapping; shared by connect() and connect_nonblocking() so the
  17000. // backend_code policy for that mapping only lives in one place.
  17001. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17002. int ret) {
  17003. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17004. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17005. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17006. ? static_cast<uint64_t>(verify_flags)
  17007. : static_cast<uint64_t>(-ret);
  17008. }
  17009. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17010. // non-fatal notification delivered between records, not an error and not
  17011. // application data, so I/O calls that see it should just be retried. Kept in
  17012. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17013. // splitting the closing brace across an #if.
  17014. inline bool mbedtls_is_session_ticket(int ret) {
  17015. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17016. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17017. #else
  17018. (void)ret;
  17019. return false;
  17020. #endif
  17021. }
  17022. // BIO-like send callback for Mbed TLS
  17023. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17024. size_t len) {
  17025. auto sock = *static_cast<socket_t *>(ctx);
  17026. #ifdef _WIN32
  17027. auto ret =
  17028. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17029. if (ret == SOCKET_ERROR) {
  17030. int err = WSAGetLastError();
  17031. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17032. return MBEDTLS_ERR_NET_SEND_FAILED;
  17033. }
  17034. #else
  17035. auto ret = send(sock, buf, len, 0);
  17036. if (ret < 0) {
  17037. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17038. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17039. }
  17040. return MBEDTLS_ERR_NET_SEND_FAILED;
  17041. }
  17042. #endif
  17043. return static_cast<int>(ret);
  17044. }
  17045. // BIO-like recv callback for Mbed TLS
  17046. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17047. auto sock = *static_cast<socket_t *>(ctx);
  17048. #ifdef _WIN32
  17049. auto ret =
  17050. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17051. if (ret == SOCKET_ERROR) {
  17052. int err = WSAGetLastError();
  17053. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17054. return MBEDTLS_ERR_NET_RECV_FAILED;
  17055. }
  17056. #else
  17057. auto ret = recv(sock, buf, len, 0);
  17058. if (ret < 0) {
  17059. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17060. return MBEDTLS_ERR_SSL_WANT_READ;
  17061. }
  17062. return MBEDTLS_ERR_NET_RECV_FAILED;
  17063. }
  17064. #endif
  17065. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17066. return static_cast<int>(ret);
  17067. }
  17068. // MbedTlsContext constructor/destructor implementations
  17069. inline MbedTlsContext::MbedTlsContext() {
  17070. mbedtls_ssl_config_init(&conf);
  17071. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17072. mbedtls_entropy_init(&entropy);
  17073. mbedtls_ctr_drbg_init(&ctr_drbg);
  17074. #endif
  17075. mbedtls_x509_crt_init(&ca_chain);
  17076. mbedtls_x509_crt_init(&own_cert);
  17077. mbedtls_pk_init(&own_key);
  17078. }
  17079. inline MbedTlsContext::~MbedTlsContext() {
  17080. mbedtls_pk_free(&own_key);
  17081. mbedtls_x509_crt_free(&own_cert);
  17082. mbedtls_x509_crt_free(&ca_chain);
  17083. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17084. mbedtls_ctr_drbg_free(&ctr_drbg);
  17085. mbedtls_entropy_free(&entropy);
  17086. #endif
  17087. mbedtls_ssl_config_free(&conf);
  17088. }
  17089. // Thread-local storage for SNI captured during handshake
  17090. // This is needed because the SNI callback doesn't have a way to pass
  17091. // session-specific data before the session is fully set up
  17092. inline std::string &mbedpending_sni() {
  17093. static thread_local std::string sni;
  17094. return sni;
  17095. }
  17096. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17097. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17098. const unsigned char *name, size_t name_len) {
  17099. (void)p_ctx;
  17100. (void)ssl;
  17101. // Store SNI name in thread-local storage
  17102. // It will be retrieved and stored in the session after handshake
  17103. if (name && name_len > 0) {
  17104. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17105. } else {
  17106. mbedpending_sni().clear();
  17107. }
  17108. return 0; // Accept any SNI
  17109. }
  17110. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17111. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17112. }
  17113. // Verify callback used when hostname verification is disabled for a session
  17114. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17115. // has_verify_callback is false). Deliberately does not consult
  17116. // get_verify_callback(): that slot is process-wide, so reading it here would
  17117. // pick up whatever another, unrelated client last installed there.
  17118. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17119. mbedtls_x509_crt *, int,
  17120. uint32_t *flags) {
  17121. (void)data;
  17122. mbedtls_clear_cn_mismatch(flags);
  17123. return 0;
  17124. }
  17125. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17126. int cert_depth, uint32_t *flags);
  17127. // MbedTLS verify callback wrapper
  17128. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17129. int cert_depth, uint32_t *flags) {
  17130. // data points to the MbedTlsSession
  17131. auto *session = static_cast<MbedTlsSession *>(data);
  17132. // set_sni() disabled hostname verification for this session: drop the
  17133. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17134. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17135. // SNI. The final pass/fail decision still comes from the remaining flags
  17136. // (or, below, from the user's own verify callback).
  17137. if (session && session->suppress_hostname_mismatch) {
  17138. mbedtls_clear_cn_mismatch(flags);
  17139. }
  17140. auto &callback = get_verify_callback();
  17141. if (!callback) { return 0; } // Continue with default verification
  17142. // Build context
  17143. VerifyContext verify_ctx;
  17144. verify_ctx.session = static_cast<session_t>(session);
  17145. verify_ctx.cert = static_cast<cert_t>(crt);
  17146. verify_ctx.depth = cert_depth;
  17147. verify_ctx.preverify_ok = (*flags == 0);
  17148. verify_ctx.error_code = static_cast<long>(*flags);
  17149. // Convert Mbed TLS flags to error string
  17150. static thread_local char error_buf[256];
  17151. if (*flags != 0) {
  17152. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17153. verify_ctx.error_string = error_buf;
  17154. } else {
  17155. verify_ctx.error_string = nullptr;
  17156. }
  17157. bool accepted = callback(verify_ctx);
  17158. if (accepted) {
  17159. *flags = 0; // Clear all error flags
  17160. return 0;
  17161. }
  17162. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17163. }
  17164. } // namespace impl
  17165. inline ctx_t create_client_context() {
  17166. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17167. if (!ctx) { return nullptr; }
  17168. ctx->is_server = false;
  17169. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17170. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17171. if (!detail::ensure_mbedtls_psa_crypto()) {
  17172. delete ctx;
  17173. return nullptr;
  17174. }
  17175. int ret;
  17176. #else
  17177. // Seed the random number generator
  17178. const char *pers = "httplib_client";
  17179. int ret = mbedtls_ctr_drbg_seed(
  17180. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17181. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17182. if (ret != 0) {
  17183. impl::mbedtls_last_error() = ret;
  17184. delete ctx;
  17185. return nullptr;
  17186. }
  17187. #endif
  17188. // Set up SSL config for client
  17189. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17190. MBEDTLS_SSL_TRANSPORT_STREAM,
  17191. MBEDTLS_SSL_PRESET_DEFAULT);
  17192. if (ret != 0) {
  17193. impl::mbedtls_last_error() = ret;
  17194. delete ctx;
  17195. return nullptr;
  17196. }
  17197. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17198. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17199. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17200. #endif
  17201. // Default: verify peer certificate
  17202. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17203. // Set minimum TLS version to 1.2
  17204. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17205. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17206. #else
  17207. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17208. MBEDTLS_SSL_MINOR_VERSION_3);
  17209. #endif
  17210. return static_cast<ctx_t>(ctx);
  17211. }
  17212. inline ctx_t create_server_context() {
  17213. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17214. if (!ctx) { return nullptr; }
  17215. ctx->is_server = true;
  17216. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17217. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17218. if (!detail::ensure_mbedtls_psa_crypto()) {
  17219. delete ctx;
  17220. return nullptr;
  17221. }
  17222. int ret;
  17223. #else
  17224. // Seed the random number generator
  17225. const char *pers = "httplib_server";
  17226. int ret = mbedtls_ctr_drbg_seed(
  17227. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17228. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17229. if (ret != 0) {
  17230. impl::mbedtls_last_error() = ret;
  17231. delete ctx;
  17232. return nullptr;
  17233. }
  17234. #endif
  17235. // Set up SSL config for server
  17236. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17237. MBEDTLS_SSL_TRANSPORT_STREAM,
  17238. MBEDTLS_SSL_PRESET_DEFAULT);
  17239. if (ret != 0) {
  17240. impl::mbedtls_last_error() = ret;
  17241. delete ctx;
  17242. return nullptr;
  17243. }
  17244. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17245. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17246. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17247. #endif
  17248. // Default: don't verify client
  17249. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17250. // Set minimum TLS version to 1.2
  17251. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17252. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17253. #else
  17254. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17255. MBEDTLS_SSL_MINOR_VERSION_3);
  17256. #endif
  17257. // Set SNI callback to capture client's SNI hostname
  17258. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17259. return static_cast<ctx_t>(ctx);
  17260. }
  17261. inline void free_context(ctx_t ctx) {
  17262. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17263. }
  17264. inline bool set_min_version(ctx_t ctx, Version version) {
  17265. if (!ctx) { return false; }
  17266. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17267. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17268. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17269. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17270. if (version >= Version::TLS1_3) {
  17271. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17272. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17273. #endif
  17274. }
  17275. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17276. #else
  17277. // Mbed TLS 2.x uses major/minor version numbers
  17278. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17279. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17280. if (version >= Version::TLS1_3) {
  17281. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17282. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17283. #else
  17284. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17285. #endif
  17286. }
  17287. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17288. #endif
  17289. return true;
  17290. }
  17291. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17292. if (!ctx || !pem) { return false; }
  17293. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17294. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17295. // Add null terminator if not present
  17296. std::string pem_str(pem, len);
  17297. int ret = mbedtls_x509_crt_parse(
  17298. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17299. pem_str.size() + 1);
  17300. if (ret != 0) {
  17301. impl::mbedtls_last_error() = ret;
  17302. return false;
  17303. }
  17304. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17305. return true;
  17306. }
  17307. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17308. if (!ctx || !file_path) { return false; }
  17309. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17310. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17311. if (ret != 0) {
  17312. impl::mbedtls_last_error() = ret;
  17313. return false;
  17314. }
  17315. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17316. return true;
  17317. }
  17318. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17319. if (!ctx || !dir_path) { return false; }
  17320. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17321. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17322. if (ret < 0) { // Returns number of certs on success, negative on error
  17323. impl::mbedtls_last_error() = ret;
  17324. return false;
  17325. }
  17326. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17327. return true;
  17328. }
  17329. inline bool load_system_certs(ctx_t ctx) {
  17330. if (!ctx) { return false; }
  17331. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17332. bool loaded = false;
  17333. #ifdef _WIN32
  17334. loaded = impl::enumerate_windows_system_certs(
  17335. [&](const unsigned char *data, size_t len) {
  17336. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17337. });
  17338. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17339. loaded = impl::enumerate_macos_keychain_certs(
  17340. [&](const unsigned char *data, size_t len) {
  17341. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17342. });
  17343. #else
  17344. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17345. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17346. loaded = true;
  17347. break;
  17348. }
  17349. }
  17350. if (!loaded) {
  17351. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17352. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17353. loaded = true;
  17354. break;
  17355. }
  17356. }
  17357. }
  17358. #endif
  17359. if (loaded) {
  17360. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17361. }
  17362. return loaded;
  17363. }
  17364. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17365. const char *password) {
  17366. if (!ctx || !cert || !key) { return false; }
  17367. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17368. // Parse certificate
  17369. std::string cert_str(cert);
  17370. int ret = mbedtls_x509_crt_parse(
  17371. &mctx->own_cert,
  17372. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17373. cert_str.size() + 1);
  17374. if (ret != 0) {
  17375. impl::mbedtls_last_error() = ret;
  17376. return false;
  17377. }
  17378. // Parse private key
  17379. std::string key_str(key);
  17380. const unsigned char *pwd =
  17381. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17382. size_t pwd_len = password ? strlen(password) : 0;
  17383. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17384. ret = mbedtls_pk_parse_key(
  17385. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17386. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17387. &mctx->ctr_drbg);
  17388. #else
  17389. ret = mbedtls_pk_parse_key(
  17390. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17391. key_str.size() + 1, pwd, pwd_len);
  17392. #endif
  17393. if (ret != 0) {
  17394. impl::mbedtls_last_error() = ret;
  17395. return false;
  17396. }
  17397. // Verify that the certificate and private key match.
  17398. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17399. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17400. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17401. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17402. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17403. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17404. #else
  17405. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17406. #endif
  17407. if (ret != 0) {
  17408. impl::mbedtls_last_error() = ret;
  17409. return false;
  17410. }
  17411. #endif
  17412. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17413. if (ret != 0) {
  17414. impl::mbedtls_last_error() = ret;
  17415. return false;
  17416. }
  17417. return true;
  17418. }
  17419. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17420. const char *key_path, const char *password) {
  17421. if (!ctx || !cert_path || !key_path) { return false; }
  17422. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17423. // Parse certificate file
  17424. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17425. if (ret != 0) {
  17426. impl::mbedtls_last_error() = ret;
  17427. return false;
  17428. }
  17429. // Parse private key file
  17430. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17431. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17432. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17433. #else
  17434. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17435. #endif
  17436. if (ret != 0) {
  17437. impl::mbedtls_last_error() = ret;
  17438. return false;
  17439. }
  17440. // Verify that the certificate and private key match.
  17441. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17442. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17443. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17444. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17445. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17446. #else
  17447. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17448. #endif
  17449. if (ret != 0) {
  17450. impl::mbedtls_last_error() = ret;
  17451. return false;
  17452. }
  17453. #endif
  17454. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17455. if (ret != 0) {
  17456. impl::mbedtls_last_error() = ret;
  17457. return false;
  17458. }
  17459. return true;
  17460. }
  17461. inline void set_verify_client(ctx_t ctx, bool require) {
  17462. if (!ctx) { return; }
  17463. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17464. mctx->verify_client = require;
  17465. if (require) {
  17466. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17467. } else {
  17468. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17469. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17470. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17471. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17472. : MBEDTLS_SSL_VERIFY_NONE);
  17473. }
  17474. }
  17475. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17476. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17477. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17478. auto session = new (std::nothrow) impl::MbedTlsSession();
  17479. if (!session) { return nullptr; }
  17480. session->sock = sock;
  17481. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17482. if (ret != 0) {
  17483. impl::mbedtls_last_error() = ret;
  17484. delete session;
  17485. return nullptr;
  17486. }
  17487. // Explicitly opt out of in-handshake hostname verification by default;
  17488. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17489. // fails outright when no hostname was set. set_sni() installs the real
  17490. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17491. // caller verifies the certificate identity post-handshake via
  17492. // verify_hostname().
  17493. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17494. // Set BIO callbacks
  17495. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17496. impl::mbedtls_net_recv_cb, nullptr);
  17497. // Set per-session verify callback with session pointer if callback is
  17498. // registered
  17499. session->has_verify_callback = mctx->has_verify_callback;
  17500. if (mctx->has_verify_callback) {
  17501. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17502. session);
  17503. }
  17504. return static_cast<session_t>(session);
  17505. }
  17506. inline void free_session(session_t session) {
  17507. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17508. }
  17509. inline bool set_sni(session_t session, const char *hostname,
  17510. bool verify_hostname) {
  17511. if (!session || !hostname) { return false; }
  17512. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17513. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17514. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17515. // independently, so a disabled hostname check is handled below by masking
  17516. // the resulting mismatch flag instead of skipping this call.
  17517. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17518. if (ret != 0) {
  17519. impl::mbedtls_last_error() = ret;
  17520. return false;
  17521. }
  17522. msession->hostname = hostname;
  17523. if (!verify_hostname) {
  17524. msession->suppress_hostname_mismatch = true;
  17525. // If a user verify callback is already wired for this session,
  17526. // mbedtls_verify_callback() masks the mismatch flag itself before
  17527. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17528. // here would be redundant. Otherwise install the self-contained masking
  17529. // callback, which never touches the process-wide callback slot.
  17530. if (!msession->has_verify_callback) {
  17531. mbedtls_ssl_set_verify(&msession->ssl,
  17532. impl::mbedtls_mask_hostname_mismatch_callback,
  17533. msession);
  17534. }
  17535. }
  17536. return true;
  17537. }
  17538. inline TlsError connect(session_t session) {
  17539. TlsError err;
  17540. if (!session) {
  17541. err.code = ErrorCode::Fatal;
  17542. return err;
  17543. }
  17544. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17545. int ret;
  17546. do {
  17547. ret = mbedtls_ssl_handshake(&msession->ssl);
  17548. } while (impl::mbedtls_is_session_ticket(ret));
  17549. if (ret == 0) {
  17550. err.code = ErrorCode::Success;
  17551. } else {
  17552. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17553. impl::mbedtls_last_error() = ret;
  17554. }
  17555. return err;
  17556. }
  17557. inline TlsError accept(session_t session) {
  17558. // Same as connect for Mbed TLS - handshake works for both client and server
  17559. auto result = connect(session);
  17560. // After successful handshake, capture SNI from thread-local storage
  17561. if (result.code == ErrorCode::Success && session) {
  17562. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17563. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17564. impl::mbedpending_sni().clear();
  17565. }
  17566. return result;
  17567. }
  17568. inline bool connect_nonblocking(session_t session, socket_t sock,
  17569. time_t timeout_sec, time_t timeout_usec,
  17570. TlsError *err) {
  17571. if (!session) {
  17572. if (err) { err->code = ErrorCode::Fatal; }
  17573. return false;
  17574. }
  17575. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17576. // Set socket to non-blocking mode
  17577. detail::set_nonblocking(sock, true);
  17578. auto cleanup =
  17579. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17580. int ret;
  17581. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17582. // Non-fatal TLS 1.3 ticket; retry immediately.
  17583. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17584. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17585. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17586. continue;
  17587. }
  17588. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17589. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17590. continue;
  17591. }
  17592. }
  17593. // TlsError or timeout
  17594. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17595. impl::mbedtls_last_error() = ret;
  17596. return false;
  17597. }
  17598. if (err) { err->code = ErrorCode::Success; }
  17599. return true;
  17600. }
  17601. inline bool accept_nonblocking(session_t session, socket_t sock,
  17602. time_t timeout_sec, time_t timeout_usec,
  17603. TlsError *err) {
  17604. // Same implementation as connect for Mbed TLS
  17605. bool result =
  17606. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17607. // After successful handshake, capture SNI from thread-local storage
  17608. if (result && session) {
  17609. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17610. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17611. impl::mbedpending_sni().clear();
  17612. }
  17613. return result;
  17614. }
  17615. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17616. if (!session || !buf) {
  17617. err.code = ErrorCode::Fatal;
  17618. return -1;
  17619. }
  17620. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17621. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17622. if (msession->has_peeked_byte) {
  17623. if (len == 0) { return 0; }
  17624. auto p = static_cast<unsigned char *>(buf);
  17625. p[0] = msession->peeked_byte;
  17626. msession->has_peeked_byte = false;
  17627. size_t n = 1;
  17628. // Top up with any already-decrypted bytes without risking a block.
  17629. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17630. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17631. if (extra > 0) { n += static_cast<size_t>(extra); }
  17632. }
  17633. err.code = ErrorCode::Success;
  17634. return static_cast<ssize_t>(n);
  17635. }
  17636. int ret;
  17637. do {
  17638. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17639. len);
  17640. } while (impl::mbedtls_is_session_ticket(ret));
  17641. if (ret > 0) {
  17642. err.code = ErrorCode::Success;
  17643. return static_cast<ssize_t>(ret);
  17644. }
  17645. if (ret == 0) {
  17646. err.code = ErrorCode::PeerClosed;
  17647. return 0;
  17648. }
  17649. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17650. err.backend_code = static_cast<uint64_t>(-ret);
  17651. impl::mbedtls_last_error() = ret;
  17652. // mbedTLS signals a clean close_notify via a negative error code rather
  17653. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17654. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17655. return -1;
  17656. }
  17657. inline ssize_t write(session_t session, const void *buf, size_t len,
  17658. TlsError &err) {
  17659. if (!session || !buf) {
  17660. err.code = ErrorCode::Fatal;
  17661. return -1;
  17662. }
  17663. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17664. int ret;
  17665. do {
  17666. ret = mbedtls_ssl_write(&msession->ssl,
  17667. static_cast<const unsigned char *>(buf), len);
  17668. } while (impl::mbedtls_is_session_ticket(ret));
  17669. if (ret > 0) {
  17670. err.code = ErrorCode::Success;
  17671. return static_cast<ssize_t>(ret);
  17672. }
  17673. if (ret == 0) {
  17674. err.code = ErrorCode::PeerClosed;
  17675. return 0;
  17676. }
  17677. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17678. err.backend_code = static_cast<uint64_t>(-ret);
  17679. impl::mbedtls_last_error() = ret;
  17680. return -1;
  17681. }
  17682. inline int pending(const_session_t session) {
  17683. if (!session) { return 0; }
  17684. auto msession =
  17685. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17686. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17687. (msession->has_peeked_byte ? 1 : 0);
  17688. }
  17689. inline void shutdown(session_t session, bool graceful) {
  17690. if (!session) { return; }
  17691. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17692. if (graceful) {
  17693. // Try to send close_notify, but don't block forever
  17694. int ret;
  17695. int attempts = 0;
  17696. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17697. attempts < 3) {
  17698. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17699. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17700. break;
  17701. }
  17702. attempts++;
  17703. }
  17704. }
  17705. }
  17706. inline bool is_peer_closed(session_t session, socket_t sock) {
  17707. if (!session || sock == INVALID_SOCKET) { return true; }
  17708. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17709. // Check if there's already decrypted or pushed-back data available.
  17710. // If so, the connection is definitely alive.
  17711. if (msession->has_peeked_byte ||
  17712. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17713. return false;
  17714. }
  17715. // Set socket to non-blocking to avoid blocking on read
  17716. detail::set_nonblocking(sock, true);
  17717. auto cleanup =
  17718. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17719. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17720. // on application data — e.g. a response that already arrived — push the
  17721. // byte back so the next read() delivers it instead of losing it.
  17722. unsigned char buf;
  17723. int ret;
  17724. do {
  17725. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17726. } while (impl::mbedtls_is_session_ticket(ret));
  17727. // If we got data or WANT_READ (would block), connection is alive
  17728. if (ret > 0) {
  17729. msession->peeked_byte = buf;
  17730. msession->has_peeked_byte = true;
  17731. return false;
  17732. }
  17733. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17734. // If we get a peer close notify or a connection reset, the peer is closed
  17735. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17736. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17737. }
  17738. inline cert_t get_peer_cert(const_session_t session) {
  17739. if (!session) { return nullptr; }
  17740. auto msession =
  17741. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17742. // Mbed TLS returns a pointer to the internal peer cert chain.
  17743. // WARNING: This pointer is only valid while the session is active.
  17744. // Do not use the certificate after calling free_session().
  17745. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17746. return const_cast<mbedtls_x509_crt *>(cert);
  17747. }
  17748. inline void free_cert(cert_t cert) {
  17749. // Mbed TLS: peer certificate is owned by the SSL context.
  17750. // No-op here, but callers should still call this for cross-backend
  17751. // portability.
  17752. (void)cert;
  17753. }
  17754. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17755. if (!cert || !hostname) { return false; }
  17756. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17757. std::string host_str(hostname);
  17758. // Check if hostname is an IP address (IPv4 or IPv6)
  17759. unsigned char ip_bytes[16];
  17760. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17761. auto is_ip = ip_len > 0;
  17762. // Check Subject Alternative Names (SAN)
  17763. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17764. // - DNS names: raw string bytes
  17765. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17766. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17767. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17768. const unsigned char *p = san->buf.p;
  17769. size_t len = san->buf.len;
  17770. if (is_ip) {
  17771. // For an IP host, only a matching iPAddress SAN of the same family
  17772. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17773. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17774. } else {
  17775. // Check if this SAN is a DNS name (printable ASCII string)
  17776. bool is_dns = len > 0;
  17777. for (size_t i = 0; i < len && is_dns; i++) {
  17778. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17779. }
  17780. if (is_dns) {
  17781. std::string san_name(reinterpret_cast<const char *>(p), len);
  17782. if (detail::match_hostname(san_name, host_str)) { return true; }
  17783. }
  17784. }
  17785. san = san->next;
  17786. }
  17787. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17788. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17789. // the OpenSSL backend's X509_check_ip behaves the same way).
  17790. if (!is_ip) {
  17791. char cn[256];
  17792. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17793. if (ret > 0) {
  17794. std::string cn_str(cn);
  17795. // Look for "CN=" in the DN string
  17796. size_t cn_pos = cn_str.find("CN=");
  17797. if (cn_pos != std::string::npos) {
  17798. size_t start = cn_pos + 3;
  17799. size_t end = cn_str.find(',', start);
  17800. std::string cn_value =
  17801. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17802. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17803. }
  17804. }
  17805. }
  17806. return false;
  17807. }
  17808. inline uint64_t hostname_mismatch_code() {
  17809. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17810. }
  17811. inline long get_verify_result(const_session_t session) {
  17812. if (!session) { return -1; }
  17813. auto msession =
  17814. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17815. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17816. // Return 0 (X509_V_OK equivalent) if verification passed
  17817. return flags == 0 ? 0 : static_cast<long>(flags);
  17818. }
  17819. inline std::string get_cert_subject_cn(cert_t cert) {
  17820. if (!cert) return "";
  17821. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17822. // Find the CN in the subject
  17823. const mbedtls_x509_name *name = &x509->subject;
  17824. while (name != nullptr) {
  17825. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17826. return std::string(reinterpret_cast<const char *>(name->val.p),
  17827. name->val.len);
  17828. }
  17829. name = name->next;
  17830. }
  17831. return "";
  17832. }
  17833. inline std::string get_cert_issuer_name(cert_t cert) {
  17834. if (!cert) return "";
  17835. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17836. // Build a human-readable issuer name string
  17837. char buf[512];
  17838. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17839. if (ret < 0) return "";
  17840. return std::string(buf);
  17841. }
  17842. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17843. sans.clear();
  17844. if (!cert) return false;
  17845. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17846. // Parse the Subject Alternative Name extension
  17847. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17848. while (cur != nullptr) {
  17849. if (cur->buf.len > 0) {
  17850. // Mbed TLS stores SAN as ASN.1 sequences
  17851. // The tag byte indicates the type
  17852. const unsigned char *p = cur->buf.p;
  17853. size_t len = cur->buf.len;
  17854. // First byte is the tag
  17855. unsigned char tag = *p;
  17856. p++;
  17857. len--;
  17858. // Parse length (simple single-byte length assumed)
  17859. if (len > 0 && *p < 0x80) {
  17860. size_t value_len = *p;
  17861. p++;
  17862. len--;
  17863. if (value_len <= len) {
  17864. SanEntry entry;
  17865. // ASN.1 context tags for GeneralName
  17866. switch (tag & 0x1F) {
  17867. case 2: // dNSName
  17868. entry.type = SanType::DNS;
  17869. entry.value =
  17870. std::string(reinterpret_cast<const char *>(p), value_len);
  17871. break;
  17872. case 7: // iPAddress
  17873. entry.type = SanType::IP;
  17874. if (value_len == 4) {
  17875. // IPv4
  17876. char buf[16];
  17877. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17878. entry.value = buf;
  17879. } else if (value_len == 16) {
  17880. // IPv6
  17881. char buf[64];
  17882. snprintf(buf, sizeof(buf),
  17883. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17884. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17885. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17886. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17887. entry.value = buf;
  17888. }
  17889. break;
  17890. case 1: // rfc822Name (email)
  17891. entry.type = SanType::EMAIL;
  17892. entry.value =
  17893. std::string(reinterpret_cast<const char *>(p), value_len);
  17894. break;
  17895. case 6: // uniformResourceIdentifier
  17896. entry.type = SanType::URI;
  17897. entry.value =
  17898. std::string(reinterpret_cast<const char *>(p), value_len);
  17899. break;
  17900. default: entry.type = SanType::OTHER; break;
  17901. }
  17902. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17903. }
  17904. }
  17905. }
  17906. cur = cur->next;
  17907. }
  17908. return true;
  17909. }
  17910. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17911. time_t &not_after) {
  17912. if (!cert) return false;
  17913. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17914. // Convert mbedtls_x509_time to time_t
  17915. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17916. struct tm tm_time = {};
  17917. tm_time.tm_year = t.year - 1900;
  17918. tm_time.tm_mon = t.mon - 1;
  17919. tm_time.tm_mday = t.day;
  17920. tm_time.tm_hour = t.hour;
  17921. tm_time.tm_min = t.min;
  17922. tm_time.tm_sec = t.sec;
  17923. #ifdef _WIN32
  17924. return _mkgmtime(&tm_time);
  17925. #else
  17926. return timegm(&tm_time);
  17927. #endif
  17928. };
  17929. not_before = to_time_t(x509->valid_from);
  17930. not_after = to_time_t(x509->valid_to);
  17931. return true;
  17932. }
  17933. inline std::string get_cert_serial(cert_t cert) {
  17934. if (!cert) return "";
  17935. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17936. // Convert serial number to hex string
  17937. std::string result;
  17938. result.reserve(x509->serial.len * 2);
  17939. for (size_t i = 0; i < x509->serial.len; i++) {
  17940. char hex[3];
  17941. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17942. result += hex;
  17943. }
  17944. return result;
  17945. }
  17946. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17947. if (!cert) return false;
  17948. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17949. if (!crt->raw.p || crt->raw.len == 0) return false;
  17950. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17951. return true;
  17952. }
  17953. inline const char *get_sni(const_session_t session) {
  17954. if (!session) return nullptr;
  17955. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17956. // For server: return SNI received from client during handshake
  17957. if (!msession->sni_hostname.empty()) {
  17958. return msession->sni_hostname.c_str();
  17959. }
  17960. // For client: return the hostname set via set_sni
  17961. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17962. return nullptr;
  17963. }
  17964. inline uint64_t peek_error() {
  17965. // Mbed TLS doesn't have an error queue, return the last error
  17966. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17967. }
  17968. inline uint64_t get_error() {
  17969. // Mbed TLS doesn't have an error queue, return and clear the last error
  17970. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17971. impl::mbedtls_last_error() = 0;
  17972. return err;
  17973. }
  17974. inline std::string error_string(uint64_t code) {
  17975. char buf[256];
  17976. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17977. return std::string(buf);
  17978. }
  17979. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17980. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17981. if (!ca_chain) { return nullptr; }
  17982. mbedtls_x509_crt_init(ca_chain);
  17983. // mbedtls_x509_crt_parse expects null-terminated PEM
  17984. int ret = mbedtls_x509_crt_parse(ca_chain,
  17985. reinterpret_cast<const unsigned char *>(pem),
  17986. len + 1); // +1 for null terminator
  17987. if (ret != 0) {
  17988. // Try without +1 in case PEM is already null-terminated
  17989. ret = mbedtls_x509_crt_parse(
  17990. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17991. if (ret != 0) {
  17992. mbedtls_x509_crt_free(ca_chain);
  17993. delete ca_chain;
  17994. return nullptr;
  17995. }
  17996. }
  17997. return static_cast<ca_store_t>(ca_chain);
  17998. }
  17999. inline void free_ca_store(ca_store_t store) {
  18000. if (store) {
  18001. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18002. mbedtls_x509_crt_free(ca_chain);
  18003. delete ca_chain;
  18004. }
  18005. }
  18006. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18007. if (!ctx || !store) { return false; }
  18008. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18009. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18010. // Free existing CA chain
  18011. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18012. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18013. // Copy the CA chain (deep copy)
  18014. // Parse from the raw data of the source cert
  18015. mbedtls_x509_crt *src = ca_chain;
  18016. while (src != nullptr) {
  18017. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18018. src->raw.len);
  18019. if (ret != 0) {
  18020. free_ca_store(store);
  18021. return false;
  18022. }
  18023. src = src->next;
  18024. }
  18025. // This function takes ownership of the store; the chain was deep-copied
  18026. // above, so release the source
  18027. free_ca_store(store);
  18028. // Update the SSL config to use the new CA chain
  18029. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18030. return true;
  18031. }
  18032. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18033. certs.clear();
  18034. if (!ctx) { return 0; }
  18035. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18036. // Iterate through the CA chain
  18037. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18038. while (cert != nullptr && cert->raw.len > 0) {
  18039. // Create a copy of the certificate for the caller
  18040. auto *copy = new mbedtls_x509_crt;
  18041. mbedtls_x509_crt_init(copy);
  18042. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18043. if (ret == 0) {
  18044. certs.push_back(static_cast<cert_t>(copy));
  18045. } else {
  18046. mbedtls_x509_crt_free(copy);
  18047. delete copy;
  18048. }
  18049. cert = cert->next;
  18050. }
  18051. return certs.size();
  18052. }
  18053. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18054. std::vector<std::string> names;
  18055. if (!ctx) { return names; }
  18056. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18057. // Iterate through the CA chain
  18058. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18059. while (cert != nullptr && cert->raw.len > 0) {
  18060. char buf[512];
  18061. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18062. if (ret > 0) { names.push_back(buf); }
  18063. cert = cert->next;
  18064. }
  18065. return names;
  18066. }
  18067. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18068. const char *key_pem, const char *password) {
  18069. if (!ctx || !cert_pem || !key_pem) { return false; }
  18070. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18071. // Free existing certificate and key
  18072. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18073. mbedtls_pk_free(&mbed_ctx->own_key);
  18074. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18075. mbedtls_pk_init(&mbed_ctx->own_key);
  18076. // Parse certificate PEM
  18077. int ret = mbedtls_x509_crt_parse(
  18078. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18079. strlen(cert_pem) + 1);
  18080. if (ret != 0) {
  18081. impl::mbedtls_last_error() = ret;
  18082. return false;
  18083. }
  18084. // Parse private key PEM
  18085. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18086. ret = mbedtls_pk_parse_key(
  18087. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18088. strlen(key_pem) + 1,
  18089. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18090. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18091. &mbed_ctx->ctr_drbg);
  18092. #else
  18093. ret = mbedtls_pk_parse_key(
  18094. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18095. strlen(key_pem) + 1,
  18096. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18097. password ? strlen(password) : 0);
  18098. #endif
  18099. if (ret != 0) {
  18100. impl::mbedtls_last_error() = ret;
  18101. return false;
  18102. }
  18103. // Configure SSL to use the new certificate and key
  18104. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18105. &mbed_ctx->own_key);
  18106. if (ret != 0) {
  18107. impl::mbedtls_last_error() = ret;
  18108. return false;
  18109. }
  18110. return true;
  18111. }
  18112. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18113. if (!ctx || !ca_pem) { return false; }
  18114. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18115. // Free existing CA chain
  18116. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18117. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18118. // Parse CA PEM
  18119. int ret = mbedtls_x509_crt_parse(
  18120. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18121. strlen(ca_pem) + 1);
  18122. if (ret != 0) {
  18123. impl::mbedtls_last_error() = ret;
  18124. return false;
  18125. }
  18126. // Update SSL config to use new CA chain
  18127. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18128. return true;
  18129. }
  18130. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18131. if (!ctx) { return false; }
  18132. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18133. impl::get_verify_callback() = std::move(callback);
  18134. mbed_ctx->has_verify_callback =
  18135. static_cast<bool>(impl::get_verify_callback());
  18136. if (mbed_ctx->has_verify_callback) {
  18137. // Set OPTIONAL mode to ensure callback is called even when verification
  18138. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18139. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18140. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18141. nullptr);
  18142. } else {
  18143. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18144. }
  18145. return true;
  18146. }
  18147. inline long get_verify_error(const_session_t session) {
  18148. if (!session) { return -1; }
  18149. auto *msession =
  18150. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18151. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18152. }
  18153. inline std::string verify_error_string(long error_code) {
  18154. if (error_code == 0) { return ""; }
  18155. char buf[256];
  18156. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18157. static_cast<uint32_t>(error_code));
  18158. // Remove trailing newline if present
  18159. std::string result(buf);
  18160. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18161. result.pop_back();
  18162. }
  18163. return result;
  18164. }
  18165. } // namespace tls
  18166. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18167. /*
  18168. * Group 10: TLS abstraction layer - wolfSSL backend
  18169. */
  18170. /*
  18171. * wolfSSL Backend Implementation
  18172. */
  18173. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18174. namespace tls {
  18175. namespace impl {
  18176. // wolfSSL session wrapper
  18177. struct WolfSSLSession {
  18178. WOLFSSL *ssl = nullptr;
  18179. socket_t sock = INVALID_SOCKET;
  18180. std::string hostname; // For client: set via set_sni
  18181. std::string sni_hostname; // For server: received from client via SNI callback
  18182. WolfSSLSession() = default;
  18183. ~WolfSSLSession() {
  18184. if (ssl) { wolfSSL_free(ssl); }
  18185. }
  18186. WolfSSLSession(const WolfSSLSession &) = delete;
  18187. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18188. };
  18189. // Thread-local error code accessor for wolfSSL
  18190. inline uint64_t &wolfssl_last_error() {
  18191. static thread_local uint64_t err = 0;
  18192. return err;
  18193. }
  18194. // Helper to map wolfSSL error to ErrorCode.
  18195. // ssl_error is the value from wolfSSL_get_error().
  18196. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18197. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18198. int &out_errno) {
  18199. switch (ssl_error) {
  18200. case SSL_ERROR_NONE: return ErrorCode::Success;
  18201. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18202. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18203. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18204. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18205. default:
  18206. if (ssl) {
  18207. // wolfSSL stores the low-level error code as a negative value.
  18208. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18209. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18210. if (low_err == DOMAIN_NAME_MISMATCH) {
  18211. return ErrorCode::HostnameMismatch;
  18212. }
  18213. // Check verify result to distinguish cert verification from generic SSL
  18214. // errors.
  18215. long vr = wolfSSL_get_verify_result(ssl);
  18216. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18217. }
  18218. return ErrorCode::Fatal;
  18219. }
  18220. }
  18221. // WolfSSLContext constructor/destructor implementations
  18222. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18223. inline WolfSSLContext::~WolfSSLContext() {
  18224. if (ctx) { wolfSSL_CTX_free(ctx); }
  18225. }
  18226. // Thread-local storage for SNI captured during handshake
  18227. inline std::string &wolfssl_pending_sni() {
  18228. static thread_local std::string sni;
  18229. return sni;
  18230. }
  18231. // SNI callback for wolfSSL server to capture client's SNI hostname
  18232. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18233. (void)ret;
  18234. (void)exArg;
  18235. void *name_data = nullptr;
  18236. unsigned short name_len =
  18237. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18238. if (name_data && name_len > 0) {
  18239. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18240. name_len);
  18241. } else {
  18242. wolfssl_pending_sni().clear();
  18243. }
  18244. return 0; // Continue regardless
  18245. }
  18246. // wolfSSL verify callback wrapper
  18247. inline int wolfssl_verify_callback(int preverify_ok,
  18248. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18249. auto &callback = get_verify_callback();
  18250. if (!callback) { return preverify_ok; }
  18251. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18252. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18253. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18254. // Get the WOLFSSL object from the X509_STORE_CTX
  18255. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18256. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18257. VerifyContext verify_ctx;
  18258. verify_ctx.session = static_cast<session_t>(ssl);
  18259. verify_ctx.cert = static_cast<cert_t>(cert);
  18260. verify_ctx.depth = depth;
  18261. verify_ctx.preverify_ok = (preverify_ok != 0);
  18262. verify_ctx.error_code = static_cast<long>(err);
  18263. if (err != 0) {
  18264. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18265. } else {
  18266. verify_ctx.error_string = nullptr;
  18267. }
  18268. bool accepted = callback(verify_ctx);
  18269. return accepted ? 1 : 0;
  18270. }
  18271. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18272. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18273. wolfSSL_CTX_set_default_passwd_cb(
  18274. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18275. auto *pwd = static_cast<const char *>(userdata);
  18276. if (!pwd) return 0;
  18277. auto len = static_cast<int>(strlen(pwd));
  18278. if (len > size) len = size;
  18279. memcpy(buf, pwd, static_cast<size_t>(len));
  18280. return len;
  18281. });
  18282. }
  18283. } // namespace impl
  18284. inline ctx_t create_client_context() {
  18285. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18286. if (!ctx) { return nullptr; }
  18287. ctx->is_server = false;
  18288. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18289. if (!method) {
  18290. delete ctx;
  18291. return nullptr;
  18292. }
  18293. ctx->ctx = wolfSSL_CTX_new(method);
  18294. if (!ctx->ctx) {
  18295. delete ctx;
  18296. return nullptr;
  18297. }
  18298. // Default: verify peer certificate
  18299. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18300. return static_cast<ctx_t>(ctx);
  18301. }
  18302. inline ctx_t create_server_context() {
  18303. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18304. if (!ctx) { return nullptr; }
  18305. ctx->is_server = true;
  18306. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18307. if (!method) {
  18308. delete ctx;
  18309. return nullptr;
  18310. }
  18311. ctx->ctx = wolfSSL_CTX_new(method);
  18312. if (!ctx->ctx) {
  18313. delete ctx;
  18314. return nullptr;
  18315. }
  18316. // Default: don't verify client
  18317. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18318. // Enable SNI on server
  18319. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18320. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18321. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18322. return static_cast<ctx_t>(ctx);
  18323. }
  18324. inline void free_context(ctx_t ctx) {
  18325. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18326. }
  18327. inline bool set_min_version(ctx_t ctx, Version version) {
  18328. if (!ctx) { return false; }
  18329. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18330. int min_ver = WOLFSSL_TLSV1_2;
  18331. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18332. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18333. }
  18334. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18335. if (!ctx || !pem) { return false; }
  18336. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18337. int ret = wolfSSL_CTX_load_verify_buffer(
  18338. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18339. static_cast<long>(len), SSL_FILETYPE_PEM);
  18340. if (ret != SSL_SUCCESS) {
  18341. impl::wolfssl_last_error() =
  18342. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18343. return false;
  18344. }
  18345. wctx->ca_pem_data_.append(pem, len);
  18346. return true;
  18347. }
  18348. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18349. if (!ctx || !file_path) { return false; }
  18350. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18351. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18352. if (ret != SSL_SUCCESS) {
  18353. impl::wolfssl_last_error() =
  18354. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18355. return false;
  18356. }
  18357. return true;
  18358. }
  18359. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18360. if (!ctx || !dir_path) { return false; }
  18361. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18362. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18363. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18364. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18365. // immediately. Return true even on failure since the CA file may have
  18366. // already been loaded, matching OpenSSL's lenient behavior.
  18367. (void)ret;
  18368. return true;
  18369. }
  18370. inline bool load_system_certs(ctx_t ctx) {
  18371. if (!ctx) { return false; }
  18372. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18373. bool loaded = false;
  18374. #ifdef _WIN32
  18375. loaded = impl::enumerate_windows_system_certs(
  18376. [&](const unsigned char *data, size_t len) {
  18377. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18378. static_cast<long>(len),
  18379. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18380. });
  18381. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18382. loaded = impl::enumerate_macos_keychain_certs(
  18383. [&](const unsigned char *data, size_t len) {
  18384. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18385. static_cast<long>(len),
  18386. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18387. });
  18388. #else
  18389. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18390. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18391. SSL_SUCCESS) {
  18392. loaded = true;
  18393. break;
  18394. }
  18395. }
  18396. if (!loaded) {
  18397. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18398. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18399. SSL_SUCCESS) {
  18400. loaded = true;
  18401. break;
  18402. }
  18403. }
  18404. }
  18405. #endif
  18406. return loaded;
  18407. }
  18408. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18409. const char *password) {
  18410. if (!ctx || !cert || !key) { return false; }
  18411. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18412. // Load certificate
  18413. int ret = wolfSSL_CTX_use_certificate_buffer(
  18414. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18415. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18416. if (ret != SSL_SUCCESS) {
  18417. impl::wolfssl_last_error() =
  18418. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18419. return false;
  18420. }
  18421. // Set password callback if password is provided
  18422. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18423. // Load private key
  18424. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18425. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18426. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18427. if (ret != SSL_SUCCESS) {
  18428. impl::wolfssl_last_error() =
  18429. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18430. return false;
  18431. }
  18432. // Verify that the certificate and private key match
  18433. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18434. }
  18435. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18436. const char *key_path, const char *password) {
  18437. if (!ctx || !cert_path || !key_path) { return false; }
  18438. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18439. // Load certificate file
  18440. int ret =
  18441. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18442. if (ret != SSL_SUCCESS) {
  18443. impl::wolfssl_last_error() =
  18444. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18445. return false;
  18446. }
  18447. // Set password callback if password is provided
  18448. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18449. // Load private key file
  18450. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18451. if (ret != SSL_SUCCESS) {
  18452. impl::wolfssl_last_error() =
  18453. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18454. return false;
  18455. }
  18456. // Verify that the certificate and private key match
  18457. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18458. }
  18459. inline void set_verify_client(ctx_t ctx, bool require) {
  18460. if (!ctx) { return; }
  18461. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18462. wctx->verify_client = require;
  18463. if (require) {
  18464. wolfSSL_CTX_set_verify(
  18465. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18466. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18467. } else {
  18468. if (wctx->has_verify_callback) {
  18469. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18470. impl::wolfssl_verify_callback);
  18471. } else {
  18472. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18473. }
  18474. }
  18475. }
  18476. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18477. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18478. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18479. auto session = new (std::nothrow) impl::WolfSSLSession();
  18480. if (!session) { return nullptr; }
  18481. session->sock = sock;
  18482. session->ssl = wolfSSL_new(wctx->ctx);
  18483. if (!session->ssl) {
  18484. impl::wolfssl_last_error() =
  18485. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18486. delete session;
  18487. return nullptr;
  18488. }
  18489. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18490. return static_cast<session_t>(session);
  18491. }
  18492. inline void free_session(session_t session) {
  18493. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18494. }
  18495. inline bool set_sni(session_t session, const char *hostname,
  18496. bool verify_hostname) {
  18497. if (!session || !hostname) { return false; }
  18498. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18499. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18500. static_cast<word16>(strlen(hostname)));
  18501. if (ret != WOLFSSL_SUCCESS) {
  18502. impl::wolfssl_last_error() =
  18503. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18504. return false;
  18505. }
  18506. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18507. // separately from the SNI extension sent above; skip it when hostname
  18508. // verification is disabled so only the chain is checked, matching OpenSSL.
  18509. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18510. wsession->hostname = hostname;
  18511. return true;
  18512. }
  18513. inline TlsError connect(session_t session) {
  18514. TlsError err;
  18515. if (!session) {
  18516. err.code = ErrorCode::Fatal;
  18517. return err;
  18518. }
  18519. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18520. int ret = wolfSSL_connect(wsession->ssl);
  18521. if (ret == SSL_SUCCESS) {
  18522. err.code = ErrorCode::Success;
  18523. } else {
  18524. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18525. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18526. err.backend_code = static_cast<uint64_t>(ssl_error);
  18527. impl::wolfssl_last_error() = err.backend_code;
  18528. }
  18529. return err;
  18530. }
  18531. inline TlsError accept(session_t session) {
  18532. TlsError err;
  18533. if (!session) {
  18534. err.code = ErrorCode::Fatal;
  18535. return err;
  18536. }
  18537. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18538. int ret = wolfSSL_accept(wsession->ssl);
  18539. if (ret == SSL_SUCCESS) {
  18540. err.code = ErrorCode::Success;
  18541. // Capture SNI from thread-local storage after successful handshake
  18542. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18543. impl::wolfssl_pending_sni().clear();
  18544. } else {
  18545. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18546. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18547. err.backend_code = static_cast<uint64_t>(ssl_error);
  18548. impl::wolfssl_last_error() = err.backend_code;
  18549. }
  18550. return err;
  18551. }
  18552. inline bool connect_nonblocking(session_t session, socket_t sock,
  18553. time_t timeout_sec, time_t timeout_usec,
  18554. TlsError *err) {
  18555. if (!session) {
  18556. if (err) { err->code = ErrorCode::Fatal; }
  18557. return false;
  18558. }
  18559. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18560. // Set socket to non-blocking mode
  18561. detail::set_nonblocking(sock, true);
  18562. auto cleanup =
  18563. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18564. int ret;
  18565. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18566. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18567. if (ssl_error == SSL_ERROR_WANT_READ) {
  18568. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18569. continue;
  18570. }
  18571. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18572. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18573. continue;
  18574. }
  18575. }
  18576. // Error or timeout
  18577. if (err) {
  18578. err->code =
  18579. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18580. err->backend_code = static_cast<uint64_t>(ssl_error);
  18581. }
  18582. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18583. return false;
  18584. }
  18585. if (err) { err->code = ErrorCode::Success; }
  18586. return true;
  18587. }
  18588. inline bool accept_nonblocking(session_t session, socket_t sock,
  18589. time_t timeout_sec, time_t timeout_usec,
  18590. TlsError *err) {
  18591. if (!session) {
  18592. if (err) { err->code = ErrorCode::Fatal; }
  18593. return false;
  18594. }
  18595. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18596. // Set socket to non-blocking mode
  18597. detail::set_nonblocking(sock, true);
  18598. auto cleanup =
  18599. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18600. int ret;
  18601. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18602. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18603. if (ssl_error == SSL_ERROR_WANT_READ) {
  18604. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18605. continue;
  18606. }
  18607. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18608. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18609. continue;
  18610. }
  18611. }
  18612. // Error or timeout
  18613. if (err) {
  18614. err->code =
  18615. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18616. err->backend_code = static_cast<uint64_t>(ssl_error);
  18617. }
  18618. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18619. return false;
  18620. }
  18621. if (err) { err->code = ErrorCode::Success; }
  18622. // Capture SNI from thread-local storage after successful handshake
  18623. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18624. impl::wolfssl_pending_sni().clear();
  18625. return true;
  18626. }
  18627. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18628. if (!session || !buf) {
  18629. err.code = ErrorCode::Fatal;
  18630. return -1;
  18631. }
  18632. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18633. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18634. if (ret > 0) {
  18635. err.code = ErrorCode::Success;
  18636. return static_cast<ssize_t>(ret);
  18637. }
  18638. if (ret == 0) {
  18639. err.code = ErrorCode::PeerClosed;
  18640. return 0;
  18641. }
  18642. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18643. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18644. err.backend_code = static_cast<uint64_t>(ssl_error);
  18645. impl::wolfssl_last_error() = err.backend_code;
  18646. return -1;
  18647. }
  18648. inline ssize_t write(session_t session, const void *buf, size_t len,
  18649. TlsError &err) {
  18650. if (!session || !buf) {
  18651. err.code = ErrorCode::Fatal;
  18652. return -1;
  18653. }
  18654. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18655. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18656. if (ret > 0) {
  18657. err.code = ErrorCode::Success;
  18658. return static_cast<ssize_t>(ret);
  18659. }
  18660. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18661. // Treat this as an error (return -1) so callers don't spin in a
  18662. // write loop adding zero to the offset.
  18663. if (ret == 0) {
  18664. err.code = ErrorCode::PeerClosed;
  18665. return -1;
  18666. }
  18667. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18668. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18669. err.backend_code = static_cast<uint64_t>(ssl_error);
  18670. impl::wolfssl_last_error() = err.backend_code;
  18671. return -1;
  18672. }
  18673. inline int pending(const_session_t session) {
  18674. if (!session) { return 0; }
  18675. auto wsession =
  18676. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18677. return wolfSSL_pending(wsession->ssl);
  18678. }
  18679. inline void shutdown(session_t session, bool graceful) {
  18680. if (!session) { return; }
  18681. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18682. if (graceful) {
  18683. int ret;
  18684. int attempts = 0;
  18685. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18686. attempts < 3) {
  18687. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18688. if (ssl_error != SSL_ERROR_WANT_READ &&
  18689. ssl_error != SSL_ERROR_WANT_WRITE) {
  18690. break;
  18691. }
  18692. attempts++;
  18693. }
  18694. } else {
  18695. wolfSSL_shutdown(wsession->ssl);
  18696. }
  18697. }
  18698. inline bool is_peer_closed(session_t session, socket_t sock) {
  18699. if (!session || sock == INVALID_SOCKET) { return true; }
  18700. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18701. // Check if there's already decrypted data available
  18702. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18703. // Set socket to non-blocking to avoid blocking on read
  18704. detail::set_nonblocking(sock, true);
  18705. auto cleanup =
  18706. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18707. // Peek 1 byte to check connection status without consuming data
  18708. unsigned char buf;
  18709. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18710. // If we got data or WANT_READ (would block), connection is alive
  18711. if (ret > 0) { return false; }
  18712. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18713. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18714. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18715. ret == 0;
  18716. }
  18717. inline cert_t get_peer_cert(const_session_t session) {
  18718. if (!session) { return nullptr; }
  18719. auto wsession =
  18720. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18721. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18722. return static_cast<cert_t>(cert);
  18723. }
  18724. inline void free_cert(cert_t cert) {
  18725. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18726. }
  18727. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18728. if (!cert || !hostname) { return false; }
  18729. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18730. std::string host_str(hostname);
  18731. // Check if hostname is an IP address (IPv4 or IPv6)
  18732. unsigned char ip_bytes[16];
  18733. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18734. auto is_ip = ip_len > 0;
  18735. // Check Subject Alternative Names
  18736. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18737. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18738. if (san_names) {
  18739. int san_count = wolfSSL_sk_num(san_names);
  18740. for (int i = 0; i < san_count; i++) {
  18741. auto *names =
  18742. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18743. if (!names) continue;
  18744. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18745. // DNS name
  18746. unsigned char *dns_name = nullptr;
  18747. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18748. if (dns_name && dns_len > 0) {
  18749. std::string san_name(reinterpret_cast<char *>(dns_name),
  18750. static_cast<size_t>(dns_len));
  18751. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18752. if (detail::match_hostname(san_name, host_str)) {
  18753. wolfSSL_sk_free(san_names);
  18754. return true;
  18755. }
  18756. }
  18757. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18758. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18759. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18760. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18761. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18762. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18763. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18764. wolfSSL_sk_free(san_names);
  18765. return true;
  18766. }
  18767. }
  18768. }
  18769. wolfSSL_sk_free(san_names);
  18770. }
  18771. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18772. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18773. // the OpenSSL backend's X509_check_ip behaves the same way).
  18774. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18775. if (subject) {
  18776. char cn[256] = {};
  18777. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18778. sizeof(cn));
  18779. if (cn_len > 0) {
  18780. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18781. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18782. }
  18783. }
  18784. return false;
  18785. }
  18786. inline uint64_t hostname_mismatch_code() {
  18787. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18788. }
  18789. inline long get_verify_result(const_session_t session) {
  18790. if (!session) { return -1; }
  18791. auto wsession =
  18792. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18793. long result = wolfSSL_get_verify_result(wsession->ssl);
  18794. return result;
  18795. }
  18796. inline std::string get_cert_subject_cn(cert_t cert) {
  18797. if (!cert) return "";
  18798. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18799. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18800. if (!subject) return "";
  18801. char cn[256] = {};
  18802. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18803. sizeof(cn));
  18804. if (cn_len <= 0) return "";
  18805. return std::string(cn, static_cast<size_t>(cn_len));
  18806. }
  18807. inline std::string get_cert_issuer_name(cert_t cert) {
  18808. if (!cert) return "";
  18809. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18810. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18811. if (!issuer) return "";
  18812. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18813. if (!name_str) return "";
  18814. std::string result(name_str);
  18815. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18816. return result;
  18817. }
  18818. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18819. sans.clear();
  18820. if (!cert) return false;
  18821. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18822. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18823. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18824. if (!san_names) return true; // No SANs is not an error
  18825. int count = wolfSSL_sk_num(san_names);
  18826. for (int i = 0; i < count; i++) {
  18827. auto *name =
  18828. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18829. if (!name) continue;
  18830. SanEntry entry;
  18831. switch (name->type) {
  18832. case WOLFSSL_GEN_DNS: {
  18833. entry.type = SanType::DNS;
  18834. unsigned char *dns_name = nullptr;
  18835. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18836. if (dns_name && dns_len > 0) {
  18837. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18838. static_cast<size_t>(dns_len));
  18839. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18840. }
  18841. break;
  18842. }
  18843. case WOLFSSL_GEN_IPADD: {
  18844. entry.type = SanType::IP;
  18845. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18846. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18847. if (ip_data && ip_len == 4) {
  18848. char buf[16];
  18849. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18850. ip_data[2], ip_data[3]);
  18851. entry.value = buf;
  18852. } else if (ip_data && ip_len == 16) {
  18853. char buf[64];
  18854. snprintf(buf, sizeof(buf),
  18855. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18856. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18857. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18858. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18859. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18860. ip_data[14], ip_data[15]);
  18861. entry.value = buf;
  18862. }
  18863. break;
  18864. }
  18865. case WOLFSSL_GEN_EMAIL:
  18866. entry.type = SanType::EMAIL;
  18867. {
  18868. unsigned char *email = nullptr;
  18869. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18870. if (email && email_len > 0) {
  18871. entry.value = std::string(reinterpret_cast<char *>(email),
  18872. static_cast<size_t>(email_len));
  18873. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18874. }
  18875. }
  18876. break;
  18877. case WOLFSSL_GEN_URI:
  18878. entry.type = SanType::URI;
  18879. {
  18880. unsigned char *uri = nullptr;
  18881. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18882. &uri, name->d.uniformResourceIdentifier);
  18883. if (uri && uri_len > 0) {
  18884. entry.value = std::string(reinterpret_cast<char *>(uri),
  18885. static_cast<size_t>(uri_len));
  18886. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18887. }
  18888. }
  18889. break;
  18890. default: entry.type = SanType::OTHER; break;
  18891. }
  18892. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18893. }
  18894. wolfSSL_sk_free(san_names);
  18895. return true;
  18896. }
  18897. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18898. time_t &not_after) {
  18899. if (!cert) return false;
  18900. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18901. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18902. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18903. if (!nb || !na) return false;
  18904. // wolfSSL_ASN1_TIME_to_tm is available
  18905. struct tm tm_nb = {}, tm_na = {};
  18906. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18907. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18908. #ifdef _WIN32
  18909. not_before = _mkgmtime(&tm_nb);
  18910. not_after = _mkgmtime(&tm_na);
  18911. #else
  18912. not_before = timegm(&tm_nb);
  18913. not_after = timegm(&tm_na);
  18914. #endif
  18915. return true;
  18916. }
  18917. inline std::string get_cert_serial(cert_t cert) {
  18918. if (!cert) return "";
  18919. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18920. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18921. if (!serial_asn1) return "";
  18922. // Get the serial number data
  18923. int len = serial_asn1->length;
  18924. unsigned char *data = serial_asn1->data;
  18925. if (!data || len <= 0) return "";
  18926. std::string result;
  18927. result.reserve(static_cast<size_t>(len) * 2);
  18928. for (int i = 0; i < len; i++) {
  18929. char hex[3];
  18930. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18931. result += hex;
  18932. }
  18933. return result;
  18934. }
  18935. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18936. if (!cert) return false;
  18937. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18938. int der_len = 0;
  18939. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18940. if (!der_data || der_len <= 0) return false;
  18941. der.assign(der_data, der_data + der_len);
  18942. return true;
  18943. }
  18944. inline const char *get_sni(const_session_t session) {
  18945. if (!session) return nullptr;
  18946. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18947. // For server: return SNI received from client during handshake
  18948. if (!wsession->sni_hostname.empty()) {
  18949. return wsession->sni_hostname.c_str();
  18950. }
  18951. // For client: return the hostname set via set_sni
  18952. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18953. return nullptr;
  18954. }
  18955. inline uint64_t peek_error() {
  18956. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18957. }
  18958. inline uint64_t get_error() {
  18959. uint64_t err = impl::wolfssl_last_error();
  18960. impl::wolfssl_last_error() = 0;
  18961. return err;
  18962. }
  18963. inline std::string error_string(uint64_t code) {
  18964. char buf[256];
  18965. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18966. return std::string(buf);
  18967. }
  18968. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18969. if (!pem || len == 0) { return nullptr; }
  18970. // Validate by attempting to load into a temporary ctx
  18971. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18972. if (!tmp_ctx) { return nullptr; }
  18973. int ret = wolfSSL_CTX_load_verify_buffer(
  18974. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18975. static_cast<long>(len), SSL_FILETYPE_PEM);
  18976. wolfSSL_CTX_free(tmp_ctx);
  18977. if (ret != SSL_SUCCESS) { return nullptr; }
  18978. return static_cast<ca_store_t>(
  18979. new impl::WolfSSLCAStore{std::string(pem, len)});
  18980. }
  18981. inline void free_ca_store(ca_store_t store) {
  18982. delete static_cast<impl::WolfSSLCAStore *>(store);
  18983. }
  18984. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18985. if (!ctx || !store) { return false; }
  18986. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18987. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18988. int ret = wolfSSL_CTX_load_verify_buffer(
  18989. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18990. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18991. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18992. // This function takes ownership of the store; the PEM data was copied into
  18993. // the context, so release the source
  18994. free_ca_store(store);
  18995. return ret == SSL_SUCCESS;
  18996. }
  18997. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18998. certs.clear();
  18999. if (!ctx) { return 0; }
  19000. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19001. if (wctx->ca_pem_data_.empty()) { return 0; }
  19002. const std::string &pem = wctx->ca_pem_data_;
  19003. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19004. const std::string end_marker = "-----END CERTIFICATE-----";
  19005. size_t pos = 0;
  19006. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19007. size_t end_pos = pem.find(end_marker, pos);
  19008. if (end_pos == std::string::npos) { break; }
  19009. end_pos += end_marker.size();
  19010. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19011. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19012. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19013. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19014. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19015. pos = end_pos;
  19016. }
  19017. return certs.size();
  19018. }
  19019. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19020. std::vector<std::string> names;
  19021. if (!ctx) { return names; }
  19022. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19023. if (wctx->ca_pem_data_.empty()) { return names; }
  19024. const std::string &pem = wctx->ca_pem_data_;
  19025. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19026. const std::string end_marker = "-----END CERTIFICATE-----";
  19027. size_t pos = 0;
  19028. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19029. size_t end_pos = pem.find(end_marker, pos);
  19030. if (end_pos == std::string::npos) { break; }
  19031. end_pos += end_marker.size();
  19032. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19033. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19034. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19035. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19036. if (x509) {
  19037. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19038. if (subject) {
  19039. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19040. if (name_str) {
  19041. names.push_back(name_str);
  19042. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19043. }
  19044. }
  19045. wolfSSL_X509_free(x509);
  19046. }
  19047. pos = end_pos;
  19048. }
  19049. return names;
  19050. }
  19051. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19052. const char *key_pem, const char *password) {
  19053. if (!ctx || !cert_pem || !key_pem) { return false; }
  19054. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19055. // Load new certificate
  19056. int ret = wolfSSL_CTX_use_certificate_buffer(
  19057. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19058. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19059. if (ret != SSL_SUCCESS) {
  19060. impl::wolfssl_last_error() =
  19061. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19062. return false;
  19063. }
  19064. // Set password if provided
  19065. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19066. // Load new private key
  19067. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19068. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19069. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19070. if (ret != SSL_SUCCESS) {
  19071. impl::wolfssl_last_error() =
  19072. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19073. return false;
  19074. }
  19075. return true;
  19076. }
  19077. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19078. if (!ctx || !ca_pem) { return false; }
  19079. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19080. int ret = wolfSSL_CTX_load_verify_buffer(
  19081. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19082. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19083. if (ret != SSL_SUCCESS) {
  19084. impl::wolfssl_last_error() =
  19085. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19086. return false;
  19087. }
  19088. return true;
  19089. }
  19090. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19091. if (!ctx) { return false; }
  19092. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19093. impl::get_verify_callback() = std::move(callback);
  19094. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19095. if (wctx->has_verify_callback) {
  19096. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19097. impl::wolfssl_verify_callback);
  19098. } else {
  19099. wolfSSL_CTX_set_verify(
  19100. wctx->ctx,
  19101. wctx->verify_client
  19102. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19103. : SSL_VERIFY_NONE,
  19104. nullptr);
  19105. }
  19106. return true;
  19107. }
  19108. inline long get_verify_error(const_session_t session) {
  19109. if (!session) { return -1; }
  19110. auto *wsession =
  19111. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19112. return wolfSSL_get_verify_result(wsession->ssl);
  19113. }
  19114. inline std::string verify_error_string(long error_code) {
  19115. if (error_code == 0) { return ""; }
  19116. const char *str =
  19117. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19118. return str ? std::string(str) : std::string();
  19119. }
  19120. } // namespace tls
  19121. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19122. // WebSocket implementation
  19123. namespace ws {
  19124. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19125. bool fin) {
  19126. std::lock_guard<std::mutex> lock(write_mutex_);
  19127. if (closed_) { return false; }
  19128. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19129. }
  19130. inline ReadResult WebSocket::read(std::string &msg) {
  19131. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19132. while (!closed_) {
  19133. Opcode opcode;
  19134. std::string payload;
  19135. bool fin;
  19136. impl::FrameRead r =
  19137. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19138. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19139. // A timeout landed on a frame boundary: the connection is untouched and
  19140. // still usable, so hand control back without closing it. That is only
  19141. // useful to a caller who asked for the timeout; the compile-time default
  19142. // is a backstop against a peer gone quiet, and elapsing it closes the
  19143. // connection so a plain `while (ws.read(msg))` loop ends.
  19144. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19145. if (r != impl::FrameRead::Ok) {
  19146. closed_ = true;
  19147. return Fail;
  19148. }
  19149. switch (opcode) {
  19150. case Opcode::Ping: {
  19151. std::lock_guard<std::mutex> lock(write_mutex_);
  19152. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19153. payload.size(), true, !is_server_);
  19154. continue;
  19155. }
  19156. case Opcode::Pong: {
  19157. std::lock_guard<std::mutex> lock(ping_mutex_);
  19158. unacked_pings_ = 0;
  19159. continue;
  19160. }
  19161. case Opcode::Close: {
  19162. if (!closed_.exchange(true)) {
  19163. // Echo close frame back
  19164. std::lock_guard<std::mutex> lock(write_mutex_);
  19165. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19166. payload.size(), true, !is_server_);
  19167. }
  19168. return Fail;
  19169. }
  19170. case Opcode::Text:
  19171. case Opcode::Binary: {
  19172. auto result = opcode == Opcode::Text ? Text : Binary;
  19173. msg = std::move(payload);
  19174. // Handle fragmentation
  19175. if (!fin) {
  19176. while (true) {
  19177. Opcode cont_opcode;
  19178. std::string cont_payload;
  19179. bool cont_fin;
  19180. // A timeout is not reportable here: half of a fragmented message is
  19181. // already in `msg` and read() has no way to resume it, so it is a
  19182. // failure like any other. Timeouts are only ever seen on a message
  19183. // boundary.
  19184. if (impl::read_websocket_frame(
  19185. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19186. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19187. impl::FrameRead::Ok) {
  19188. closed_ = true;
  19189. return Fail;
  19190. }
  19191. if (cont_opcode == Opcode::Ping) {
  19192. std::lock_guard<std::mutex> lock(write_mutex_);
  19193. detail::write_websocket_frame(
  19194. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19195. true, !is_server_);
  19196. continue;
  19197. }
  19198. if (cont_opcode == Opcode::Pong) {
  19199. std::lock_guard<std::mutex> lock(ping_mutex_);
  19200. unacked_pings_ = 0;
  19201. continue;
  19202. }
  19203. if (cont_opcode == Opcode::Close) {
  19204. if (!closed_.exchange(true)) {
  19205. std::lock_guard<std::mutex> lock(write_mutex_);
  19206. detail::write_websocket_frame(
  19207. strm_, Opcode::Close, cont_payload.data(),
  19208. cont_payload.size(), true, !is_server_);
  19209. }
  19210. return Fail;
  19211. }
  19212. // RFC 6455: continuation frames must use opcode 0x0
  19213. if (cont_opcode != Opcode::Continuation) {
  19214. closed_ = true;
  19215. return Fail;
  19216. }
  19217. msg += cont_payload;
  19218. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19219. closed_ = true;
  19220. return Fail;
  19221. }
  19222. if (cont_fin) { break; }
  19223. }
  19224. }
  19225. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19226. if (result == Text && !impl::is_valid_utf8(msg)) {
  19227. // close() takes the read lock to wait for the peer's Close reply, so
  19228. // it must not run while this thread still holds it.
  19229. read_lock.unlock();
  19230. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19231. return Fail;
  19232. }
  19233. return result;
  19234. }
  19235. default: closed_ = true; return Fail;
  19236. }
  19237. }
  19238. return Fail;
  19239. }
  19240. inline bool WebSocket::send(const std::string &data) {
  19241. return send_frame(Opcode::Text, data.data(), data.size());
  19242. }
  19243. inline bool WebSocket::send(const char *data, size_t len) {
  19244. return send_frame(Opcode::Binary, data, len);
  19245. }
  19246. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19247. if (closed_.exchange(true)) { return; }
  19248. ping_cv_.notify_all();
  19249. std::string payload;
  19250. auto code = static_cast<uint16_t>(status);
  19251. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19252. payload.push_back(static_cast<char>(code & 0xFF));
  19253. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19254. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19255. payload += reason.substr(0, 123);
  19256. {
  19257. std::lock_guard<std::mutex> lock(write_mutex_);
  19258. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19259. payload.size(), true, !is_server_);
  19260. }
  19261. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19262. // Close response before closing the TCP connection.
  19263. //
  19264. // Wait only when no other thread is parsing frames. When one is, it is the
  19265. // thread positioned to see the peer's reply, and reading here would take
  19266. // bytes out of the message it is assembling. Bailing out also leaves the
  19267. // stream, including its read timeout, entirely to that thread.
  19268. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19269. if (!read_lock.owns_lock()) { return; }
  19270. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19271. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19272. Opcode op;
  19273. std::string resp;
  19274. bool fin;
  19275. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19276. impl::FrameRead::Ok) {
  19277. if (op == Opcode::Close) { break; }
  19278. }
  19279. }
  19280. inline WebSocket::~WebSocket() {
  19281. {
  19282. std::lock_guard<std::mutex> lock(ping_mutex_);
  19283. closed_ = true;
  19284. }
  19285. ping_cv_.notify_all();
  19286. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19287. }
  19288. inline void WebSocket::start_heartbeat() {
  19289. if (ping_interval_sec_ == 0) { return; }
  19290. ping_thread_ = std::thread([this]() {
  19291. std::unique_lock<std::mutex> lock(ping_mutex_);
  19292. while (!closed_) {
  19293. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19294. if (closed_) { break; }
  19295. // If the peer has failed to respond to the previous pings, give up.
  19296. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19297. // opt-in liveness check controlled by max_missed_pongs_.
  19298. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19299. lock.unlock();
  19300. close(CloseStatus::GoingAway, "pong timeout");
  19301. return;
  19302. }
  19303. lock.unlock();
  19304. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19305. lock.lock();
  19306. closed_ = true;
  19307. break;
  19308. }
  19309. lock.lock();
  19310. unacked_pings_++;
  19311. }
  19312. });
  19313. }
  19314. inline const Request &WebSocket::request() const { return req_; }
  19315. inline bool WebSocket::is_open() const { return !closed_; }
  19316. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19317. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19318. // poll(), where 0 would instead mean "return immediately", so hand it the
  19319. // negative poll uses for an unbounded wait.
  19320. if (sec == 0 && usec == 0) { sec = -1; }
  19321. strm_.set_read_timeout(sec, usec);
  19322. read_timeout_set_ = true;
  19323. }
  19324. // WebSocketClient implementation
  19325. inline WebSocketClient::WebSocketClient(
  19326. const std::string &scheme_host_port_path, const Headers &headers)
  19327. : headers_(headers) {
  19328. detail::UrlComponents uc;
  19329. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19330. !uc.host.empty() && !uc.path.empty()) {
  19331. auto &scheme = uc.scheme;
  19332. #ifdef CPPHTTPLIB_SSL_ENABLED
  19333. if (scheme != "ws" && scheme != "wss") {
  19334. #else
  19335. if (scheme != "ws") {
  19336. #endif
  19337. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19338. std::string msg = "'" + scheme + "' scheme is not supported.";
  19339. throw std::invalid_argument(msg);
  19340. #endif
  19341. return;
  19342. }
  19343. auto is_ssl = scheme == "wss";
  19344. host_ = std::move(uc.host);
  19345. port_ = is_ssl ? 443 : 80;
  19346. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19347. path_ = std::move(uc.path);
  19348. if (!uc.query.empty()) { path_ += uc.query; }
  19349. #ifdef CPPHTTPLIB_SSL_ENABLED
  19350. is_ssl_ = is_ssl;
  19351. if (is_ssl_) {
  19352. // The context lives as long as the client so that CA configuration
  19353. // survives reconnects; sessions are created per connection.
  19354. tls_ctx_ = tls::create_client_context();
  19355. if (!tls_ctx_) { return; }
  19356. }
  19357. #else
  19358. if (is_ssl) { return; }
  19359. #endif
  19360. is_valid_ = true;
  19361. }
  19362. }
  19363. #ifdef CPPHTTPLIB_SSL_ENABLED
  19364. inline WebSocketClient::WebSocketClient(
  19365. const std::string &scheme_host_port_path, const PemMemory &pem,
  19366. const Headers &headers)
  19367. : WebSocketClient(scheme_host_port_path, headers) {
  19368. // For ws:// URLs the client certificate is silently ignored, consistent
  19369. // with the TLS-only setters such as set_ca_cert_path().
  19370. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19371. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19372. pem.private_key_password)) {
  19373. tls::free_context(tls_ctx_);
  19374. tls_ctx_ = nullptr;
  19375. is_valid_ = false;
  19376. }
  19377. }
  19378. }
  19379. #endif
  19380. inline WebSocketClient::~WebSocketClient() {
  19381. shutdown_and_close();
  19382. #ifdef CPPHTTPLIB_SSL_ENABLED
  19383. if (tls_ctx_) {
  19384. tls::free_context(tls_ctx_);
  19385. tls_ctx_ = nullptr;
  19386. }
  19387. #endif
  19388. }
  19389. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19390. inline void WebSocketClient::shutdown_and_close() {
  19391. // Send the close frame while the TLS session is still alive: ws_ holds an
  19392. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19393. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19394. if (ws_ && ws_->is_open()) { ws_->close(); }
  19395. ws_.reset();
  19396. #ifdef CPPHTTPLIB_SSL_ENABLED
  19397. if (is_ssl_) {
  19398. if (tls_session_) {
  19399. tls::shutdown(tls_session_, true);
  19400. tls::free_session(tls_session_);
  19401. tls_session_ = nullptr;
  19402. }
  19403. }
  19404. #endif
  19405. if (sock_ != INVALID_SOCKET) {
  19406. detail::shutdown_socket(sock_);
  19407. detail::close_socket(sock_);
  19408. sock_ = INVALID_SOCKET;
  19409. }
  19410. }
  19411. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19412. Error &error, int &ssl_error,
  19413. uint64_t &ssl_backend_error) {
  19414. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19415. // The streams wait with poll(), where 0 instead means "return immediately",
  19416. // so they are given the negative poll uses for an unbounded wait.
  19417. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19418. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19419. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19420. // The handshake belongs to establishing the connection, so an unset read
  19421. // timeout leaves it bounded by the connection timeout instead of forever.
  19422. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19423. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19424. #ifdef CPPHTTPLIB_SSL_ENABLED
  19425. if (is_ssl_) {
  19426. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19427. // is not safe to call concurrently on one client to begin with, since
  19428. // nothing else here is guarded either.
  19429. if (server_certificate_verification_ && !certs_loaded_) {
  19430. uint64_t backend_error = 0;
  19431. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19432. ca_cert_dir_path_, custom_ca_loaded_,
  19433. system_ca_mode_, backend_error);
  19434. certs_loaded_ = true;
  19435. }
  19436. detail::ClientTlsSessionOptions options;
  19437. options.server_hostname_verification = server_hostname_verification_;
  19438. detail::ClientTlsSessionError tls_error;
  19439. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19440. server_certificate_verification_,
  19441. hs_sec, hs_usec, &tls_error,
  19442. options)) {
  19443. error = tls_error.error;
  19444. ssl_error = tls_error.ssl_error;
  19445. ssl_backend_error = tls_error.backend_error;
  19446. return false;
  19447. }
  19448. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19449. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19450. write_timeout_usec_));
  19451. return true;
  19452. }
  19453. #else
  19454. (void)error;
  19455. (void)ssl_error;
  19456. (void)ssl_backend_error;
  19457. (void)hs_sec;
  19458. (void)hs_usec;
  19459. #endif
  19460. strm = std::unique_ptr<Stream>(
  19461. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19462. write_timeout_sec_, write_timeout_usec_));
  19463. return true;
  19464. }
  19465. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19466. #ifdef CPPHTTPLIB_SSL_ENABLED
  19467. auto is_ssl = is_ssl_;
  19468. #else
  19469. auto is_ssl = false;
  19470. #endif
  19471. if (!req.has_header("Host")) {
  19472. req.headers.emplace("Host", detail::make_default_host_header_value(
  19473. host_, port_, is_ssl, address_family_));
  19474. }
  19475. detail::add_default_user_agent_header(req);
  19476. }
  19477. inline Result WebSocketClient::connect() {
  19478. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19479. shutdown_and_close();
  19480. // Check is custom IP or hostname specified for host_
  19481. std::string connect_host;
  19482. std::string ip;
  19483. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19484. auto error = Error::Success;
  19485. sock_ = detail::create_client_socket(
  19486. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19487. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19488. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19489. write_timeout_usec_, interface_, error);
  19490. if (sock_ == INVALID_SOCKET) {
  19491. if (error == Error::Success) { error = Error::Connection; }
  19492. return Result{error, -1, Headers{}};
  19493. }
  19494. std::unique_ptr<Stream> strm;
  19495. auto stream_error = Error::SSLConnection;
  19496. int ssl_error = 0;
  19497. uint64_t ssl_backend_error = 0;
  19498. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19499. shutdown_and_close();
  19500. #ifdef CPPHTTPLIB_SSL_ENABLED
  19501. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19502. #else
  19503. return Result{stream_error, -1, Headers{}};
  19504. #endif
  19505. }
  19506. Request req;
  19507. req.method = "GET";
  19508. req.path = path_;
  19509. req.headers = headers_;
  19510. prepare_default_headers(req);
  19511. detail::WebSocketUpgradeResponse upgrade;
  19512. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19513. shutdown_and_close();
  19514. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19515. }
  19516. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19517. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19518. websocket_ping_interval_sec_,
  19519. websocket_max_missed_pongs_));
  19520. // The stream was created with the timeout already; tell the WebSocket
  19521. // whether it came from the caller, so read() knows to report it as Timeout.
  19522. ws_->read_timeout_set_ = read_timeout_set_;
  19523. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19524. }
  19525. inline ReadResult WebSocketClient::read(std::string &msg) {
  19526. if (!ws_) { return Fail; }
  19527. return ws_->read(msg);
  19528. }
  19529. inline bool WebSocketClient::send(const std::string &data) {
  19530. if (!ws_) { return false; }
  19531. return ws_->send(data);
  19532. }
  19533. inline bool WebSocketClient::send(const char *data, size_t len) {
  19534. if (!ws_) { return false; }
  19535. return ws_->send(data, len);
  19536. }
  19537. inline void WebSocketClient::close(CloseStatus status,
  19538. const std::string &reason) {
  19539. if (ws_) { ws_->close(status, reason); }
  19540. }
  19541. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19542. inline const std::string &WebSocketClient::subprotocol() const {
  19543. return subprotocol_;
  19544. }
  19545. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19546. read_timeout_sec_ = sec;
  19547. read_timeout_usec_ = usec;
  19548. read_timeout_set_ = true;
  19549. // The members above only seed the next connect(); read() consults the
  19550. // stream, so an already-open connection has to be told directly.
  19551. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19552. }
  19553. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19554. write_timeout_sec_ = sec;
  19555. write_timeout_usec_ = usec;
  19556. }
  19557. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19558. websocket_ping_interval_sec_ = sec;
  19559. }
  19560. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19561. websocket_max_missed_pongs_ = count;
  19562. }
  19563. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19564. inline void WebSocketClient::set_address_family(int family) {
  19565. address_family_ = family;
  19566. }
  19567. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19568. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19569. socket_options_ = std::move(socket_options);
  19570. }
  19571. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19572. connection_timeout_sec_ = sec;
  19573. connection_timeout_usec_ = usec;
  19574. }
  19575. inline void WebSocketClient::set_interface(const std::string &intf) {
  19576. interface_ = intf;
  19577. }
  19578. inline void WebSocketClient::set_hostname_addr_map(
  19579. std::map<std::string, std::string> addr_map) {
  19580. addr_map_ = std::move(addr_map);
  19581. }
  19582. #ifdef CPPHTTPLIB_SSL_ENABLED
  19583. inline void
  19584. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19585. const std::string &ca_cert_dir_path) {
  19586. ca_cert_file_path_ = ca_cert_file_path;
  19587. ca_cert_dir_path_ = ca_cert_dir_path;
  19588. }
  19589. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19590. if (store && tls_ctx_) {
  19591. // set_ca_store takes ownership of store
  19592. tls::set_ca_store(tls_ctx_, store);
  19593. custom_ca_loaded_ = true;
  19594. } else if (store) {
  19595. tls::free_ca_store(store);
  19596. }
  19597. }
  19598. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19599. std::size_t size) {
  19600. if (tls_ctx_ && ca_cert && size > 0) {
  19601. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19602. custom_ca_loaded_ = true;
  19603. }
  19604. }
  19605. inline void
  19606. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19607. server_certificate_verification_ = enabled;
  19608. }
  19609. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19610. server_hostname_verification_ = enabled;
  19611. }
  19612. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19613. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19614. }
  19615. #endif // CPPHTTPLIB_SSL_ENABLED
  19616. } // namespace ws
  19617. // ----------------------------------------------------------------------------
  19618. } // namespace httplib
  19619. #endif // CPPHTTPLIB_HTTPLIB_H