httplib.h 784 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028
  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{} || res.ptr != pb + r.second ||
  6359. v < 0.0 || v > 1.0) {
  6360. invalid = true;
  6361. return true;
  6362. }
  6363. quality = v;
  6364. return true;
  6365. });
  6366. return !invalid;
  6367. }
  6368. inline EncodingType encoding_type(const Request &req,
  6369. const std::string &content_type) {
  6370. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6371. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6372. if (s.empty()) { return EncodingType::None; }
  6373. // Single-pass: iterate tokens and track the best supported encoding.
  6374. // Server preference breaks ties (br > gzip > zstd).
  6375. EncodingType best = EncodingType::None;
  6376. double best_q = 0.0; // q=0 means "not acceptable"
  6377. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6378. auto priority = [](EncodingType t) -> int {
  6379. switch (t) {
  6380. case EncodingType::Brotli: return 0;
  6381. case EncodingType::Gzip: return 1;
  6382. case EncodingType::Zstd: return 2;
  6383. default: return 3;
  6384. }
  6385. };
  6386. std::string name;
  6387. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6388. double quality = 1.0;
  6389. if (!parse_quality(b, e, name, quality)) { return; }
  6390. if (quality <= 0.0) { return; }
  6391. EncodingType type = EncodingType::None;
  6392. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6393. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6394. #endif
  6395. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6396. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6397. type = EncodingType::Gzip;
  6398. }
  6399. #endif
  6400. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6401. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6402. type = EncodingType::Zstd;
  6403. }
  6404. #endif
  6405. if (type == EncodingType::None) { return; }
  6406. // Higher q-value wins; for equal q, server preference breaks ties
  6407. if (quality > best_q ||
  6408. (quality == best_q && priority(type) < priority(best))) {
  6409. best_q = quality;
  6410. best = type;
  6411. }
  6412. });
  6413. return best;
  6414. }
  6415. // `content_type` is taken separately because a file-backed response has not
  6416. // been given one yet when its coding has to be decided.
  6417. inline EncodingType encoding_type(const Request &req, const Response &res,
  6418. const std::string &content_type) {
  6419. // The response already names a content coding of its own: a handler serving
  6420. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6421. // point whose headers name the coding its files are stored in. Applying one
  6422. // on top of that would double-encode the body and append a second
  6423. // `Content-Encoding` field line.
  6424. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6425. return encoding_type(req, content_type);
  6426. }
  6427. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6428. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6429. }
  6430. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6431. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6432. if (type == EncodingType::Gzip) {
  6433. return detail::make_unique<gzip_compressor>();
  6434. }
  6435. #endif
  6436. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6437. if (type == EncodingType::Brotli) {
  6438. return detail::make_unique<brotli_compressor>();
  6439. }
  6440. #endif
  6441. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6442. if (type == EncodingType::Zstd) {
  6443. return detail::make_unique<zstd_compressor>();
  6444. }
  6445. #endif
  6446. (void)type;
  6447. return nullptr;
  6448. }
  6449. inline const char *encoding_name(EncodingType type) {
  6450. switch (type) {
  6451. case EncodingType::Gzip: return "gzip";
  6452. case EncodingType::Brotli: return "br";
  6453. case EncodingType::Zstd: return "zstd";
  6454. default: return "";
  6455. }
  6456. }
  6457. inline bool nocompressor::compress(const char *data, size_t data_length,
  6458. bool /*last*/, Callback callback) {
  6459. if (!data_length) { return true; }
  6460. return callback(data, data_length);
  6461. }
  6462. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6463. inline gzip_compressor::gzip_compressor() {
  6464. std::memset(&strm_, 0, sizeof(strm_));
  6465. strm_.zalloc = Z_NULL;
  6466. strm_.zfree = Z_NULL;
  6467. strm_.opaque = Z_NULL;
  6468. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6469. Z_DEFAULT_STRATEGY) == Z_OK;
  6470. }
  6471. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6472. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6473. bool last, Callback callback) {
  6474. assert(is_valid_);
  6475. do {
  6476. constexpr size_t max_avail_in =
  6477. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6478. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6479. (std::min)(data_length, max_avail_in));
  6480. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6481. data_length -= strm_.avail_in;
  6482. data += strm_.avail_in;
  6483. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6484. auto ret = Z_OK;
  6485. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6486. do {
  6487. strm_.avail_out = static_cast<uInt>(buff.size());
  6488. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6489. ret = deflate(&strm_, flush);
  6490. if (ret == Z_STREAM_ERROR) { return false; }
  6491. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6492. return false;
  6493. }
  6494. } while (strm_.avail_out == 0);
  6495. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6496. (flush == Z_NO_FLUSH && ret == Z_OK));
  6497. assert(strm_.avail_in == 0);
  6498. } while (data_length > 0);
  6499. return true;
  6500. }
  6501. inline gzip_decompressor::gzip_decompressor() {
  6502. std::memset(&strm_, 0, sizeof(strm_));
  6503. strm_.zalloc = Z_NULL;
  6504. strm_.zfree = Z_NULL;
  6505. strm_.opaque = Z_NULL;
  6506. // 15 is the value of wbits, which should be at the maximum possible value
  6507. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6508. // that the stream type should be automatically detected either gzip or
  6509. // deflate.
  6510. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6511. }
  6512. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6513. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6514. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6515. Callback callback) {
  6516. assert(is_valid_);
  6517. auto ret = Z_OK;
  6518. do {
  6519. constexpr size_t max_avail_in =
  6520. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6521. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6522. (std::min)(data_length, max_avail_in));
  6523. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6524. data_length -= strm_.avail_in;
  6525. data += strm_.avail_in;
  6526. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6527. while (strm_.avail_in > 0 && ret == Z_OK) {
  6528. strm_.avail_out = static_cast<uInt>(buff.size());
  6529. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6530. ret = inflate(&strm_, Z_NO_FLUSH);
  6531. assert(ret != Z_STREAM_ERROR);
  6532. switch (ret) {
  6533. case Z_NEED_DICT:
  6534. case Z_DATA_ERROR:
  6535. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6536. }
  6537. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6538. return false;
  6539. }
  6540. }
  6541. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6542. } while (data_length > 0);
  6543. return true;
  6544. }
  6545. #endif
  6546. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6547. inline brotli_compressor::brotli_compressor() {
  6548. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6549. }
  6550. inline brotli_compressor::~brotli_compressor() {
  6551. BrotliEncoderDestroyInstance(state_);
  6552. }
  6553. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6554. bool last, Callback callback) {
  6555. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6556. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6557. auto available_in = data_length;
  6558. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6559. for (;;) {
  6560. if (last) {
  6561. if (BrotliEncoderIsFinished(state_)) { break; }
  6562. } else {
  6563. if (!available_in) { break; }
  6564. }
  6565. auto available_out = buff.size();
  6566. auto next_out = buff.data();
  6567. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6568. &available_out, &next_out, nullptr)) {
  6569. return false;
  6570. }
  6571. auto output_bytes = buff.size() - available_out;
  6572. if (output_bytes) {
  6573. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6574. }
  6575. }
  6576. return true;
  6577. }
  6578. inline brotli_decompressor::brotli_decompressor() {
  6579. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6580. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6581. : BROTLI_DECODER_RESULT_ERROR;
  6582. }
  6583. inline brotli_decompressor::~brotli_decompressor() {
  6584. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6585. }
  6586. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6587. inline bool brotli_decompressor::decompress(const char *data,
  6588. size_t data_length,
  6589. Callback callback) {
  6590. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6591. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6592. return 0;
  6593. }
  6594. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6595. size_t avail_in = data_length;
  6596. size_t total_out;
  6597. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6598. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6599. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6600. char *next_out = buff.data();
  6601. size_t avail_out = buff.size();
  6602. decoder_r = BrotliDecoderDecompressStream(
  6603. decoder_s, &avail_in, &next_in, &avail_out,
  6604. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6605. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6606. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6607. }
  6608. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6609. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6610. }
  6611. #endif
  6612. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6613. inline zstd_compressor::zstd_compressor() {
  6614. ctx_ = ZSTD_createCCtx();
  6615. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6616. }
  6617. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6618. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6619. bool last, Callback callback) {
  6620. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6621. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6622. ZSTD_inBuffer input = {data, data_length, 0};
  6623. bool finished;
  6624. do {
  6625. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6626. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6627. if (ZSTD_isError(remaining)) { return false; }
  6628. if (!callback(buff.data(), output.pos)) { return false; }
  6629. finished = last ? (remaining == 0) : (input.pos == input.size);
  6630. } while (!finished);
  6631. return true;
  6632. }
  6633. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6634. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6635. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6636. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6637. Callback callback) {
  6638. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6639. ZSTD_inBuffer input = {data, data_length, 0};
  6640. while (input.pos < input.size) {
  6641. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6642. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6643. if (ZSTD_isError(remaining)) { return false; }
  6644. if (!callback(buff.data(), output.pos)) { return false; }
  6645. }
  6646. return true;
  6647. }
  6648. #endif
  6649. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6650. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6651. // unknown coding, and its payload would be handed back still compressed.
  6652. inline bool is_zlib_encoding(const std::string &encoding) {
  6653. return case_ignore::equal(encoding, "gzip") ||
  6654. case_ignore::equal(encoding, "deflate");
  6655. }
  6656. inline bool is_brotli_encoding(const std::string &encoding) {
  6657. return case_ignore::equal(encoding, "br");
  6658. }
  6659. inline bool is_zstd_encoding(const std::string &encoding) {
  6660. return case_ignore::equal(encoding, "zstd");
  6661. }
  6662. // Returns true if the content coding is one cpp-httplib is able to decompress
  6663. // when the corresponding support is compiled in.
  6664. inline bool is_known_content_encoding(const std::string &encoding) {
  6665. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6666. is_zstd_encoding(encoding);
  6667. }
  6668. inline std::unique_ptr<decompressor>
  6669. create_decompressor(const std::string &encoding) {
  6670. std::unique_ptr<decompressor> decompressor;
  6671. if (is_zlib_encoding(encoding)) {
  6672. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6673. decompressor = detail::make_unique<gzip_decompressor>();
  6674. #endif
  6675. } else if (is_brotli_encoding(encoding)) {
  6676. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6677. decompressor = detail::make_unique<brotli_decompressor>();
  6678. #endif
  6679. } else if (is_zstd_encoding(encoding)) {
  6680. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6681. decompressor = detail::make_unique<zstd_decompressor>();
  6682. #endif
  6683. }
  6684. return decompressor;
  6685. }
  6686. // Returns the best available compressor and its Content-Encoding name.
  6687. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6688. inline std::pair<std::unique_ptr<compressor>, const char *>
  6689. create_compressor() {
  6690. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6691. return {detail::make_unique<brotli_compressor>(), "br"};
  6692. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6693. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6694. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6695. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6696. #else
  6697. return {nullptr, nullptr};
  6698. #endif
  6699. }
  6700. inline bool is_prohibited_header_name(const std::string &name) {
  6701. using udl::operator""_t;
  6702. switch (str2tag(name)) {
  6703. case "REMOTE_ADDR"_t:
  6704. case "REMOTE_PORT"_t:
  6705. case "LOCAL_ADDR"_t:
  6706. case "LOCAL_PORT"_t: return true;
  6707. default: return false;
  6708. }
  6709. }
  6710. inline bool has_header(const Headers &headers, const std::string &key) {
  6711. if (is_prohibited_header_name(key)) { return false; }
  6712. return headers.find(key) != headers.end();
  6713. }
  6714. inline const char *get_header_value(const Headers &headers,
  6715. const std::string &key, const char *def,
  6716. size_t id) {
  6717. if (is_prohibited_header_name(key)) {
  6718. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6719. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6720. throw std::invalid_argument(msg);
  6721. #else
  6722. return "";
  6723. #endif
  6724. }
  6725. auto rng = headers.equal_range(key);
  6726. auto it = rng.first;
  6727. std::advance(it, static_cast<ssize_t>(id));
  6728. if (it != rng.second) { return it->second.c_str(); }
  6729. return def;
  6730. }
  6731. inline size_t get_header_value_count(const Headers &headers,
  6732. const std::string &key) {
  6733. return headers.count(key);
  6734. }
  6735. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6736. // list may be sent as several field lines, and the combined field value is
  6737. // those values joined by commas in the order they were received. Callers that
  6738. // parse such a list must work on the combined value; reading only the first
  6739. // occurrence silently drops whatever the later field lines carry.
  6740. inline std::string get_combined_header_value(const Headers &headers,
  6741. const std::string &key) {
  6742. std::string combined;
  6743. auto rng = headers.equal_range(key);
  6744. for (auto it = rng.first; it != rng.second; ++it) {
  6745. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6746. // elements, so an empty field line must not contribute a bare comma to the
  6747. // combined value.
  6748. if (it->second.empty()) { continue; }
  6749. if (!combined.empty()) { combined += ", "; }
  6750. combined += it->second;
  6751. }
  6752. return combined;
  6753. }
  6754. inline bool has_header_token(const Headers &headers, const std::string &key,
  6755. const std::string &token) {
  6756. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6757. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6758. // several lines. Match complete tokens rather than searching the raw value,
  6759. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6760. auto rng = headers.equal_range(key);
  6761. for (auto it = rng.first; it != rng.second; ++it) {
  6762. const auto &value = it->second;
  6763. if (split_find(value.data(), value.data() + value.size(), ',',
  6764. [&](const char *b, const char *e) {
  6765. return case_ignore::equal(std::string(b, e), token);
  6766. })) {
  6767. return true;
  6768. }
  6769. }
  6770. return false;
  6771. }
  6772. template <typename Map>
  6773. inline typename Map::mapped_type
  6774. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6775. auto rng = m.equal_range(key);
  6776. auto it = rng.first;
  6777. std::advance(it, static_cast<ssize_t>(id));
  6778. if (it != rng.second) { return it->second; }
  6779. return typename Map::mapped_type();
  6780. }
  6781. inline void set_header(Headers &headers, const std::string &key,
  6782. const std::string &val) {
  6783. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6784. }
  6785. inline bool read_headers(Stream &strm, Headers &headers) {
  6786. const auto bufsiz = 2048;
  6787. char buf[bufsiz];
  6788. stream_line_reader line_reader(strm, buf, bufsiz);
  6789. size_t header_count = 0;
  6790. for (;;) {
  6791. if (!line_reader.getline()) { return false; }
  6792. // Check if the line ends with CRLF.
  6793. auto line_terminator_len = 2;
  6794. if (line_reader.end_with_crlf()) {
  6795. // Blank line indicates end of headers.
  6796. if (line_reader.size() == 2) { break; }
  6797. } else {
  6798. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6799. // Blank line indicates end of headers.
  6800. if (line_reader.size() == 1) { break; }
  6801. line_terminator_len = 1;
  6802. #else
  6803. continue; // Skip invalid line.
  6804. #endif
  6805. }
  6806. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6807. // Check header count limit
  6808. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6809. // Exclude line terminator
  6810. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6811. if (!parse_header(line_reader.ptr(), end,
  6812. [&](const std::string &key, const std::string &val) {
  6813. headers.emplace(key, val);
  6814. })) {
  6815. return false;
  6816. }
  6817. header_count++;
  6818. }
  6819. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6820. // headers that have different values to prevent request smuggling.
  6821. auto cl_range = headers.equal_range("Content-Length");
  6822. if (cl_range.first != cl_range.second) {
  6823. const auto &first_val = cl_range.first->second;
  6824. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6825. if (it->second != first_val) { return false; }
  6826. }
  6827. }
  6828. return true;
  6829. }
  6830. inline bool parse_status_line(const char *line, std::string &version,
  6831. int &status, std::string &reason) {
  6832. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6833. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6834. #else
  6835. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6836. #endif
  6837. std::cmatch m;
  6838. if (!std::regex_match(line, m, re)) { return false; }
  6839. version = std::string(m[1]);
  6840. status = std::stoi(std::string(m[2]));
  6841. reason = std::string(m[3]);
  6842. return true;
  6843. }
  6844. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6845. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6846. struct WebSocketUpgradeResponse {
  6847. Error error = Error::Success;
  6848. int status = -1;
  6849. Headers headers;
  6850. std::string selected_subprotocol;
  6851. };
  6852. inline bool read_websocket_upgrade_response(Stream &strm,
  6853. const std::string &expected_accept,
  6854. WebSocketUpgradeResponse &upgrade) {
  6855. // Read status line
  6856. const auto bufsiz = 2048;
  6857. char buf[bufsiz];
  6858. stream_line_reader line_reader(strm, buf, bufsiz);
  6859. if (!line_reader.getline()) {
  6860. upgrade.error = Error::Read;
  6861. return false;
  6862. }
  6863. std::string version;
  6864. std::string reason;
  6865. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6866. upgrade.error = Error::WebSocketHandshake;
  6867. return false;
  6868. }
  6869. // Read the headers even for a rejection so the caller can see why the
  6870. // server refused the upgrade. A non-101 response may carry a body; it is
  6871. // deliberately left unread since the caller closes the socket right away.
  6872. if (!read_headers(strm, upgrade.headers)) {
  6873. upgrade.error = Error::Read;
  6874. return false;
  6875. }
  6876. const auto &headers = upgrade.headers;
  6877. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6878. upgrade.error = Error::WebSocketHandshake;
  6879. return false;
  6880. }
  6881. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6882. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6883. upgrade.error = Error::WebSocketHandshake;
  6884. return false;
  6885. }
  6886. // Verify Connection: Upgrade
  6887. if (!has_header_token(headers, "Connection", "upgrade")) {
  6888. upgrade.error = Error::WebSocketHandshake;
  6889. return false;
  6890. }
  6891. // Verify Sec-WebSocket-Accept header value
  6892. auto it = headers.find("Sec-WebSocket-Accept");
  6893. if (it == headers.end() || it->second != expected_accept) {
  6894. upgrade.error = Error::WebSocketHandshake;
  6895. return false;
  6896. }
  6897. // Extract negotiated subprotocol
  6898. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6899. if (proto_it != headers.end()) {
  6900. upgrade.selected_subprotocol = proto_it->second;
  6901. }
  6902. return true;
  6903. }
  6904. enum class ReadContentResult {
  6905. Success, // Successfully read the content
  6906. PayloadTooLarge, // The content exceeds the specified payload limit
  6907. Error // An error occurred while reading the content
  6908. };
  6909. inline ReadContentResult read_content_with_length(
  6910. Stream &strm, size_t len, DownloadProgress progress,
  6911. ContentReceiverWithProgress out,
  6912. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6913. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6914. detail::BodyReader br;
  6915. br.stream = &strm;
  6916. br.has_content_length = true;
  6917. br.content_length = len;
  6918. br.payload_max_length = payload_max_length;
  6919. br.chunked = false;
  6920. br.bytes_read = 0;
  6921. br.last_error = Error::Success;
  6922. size_t r = 0;
  6923. while (r < len) {
  6924. auto read_len = static_cast<size_t>(len - r);
  6925. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6926. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6927. if (n <= 0) {
  6928. // Check if it was a payload size error
  6929. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6930. return ReadContentResult::PayloadTooLarge;
  6931. }
  6932. return ReadContentResult::Error;
  6933. }
  6934. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6935. return ReadContentResult::Error;
  6936. }
  6937. r += static_cast<size_t>(n);
  6938. if (progress) {
  6939. if (!progress(r, len)) { return ReadContentResult::Error; }
  6940. }
  6941. }
  6942. return ReadContentResult::Success;
  6943. }
  6944. inline ReadContentResult
  6945. read_content_without_length(Stream &strm, size_t payload_max_length,
  6946. ContentReceiverWithProgress out) {
  6947. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6948. size_t r = 0;
  6949. for (;;) {
  6950. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6951. if (n == 0) { return ReadContentResult::Success; }
  6952. if (n < 0) { return ReadContentResult::Error; }
  6953. // Check if adding this data would exceed the payload limit
  6954. if (r > payload_max_length ||
  6955. payload_max_length - r < static_cast<size_t>(n)) {
  6956. return ReadContentResult::PayloadTooLarge;
  6957. }
  6958. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6959. return ReadContentResult::Error;
  6960. }
  6961. r += static_cast<size_t>(n);
  6962. }
  6963. return ReadContentResult::Success;
  6964. }
  6965. template <typename T>
  6966. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6967. size_t payload_max_length,
  6968. ContentReceiverWithProgress out) {
  6969. detail::ChunkedDecoder dec(strm);
  6970. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6971. size_t total_len = 0;
  6972. for (;;) {
  6973. size_t chunk_offset = 0;
  6974. size_t chunk_total = 0;
  6975. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6976. if (n < 0) { return ReadContentResult::Error; }
  6977. if (n == 0) {
  6978. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6979. return ReadContentResult::Error;
  6980. }
  6981. return ReadContentResult::Success;
  6982. }
  6983. if (total_len > payload_max_length ||
  6984. payload_max_length - total_len < static_cast<size_t>(n)) {
  6985. return ReadContentResult::PayloadTooLarge;
  6986. }
  6987. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6988. return ReadContentResult::Error;
  6989. }
  6990. total_len += static_cast<size_t>(n);
  6991. }
  6992. }
  6993. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6994. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6995. // is the final transfer coding. A single field value may list several
  6996. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6997. // several Transfer-Encoding lines, which combine into one comma-separated
  6998. // list in the order the lines were received. Headers preserves that order,
  6999. // so the final coding is the last token of the last line. Match it
  7000. // case-insensitively rather than comparing the whole value against
  7001. // "chunked".
  7002. //
  7003. // Security: reading a chunked message as unframed leaves its body in the
  7004. // socket, where a keep-alive connection parses it as a smuggled request.
  7005. // Server::process_request() answers 400 and closes when the final coding is
  7006. // not chunked, so a request whose framing cannot be determined never
  7007. // reaches the "no body" path.
  7008. auto rng = headers.equal_range("Transfer-Encoding");
  7009. if (rng.first == rng.second) { return false; }
  7010. // Cleared per line, so a trailing line carrying no coding at all leaves the
  7011. // combined list ending in nothing rather than inheriting the line before it.
  7012. std::string last_coding;
  7013. for (auto it = rng.first; it != rng.second; ++it) {
  7014. const auto &value = it->second;
  7015. last_coding.clear();
  7016. split(value.data(), value.data() + value.size(), ',',
  7017. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  7018. }
  7019. return case_ignore::equal(last_coding, "chunked");
  7020. }
  7021. inline bool has_conflicting_content_length(const Headers &headers) {
  7022. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  7023. // Content-Length is framed ambiguously. The body readers here delimit it by
  7024. // the transfer coding and drop Content-Length, while an intermediary may do
  7025. // the reverse, so the two disagree on where the body ends and a reused
  7026. // connection is desynchronised (request/response smuggling). Content-Length:
  7027. // 0 is tolerated for compatibility with existing peers.
  7028. return has_header(headers, "Transfer-Encoding") &&
  7029. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  7030. }
  7031. template <typename T, typename U>
  7032. bool prepare_content_receiver(T &x, int &status,
  7033. ContentReceiverWithProgress receiver,
  7034. bool decompress, size_t payload_max_length,
  7035. bool &exceed_payload_max_length, U callback) {
  7036. if (decompress) {
  7037. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7038. std::unique_ptr<decompressor> decompressor;
  7039. if (!encoding.empty()) {
  7040. // A coding we know about but were not built with is an error. An
  7041. // unrecognized coding (including "identity") is left alone and the
  7042. // payload is passed through as-is, since some servers misuse the header,
  7043. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7044. decompressor = detail::create_decompressor(encoding);
  7045. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7046. status = StatusCode::UnsupportedMediaType_415;
  7047. return false;
  7048. }
  7049. }
  7050. if (decompressor) {
  7051. if (decompressor->is_valid()) {
  7052. size_t decompressed_size = 0;
  7053. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7054. size_t off, size_t len) {
  7055. return decompressor->decompress(
  7056. buf, n, [&](const char *buf2, size_t n2) {
  7057. // Guard against zip-bomb: check
  7058. // decompressed size against limit.
  7059. if (payload_max_length > 0 &&
  7060. (decompressed_size >= payload_max_length ||
  7061. n2 > payload_max_length - decompressed_size)) {
  7062. exceed_payload_max_length = true;
  7063. return false;
  7064. }
  7065. decompressed_size += n2;
  7066. return receiver(buf2, n2, off, len);
  7067. });
  7068. };
  7069. return callback(std::move(out));
  7070. } else {
  7071. status = StatusCode::InternalServerError_500;
  7072. return false;
  7073. }
  7074. }
  7075. }
  7076. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7077. size_t len) {
  7078. return receiver(buf, n, off, len);
  7079. };
  7080. return callback(std::move(out));
  7081. }
  7082. template <typename T>
  7083. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7084. DownloadProgress progress,
  7085. ContentReceiverWithProgress receiver, bool decompress) {
  7086. bool exceed_payload_max_length = false;
  7087. return prepare_content_receiver(
  7088. x, status, std::move(receiver), decompress, payload_max_length,
  7089. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7090. auto ret = true;
  7091. // Note: exceed_payload_max_length may also be set by the decompressor
  7092. // wrapper in prepare_content_receiver when the decompressed payload
  7093. // size exceeds the limit.
  7094. if (is_chunked_transfer_encoding(x.headers)) {
  7095. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7096. if (result == ReadContentResult::Success) {
  7097. ret = true;
  7098. } else if (result == ReadContentResult::PayloadTooLarge) {
  7099. exceed_payload_max_length = true;
  7100. ret = false;
  7101. } else {
  7102. ret = false;
  7103. }
  7104. } else if (!has_header(x.headers, "Content-Length")) {
  7105. auto result =
  7106. read_content_without_length(strm, payload_max_length, out);
  7107. if (result == ReadContentResult::Success) {
  7108. ret = true;
  7109. } else if (result == ReadContentResult::PayloadTooLarge) {
  7110. exceed_payload_max_length = true;
  7111. ret = false;
  7112. } else {
  7113. ret = false;
  7114. }
  7115. } else {
  7116. auto is_invalid_value = false;
  7117. auto len = get_header_value_u64(x.headers, "Content-Length",
  7118. (std::numeric_limits<size_t>::max)(),
  7119. 0, is_invalid_value);
  7120. if (is_invalid_value) {
  7121. ret = false;
  7122. } else if (len > 0) {
  7123. auto result = read_content_with_length(
  7124. strm, len, std::move(progress), out, payload_max_length);
  7125. ret = (result == ReadContentResult::Success);
  7126. if (result == ReadContentResult::PayloadTooLarge) {
  7127. exceed_payload_max_length = true;
  7128. }
  7129. }
  7130. }
  7131. if (!ret) {
  7132. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7133. : StatusCode::BadRequest_400;
  7134. }
  7135. return ret;
  7136. });
  7137. }
  7138. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7139. const std::string &path) {
  7140. // Neither the method nor the request target may carry CR/LF (or other
  7141. // control octets); otherwise a value smuggled into either splits the request
  7142. // line and injects headers or a whole request. The method must be a token
  7143. // (RFC 9110 Section 9.1), which also rejects an empty method and embedded
  7144. // spaces. The target gets the same field-value check that already guards
  7145. // header values in check_and_write_headers.
  7146. if (!fields::is_token(method)) { return -1; }
  7147. if (!fields::is_field_value(path)) { return -1; }
  7148. std::string s = method;
  7149. s += ' ';
  7150. s += path;
  7151. s += " HTTP/1.1\r\n";
  7152. return strm.write(s.data(), s.size());
  7153. }
  7154. inline ssize_t write_response_line(Stream &strm, int status) {
  7155. std::string s = "HTTP/1.1 ";
  7156. s += std::to_string(status);
  7157. s += ' ';
  7158. s += httplib::status_message(status);
  7159. s += "\r\n";
  7160. return strm.write(s.data(), s.size());
  7161. }
  7162. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7163. ssize_t write_len = 0;
  7164. for (const auto &x : headers) {
  7165. // Skip fields with invalid names or values to prevent response splitting
  7166. // via CR/LF injection, matching set_header(). The client validates request
  7167. // headers up front in check_and_write_headers, but the server passes
  7168. // res.headers straight to this writer, and res.headers is a public field
  7169. // an application can populate directly with request-derived values.
  7170. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7171. std::string s;
  7172. s = x.first;
  7173. s += ": ";
  7174. s += x.second;
  7175. s += "\r\n";
  7176. auto len = strm.write(s.data(), s.size());
  7177. if (len < 0) { return len; }
  7178. write_len += len;
  7179. }
  7180. auto len = strm.write("\r\n");
  7181. if (len < 0) { return len; }
  7182. write_len += len;
  7183. return write_len;
  7184. }
  7185. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7186. size_t offset = 0;
  7187. while (offset < l) {
  7188. auto length = strm.write(d + offset, l - offset);
  7189. if (length < 0) { return false; }
  7190. offset += static_cast<size_t>(length);
  7191. }
  7192. return true;
  7193. }
  7194. template <typename T>
  7195. inline bool write_content_with_progress(Stream &strm,
  7196. const ContentProvider &content_provider,
  7197. size_t offset, size_t length,
  7198. T is_shutting_down,
  7199. const UploadProgress &upload_progress,
  7200. Error &error) {
  7201. size_t end_offset = offset + length;
  7202. size_t start_offset = offset;
  7203. auto ok = true;
  7204. auto finished = false;
  7205. DataSink data_sink;
  7206. data_sink.write = [&](const char *d, size_t l) -> bool {
  7207. if (ok) {
  7208. if (write_data(strm, d, l)) {
  7209. offset += l;
  7210. if (upload_progress && length > 0) {
  7211. size_t current_written = offset - start_offset;
  7212. if (!upload_progress(current_written, length)) {
  7213. ok = false;
  7214. return false;
  7215. }
  7216. }
  7217. } else {
  7218. ok = false;
  7219. }
  7220. }
  7221. return ok;
  7222. };
  7223. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7224. // The body is framed by `length`, so a provider that reports itself done
  7225. // early has truncated it. Record that and let the short-body check below
  7226. // fail the write, rather than calling the provider again forever.
  7227. data_sink.done = [&]() { finished = true; };
  7228. while (offset < end_offset && !finished && !is_shutting_down()) {
  7229. auto last_offset = offset;
  7230. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7231. error = Error::Write;
  7232. return false;
  7233. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7234. error = Error::Canceled;
  7235. return false;
  7236. } else if (!ok) {
  7237. error = Error::Write;
  7238. return false;
  7239. }
  7240. // A provider that reports success without writing anything and without
  7241. // reporting itself done gets handed the same offset and length again on
  7242. // the next pass, so it would spin here for as long as the peer stays
  7243. // connected. Treat making no progress as a short body, like done() early.
  7244. if (!finished && offset == last_offset) {
  7245. error = Error::Write;
  7246. return false;
  7247. }
  7248. }
  7249. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7250. error = Error::Write;
  7251. return false;
  7252. }
  7253. error = Error::Success;
  7254. return true;
  7255. }
  7256. template <typename T>
  7257. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7258. size_t offset, size_t length, T is_shutting_down,
  7259. Error &error) {
  7260. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7261. is_shutting_down, nullptr, error);
  7262. }
  7263. template <typename T>
  7264. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7265. size_t offset, size_t length,
  7266. const T &is_shutting_down) {
  7267. auto error = Error::Success;
  7268. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7269. error);
  7270. }
  7271. template <typename T>
  7272. inline bool
  7273. write_content_without_length(Stream &strm,
  7274. const ContentProvider &content_provider,
  7275. const T &is_shutting_down) {
  7276. size_t offset = 0;
  7277. auto data_available = true;
  7278. auto ok = true;
  7279. DataSink data_sink;
  7280. data_sink.write = [&](const char *d, size_t l) -> bool {
  7281. if (ok) {
  7282. offset += l;
  7283. if (!write_data(strm, d, l)) { ok = false; }
  7284. }
  7285. return ok;
  7286. };
  7287. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7288. data_sink.done = [&](void) { data_available = false; };
  7289. while (data_available && !is_shutting_down()) {
  7290. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7291. return false;
  7292. } else if (!content_provider(offset, 0, data_sink)) {
  7293. return false;
  7294. } else if (!ok) {
  7295. return false;
  7296. }
  7297. }
  7298. return !data_available; // true only if done() was called, false if shutting
  7299. // down
  7300. }
  7301. // Runs a known-length content provider to completion and compresses what it
  7302. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7303. // by an mmap hands the compressor a pointer straight into the mapping.
  7304. inline bool compress_content_provider(const ContentProvider &content_provider,
  7305. size_t length, compressor &cmp,
  7306. std::string &out) {
  7307. size_t offset = 0;
  7308. auto ok = true;
  7309. auto finished = false;
  7310. DataSink data_sink;
  7311. auto append = [&](const char *data, size_t data_len) {
  7312. out.append(data, data_len);
  7313. return true;
  7314. };
  7315. data_sink.write = [&](const char *d, size_t l) -> bool {
  7316. if (!ok) { return false; }
  7317. offset += l;
  7318. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7319. return ok;
  7320. };
  7321. // The body is framed by `length`, so a provider that reports itself done
  7322. // early has truncated it; the short-body check below turns that into a
  7323. // failure rather than calling the provider again forever.
  7324. data_sink.done = [&]() { finished = true; };
  7325. while (offset < length && !finished) {
  7326. auto prev_offset = offset;
  7327. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7328. return false;
  7329. }
  7330. // No Stream to block on here, so a provider that keeps returning true
  7331. // without writing would spin. Treat a pass that made no progress as a
  7332. // failure.
  7333. if (offset == prev_offset) { return false; }
  7334. }
  7335. if (offset != length) { return false; }
  7336. return cmp.compress(nullptr, 0, true, append);
  7337. }
  7338. // Serves `m` as the response body. `set_content_provider()` clears the coding
  7339. // and the file flag, so recording them has to come after; keeping all of it
  7340. // here means a third file-serving path cannot get that order wrong.
  7341. inline void set_file_content_provider(Response &res,
  7342. const std::shared_ptr<mmap> &m,
  7343. const std::string &content_type,
  7344. EncodingType encoding) {
  7345. res.set_content_provider(
  7346. m->size(), content_type,
  7347. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7348. sink.write(m->data() + offset, length);
  7349. return true;
  7350. });
  7351. res.is_file_content_provider_ = true;
  7352. res.content_coding_ = encoding;
  7353. }
  7354. template <typename T, typename U>
  7355. inline bool
  7356. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7357. const T &is_shutting_down, U &compressor, Error &error) {
  7358. size_t offset = 0;
  7359. auto data_available = true;
  7360. auto ok = true;
  7361. DataSink data_sink;
  7362. data_sink.write = [&](const char *d, size_t l) -> bool {
  7363. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7364. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7365. // zero-length chunk is the terminator, so it must not be emitted here.
  7366. if (ok && l > 0) {
  7367. offset += l;
  7368. std::string payload;
  7369. if (compressor.compress(d, l, false,
  7370. [&](const char *data, size_t data_len) {
  7371. payload.append(data, data_len);
  7372. return true;
  7373. })) {
  7374. if (!payload.empty()) {
  7375. // Emit chunked response header and footer for each chunk
  7376. auto chunk =
  7377. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7378. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7379. }
  7380. } else {
  7381. ok = false;
  7382. }
  7383. }
  7384. return ok;
  7385. };
  7386. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7387. auto done_with_trailer = [&](const Headers *trailer) {
  7388. if (!ok) { return; }
  7389. data_available = false;
  7390. std::string payload;
  7391. if (!compressor.compress(nullptr, 0, true,
  7392. [&](const char *data, size_t data_len) {
  7393. payload.append(data, data_len);
  7394. return true;
  7395. })) {
  7396. ok = false;
  7397. return;
  7398. }
  7399. if (!payload.empty()) {
  7400. // Emit chunked response header and footer for each chunk
  7401. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7402. if (!write_data(strm, chunk.data(), chunk.size())) {
  7403. ok = false;
  7404. return;
  7405. }
  7406. }
  7407. constexpr const char done_marker[] = "0\r\n";
  7408. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7409. // Trailer
  7410. if (trailer) {
  7411. for (const auto &kv : *trailer) {
  7412. // Skip fields with invalid names or values to prevent response
  7413. // splitting via CR/LF injection, matching set_header().
  7414. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7415. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7416. if (!write_data(strm, field_line.data(), field_line.size())) {
  7417. ok = false;
  7418. }
  7419. }
  7420. }
  7421. constexpr const char crlf[] = "\r\n";
  7422. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7423. };
  7424. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7425. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7426. done_with_trailer(&trailer);
  7427. };
  7428. while (data_available && !is_shutting_down()) {
  7429. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7430. error = Error::Write;
  7431. return false;
  7432. } else if (!content_provider(offset, 0, data_sink)) {
  7433. error = Error::Canceled;
  7434. return false;
  7435. } else if (!ok) {
  7436. error = Error::Write;
  7437. return false;
  7438. }
  7439. }
  7440. if (data_available) { // exited due to is_shutting_down(), not done()
  7441. error = Error::Write;
  7442. return false;
  7443. }
  7444. error = Error::Success;
  7445. return true;
  7446. }
  7447. template <typename T, typename U>
  7448. inline bool write_content_chunked(Stream &strm,
  7449. const ContentProvider &content_provider,
  7450. const T &is_shutting_down, U &compressor) {
  7451. auto error = Error::Success;
  7452. return write_content_chunked(strm, content_provider, is_shutting_down,
  7453. compressor, error);
  7454. }
  7455. template <typename T>
  7456. inline bool redirect(T &cli, Request &req, Response &res,
  7457. const std::string &path, const std::string &location,
  7458. Error &error) {
  7459. Request new_req = req;
  7460. new_req.path = path;
  7461. new_req.redirect_count_ -= 1;
  7462. if (res.status == StatusCode::SeeOther_303 &&
  7463. (req.method != "GET" && req.method != "HEAD")) {
  7464. new_req.method = "GET";
  7465. new_req.body.clear();
  7466. new_req.headers.clear();
  7467. }
  7468. Response new_res;
  7469. auto ret = cli.send(new_req, new_res, error);
  7470. if (ret) {
  7471. req = std::move(new_req);
  7472. res = std::move(new_res);
  7473. if (res.location.empty()) { res.location = location; }
  7474. }
  7475. return ret;
  7476. }
  7477. inline std::string params_to_query_str(const Params &params) {
  7478. std::string query;
  7479. for (auto it = params.begin(); it != params.end(); ++it) {
  7480. if (it != params.begin()) { query += '&'; }
  7481. query += encode_query_component(it->first);
  7482. query += '=';
  7483. query += encode_query_component(it->second);
  7484. }
  7485. return query;
  7486. }
  7487. // Splits one "key=value" span of a query string at its first '='. A span with
  7488. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7489. // "?flag" keeps its name.
  7490. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7491. std::string &val) {
  7492. divide(b, static_cast<std::size_t>(e - b), '=',
  7493. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7494. std::size_t rhs_size) {
  7495. key.assign(lhs_data, lhs_size);
  7496. val.assign(rhs_data, rhs_size);
  7497. });
  7498. }
  7499. inline void parse_query_text(const char *data, std::size_t size,
  7500. Params &params) {
  7501. std::set<std::string> cache;
  7502. split(data, data + size, '&', [&](const char *b, const char *e) {
  7503. std::string kv(b, e);
  7504. if (cache.find(kv) != cache.end()) { return; }
  7505. cache.insert(std::move(kv));
  7506. std::string key;
  7507. std::string val;
  7508. divide_query_pair(b, e, key, val);
  7509. if (!key.empty()) {
  7510. params.emplace(decode_query_component(key), decode_query_component(val));
  7511. }
  7512. });
  7513. }
  7514. inline void parse_query_text(const std::string &s, Params &params) {
  7515. parse_query_text(s.data(), s.size(), params);
  7516. }
  7517. // Normalize a query string by decoding and re-encoding each key/value pair
  7518. // while preserving the original parameter order. This avoids double-encoding
  7519. // and ensures consistent encoding. It works on the raw string rather than
  7520. // parsing into Params and re-serializing, because that round trip cannot
  7521. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7522. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7523. // duplicated pairs.
  7524. inline std::string normalize_query_string(const std::string &query) {
  7525. std::string result;
  7526. split(query.data(), query.data() + query.size(), '&',
  7527. [&](const char *b, const char *e) {
  7528. std::string key;
  7529. std::string val;
  7530. divide_query_pair(b, e, key, val);
  7531. if (!key.empty()) {
  7532. auto dec_key = decode_query_component(key);
  7533. auto dec_val = decode_query_component(val);
  7534. if (!result.empty()) { result += '&'; }
  7535. result += encode_query_component(dec_key);
  7536. if (!val.empty() || std::find(b, e, '=') != e) {
  7537. result += '=';
  7538. result += encode_query_component(dec_val);
  7539. }
  7540. }
  7541. });
  7542. return result;
  7543. }
  7544. // Build the request target that goes on the wire from a caller-supplied path.
  7545. // Shared by the buffered send path and the streaming API so that both put the
  7546. // same bytes in the request line for the same input.
  7547. inline std::string encode_request_target(const std::string &target,
  7548. bool path_encode) {
  7549. // `substr(0, npos)` yields the whole string, which is what the no-query
  7550. // case needs.
  7551. auto query_pos = target.find('?');
  7552. auto path_part = target.substr(0, query_pos);
  7553. std::string query_part;
  7554. if (query_pos != std::string::npos) {
  7555. query_part = target.substr(query_pos + 1);
  7556. }
  7557. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7558. if (!query_part.empty()) {
  7559. // When path encoding is disabled the caller has supplied an already-encoded
  7560. // target and expects the exact bytes to be sent on the wire, so skip
  7561. // normalization for the query too. Normalizing would decode-then-re-encode
  7562. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7563. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7564. if (path_encode) {
  7565. auto normalized = normalize_query_string(query_part);
  7566. if (!normalized.empty()) {
  7567. result += '?';
  7568. result += normalized;
  7569. }
  7570. } else {
  7571. result += '?';
  7572. result += query_part;
  7573. }
  7574. }
  7575. return result;
  7576. }
  7577. inline bool parse_multipart_boundary(const std::string &content_type,
  7578. std::string &boundary) {
  7579. std::map<std::string, std::string> params;
  7580. extract_media_type(content_type, &params);
  7581. auto it = params.find("boundary");
  7582. if (it == params.end()) { return false; }
  7583. boundary = it->second;
  7584. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7585. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7586. // bytes costs a nearly full comparison at nearly every position: the
  7587. // boundary's length multiplies the worst-case cost of scanning a body.
  7588. return !boundary.empty() && boundary.size() <= 70;
  7589. }
  7590. inline void parse_disposition_params(const std::string &s, Params &params) {
  7591. std::set<std::string> cache;
  7592. split_unquoted(s.data(), s.data() + s.size(), ';',
  7593. [&](const char *b, const char *e) {
  7594. std::string kv(b, e);
  7595. if (cache.find(kv) != cache.end()) { return; }
  7596. cache.insert(kv);
  7597. std::string key;
  7598. std::string val;
  7599. divide_param_pair(b, e, key, val);
  7600. if (!key.empty()) {
  7601. params.emplace(trim_double_quotes_copy(key),
  7602. trim_double_quotes_copy(val));
  7603. }
  7604. });
  7605. }
  7606. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7607. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7608. #else
  7609. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7610. #endif
  7611. auto is_valid = [](const std::string &str) {
  7612. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7613. };
  7614. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7615. const auto pos = static_cast<size_t>(6);
  7616. const auto len = static_cast<size_t>(s.size() - 6);
  7617. auto all_valid_ranges = true;
  7618. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7619. if (!all_valid_ranges) { return; }
  7620. const auto it = std::find(b, e, '-');
  7621. if (it == e) {
  7622. all_valid_ranges = false;
  7623. return;
  7624. }
  7625. const auto lhs = std::string(b, it);
  7626. const auto rhs = std::string(it + 1, e);
  7627. if (!is_valid(lhs) || !is_valid(rhs)) {
  7628. all_valid_ranges = false;
  7629. return;
  7630. }
  7631. ssize_t first = -1;
  7632. if (!lhs.empty()) {
  7633. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7634. // would turn the range into a suffix range.
  7635. auto res =
  7636. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7637. if (res.ec != std::errc{}) {
  7638. all_valid_ranges = false;
  7639. return;
  7640. }
  7641. }
  7642. ssize_t last = -1;
  7643. if (!rhs.empty()) {
  7644. // An overflowing last-byte-pos is past any content length, so keeping
  7645. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7646. ssize_t v;
  7647. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7648. if (res.ec == std::errc{}) { last = v; }
  7649. }
  7650. if ((first == -1 && last == -1) ||
  7651. (first != -1 && last != -1 && first > last)) {
  7652. all_valid_ranges = false;
  7653. return;
  7654. }
  7655. ranges.emplace_back(first, last);
  7656. });
  7657. return all_valid_ranges && !ranges.empty();
  7658. }
  7659. return false;
  7660. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7661. }
  7662. #else
  7663. } catch (...) { return false; }
  7664. #endif
  7665. inline bool parse_accept_header(const std::string &s,
  7666. std::vector<std::string> &content_types) {
  7667. content_types.clear();
  7668. // Empty string is considered valid (no preference)
  7669. if (s.empty()) { return true; }
  7670. struct AcceptEntry {
  7671. std::string media_type;
  7672. double quality;
  7673. int order;
  7674. };
  7675. std::vector<AcceptEntry> entries;
  7676. int order = 0;
  7677. bool has_invalid_entry = false;
  7678. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7679. // has to parse and ignore empty list elements, so a leading, trailing or
  7680. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7681. // split() skips them, and the header length limit bounds how many a sender
  7682. // can send, so ignoring all of them cannot be used as a denial-of-service
  7683. // vector.
  7684. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7685. std::string entry(b, e);
  7686. entry = trim_copy(entry);
  7687. AcceptEntry accept_entry;
  7688. accept_entry.order = order++;
  7689. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7690. accept_entry.media_type, accept_entry.quality)) {
  7691. has_invalid_entry = true;
  7692. return;
  7693. }
  7694. // Remove additional parameters from media type
  7695. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7696. // Basic validation of media type format
  7697. if (accept_entry.media_type.empty()) {
  7698. has_invalid_entry = true;
  7699. return;
  7700. }
  7701. // Check for basic media type format (should contain '/' or be '*')
  7702. if (accept_entry.media_type != "*" &&
  7703. accept_entry.media_type.find('/') == std::string::npos) {
  7704. has_invalid_entry = true;
  7705. return;
  7706. }
  7707. entries.push_back(std::move(accept_entry));
  7708. });
  7709. // Return false if any invalid entry was found
  7710. if (has_invalid_entry) { return false; }
  7711. // Sort by quality (descending), then by original order (ascending)
  7712. std::sort(entries.begin(), entries.end(),
  7713. [](const AcceptEntry &a, const AcceptEntry &b) {
  7714. if (a.quality != b.quality) {
  7715. return a.quality > b.quality; // Higher quality first
  7716. }
  7717. return a.order < b.order; // Earlier order first for same quality
  7718. });
  7719. // Extract sorted media types
  7720. content_types.reserve(entries.size());
  7721. for (auto &entry : entries) {
  7722. content_types.push_back(std::move(entry.media_type));
  7723. }
  7724. return true;
  7725. }
  7726. class FormDataParser {
  7727. public:
  7728. FormDataParser() = default;
  7729. void set_boundary(std::string &&boundary) {
  7730. boundary_ = std::move(boundary);
  7731. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7732. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7733. }
  7734. bool is_valid() const { return is_valid_; }
  7735. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7736. const ContentReceiver &content_callback) {
  7737. // Once the close delimiter has been seen the rest of the body is epilogue
  7738. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7739. // spread across reads is not copied in only to be erased right away.
  7740. if (state_ == 5) { return true; }
  7741. buf_append(buf, n);
  7742. while (buf_size() > 0) {
  7743. switch (state_) {
  7744. case 0: { // Initial boundary
  7745. auto pos = buf_find(dash_boundary_crlf_);
  7746. if (pos == buf_size()) {
  7747. // Not found yet: keep only a possible partial boundary at the tail so
  7748. // that a body which never contains the boundary cannot grow the
  7749. // buffer (and get rescanned from the start) without bound.
  7750. auto keep = dash_boundary_crlf_.size() - 1;
  7751. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7752. return true;
  7753. }
  7754. buf_erase(pos + dash_boundary_crlf_.size());
  7755. state_ = 1;
  7756. break;
  7757. }
  7758. case 1: { // New entry
  7759. clear_file_info();
  7760. state_ = 2;
  7761. break;
  7762. }
  7763. case 2: { // Headers
  7764. auto pos = buf_find(crlf_);
  7765. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7766. while (pos < buf_size()) {
  7767. // Empty line
  7768. if (pos == 0) {
  7769. if (!header_callback(file_)) {
  7770. is_valid_ = false;
  7771. return false;
  7772. }
  7773. buf_erase(crlf_.size());
  7774. state_ = 3;
  7775. break;
  7776. }
  7777. // Check header count limit
  7778. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7779. is_valid_ = false;
  7780. return false;
  7781. }
  7782. header_count_++;
  7783. const auto header = buf_head(pos);
  7784. if (!parse_header(header.data(), header.data() + header.size(),
  7785. [&](const std::string &, const std::string &) {})) {
  7786. is_valid_ = false;
  7787. return false;
  7788. }
  7789. // Parse and emplace space trimmed headers into a map
  7790. if (!parse_header(
  7791. header.data(), header.data() + header.size(),
  7792. [&](const std::string &key, const std::string &val) {
  7793. file_.headers.emplace(key, val);
  7794. })) {
  7795. is_valid_ = false;
  7796. return false;
  7797. }
  7798. constexpr const char header_content_type[] = "Content-Type:";
  7799. if (start_with_case_ignore(header, header_content_type)) {
  7800. file_.content_type =
  7801. trim_copy(header.substr(str_len(header_content_type)));
  7802. } else {
  7803. std::string disposition_params;
  7804. if (parse_content_disposition(header, disposition_params)) {
  7805. Params params;
  7806. parse_disposition_params(disposition_params, params);
  7807. auto it = params.find("name");
  7808. if (it != params.end()) {
  7809. file_.name = it->second;
  7810. } else {
  7811. is_valid_ = false;
  7812. return false;
  7813. }
  7814. it = params.find("filename");
  7815. if (it != params.end()) { file_.filename = it->second; }
  7816. it = params.find("filename*");
  7817. if (it != params.end()) {
  7818. // RFC 5987: only UTF-8 encoding is allowed
  7819. const auto &val = it->second;
  7820. constexpr const char utf8_prefix[] = "UTF-8''";
  7821. constexpr size_t prefix_len = str_len(utf8_prefix);
  7822. if (val.size() > prefix_len &&
  7823. start_with_case_ignore(val, utf8_prefix)) {
  7824. file_.filename = decode_path_component(
  7825. val.substr(prefix_len)); // override...
  7826. } else {
  7827. is_valid_ = false;
  7828. return false;
  7829. }
  7830. }
  7831. }
  7832. }
  7833. buf_erase(pos + crlf_.size());
  7834. pos = buf_find(crlf_);
  7835. }
  7836. if (state_ != 3) { return true; }
  7837. break;
  7838. }
  7839. case 3: { // Body
  7840. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7841. auto pos = buf_find(crlf_dash_boundary_);
  7842. if (pos < buf_size()) {
  7843. if (!content_callback(buf_data(), pos)) {
  7844. is_valid_ = false;
  7845. return false;
  7846. }
  7847. buf_erase(pos + crlf_dash_boundary_.size());
  7848. state_ = 4;
  7849. } else {
  7850. auto len = buf_size() - crlf_dash_boundary_.size();
  7851. if (len > 0) {
  7852. if (!content_callback(buf_data(), len)) {
  7853. is_valid_ = false;
  7854. return false;
  7855. }
  7856. buf_erase(len);
  7857. }
  7858. return true;
  7859. }
  7860. break;
  7861. }
  7862. case 4: { // Boundary
  7863. if (crlf_.size() > buf_size()) { return true; }
  7864. if (buf_start_with(crlf_)) {
  7865. buf_erase(crlf_.size());
  7866. state_ = 1;
  7867. } else if (buf_start_with(dash_)) {
  7868. buf_erase(dash_.size());
  7869. is_valid_ = true;
  7870. state_ = 5;
  7871. } else {
  7872. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7873. // accepted after a boundary; RFC 2046 allows transport-padding in
  7874. // between, but this parser has never supported it. Either way the
  7875. // body is already destined to be rejected, so fail now instead of
  7876. // buffering the rest of it. Both are two bytes, so the check above
  7877. // already guarantees enough buffered data to decide.
  7878. is_valid_ = false;
  7879. return false;
  7880. }
  7881. break;
  7882. }
  7883. case 5: { // Epilogue
  7884. buf_erase(buf_size());
  7885. break;
  7886. }
  7887. }
  7888. }
  7889. return true;
  7890. }
  7891. private:
  7892. void clear_file_info() {
  7893. file_.name.clear();
  7894. file_.filename.clear();
  7895. file_.content_type.clear();
  7896. file_.headers.clear();
  7897. header_count_ = 0;
  7898. }
  7899. bool start_with_case_ignore(const std::string &a, const char *b,
  7900. size_t offset = 0) const {
  7901. const auto b_len = strlen(b);
  7902. if (a.size() < offset + b_len) { return false; }
  7903. for (size_t i = 0; i < b_len; i++) {
  7904. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7905. return false;
  7906. }
  7907. }
  7908. return true;
  7909. }
  7910. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7911. // Returns true if header matches, with the params portion in `params_out`.
  7912. bool parse_content_disposition(const std::string &header,
  7913. std::string &params_out) const {
  7914. constexpr const char prefix[] = "Content-Disposition:";
  7915. constexpr size_t prefix_len = str_len(prefix);
  7916. if (!start_with_case_ignore(header, prefix)) { return false; }
  7917. // Skip whitespace after "Content-Disposition:"
  7918. auto pos = prefix_len;
  7919. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7920. pos++;
  7921. }
  7922. // Match "form-data;" (case-insensitive)
  7923. constexpr const char form_data[] = "form-data;";
  7924. constexpr size_t form_data_len = str_len(form_data);
  7925. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7926. pos += form_data_len;
  7927. // Skip whitespace after "form-data;"
  7928. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7929. pos++;
  7930. }
  7931. params_out = header.substr(pos);
  7932. return true;
  7933. }
  7934. const std::string dash_ = "--";
  7935. const std::string crlf_ = "\r\n";
  7936. std::string boundary_;
  7937. std::string dash_boundary_crlf_;
  7938. std::string crlf_dash_boundary_;
  7939. size_t state_ = 0;
  7940. bool is_valid_ = false;
  7941. FormData file_;
  7942. size_t header_count_ = 0;
  7943. // Buffer
  7944. bool start_with(const std::string &a, size_t spos, size_t epos,
  7945. const std::string &b) const {
  7946. if (epos - spos < b.size()) { return false; }
  7947. for (size_t i = 0; i < b.size(); i++) {
  7948. if (a[i + spos] != b[i]) { return false; }
  7949. }
  7950. return true;
  7951. }
  7952. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7953. const char *buf_data() const { return &buf_[buf_spos_]; }
  7954. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7955. bool buf_start_with(const std::string &s) const {
  7956. return start_with(buf_, buf_spos_, buf_epos_, s);
  7957. }
  7958. size_t buf_find(const std::string &s) const {
  7959. auto c = s.front();
  7960. size_t off = buf_spos_;
  7961. while (off < buf_epos_) {
  7962. auto pos = off;
  7963. while (true) {
  7964. if (pos == buf_epos_) { return buf_size(); }
  7965. if (buf_[pos] == c) { break; }
  7966. pos++;
  7967. }
  7968. auto remaining_size = buf_epos_ - pos;
  7969. if (s.size() > remaining_size) { return buf_size(); }
  7970. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7971. off = pos + 1;
  7972. }
  7973. return buf_size();
  7974. }
  7975. void buf_append(const char *data, size_t n) {
  7976. auto remaining_size = buf_size();
  7977. if (remaining_size > 0 && buf_spos_ > 0) {
  7978. for (size_t i = 0; i < remaining_size; i++) {
  7979. buf_[i] = buf_[buf_spos_ + i];
  7980. }
  7981. }
  7982. buf_spos_ = 0;
  7983. buf_epos_ = remaining_size;
  7984. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7985. for (size_t i = 0; i < n; i++) {
  7986. buf_[buf_epos_ + i] = data[i];
  7987. }
  7988. buf_epos_ += n;
  7989. }
  7990. void buf_erase(size_t size) { buf_spos_ += size; }
  7991. std::string buf_;
  7992. size_t buf_spos_ = 0;
  7993. size_t buf_epos_ = 0;
  7994. };
  7995. inline std::string random_string(size_t length) {
  7996. constexpr const char data[] =
  7997. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7998. thread_local auto engine([]() {
  7999. // std::random_device might actually be deterministic on some
  8000. // platforms, but due to lack of support in the c++ standard library,
  8001. // doing better requires either some ugly hacks or breaking portability.
  8002. std::random_device seed_gen;
  8003. // Request 128 bits of entropy for initialization
  8004. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  8005. return std::mt19937(seed_sequence);
  8006. }());
  8007. std::string result;
  8008. for (size_t i = 0; i < length; i++) {
  8009. result += data[engine() % (sizeof(data) - 1)];
  8010. }
  8011. return result;
  8012. }
  8013. inline std::string make_multipart_data_boundary() {
  8014. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  8015. }
  8016. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  8017. auto valid = true;
  8018. for (size_t i = 0; i < boundary.size(); i++) {
  8019. auto c = boundary[i];
  8020. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  8021. valid = false;
  8022. break;
  8023. }
  8024. }
  8025. return valid;
  8026. }
  8027. // Escape a multipart field name/filename following the WHATWG HTML standard
  8028. // ("escape a multipart form-data name"), which is what browsers send:
  8029. // '"' -> %22, CR -> %0D, LF -> %0A
  8030. // With escape_quote = false, only CR and LF are escaped; this is for header
  8031. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  8032. inline std::string escape_multipart_field(const std::string &s,
  8033. bool escape_quote = true) {
  8034. std::string result;
  8035. result.reserve(s.size());
  8036. for (auto c : s) {
  8037. switch (c) {
  8038. case '"':
  8039. if (escape_quote) {
  8040. result += "%22";
  8041. } else {
  8042. result += c;
  8043. }
  8044. break;
  8045. case '\r': result += "%0D"; break;
  8046. case '\n': result += "%0A"; break;
  8047. default: result += c; break;
  8048. }
  8049. }
  8050. return result;
  8051. }
  8052. template <typename T>
  8053. inline std::string
  8054. serialize_multipart_formdata_item_begin(const T &item,
  8055. const std::string &boundary) {
  8056. std::string body = "--" + boundary + "\r\n";
  8057. body += "Content-Disposition: form-data; name=\"" +
  8058. escape_multipart_field(item.name) + "\"";
  8059. if (!item.filename.empty()) {
  8060. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8061. }
  8062. body += "\r\n";
  8063. if (!item.content_type.empty()) {
  8064. body +=
  8065. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8066. "\r\n";
  8067. }
  8068. body += "\r\n";
  8069. return body;
  8070. }
  8071. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8072. inline std::string
  8073. serialize_multipart_formdata_finish(const std::string &boundary) {
  8074. return "--" + boundary + "--\r\n";
  8075. }
  8076. inline std::string
  8077. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8078. return "multipart/form-data; boundary=" + boundary;
  8079. }
  8080. inline std::string
  8081. serialize_multipart_formdata(const UploadFormDataItems &items,
  8082. const std::string &boundary, bool finish = true) {
  8083. std::string body;
  8084. for (const auto &item : items) {
  8085. body += serialize_multipart_formdata_item_begin(item, boundary);
  8086. body += item.content + serialize_multipart_formdata_item_end();
  8087. }
  8088. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8089. return body;
  8090. }
  8091. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8092. const std::string &boundary) {
  8093. size_t total = 0;
  8094. for (const auto &item : items) {
  8095. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8096. total += item.content.size();
  8097. total += serialize_multipart_formdata_item_end().size();
  8098. }
  8099. total += serialize_multipart_formdata_finish(boundary).size();
  8100. return total;
  8101. }
  8102. struct MultipartSegment {
  8103. const char *data;
  8104. size_t size;
  8105. };
  8106. // NOTE: items must outlive the returned ContentProvider
  8107. // (safe for synchronous use inside Post/Put/Patch)
  8108. inline ContentProvider
  8109. make_multipart_content_provider(const UploadFormDataItems &items,
  8110. const std::string &boundary) {
  8111. // Own the per-item header strings and the finish string
  8112. std::vector<std::string> owned;
  8113. owned.reserve(items.size() + 1);
  8114. for (const auto &item : items)
  8115. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8116. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8117. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8118. std::vector<MultipartSegment> segs;
  8119. segs.reserve(items.size() * 3 + 1);
  8120. static const char crlf[] = "\r\n";
  8121. for (size_t i = 0; i < items.size(); i++) {
  8122. segs.push_back({owned[i].data(), owned[i].size()});
  8123. segs.push_back({items[i].content.data(), items[i].content.size()});
  8124. segs.push_back({crlf, 2});
  8125. }
  8126. segs.push_back({owned.back().data(), owned.back().size()});
  8127. struct MultipartState {
  8128. std::vector<std::string> owned;
  8129. std::vector<MultipartSegment> segs;
  8130. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8131. };
  8132. auto state = std::make_shared<MultipartState>();
  8133. state->owned = std::move(owned);
  8134. // `segs` holds raw pointers into owned strings; std::string move preserves
  8135. // the data pointer, so these pointers remain valid after the move above.
  8136. state->segs = std::move(segs);
  8137. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8138. // Buffer multiple small segments into fewer, larger writes to avoid
  8139. // excessive TCP packets when there are many form data items (#2410)
  8140. auto &buf = state->buf;
  8141. auto buf_size = buf.size();
  8142. size_t buf_len = 0;
  8143. size_t remaining = length;
  8144. // Find the first segment containing 'offset'
  8145. size_t pos = 0;
  8146. size_t seg_idx = 0;
  8147. for (; seg_idx < state->segs.size(); seg_idx++) {
  8148. const auto &seg = state->segs[seg_idx];
  8149. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8150. pos += seg.size;
  8151. }
  8152. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8153. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8154. const auto &seg = state->segs[seg_idx];
  8155. size_t available = seg.size - seg_offset;
  8156. size_t to_copy = (std::min)(available, remaining);
  8157. const char *src = seg.data + seg_offset;
  8158. seg_offset = 0; // only the first segment has a non-zero offset
  8159. while (to_copy > 0) {
  8160. size_t space = buf_size - buf_len;
  8161. size_t chunk = (std::min)(to_copy, space);
  8162. std::memcpy(buf.data() + buf_len, src, chunk);
  8163. buf_len += chunk;
  8164. src += chunk;
  8165. to_copy -= chunk;
  8166. remaining -= chunk;
  8167. if (buf_len == buf_size) {
  8168. if (!sink.write(buf.data(), buf_len)) { return false; }
  8169. buf_len = 0;
  8170. }
  8171. }
  8172. }
  8173. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8174. return true;
  8175. };
  8176. }
  8177. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8178. if (ranges.size() <= 1) return;
  8179. // Sort ranges by start position
  8180. std::sort(ranges.begin(), ranges.end(),
  8181. [](const Range &a, const Range &b) { return a.first < b.first; });
  8182. Ranges coalesced;
  8183. coalesced.reserve(ranges.size());
  8184. for (auto &r : ranges) {
  8185. auto first_pos = r.first;
  8186. auto last_pos = r.second;
  8187. // Handle special cases like in range_error
  8188. if (first_pos == -1 && last_pos == -1) {
  8189. first_pos = 0;
  8190. last_pos = static_cast<ssize_t>(content_length);
  8191. }
  8192. if (first_pos == -1) {
  8193. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8194. last_pos = static_cast<ssize_t>(content_length) - 1;
  8195. }
  8196. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8197. last_pos = static_cast<ssize_t>(content_length) - 1;
  8198. }
  8199. // Skip invalid ranges
  8200. if (!(0 <= first_pos && first_pos <= last_pos &&
  8201. last_pos < static_cast<ssize_t>(content_length))) {
  8202. continue;
  8203. }
  8204. // Coalesce with previous range if overlapping or adjacent (but not
  8205. // identical)
  8206. if (!coalesced.empty()) {
  8207. auto &prev = coalesced.back();
  8208. // Check if current range overlaps or is adjacent to previous range
  8209. // but don't coalesce identical ranges (allow duplicates)
  8210. if (first_pos <= prev.second + 1 &&
  8211. !(first_pos == prev.first && last_pos == prev.second)) {
  8212. // Extend the previous range
  8213. prev.second = (std::max)(prev.second, last_pos);
  8214. continue;
  8215. }
  8216. }
  8217. // Add new range
  8218. coalesced.emplace_back(first_pos, last_pos);
  8219. }
  8220. ranges = std::move(coalesced);
  8221. }
  8222. inline bool range_error(Request &req, Response &res) {
  8223. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8224. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8225. req.ranges.clear();
  8226. if (res.status == StatusCode::PartialContent_206) {
  8227. res.status = StatusCode::OK_200;
  8228. }
  8229. return false;
  8230. }
  8231. ssize_t content_len = static_cast<ssize_t>(
  8232. res.content_length_ ? res.content_length_ : res.body.size());
  8233. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8234. size_t overwrapping_count = 0;
  8235. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8236. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8237. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8238. // Too many ranges
  8239. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8240. for (auto &r : req.ranges) {
  8241. auto &first_pos = r.first;
  8242. auto &last_pos = r.second;
  8243. if (first_pos == -1 && last_pos == -1) {
  8244. first_pos = 0;
  8245. last_pos = content_len;
  8246. }
  8247. if (first_pos == -1) {
  8248. first_pos = content_len - last_pos;
  8249. last_pos = content_len - 1;
  8250. }
  8251. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8252. // A client can limit the number of bytes requested without knowing the
  8253. // size of the selected representation. If the last-pos value is absent,
  8254. // or if the value is greater than or equal to the current length of the
  8255. // representation data, the byte range is interpreted as the remainder of
  8256. // the representation (i.e., the server replaces the value of last-pos
  8257. // with a value that is one less than the current length of the selected
  8258. // representation).
  8259. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8260. if (last_pos == -1 || last_pos >= content_len) {
  8261. last_pos = content_len - 1;
  8262. }
  8263. // Range must be within content length
  8264. if (!(0 <= first_pos && first_pos <= last_pos &&
  8265. last_pos <= content_len - 1)) {
  8266. return true;
  8267. }
  8268. // Request must not have more than two overlapping ranges
  8269. for (const auto &processed_range : processed_ranges) {
  8270. if (!(last_pos < processed_range.first ||
  8271. first_pos > processed_range.second)) {
  8272. overwrapping_count++;
  8273. if (overwrapping_count > 2) { return true; }
  8274. break; // Only count once per range
  8275. }
  8276. }
  8277. processed_ranges.emplace_back(first_pos, last_pos);
  8278. }
  8279. // After validation, coalesce overlapping ranges as per RFC 9110
  8280. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8281. }
  8282. return false;
  8283. }
  8284. inline std::pair<size_t, size_t>
  8285. get_range_offset_and_length(Range r, size_t content_length) {
  8286. assert(r.first != -1 && r.second != -1);
  8287. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8288. assert(r.first <= r.second &&
  8289. r.second < static_cast<ssize_t>(content_length));
  8290. (void)(content_length);
  8291. return std::make_pair(static_cast<size_t>(r.first),
  8292. static_cast<size_t>(r.second - r.first) + 1);
  8293. }
  8294. inline std::string make_content_range_header_field(
  8295. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8296. auto st = offset_and_length.first;
  8297. auto ed = st + offset_and_length.second - 1;
  8298. std::string field = "bytes ";
  8299. field += std::to_string(st);
  8300. field += '-';
  8301. field += std::to_string(ed);
  8302. field += '/';
  8303. field += std::to_string(content_length);
  8304. return field;
  8305. }
  8306. template <typename SToken, typename CToken, typename Content>
  8307. bool process_multipart_ranges_data(const Request &req,
  8308. const std::string &boundary,
  8309. const std::string &content_type,
  8310. size_t content_length, SToken stoken,
  8311. CToken ctoken, Content content) {
  8312. for (size_t i = 0; i < req.ranges.size(); i++) {
  8313. ctoken("--");
  8314. stoken(boundary);
  8315. ctoken("\r\n");
  8316. if (!content_type.empty()) {
  8317. ctoken("Content-Type: ");
  8318. stoken(content_type);
  8319. ctoken("\r\n");
  8320. }
  8321. auto offset_and_length =
  8322. get_range_offset_and_length(req.ranges[i], content_length);
  8323. ctoken("Content-Range: ");
  8324. stoken(make_content_range_header_field(offset_and_length, content_length));
  8325. ctoken("\r\n");
  8326. ctoken("\r\n");
  8327. if (!content(offset_and_length.first, offset_and_length.second)) {
  8328. return false;
  8329. }
  8330. ctoken("\r\n");
  8331. }
  8332. ctoken("--");
  8333. stoken(boundary);
  8334. ctoken("--");
  8335. return true;
  8336. }
  8337. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8338. const std::string &boundary,
  8339. const std::string &content_type,
  8340. size_t content_length,
  8341. std::string &data) {
  8342. process_multipart_ranges_data(
  8343. req, boundary, content_type, content_length,
  8344. [&](const std::string &token) { data += token; },
  8345. [&](const std::string &token) { data += token; },
  8346. [&](size_t offset, size_t length) {
  8347. assert(offset + length <= content_length);
  8348. data += res.body.substr(offset, length);
  8349. return true;
  8350. });
  8351. }
  8352. inline size_t get_multipart_ranges_data_length(const Request &req,
  8353. const std::string &boundary,
  8354. const std::string &content_type,
  8355. size_t content_length) {
  8356. size_t data_length = 0;
  8357. process_multipart_ranges_data(
  8358. req, boundary, content_type, content_length,
  8359. [&](const std::string &token) { data_length += token.size(); },
  8360. [&](const std::string &token) { data_length += token.size(); },
  8361. [&](size_t /*offset*/, size_t length) {
  8362. data_length += length;
  8363. return true;
  8364. });
  8365. return data_length;
  8366. }
  8367. template <typename T>
  8368. inline bool
  8369. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8370. const std::string &boundary,
  8371. const std::string &content_type,
  8372. size_t content_length, const T &is_shutting_down) {
  8373. return process_multipart_ranges_data(
  8374. req, boundary, content_type, content_length,
  8375. [&](const std::string &token) { strm.write(token); },
  8376. [&](const std::string &token) { strm.write(token); },
  8377. [&](size_t offset, size_t length) {
  8378. return write_content(strm, res.content_provider_, offset, length,
  8379. is_shutting_down);
  8380. });
  8381. }
  8382. inline bool has_framed_body(const Request &req) {
  8383. return is_chunked_transfer_encoding(req.headers) ||
  8384. req.get_header_value_u64("Content-Length") > 0;
  8385. }
  8386. inline bool is_connection_persistent(const Request &req) {
  8387. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8388. if (req.version == "HTTP/1.0" &&
  8389. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8390. return false;
  8391. }
  8392. return true;
  8393. }
  8394. inline bool expect_content(const Request &req) {
  8395. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8396. req.method == "DELETE") {
  8397. return true;
  8398. }
  8399. return has_framed_body(req);
  8400. }
  8401. #ifdef _WIN32
  8402. class WSInit {
  8403. public:
  8404. WSInit() {
  8405. WSADATA wsaData;
  8406. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8407. }
  8408. ~WSInit() {
  8409. if (is_valid_) WSACleanup();
  8410. }
  8411. bool is_valid_ = false;
  8412. };
  8413. static WSInit wsinit_;
  8414. #endif
  8415. // RFC 9110 Section 11.6.1 defines a challenge list as
  8416. // WWW-Authenticate = #challenge
  8417. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8418. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8419. // so a server may offer several schemes, each with its own comma-separated
  8420. // auth-param list, in either order and either as separate field lines or
  8421. // packed into one. Splitting on every comma would break apart a challenge's
  8422. // own param list; splitting only on the first space would miss a Digest
  8423. // challenge that isn't first. Split on commas that aren't inside a
  8424. // quoted-string instead, then track which scheme each resulting segment
  8425. // belongs to: a segment whose text before "=" contains whitespace (or that
  8426. // has no "=" at all) starts a new challenge named by its leading token.
  8427. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8428. std::vector<std::string> segments;
  8429. size_t start = 0;
  8430. auto in_quotes = false;
  8431. for (size_t i = 0; i < s.size(); i++) {
  8432. auto c = s[i];
  8433. if (in_quotes) {
  8434. if (c == '\\' && i + 1 < s.size()) {
  8435. i++;
  8436. } else if (c == '"') {
  8437. in_quotes = false;
  8438. }
  8439. } else if (c == '"') {
  8440. in_quotes = true;
  8441. } else if (c == ',') {
  8442. segments.push_back(s.substr(start, i - start));
  8443. start = i + 1;
  8444. }
  8445. }
  8446. segments.push_back(s.substr(start));
  8447. return segments;
  8448. }
  8449. inline std::string unescape_quoted_pairs(const std::string &s) {
  8450. std::string out;
  8451. out.reserve(s.size());
  8452. for (size_t i = 0; i < s.size(); i++) {
  8453. if (s[i] == '\\' && i + 1 < s.size()) {
  8454. out += s[++i];
  8455. } else {
  8456. out += s[i];
  8457. }
  8458. }
  8459. return out;
  8460. }
  8461. inline bool parse_www_authenticate(const Response &res,
  8462. std::map<std::string, std::string> &auth,
  8463. bool is_proxy) {
  8464. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8465. auto combined = get_combined_header_value(res.headers, auth_key);
  8466. if (combined.empty()) { return false; }
  8467. auto found_digest = false;
  8468. auto in_digest_challenge = false;
  8469. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8470. auto segment = trim_copy(raw_segment);
  8471. if (segment.empty()) { continue; }
  8472. auto eq_pos = segment.find('=');
  8473. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8474. // for the first segment of a challenge, "<scheme> <key>") must be
  8475. // trimmed before its boundaries are inspected.
  8476. auto key_part = trim_copy(
  8477. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8478. auto space_pos = key_part.find_last_of(" \t");
  8479. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8480. // "<scheme>[ <key>]" starts a new challenge.
  8481. auto scheme_end =
  8482. space_pos == std::string::npos ? key_part.size() : space_pos;
  8483. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8484. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8485. // from one challenge is never paired with another's algorithm.
  8486. in_digest_challenge =
  8487. !found_digest &&
  8488. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8489. if (in_digest_challenge) { found_digest = true; }
  8490. if (space_pos == std::string::npos) {
  8491. // Bare scheme (or a token68), no auth-param on this segment.
  8492. continue;
  8493. }
  8494. key_part = key_part.substr(space_pos + 1);
  8495. }
  8496. if (!in_digest_challenge) { continue; }
  8497. auto val = trim_copy(segment.substr(eq_pos + 1));
  8498. auto unquoted = trim_double_quotes_copy(val);
  8499. if (unquoted.size() != val.size()) {
  8500. unquoted = unescape_quoted_pairs(unquoted);
  8501. }
  8502. auth[std::move(key_part)] = std::move(unquoted);
  8503. }
  8504. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8505. // make_digest_authentication_header() dereferences both unconditionally, so
  8506. // a challenge missing either can't produce a usable Authorization header.
  8507. // Treat it the same as no Digest challenge at all.
  8508. return found_digest && auth.find("realm") != auth.end() &&
  8509. auth.find("nonce") != auth.end();
  8510. }
  8511. class ContentProviderAdapter {
  8512. public:
  8513. explicit ContentProviderAdapter(
  8514. ContentProviderWithoutLength &&content_provider)
  8515. : content_provider_(std::move(content_provider)) {}
  8516. bool operator()(size_t offset, size_t, DataSink &sink) {
  8517. return content_provider_(offset, sink);
  8518. }
  8519. private:
  8520. ContentProviderWithoutLength content_provider_;
  8521. };
  8522. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8523. namespace fields {
  8524. inline bool is_token_char(char c) {
  8525. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8526. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8527. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8528. }
  8529. inline bool is_token(const std::string &s) {
  8530. if (s.empty()) { return false; }
  8531. for (auto c : s) {
  8532. if (!is_token_char(c)) { return false; }
  8533. }
  8534. return true;
  8535. }
  8536. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8537. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8538. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8539. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8540. inline bool is_field_content(const std::string &s) {
  8541. if (s.empty()) { return true; }
  8542. if (s.size() == 1) {
  8543. return is_field_vchar(s[0]);
  8544. } else if (s.size() == 2) {
  8545. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8546. } else {
  8547. size_t i = 0;
  8548. if (!is_field_vchar(s[i])) { return false; }
  8549. i++;
  8550. while (i < s.size() - 1) {
  8551. auto c = s[i++];
  8552. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8553. } else {
  8554. return false;
  8555. }
  8556. }
  8557. return is_field_vchar(s[i]);
  8558. }
  8559. }
  8560. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8561. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8562. return is_field_name(name) && is_field_value(value);
  8563. }
  8564. } // namespace fields
  8565. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8566. WebSocketUpgradeResponse &upgrade) {
  8567. // Generate random Sec-WebSocket-Key
  8568. thread_local std::mt19937 rng(std::random_device{}());
  8569. std::string key_bytes(16, '\0');
  8570. for (size_t i = 0; i < 16; i += 4) {
  8571. auto r = rng();
  8572. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8573. }
  8574. auto client_key = base64_encode(key_bytes);
  8575. req.headers.erase("Upgrade");
  8576. req.headers.erase("Connection");
  8577. req.headers.erase("Sec-WebSocket-Key");
  8578. req.headers.erase("Sec-WebSocket-Version");
  8579. req.headers.emplace("Upgrade", "websocket");
  8580. req.headers.emplace("Connection", "Upgrade");
  8581. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8582. req.headers.emplace("Sec-WebSocket-Version", "13");
  8583. // Build the request in memory first, like ClientImpl::write_request does.
  8584. // Writing straight to the socket would leak a request line onto the wire
  8585. // before check_and_write_headers gets a chance to reject an invalid header,
  8586. // and would emit one small write per header.
  8587. BufferStream bstrm;
  8588. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8589. upgrade.error = Error::Write;
  8590. return false;
  8591. }
  8592. auto error = Error::Success;
  8593. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8594. upgrade.error = error;
  8595. return false;
  8596. }
  8597. const auto &data = bstrm.get_buffer();
  8598. if (!write_data(strm, data.data(), data.size())) {
  8599. upgrade.error = Error::Write;
  8600. return false;
  8601. }
  8602. // Verify 101 response and Sec-WebSocket-Accept header
  8603. auto expected_accept = websocket_accept_key(client_key);
  8604. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8605. }
  8606. inline bool is_ip_address(const std::string &host) {
  8607. struct in_addr addr4;
  8608. struct in6_addr addr6;
  8609. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8610. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8611. }
  8612. // Resolve where a client should connect for `host`, honoring a user-supplied
  8613. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8614. // supplying the Host header and SNI; only the connection target changes.
  8615. //
  8616. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8617. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8618. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8619. // absent or empty mapping leaves `host` as the connection target; without the
  8620. // empty check the value would reach getaddrinfo as a null node and silently
  8621. // resolve to loopback.
  8622. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8623. const std::string &host, std::string &connect_host,
  8624. std::string &ip) {
  8625. connect_host = host;
  8626. ip.clear();
  8627. auto it = addr_map.find(host);
  8628. if (it == addr_map.end() || it->second.empty()) { return; }
  8629. if (is_ip_address(it->second)) {
  8630. ip = it->second;
  8631. } else {
  8632. connect_host = it->second;
  8633. }
  8634. }
  8635. } // namespace detail
  8636. /*
  8637. * Group 2: detail namespace - SSL common utilities
  8638. */
  8639. #ifdef CPPHTTPLIB_SSL_ENABLED
  8640. namespace detail {
  8641. class SSLSocketStream final : public Stream {
  8642. public:
  8643. SSLSocketStream(
  8644. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8645. time_t read_timeout_usec, time_t write_timeout_sec,
  8646. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8647. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8648. (std::chrono::steady_clock::time_point::min)());
  8649. ~SSLSocketStream() override;
  8650. bool is_readable() const override;
  8651. bool wait_readable() const override;
  8652. bool wait_writable() const override;
  8653. bool is_peer_alive() const override;
  8654. ssize_t read(char *ptr, size_t size) override;
  8655. ssize_t write(const char *ptr, size_t size) override;
  8656. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8657. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8658. socket_t socket() const override;
  8659. time_t duration() const override;
  8660. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8661. // See SocketStream::set_readable_hint().
  8662. void set_readable_hint() { readable_hint_ = true; }
  8663. private:
  8664. bool ensure_readable();
  8665. socket_t sock_;
  8666. tls::session_t session_;
  8667. time_t read_timeout_sec_;
  8668. time_t read_timeout_usec_;
  8669. time_t write_timeout_sec_;
  8670. time_t write_timeout_usec_;
  8671. time_t max_timeout_msec_;
  8672. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8673. bool readable_hint_ = false;
  8674. };
  8675. // A TLS stream for WebSocket connections, where the receive path and the
  8676. // send path (application send() plus the heartbeat ping thread) run on
  8677. // different threads. A single TLS session must never be entered
  8678. // concurrently, so every call into the session is serialized by one mutex.
  8679. //
  8680. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8681. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8682. // call under the lock, then waits for readiness with select() outside the
  8683. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8684. // blocked waiting for data never stalls a concurrent sender.
  8685. //
  8686. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8687. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8688. class WebSocketSSLStream final : public Stream {
  8689. public:
  8690. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8691. time_t read_timeout_sec, time_t read_timeout_usec,
  8692. time_t write_timeout_sec, time_t write_timeout_usec);
  8693. ~WebSocketSSLStream() override;
  8694. bool is_readable() const override;
  8695. bool wait_readable() const override;
  8696. bool wait_writable() const override;
  8697. ssize_t read(char *ptr, size_t size) override;
  8698. ssize_t write(const char *ptr, size_t size) override;
  8699. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8700. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8701. socket_t socket() const override;
  8702. time_t duration() const override;
  8703. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8704. private:
  8705. mutable std::mutex session_mutex_;
  8706. socket_t sock_;
  8707. tls::session_t session_;
  8708. // WebSocket::close() shortens the read timeout from the closing thread
  8709. // while the receive thread is inside wait_readable(), so these two are read
  8710. // and written concurrently. The write timeouts are never mutated.
  8711. std::atomic<time_t> read_timeout_sec_;
  8712. std::atomic<time_t> read_timeout_usec_;
  8713. time_t write_timeout_sec_;
  8714. time_t write_timeout_usec_;
  8715. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8716. };
  8717. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8718. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8719. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8720. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8721. unsigned int hash_length = 0;
  8722. unsigned char hash[EVP_MAX_MD_SIZE];
  8723. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8724. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8725. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8726. std::stringstream ss;
  8727. for (auto i = 0u; i < hash_length; ++i) {
  8728. ss << std::hex << std::setw(2) << std::setfill('0')
  8729. << static_cast<unsigned int>(hash[i]);
  8730. }
  8731. return ss.str();
  8732. }
  8733. inline std::string MD5(const std::string &s) {
  8734. return message_digest(s, EVP_md5());
  8735. }
  8736. inline std::string SHA_256(const std::string &s) {
  8737. return message_digest(s, EVP_sha256());
  8738. }
  8739. inline std::string SHA_512(const std::string &s) {
  8740. return message_digest(s, EVP_sha512());
  8741. }
  8742. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8743. namespace {
  8744. template <size_t N>
  8745. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8746. std::stringstream ss;
  8747. for (size_t i = 0; i < N; ++i) {
  8748. ss << std::hex << std::setw(2) << std::setfill('0')
  8749. << static_cast<unsigned int>(hash[i]);
  8750. }
  8751. return ss.str();
  8752. }
  8753. } // namespace
  8754. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8755. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8756. // initialized once. PSA state is process-global; do not free it.
  8757. inline bool ensure_mbedtls_psa_crypto() {
  8758. static std::once_flag once;
  8759. static bool ok = false;
  8760. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8761. return ok;
  8762. }
  8763. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8764. unsigned char *out, size_t out_size) {
  8765. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8766. size_t olen = 0;
  8767. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8768. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8769. olen == out_size;
  8770. }
  8771. #endif
  8772. inline std::string MD5(const std::string &s) {
  8773. unsigned char hash[16];
  8774. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8775. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8776. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8777. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8778. hash);
  8779. #else
  8780. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8781. hash);
  8782. #endif
  8783. return hash_to_hex(hash);
  8784. }
  8785. inline std::string SHA_256(const std::string &s) {
  8786. unsigned char hash[32];
  8787. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8788. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8789. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8790. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8791. hash, 0);
  8792. #else
  8793. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8794. s.size(), hash, 0);
  8795. #endif
  8796. return hash_to_hex(hash);
  8797. }
  8798. inline std::string SHA_512(const std::string &s) {
  8799. unsigned char hash[64];
  8800. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8801. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8802. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8803. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8804. hash, 0);
  8805. #else
  8806. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8807. s.size(), hash, 0);
  8808. #endif
  8809. return hash_to_hex(hash);
  8810. }
  8811. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8812. namespace {
  8813. template <size_t N>
  8814. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8815. std::stringstream ss;
  8816. for (size_t i = 0; i < N; ++i) {
  8817. ss << std::hex << std::setw(2) << std::setfill('0')
  8818. << static_cast<unsigned int>(hash[i]);
  8819. }
  8820. return ss.str();
  8821. }
  8822. } // namespace
  8823. inline std::string MD5(const std::string &s) {
  8824. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8825. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8826. static_cast<word32>(s.size()), hash);
  8827. return hash_to_hex(hash);
  8828. }
  8829. inline std::string SHA_256(const std::string &s) {
  8830. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8831. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8832. static_cast<word32>(s.size()), hash);
  8833. return hash_to_hex(hash);
  8834. }
  8835. inline std::string SHA_512(const std::string &s) {
  8836. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8837. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8838. static_cast<word32>(s.size()), hash);
  8839. return hash_to_hex(hash);
  8840. }
  8841. #endif
  8842. template <typename T>
  8843. inline bool process_server_socket_ssl(
  8844. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8845. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8846. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8847. time_t write_timeout_usec, T callback) {
  8848. return process_server_socket_core(
  8849. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8850. [&](bool close_connection, bool &connection_closed) {
  8851. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8852. write_timeout_sec, write_timeout_usec);
  8853. // See the non-TLS path in process_server_socket().
  8854. strm.set_readable_hint();
  8855. return callback(strm, close_connection, connection_closed);
  8856. });
  8857. }
  8858. template <typename T>
  8859. inline bool process_client_socket_ssl(
  8860. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8861. time_t read_timeout_usec, time_t write_timeout_sec,
  8862. time_t write_timeout_usec, time_t max_timeout_msec,
  8863. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8864. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8865. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8866. start_time);
  8867. return callback(strm);
  8868. }
  8869. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8870. const Request &req, const std::map<std::string, std::string> &auth,
  8871. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8872. const std::string &password, bool is_proxy = false) {
  8873. std::string nc;
  8874. {
  8875. std::stringstream ss;
  8876. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8877. nc = ss.str();
  8878. }
  8879. std::string qop;
  8880. if (auth.find("qop") != auth.end()) {
  8881. qop = auth.at("qop");
  8882. if (qop.find("auth-int") != std::string::npos) {
  8883. qop = "auth-int";
  8884. } else if (qop.find("auth") != std::string::npos) {
  8885. qop = "auth";
  8886. } else {
  8887. qop.clear();
  8888. }
  8889. }
  8890. std::string algo = "MD5";
  8891. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8892. std::string response;
  8893. {
  8894. auto H = algo == "SHA-256" ? detail::SHA_256
  8895. : algo == "SHA-512" ? detail::SHA_512
  8896. : detail::MD5;
  8897. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8898. auto A2 = req.method + ":" + req.path;
  8899. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8900. if (qop.empty()) {
  8901. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8902. } else {
  8903. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8904. ":" + qop + ":" + H(A2));
  8905. }
  8906. }
  8907. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8908. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8909. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8910. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8911. (qop.empty() ? ", response=\""
  8912. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8913. cnonce + "\", response=\"") +
  8914. response + "\"" +
  8915. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8916. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8917. return std::make_pair(key, field);
  8918. }
  8919. inline bool match_hostname(const std::string &pattern,
  8920. const std::string &hostname) {
  8921. // Exact match (case-insensitive)
  8922. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8923. // Split both pattern and hostname into components by '.'
  8924. std::vector<std::string> pattern_components;
  8925. if (!pattern.empty()) {
  8926. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8927. [&](const char *b, const char *e) {
  8928. pattern_components.emplace_back(b, e);
  8929. });
  8930. }
  8931. std::vector<std::string> host_components;
  8932. if (!hostname.empty()) {
  8933. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8934. [&](const char *b, const char *e) {
  8935. host_components.emplace_back(b, e);
  8936. });
  8937. }
  8938. // Component count must match
  8939. if (host_components.size() != pattern_components.size()) { return false; }
  8940. // Compare each component with wildcard support
  8941. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8942. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8943. auto itr = pattern_components.begin();
  8944. for (const auto &h : host_components) {
  8945. auto &p = *itr;
  8946. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8947. bool partial_match = false;
  8948. if (!p.empty() && p[p.size() - 1] == '*') {
  8949. const auto prefix_length = p.size() - 1;
  8950. if (prefix_length == 0) {
  8951. partial_match = true;
  8952. } else if (h.size() >= prefix_length) {
  8953. partial_match =
  8954. std::equal(p.begin(),
  8955. p.begin() + static_cast<std::string::difference_type>(
  8956. prefix_length),
  8957. h.begin(), [](const char ca, const char cb) {
  8958. return detail::case_ignore::to_lower(ca) ==
  8959. detail::case_ignore::to_lower(cb);
  8960. });
  8961. }
  8962. }
  8963. if (!partial_match) { return false; }
  8964. }
  8965. ++itr;
  8966. }
  8967. return true;
  8968. }
  8969. #ifdef _WIN32
  8970. // Verify certificate using Windows CertGetCertificateChain API.
  8971. // This provides real-time certificate validation with Windows Update
  8972. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8973. inline bool
  8974. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8975. const std::string &hostname,
  8976. bool verify_hostname, uint64_t &out_error) {
  8977. if (der_cert.empty()) { return false; }
  8978. out_error = 0;
  8979. // Create Windows certificate context from DER data
  8980. auto cert_context = CertCreateCertificateContext(
  8981. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8982. static_cast<DWORD>(der_cert.size()));
  8983. if (!cert_context) {
  8984. out_error = GetLastError();
  8985. return false;
  8986. }
  8987. auto cert_guard =
  8988. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8989. // Setup chain parameters
  8990. CERT_CHAIN_PARA chain_para = {};
  8991. chain_para.cbSize = sizeof(chain_para);
  8992. // Build certificate chain with revocation checking
  8993. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8994. auto chain_result = CertGetCertificateChain(
  8995. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8996. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8997. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8998. nullptr, &chain_context);
  8999. if (!chain_result || !chain_context) {
  9000. out_error = GetLastError();
  9001. return false;
  9002. }
  9003. auto chain_guard =
  9004. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  9005. // Check if chain has errors
  9006. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  9007. out_error = chain_context->TrustStatus.dwErrorStatus;
  9008. return false;
  9009. }
  9010. // Verify SSL policy
  9011. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  9012. extra_policy_para.cbSize = sizeof(extra_policy_para);
  9013. #ifdef AUTHTYPE_SERVER
  9014. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  9015. #endif
  9016. std::wstring whost;
  9017. if (verify_hostname) {
  9018. whost = u8string_to_wstring(hostname.c_str());
  9019. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  9020. }
  9021. CERT_CHAIN_POLICY_PARA policy_para = {};
  9022. policy_para.cbSize = sizeof(policy_para);
  9023. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  9024. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  9025. #else
  9026. policy_para.dwFlags = 0;
  9027. #endif
  9028. policy_para.pvExtraPolicyPara = &extra_policy_para;
  9029. CERT_CHAIN_POLICY_STATUS policy_status = {};
  9030. policy_status.cbSize = sizeof(policy_status);
  9031. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  9032. &policy_para, &policy_status)) {
  9033. out_error = GetLastError();
  9034. return false;
  9035. }
  9036. if (policy_status.dwError != 0) {
  9037. out_error = policy_status.dwError;
  9038. return false;
  9039. }
  9040. return true;
  9041. }
  9042. #endif // _WIN32
  9043. // Loads CA file/dir configuration and applies the system CA policy to a
  9044. // client TLS context. PEM data and native stores are applied to the context
  9045. // directly at set time; has_custom_store reflects them for the Auto policy
  9046. // decision.
  9047. inline bool load_client_ca_config(tls::ctx_t ctx,
  9048. const std::string &ca_cert_file_path,
  9049. const std::string &ca_cert_dir_path,
  9050. bool has_custom_store, SystemCAMode mode,
  9051. uint64_t &backend_error) {
  9052. auto ret = true;
  9053. if (!ca_cert_file_path.empty()) {
  9054. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9055. backend_error = tls::get_error();
  9056. ret = false;
  9057. }
  9058. } else if (!ca_cert_dir_path.empty()) {
  9059. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9060. backend_error = tls::get_error();
  9061. ret = false;
  9062. }
  9063. }
  9064. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9065. !ca_cert_dir_path.empty() || has_custom_store;
  9066. if (mode == SystemCAMode::Enabled ||
  9067. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9068. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9069. }
  9070. return ret;
  9071. }
  9072. // The parts of session setup that only SSLClient needs, plus the handful
  9073. // WebSocketClient also exposes; everything else takes the defaults, which is
  9074. // what keeps the two clients on one implementation.
  9075. struct ClientTlsSessionOptions {
  9076. // Both SSLClient and WebSocketClient expose this independently of
  9077. // certificate verification.
  9078. bool server_hostname_verification = true;
  9079. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9080. // When non-null, guards session creation against concurrent use of the
  9081. // context. A WebSocketClient is not safe to use from several threads to
  9082. // begin with, so it passes nothing.
  9083. std::mutex *ctx_mutex = nullptr;
  9084. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9085. // The caller decides whether Schannel has anything to say about this
  9086. // connection; see SSLClient::initialize_ssl().
  9087. bool windows_cert_verification = false;
  9088. #endif
  9089. };
  9090. // Filled in on failure for callers that report error details.
  9091. struct ClientTlsSessionError {
  9092. Error error = Error::Success;
  9093. int ssl_error = 0;
  9094. uint64_t backend_error = 0;
  9095. };
  9096. // Establishes a client TLS session on an already connected socket. On failure
  9097. // the session is left for the caller to free: SSLClient frees it right away,
  9098. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9099. inline bool setup_client_tls_session(
  9100. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9101. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9102. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9103. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9104. using namespace tls;
  9105. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9106. if (out_error) {
  9107. out_error->error = error;
  9108. out_error->ssl_error = ssl_error;
  9109. out_error->backend_error = backend_error;
  9110. }
  9111. return false;
  9112. };
  9113. if (!ctx) {
  9114. session = nullptr;
  9115. return fail(Error::SSLConnection, 0, 0);
  9116. }
  9117. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9118. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9119. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9120. // verification happens during the handshake even for IP hosts; the
  9121. // certificate identity is verified post-handshake via verify_hostname().
  9122. set_verify_client(ctx, server_certificate_verification);
  9123. #endif
  9124. {
  9125. std::unique_lock<std::mutex> guard;
  9126. if (options.ctx_mutex) {
  9127. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9128. }
  9129. session = create_session(ctx, sock);
  9130. }
  9131. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9132. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9133. // their identity is checked post-handshake below instead. On Mbed TLS and
  9134. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9135. // options.server_hostname_verification is threaded through here.
  9136. if (!is_ip_address(host)) {
  9137. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9138. return fail(Error::SSLConnection, 0, get_error());
  9139. }
  9140. }
  9141. TlsError tls_err;
  9142. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9143. &tls_err)) {
  9144. auto error = Error::SSLConnection;
  9145. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9146. error = Error::SSLServerVerification;
  9147. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9148. error = Error::SSLServerHostnameVerification;
  9149. }
  9150. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9151. }
  9152. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9153. if (options.session_verifier) {
  9154. verification_status = options.session_verifier(session);
  9155. }
  9156. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9157. return fail(Error::SSLServerVerification, 0, get_error());
  9158. }
  9159. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9160. server_certificate_verification) {
  9161. auto verify_result = get_verify_result(session);
  9162. if (verify_result != 0) {
  9163. return fail(Error::SSLServerVerification, 0,
  9164. static_cast<uint64_t>(verify_result));
  9165. }
  9166. auto server_cert = get_peer_cert(session);
  9167. if (!server_cert) {
  9168. return fail(Error::SSLServerVerification, 0, get_error());
  9169. }
  9170. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9171. // Identity check against the peer certificate, post-handshake for all
  9172. // backends. For IP hosts this is the only identity verification, since no
  9173. // hostname is bound during the handshake.
  9174. if (options.server_hostname_verification) {
  9175. if (!verify_hostname(server_cert, host.c_str())) {
  9176. return fail(Error::SSLServerHostnameVerification, 0,
  9177. hostname_mismatch_code());
  9178. }
  9179. }
  9180. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9181. // Additional Windows Schannel verification.
  9182. // This provides real-time certificate validation with Windows Update
  9183. // integration, working with both OpenSSL and MbedTLS backends.
  9184. if (options.windows_cert_verification) {
  9185. std::vector<unsigned char> der;
  9186. if (get_cert_der(server_cert, der)) {
  9187. uint64_t wincrypt_error = 0;
  9188. if (!verify_cert_with_windows_schannel(
  9189. der, host, options.server_hostname_verification,
  9190. wincrypt_error)) {
  9191. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9192. }
  9193. }
  9194. }
  9195. #endif
  9196. }
  9197. return true;
  9198. }
  9199. } // namespace detail
  9200. #endif // CPPHTTPLIB_SSL_ENABLED
  9201. /*
  9202. * Group 3: httplib namespace - Non-SSL public API implementations
  9203. */
  9204. inline void default_socket_options(socket_t sock) {
  9205. set_socket_opt(sock, SOL_SOCKET,
  9206. #ifdef SO_REUSEPORT
  9207. SO_REUSEPORT,
  9208. #else
  9209. SO_REUSEADDR,
  9210. #endif
  9211. 1);
  9212. }
  9213. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9214. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9215. sizeof(optval));
  9216. }
  9217. inline std::string get_bearer_token_auth(const Request &req) {
  9218. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9219. // than the prefix carries no token.
  9220. constexpr const char bearer_prefix[] = "Bearer ";
  9221. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9222. auto value = req.get_header_value("Authorization");
  9223. if (value.size() >= bearer_prefix_len &&
  9224. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9225. bearer_prefix)) {
  9226. return value.substr(bearer_prefix_len);
  9227. }
  9228. return "";
  9229. }
  9230. inline const char *status_message(int status) {
  9231. switch (status) {
  9232. case StatusCode::Continue_100: return "Continue";
  9233. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9234. case StatusCode::Processing_102: return "Processing";
  9235. case StatusCode::EarlyHints_103: return "Early Hints";
  9236. case StatusCode::OK_200: return "OK";
  9237. case StatusCode::Created_201: return "Created";
  9238. case StatusCode::Accepted_202: return "Accepted";
  9239. case StatusCode::NonAuthoritativeInformation_203:
  9240. return "Non-Authoritative Information";
  9241. case StatusCode::NoContent_204: return "No Content";
  9242. case StatusCode::ResetContent_205: return "Reset Content";
  9243. case StatusCode::PartialContent_206: return "Partial Content";
  9244. case StatusCode::MultiStatus_207: return "Multi-Status";
  9245. case StatusCode::AlreadyReported_208: return "Already Reported";
  9246. case StatusCode::IMUsed_226: return "IM Used";
  9247. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9248. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9249. case StatusCode::Found_302: return "Found";
  9250. case StatusCode::SeeOther_303: return "See Other";
  9251. case StatusCode::NotModified_304: return "Not Modified";
  9252. case StatusCode::UseProxy_305: return "Use Proxy";
  9253. case StatusCode::unused_306: return "unused";
  9254. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9255. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9256. case StatusCode::BadRequest_400: return "Bad Request";
  9257. case StatusCode::Unauthorized_401: return "Unauthorized";
  9258. case StatusCode::PaymentRequired_402: return "Payment Required";
  9259. case StatusCode::Forbidden_403: return "Forbidden";
  9260. case StatusCode::NotFound_404: return "Not Found";
  9261. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9262. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9263. case StatusCode::ProxyAuthenticationRequired_407:
  9264. return "Proxy Authentication Required";
  9265. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9266. case StatusCode::Conflict_409: return "Conflict";
  9267. case StatusCode::Gone_410: return "Gone";
  9268. case StatusCode::LengthRequired_411: return "Length Required";
  9269. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9270. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9271. case StatusCode::UriTooLong_414: return "URI Too Long";
  9272. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9273. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9274. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9275. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9276. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9277. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9278. case StatusCode::Locked_423: return "Locked";
  9279. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9280. case StatusCode::TooEarly_425: return "Too Early";
  9281. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9282. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9283. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9284. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9285. return "Request Header Fields Too Large";
  9286. case StatusCode::UnavailableForLegalReasons_451:
  9287. return "Unavailable For Legal Reasons";
  9288. case StatusCode::NotImplemented_501: return "Not Implemented";
  9289. case StatusCode::BadGateway_502: return "Bad Gateway";
  9290. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9291. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9292. case StatusCode::HttpVersionNotSupported_505:
  9293. return "HTTP Version Not Supported";
  9294. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9295. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9296. case StatusCode::LoopDetected_508: return "Loop Detected";
  9297. case StatusCode::NotExtended_510: return "Not Extended";
  9298. case StatusCode::NetworkAuthenticationRequired_511:
  9299. return "Network Authentication Required";
  9300. default:
  9301. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9302. }
  9303. }
  9304. inline std::string to_string(const Error error) {
  9305. switch (error) {
  9306. case Error::Success: return "Success (no error)";
  9307. case Error::Unknown: return "Unknown";
  9308. case Error::Connection: return "Could not establish connection";
  9309. case Error::BindIPAddress: return "Failed to bind IP address";
  9310. case Error::Read: return "Failed to read connection";
  9311. case Error::Write: return "Failed to write connection";
  9312. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9313. case Error::Canceled: return "Connection handling canceled";
  9314. case Error::SSLConnection: return "SSL connection failed";
  9315. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9316. case Error::SSLServerVerification: return "SSL server verification failed";
  9317. case Error::SSLServerHostnameVerification:
  9318. return "SSL server hostname verification failed";
  9319. case Error::UnsupportedMultipartBoundaryChars:
  9320. return "Unsupported HTTP multipart boundary characters";
  9321. case Error::Compression: return "Compression failed";
  9322. case Error::ConnectionTimeout: return "Connection timed out";
  9323. case Error::ProxyConnection: return "Proxy connection failed";
  9324. case Error::ConnectionClosed: return "Connection closed by server";
  9325. case Error::Timeout: return "Read timeout";
  9326. case Error::ResourceExhaustion: return "Resource exhaustion";
  9327. case Error::TooManyFormDataFiles: return "Too many form data files";
  9328. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9329. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9330. case Error::ExceedMaxSocketDescriptorCount:
  9331. return "Exceeded maximum socket descriptor count";
  9332. case Error::InvalidRequestLine: return "Invalid request line";
  9333. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9334. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9335. case Error::InvalidHeaders: return "Invalid headers";
  9336. case Error::MultipartParsing: return "Multipart parsing failed";
  9337. case Error::OpenFile: return "Failed to open file";
  9338. case Error::Listen: return "Failed to listen on socket";
  9339. case Error::GetSockName: return "Failed to get socket name";
  9340. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9341. case Error::HTTPParsing: return "HTTP parsing failed";
  9342. case Error::InvalidRangeHeader: return "Invalid Range header";
  9343. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9344. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9345. case Error::UserCallbackException: return "User callback threw an exception";
  9346. default: break;
  9347. }
  9348. return "Invalid";
  9349. }
  9350. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9351. os << to_string(obj);
  9352. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9353. return os;
  9354. }
  9355. inline std::string hosted_at(const std::string &hostname) {
  9356. std::vector<std::string> addrs;
  9357. hosted_at(hostname, addrs);
  9358. if (addrs.empty()) { return std::string(); }
  9359. return addrs[0];
  9360. }
  9361. inline void hosted_at(const std::string &hostname,
  9362. std::vector<std::string> &addrs) {
  9363. struct addrinfo hints;
  9364. struct addrinfo *result;
  9365. memset(&hints, 0, sizeof(struct addrinfo));
  9366. hints.ai_family = AF_UNSPEC;
  9367. hints.ai_socktype = SOCK_STREAM;
  9368. hints.ai_protocol = 0;
  9369. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9370. &result, 0)) {
  9371. #if defined __linux__ && !defined __ANDROID__
  9372. res_init();
  9373. #endif
  9374. return;
  9375. }
  9376. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9377. for (auto rp = result; rp; rp = rp->ai_next) {
  9378. const auto &addr =
  9379. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9380. std::string ip;
  9381. auto dummy = -1;
  9382. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9383. dummy)) {
  9384. addrs.emplace_back(std::move(ip));
  9385. }
  9386. }
  9387. }
  9388. inline std::string encode_uri_component(const std::string &value) {
  9389. std::ostringstream escaped;
  9390. escaped.fill('0');
  9391. escaped << std::hex;
  9392. for (auto c : value) {
  9393. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9394. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9395. escaped << c;
  9396. } else {
  9397. escaped << std::uppercase;
  9398. escaped << '%' << std::setw(2)
  9399. << static_cast<int>(static_cast<unsigned char>(c));
  9400. escaped << std::nouppercase;
  9401. }
  9402. }
  9403. return escaped.str();
  9404. }
  9405. inline std::string encode_uri(const std::string &value) {
  9406. std::ostringstream escaped;
  9407. escaped.fill('0');
  9408. escaped << std::hex;
  9409. for (auto c : value) {
  9410. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9411. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9412. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9413. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9414. escaped << c;
  9415. } else {
  9416. escaped << std::uppercase;
  9417. escaped << '%' << std::setw(2)
  9418. << static_cast<int>(static_cast<unsigned char>(c));
  9419. escaped << std::nouppercase;
  9420. }
  9421. }
  9422. return escaped.str();
  9423. }
  9424. inline std::string decode_uri_component(const std::string &value) {
  9425. std::string result;
  9426. for (size_t i = 0; i < value.size(); i++) {
  9427. if (value[i] == '%' && i + 2 < value.size()) {
  9428. auto val = 0;
  9429. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9430. result += static_cast<char>(val);
  9431. i += 2;
  9432. } else {
  9433. result += value[i];
  9434. }
  9435. } else {
  9436. result += value[i];
  9437. }
  9438. }
  9439. return result;
  9440. }
  9441. inline std::string decode_uri(const std::string &value) {
  9442. std::string result;
  9443. for (size_t i = 0; i < value.size(); i++) {
  9444. if (value[i] == '%' && i + 2 < value.size()) {
  9445. auto val = 0;
  9446. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9447. auto c = static_cast<char>(val);
  9448. // Keep escapes of the reserved characters that encode_uri leaves
  9449. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9450. // delimiter is not promoted into a real one (as with JS decodeURI).
  9451. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9452. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9453. c == '#') {
  9454. result += value[i];
  9455. result += value[i + 1];
  9456. result += value[i + 2];
  9457. } else {
  9458. result += c;
  9459. }
  9460. i += 2;
  9461. } else {
  9462. result += value[i];
  9463. }
  9464. } else {
  9465. result += value[i];
  9466. }
  9467. }
  9468. return result;
  9469. }
  9470. inline std::string encode_path_component(const std::string &component) {
  9471. std::string result;
  9472. result.reserve(component.size() * 3);
  9473. for (size_t i = 0; i < component.size(); i++) {
  9474. auto c = static_cast<unsigned char>(component[i]);
  9475. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9476. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9477. c == '_' || c == '~') {
  9478. result += static_cast<char>(c);
  9479. }
  9480. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9481. // "," / ";" / "="
  9482. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9483. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9484. c == '=') {
  9485. result += static_cast<char>(c);
  9486. }
  9487. // Colon is allowed in path segments except first segment
  9488. else if (c == ':') {
  9489. result += static_cast<char>(c);
  9490. }
  9491. // @ is allowed in path
  9492. else if (c == '@') {
  9493. result += static_cast<char>(c);
  9494. } else {
  9495. result += '%';
  9496. char hex[3];
  9497. snprintf(hex, sizeof(hex), "%02X", c);
  9498. result.append(hex, 2);
  9499. }
  9500. }
  9501. return result;
  9502. }
  9503. inline std::string decode_path_component(const std::string &component) {
  9504. std::string result;
  9505. result.reserve(component.size());
  9506. for (size_t i = 0; i < component.size(); i++) {
  9507. if (component[i] == '%' && i + 1 < component.size()) {
  9508. if (component[i + 1] == 'u') {
  9509. // Unicode %uXXXX encoding
  9510. auto val = 0;
  9511. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9512. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9513. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9514. char buff[4];
  9515. size_t len = detail::to_utf8(val, buff);
  9516. if (len > 0) { result.append(buff, len); }
  9517. i += 5; // 'u0000'
  9518. } else {
  9519. result += component[i];
  9520. }
  9521. } else {
  9522. // Standard %XX encoding
  9523. auto val = 0;
  9524. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9525. // 2 digits hex codes
  9526. result += static_cast<char>(val);
  9527. i += 2; // 'XX'
  9528. } else {
  9529. result += component[i];
  9530. }
  9531. }
  9532. } else {
  9533. result += component[i];
  9534. }
  9535. }
  9536. return result;
  9537. }
  9538. inline std::string encode_query_component(const std::string &component,
  9539. bool space_as_plus) {
  9540. std::string result;
  9541. result.reserve(component.size() * 3);
  9542. for (size_t i = 0; i < component.size(); i++) {
  9543. auto c = static_cast<unsigned char>(component[i]);
  9544. // Unreserved characters per RFC 3986
  9545. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9546. c == '_' || c == '~') {
  9547. result += static_cast<char>(c);
  9548. }
  9549. // Space handling
  9550. else if (c == ' ') {
  9551. if (space_as_plus) {
  9552. result += '+';
  9553. } else {
  9554. result += "%20";
  9555. }
  9556. }
  9557. // Plus sign handling
  9558. else if (c == '+') {
  9559. if (space_as_plus) {
  9560. result += "%2B";
  9561. } else {
  9562. result += static_cast<char>(c);
  9563. }
  9564. }
  9565. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9566. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9567. c == '*' || c == ',' || c == ';') {
  9568. result += static_cast<char>(c);
  9569. }
  9570. // Colon and @ are allowed in query
  9571. else if (c == ':' || c == '@') {
  9572. result += static_cast<char>(c);
  9573. }
  9574. // Forward slash is allowed in query values
  9575. else if (c == '/') {
  9576. result += static_cast<char>(c);
  9577. }
  9578. // Question mark is allowed in query values (after first ?)
  9579. else if (c == '?') {
  9580. result += static_cast<char>(c);
  9581. } else {
  9582. result += '%';
  9583. char hex[3];
  9584. snprintf(hex, sizeof(hex), "%02X", c);
  9585. result.append(hex, 2);
  9586. }
  9587. }
  9588. return result;
  9589. }
  9590. inline std::string decode_query_component(const std::string &component,
  9591. bool plus_as_space) {
  9592. std::string result;
  9593. result.reserve(component.size());
  9594. for (size_t i = 0; i < component.size(); i++) {
  9595. if (component[i] == '%' && i + 2 < component.size()) {
  9596. auto val = 0;
  9597. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9598. result += static_cast<char>(val);
  9599. i += 2;
  9600. } else {
  9601. result += component[i];
  9602. }
  9603. } else if (component[i] == '+' && plus_as_space) {
  9604. result += ' '; // + becomes space in form-urlencoded
  9605. } else {
  9606. result += component[i];
  9607. }
  9608. }
  9609. return result;
  9610. }
  9611. inline std::string sanitize_filename(const std::string &filename) {
  9612. // Extract basename: find the last path separator (/ or \)
  9613. auto pos = filename.find_last_of("/\\");
  9614. auto result =
  9615. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9616. // Strip null bytes
  9617. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9618. // Trim whitespace
  9619. {
  9620. auto start = result.find_first_not_of(" \t");
  9621. auto end = result.find_last_not_of(" \t");
  9622. result = (start == std::string::npos)
  9623. ? ""
  9624. : result.substr(start, end - start + 1);
  9625. }
  9626. // Reject . and ..
  9627. if (result == "." || result == "..") { return ""; }
  9628. return result;
  9629. }
  9630. inline std::string append_query_params(const std::string &path,
  9631. const Params &params) {
  9632. std::string path_with_query = path;
  9633. thread_local const std::regex re("[^?]+\\?.*");
  9634. auto delm = std::regex_match(path, re) ? '&' : '?';
  9635. path_with_query += delm + detail::params_to_query_str(params);
  9636. return path_with_query;
  9637. }
  9638. // Header utilities
  9639. inline std::pair<std::string, std::string>
  9640. make_range_header(const Ranges &ranges) {
  9641. std::string field = "bytes=";
  9642. auto i = 0;
  9643. for (const auto &r : ranges) {
  9644. if (i != 0) { field += ", "; }
  9645. if (r.first != -1) { field += std::to_string(r.first); }
  9646. field += '-';
  9647. if (r.second != -1) { field += std::to_string(r.second); }
  9648. i++;
  9649. }
  9650. return std::make_pair("Range", std::move(field));
  9651. }
  9652. inline std::pair<std::string, std::string>
  9653. make_basic_authentication_header(const std::string &username,
  9654. const std::string &password, bool is_proxy) {
  9655. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9656. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9657. return std::make_pair(key, std::move(field));
  9658. }
  9659. inline std::pair<std::string, std::string>
  9660. make_bearer_token_authentication_header(const std::string &token,
  9661. bool is_proxy = false) {
  9662. auto field = "Bearer " + token;
  9663. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9664. return std::make_pair(key, std::move(field));
  9665. }
  9666. // Request implementation
  9667. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9668. size_t id) const {
  9669. return detail::get_header_value_u64(headers, key, def, id);
  9670. }
  9671. inline bool Request::has_header(const std::string &key) const {
  9672. return detail::has_header(headers, key);
  9673. }
  9674. inline std::string Request::get_header_value(const std::string &key,
  9675. const char *def, size_t id) const {
  9676. return detail::get_header_value(headers, key, def, id);
  9677. }
  9678. inline size_t Request::get_header_value_count(const std::string &key) const {
  9679. return detail::get_header_value_count(headers, key);
  9680. }
  9681. inline void Request::set_header(const std::string &key,
  9682. const std::string &val) {
  9683. detail::set_header(headers, key, val);
  9684. }
  9685. inline bool Request::has_trailer(const std::string &key) const {
  9686. return trailers.find(key) != trailers.end();
  9687. }
  9688. inline std::string Request::get_trailer_value(const std::string &key,
  9689. size_t id) const {
  9690. return detail::get_multimap_value(trailers, key, id);
  9691. }
  9692. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9693. return trailers.count(key);
  9694. }
  9695. inline bool Request::has_param(const std::string &key) const {
  9696. return params.find(key) != params.end();
  9697. }
  9698. inline std::string Request::get_param_value(const std::string &key,
  9699. size_t id) const {
  9700. return detail::get_multimap_value(params, key, id);
  9701. }
  9702. inline std::vector<std::string>
  9703. Request::get_param_values(const std::string &key) const {
  9704. auto rng = params.equal_range(key);
  9705. std::vector<std::string> values;
  9706. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9707. for (auto it = rng.first; it != rng.second; ++it) {
  9708. values.push_back(it->second);
  9709. }
  9710. return values;
  9711. }
  9712. inline size_t Request::get_param_value_count(const std::string &key) const {
  9713. return params.count(key);
  9714. }
  9715. inline bool Request::is_multipart_form_data() const {
  9716. const auto &content_type = get_header_value("Content-Type");
  9717. return detail::extract_media_type(content_type) == "multipart/form-data";
  9718. }
  9719. // Multipart FormData implementation
  9720. inline std::string MultipartFormData::get_field(const std::string &key,
  9721. size_t id) const {
  9722. auto rng = fields.equal_range(key);
  9723. auto it = rng.first;
  9724. std::advance(it, static_cast<ssize_t>(id));
  9725. if (it != rng.second) { return it->second.content; }
  9726. return std::string();
  9727. }
  9728. inline std::vector<std::string>
  9729. MultipartFormData::get_fields(const std::string &key) const {
  9730. std::vector<std::string> values;
  9731. auto rng = fields.equal_range(key);
  9732. for (auto it = rng.first; it != rng.second; it++) {
  9733. values.push_back(it->second.content);
  9734. }
  9735. return values;
  9736. }
  9737. inline bool MultipartFormData::has_field(const std::string &key) const {
  9738. return fields.find(key) != fields.end();
  9739. }
  9740. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9741. return fields.count(key);
  9742. }
  9743. inline FormData MultipartFormData::get_file(const std::string &key,
  9744. size_t id) const {
  9745. return detail::get_multimap_value(files, key, id);
  9746. }
  9747. inline std::vector<FormData>
  9748. MultipartFormData::get_files(const std::string &key) const {
  9749. std::vector<FormData> values;
  9750. auto rng = files.equal_range(key);
  9751. for (auto it = rng.first; it != rng.second; it++) {
  9752. values.push_back(it->second);
  9753. }
  9754. return values;
  9755. }
  9756. inline bool MultipartFormData::has_file(const std::string &key) const {
  9757. return files.find(key) != files.end();
  9758. }
  9759. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9760. return files.count(key);
  9761. }
  9762. // Multipart FormData writer implementation
  9763. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9764. return detail::is_multipart_boundary_chars_valid(boundary);
  9765. }
  9766. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9767. : boundary_(detail::make_multipart_data_boundary()) {}
  9768. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9769. : boundary_(std::move(boundary)) {}
  9770. inline const std::string &MultipartFormDataWriter::boundary() const {
  9771. return boundary_;
  9772. }
  9773. inline std::string MultipartFormDataWriter::content_type() const {
  9774. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9775. }
  9776. inline std::string
  9777. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9778. return detail::serialize_multipart_formdata(items, boundary_);
  9779. }
  9780. inline size_t MultipartFormDataWriter::content_length(
  9781. const UploadFormDataItems &items) const {
  9782. return detail::get_multipart_content_length(items, boundary_);
  9783. }
  9784. inline std::string
  9785. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9786. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9787. }
  9788. inline std::string MultipartFormDataWriter::item_end() {
  9789. return detail::serialize_multipart_formdata_item_end();
  9790. }
  9791. inline std::string MultipartFormDataWriter::finish() const {
  9792. return detail::serialize_multipart_formdata_finish(boundary_);
  9793. }
  9794. // Response implementation
  9795. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9796. size_t id) const {
  9797. return detail::get_header_value_u64(headers, key, def, id);
  9798. }
  9799. inline bool Response::has_header(const std::string &key) const {
  9800. return headers.find(key) != headers.end();
  9801. }
  9802. inline std::string Response::get_header_value(const std::string &key,
  9803. const char *def,
  9804. size_t id) const {
  9805. return detail::get_header_value(headers, key, def, id);
  9806. }
  9807. inline size_t Response::get_header_value_count(const std::string &key) const {
  9808. return detail::get_header_value_count(headers, key);
  9809. }
  9810. inline void Response::set_header(const std::string &key,
  9811. const std::string &val) {
  9812. detail::set_header(headers, key, val);
  9813. }
  9814. inline bool Response::has_trailer(const std::string &key) const {
  9815. return trailers.find(key) != trailers.end();
  9816. }
  9817. inline std::string Response::get_trailer_value(const std::string &key,
  9818. size_t id) const {
  9819. return detail::get_multimap_value(trailers, key, id);
  9820. }
  9821. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9822. return trailers.count(key);
  9823. }
  9824. inline void Response::set_redirect(const std::string &url, int stat) {
  9825. if (detail::fields::is_field_value(url)) {
  9826. set_header("Location", url);
  9827. if (300 <= stat && stat < 400) {
  9828. this->status = stat;
  9829. } else {
  9830. this->status = StatusCode::Found_302;
  9831. }
  9832. }
  9833. }
  9834. inline void Response::set_content(const char *s, size_t n,
  9835. const std::string &content_type) {
  9836. body.assign(s, n);
  9837. auto rng = headers.equal_range("Content-Type");
  9838. headers.erase(rng.first, rng.second);
  9839. set_header("Content-Type", content_type);
  9840. content_coding_ = detail::EncodingType::None;
  9841. }
  9842. inline void Response::set_content(const std::string &s,
  9843. const std::string &content_type) {
  9844. set_content(s.data(), s.size(), content_type);
  9845. }
  9846. inline void Response::set_content(std::string &&s,
  9847. const std::string &content_type) {
  9848. body = std::move(s);
  9849. auto rng = headers.equal_range("Content-Type");
  9850. headers.erase(rng.first, rng.second);
  9851. set_header("Content-Type", content_type);
  9852. content_coding_ = detail::EncodingType::None;
  9853. }
  9854. inline void Response::set_content_provider(
  9855. size_t in_length, const std::string &content_type, ContentProvider provider,
  9856. ContentProviderResourceReleaser resource_releaser) {
  9857. set_header("Content-Type", content_type);
  9858. content_length_ = in_length;
  9859. if (in_length > 0) { content_provider_ = std::move(provider); }
  9860. content_provider_resource_releaser_ = std::move(resource_releaser);
  9861. is_chunked_content_provider_ = false;
  9862. is_file_content_provider_ = false;
  9863. content_coding_ = detail::EncodingType::None;
  9864. }
  9865. inline void Response::set_content_provider(
  9866. const std::string &content_type, ContentProviderWithoutLength provider,
  9867. ContentProviderResourceReleaser resource_releaser) {
  9868. set_header("Content-Type", content_type);
  9869. content_length_ = 0;
  9870. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9871. content_provider_resource_releaser_ = std::move(resource_releaser);
  9872. is_chunked_content_provider_ = false;
  9873. is_file_content_provider_ = false;
  9874. content_coding_ = detail::EncodingType::None;
  9875. }
  9876. inline void Response::set_chunked_content_provider(
  9877. const std::string &content_type, ContentProviderWithoutLength provider,
  9878. ContentProviderResourceReleaser resource_releaser) {
  9879. set_header("Content-Type", content_type);
  9880. content_length_ = 0;
  9881. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9882. content_provider_resource_releaser_ = std::move(resource_releaser);
  9883. is_chunked_content_provider_ = true;
  9884. is_file_content_provider_ = false;
  9885. content_coding_ = detail::EncodingType::None;
  9886. }
  9887. inline void Response::set_file_content(const std::string &path,
  9888. const std::string &content_type) {
  9889. file_content_path_ = path;
  9890. file_content_content_type_ = content_type;
  9891. }
  9892. inline void Response::set_file_content(const std::string &path) {
  9893. file_content_path_ = path;
  9894. }
  9895. // Result implementation
  9896. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9897. size_t def,
  9898. size_t id) const {
  9899. return detail::get_header_value_u64(request_headers_, key, def, id);
  9900. }
  9901. inline bool Result::has_request_header(const std::string &key) const {
  9902. return request_headers_.find(key) != request_headers_.end();
  9903. }
  9904. inline std::string Result::get_request_header_value(const std::string &key,
  9905. const char *def,
  9906. size_t id) const {
  9907. return detail::get_header_value(request_headers_, key, def, id);
  9908. }
  9909. inline size_t
  9910. Result::get_request_header_value_count(const std::string &key) const {
  9911. return request_headers_.count(key);
  9912. }
  9913. // Stream implementation
  9914. inline ssize_t Stream::write(const char *ptr) {
  9915. return write(ptr, strlen(ptr));
  9916. }
  9917. inline ssize_t Stream::write(const std::string &s) {
  9918. return write(s.data(), s.size());
  9919. }
  9920. // BodyReader implementation
  9921. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9922. if (!stream) {
  9923. last_error = Error::Connection;
  9924. return -1;
  9925. }
  9926. if (eof) { return 0; }
  9927. if (!chunked) {
  9928. // Content-Length based reading
  9929. if (has_content_length && bytes_read >= content_length) {
  9930. eof = true;
  9931. return 0;
  9932. }
  9933. auto to_read = len;
  9934. if (has_content_length) {
  9935. auto remaining = content_length - bytes_read;
  9936. to_read = (std::min)(len, remaining);
  9937. }
  9938. auto n = stream->read(buf, to_read);
  9939. if (n < 0) {
  9940. last_error = stream->get_error();
  9941. if (last_error == Error::Success) { last_error = Error::Read; }
  9942. eof = true;
  9943. return n;
  9944. }
  9945. if (n == 0) {
  9946. // Unexpected EOF before content_length
  9947. last_error = stream->get_error();
  9948. if (last_error == Error::Success) { last_error = Error::Read; }
  9949. eof = true;
  9950. return 0;
  9951. }
  9952. bytes_read += static_cast<size_t>(n);
  9953. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9954. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9955. last_error = Error::ExceedMaxPayloadSize;
  9956. eof = true;
  9957. return -1;
  9958. }
  9959. return n;
  9960. }
  9961. // Chunked transfer encoding: delegate to shared decoder instance.
  9962. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9963. size_t chunk_offset = 0;
  9964. size_t chunk_total = 0;
  9965. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9966. if (n < 0) {
  9967. last_error = stream->get_error();
  9968. if (last_error == Error::Success) { last_error = Error::Read; }
  9969. eof = true;
  9970. return n;
  9971. }
  9972. if (n == 0) {
  9973. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9974. eof = true;
  9975. return 0;
  9976. }
  9977. bytes_read += static_cast<size_t>(n);
  9978. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9979. last_error = Error::ExceedMaxPayloadSize;
  9980. eof = true;
  9981. return -1;
  9982. }
  9983. return n;
  9984. }
  9985. // ThreadPool implementation
  9986. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9987. time_t idle_timeout_sec)
  9988. : base_thread_count_(n), max_queued_requests_(mqr),
  9989. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9990. shutdown_(false) {
  9991. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9992. if (max_n != 0 && max_n < n) {
  9993. std::string msg = "max_threads must be >= base_threads";
  9994. throw std::invalid_argument(msg);
  9995. }
  9996. #endif
  9997. max_thread_count_ = max_n == 0 ? n : max_n;
  9998. threads_.reserve(base_thread_count_);
  9999. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10000. try {
  10001. #endif
  10002. for (size_t i = 0; i < base_thread_count_; i++) {
  10003. threads_.emplace_back(std::thread([this]() { worker(false); }));
  10004. }
  10005. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10006. } catch (...) {
  10007. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  10008. // signal the workers we already spawned to exit and join them so the
  10009. // vector destructor does not see joinable threads (which would call
  10010. // std::terminate). Then rethrow so the caller learns of the failure.
  10011. {
  10012. std::unique_lock<std::mutex> lock(mutex_);
  10013. shutdown_ = true;
  10014. }
  10015. cond_.notify_all();
  10016. for (auto &t : threads_) {
  10017. if (t.joinable()) { t.join(); }
  10018. }
  10019. throw;
  10020. }
  10021. #endif
  10022. }
  10023. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  10024. {
  10025. std::unique_lock<std::mutex> lock(mutex_);
  10026. if (shutdown_) { return false; }
  10027. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  10028. return false;
  10029. }
  10030. jobs_.push_back(std::move(fn));
  10031. // Spawn a dynamic thread if no idle threads and under max
  10032. if (idle_thread_count_ == 0 &&
  10033. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  10034. cleanup_finished_threads();
  10035. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  10036. }
  10037. }
  10038. cond_.notify_one();
  10039. return true;
  10040. }
  10041. inline void ThreadPool::shutdown() {
  10042. {
  10043. std::unique_lock<std::mutex> lock(mutex_);
  10044. shutdown_ = true;
  10045. }
  10046. cond_.notify_all();
  10047. for (auto &t : threads_) {
  10048. if (t.joinable()) { t.join(); }
  10049. }
  10050. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10051. // with worker threads that call move_to_finished() concurrently.
  10052. std::list<std::thread> remaining_dynamic;
  10053. {
  10054. std::unique_lock<std::mutex> lock(mutex_);
  10055. remaining_dynamic = std::move(dynamic_threads_);
  10056. }
  10057. for (auto &t : remaining_dynamic) {
  10058. if (t.joinable()) { t.join(); }
  10059. }
  10060. std::unique_lock<std::mutex> lock(mutex_);
  10061. cleanup_finished_threads();
  10062. }
  10063. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10064. // Must be called with mutex_ held
  10065. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10066. if (it->get_id() == id) {
  10067. finished_threads_.push_back(std::move(*it));
  10068. dynamic_threads_.erase(it);
  10069. return;
  10070. }
  10071. }
  10072. }
  10073. inline void ThreadPool::cleanup_finished_threads() {
  10074. // Must be called with mutex_ held
  10075. for (auto &t : finished_threads_) {
  10076. if (t.joinable()) { t.join(); }
  10077. }
  10078. finished_threads_.clear();
  10079. }
  10080. inline void ThreadPool::worker(bool is_dynamic) {
  10081. for (;;) {
  10082. std::function<void()> fn;
  10083. {
  10084. std::unique_lock<std::mutex> lock(mutex_);
  10085. idle_thread_count_++;
  10086. if (is_dynamic) {
  10087. auto has_work =
  10088. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10089. [&] { return !jobs_.empty() || shutdown_; });
  10090. if (!has_work) {
  10091. // Timed out with no work - exit this dynamic thread
  10092. idle_thread_count_--;
  10093. move_to_finished(std::this_thread::get_id());
  10094. break;
  10095. }
  10096. } else {
  10097. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10098. }
  10099. idle_thread_count_--;
  10100. if (shutdown_ && jobs_.empty()) { break; }
  10101. fn = std::move(jobs_.front());
  10102. jobs_.pop_front();
  10103. }
  10104. assert(true == static_cast<bool>(fn));
  10105. fn();
  10106. }
  10107. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10108. !defined(LIBRESSL_VERSION_NUMBER)
  10109. OPENSSL_thread_stop();
  10110. #endif
  10111. }
  10112. /*
  10113. * Group 1 (continued): detail namespace - Stream implementations
  10114. */
  10115. namespace detail {
  10116. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10117. time_t timeout_sec, time_t timeout_usec,
  10118. time_t &actual_timeout_sec,
  10119. time_t &actual_timeout_usec) {
  10120. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10121. auto actual_timeout_msec =
  10122. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10123. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10124. actual_timeout_sec = actual_timeout_msec / 1000;
  10125. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10126. }
  10127. // Socket stream implementation
  10128. inline SocketStream::SocketStream(
  10129. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10130. time_t write_timeout_sec, time_t write_timeout_usec,
  10131. time_t max_timeout_msec,
  10132. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10133. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10134. read_timeout_usec_(read_timeout_usec),
  10135. write_timeout_sec_(write_timeout_sec),
  10136. write_timeout_usec_(write_timeout_usec),
  10137. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10138. read_buff_(read_buff_size_, 0) {}
  10139. inline SocketStream::~SocketStream() = default;
  10140. inline bool SocketStream::is_readable() const {
  10141. return read_buff_off_ < read_buff_content_size_;
  10142. }
  10143. inline bool SocketStream::wait_readable() const {
  10144. if (max_timeout_msec_ <= 0) {
  10145. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10146. }
  10147. time_t read_timeout_sec;
  10148. time_t read_timeout_usec;
  10149. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10150. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10151. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10152. }
  10153. inline bool SocketStream::wait_writable() const {
  10154. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10155. }
  10156. inline bool SocketStream::ensure_readable() {
  10157. if (readable_hint_) {
  10158. readable_hint_ = false;
  10159. return true;
  10160. }
  10161. return wait_readable();
  10162. }
  10163. inline const char *SocketStream::buffered_data(size_t &size) const {
  10164. size = read_buff_content_size_ - read_buff_off_;
  10165. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10166. }
  10167. inline void SocketStream::consume_buffered(size_t size) {
  10168. assert(size <= read_buff_content_size_ - read_buff_off_);
  10169. read_buff_off_ += size;
  10170. }
  10171. inline bool SocketStream::is_peer_alive() const {
  10172. return detail::is_socket_alive(sock_);
  10173. }
  10174. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10175. #ifdef _WIN32
  10176. size =
  10177. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10178. #else
  10179. size = (std::min)(size,
  10180. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10181. #endif
  10182. if (read_buff_off_ < read_buff_content_size_) {
  10183. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10184. if (size <= remaining_size) {
  10185. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10186. read_buff_off_ += size;
  10187. return static_cast<ssize_t>(size);
  10188. } else {
  10189. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10190. read_buff_off_ += remaining_size;
  10191. return static_cast<ssize_t>(remaining_size);
  10192. }
  10193. }
  10194. if (!ensure_readable()) {
  10195. error_ = Error::Timeout;
  10196. return -1;
  10197. }
  10198. read_buff_off_ = 0;
  10199. read_buff_content_size_ = 0;
  10200. if (size < read_buff_size_) {
  10201. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10202. CPPHTTPLIB_RECV_FLAGS);
  10203. if (n <= 0) {
  10204. if (n == 0) {
  10205. error_ = Error::ConnectionClosed;
  10206. } else {
  10207. error_ = Error::Read;
  10208. }
  10209. return n;
  10210. } else if (n <= static_cast<ssize_t>(size)) {
  10211. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10212. return n;
  10213. } else {
  10214. memcpy(ptr, read_buff_.data(), size);
  10215. read_buff_off_ = size;
  10216. read_buff_content_size_ = static_cast<size_t>(n);
  10217. return static_cast<ssize_t>(size);
  10218. }
  10219. } else {
  10220. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10221. if (n <= 0) {
  10222. if (n == 0) {
  10223. error_ = Error::ConnectionClosed;
  10224. } else {
  10225. error_ = Error::Read;
  10226. }
  10227. }
  10228. return n;
  10229. }
  10230. }
  10231. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10232. if (!wait_writable()) { return -1; }
  10233. #if defined(_WIN32) && !defined(_WIN64)
  10234. size =
  10235. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10236. #endif
  10237. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10238. }
  10239. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10240. int &port) const {
  10241. return detail::get_remote_ip_and_port(sock_, ip, port);
  10242. }
  10243. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10244. int &port) const {
  10245. return detail::get_local_ip_and_port(sock_, ip, port);
  10246. }
  10247. inline socket_t SocketStream::socket() const { return sock_; }
  10248. inline time_t SocketStream::duration() const {
  10249. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10250. std::chrono::steady_clock::now() - start_time_)
  10251. .count();
  10252. }
  10253. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10254. read_timeout_sec_ = sec;
  10255. read_timeout_usec_ = usec;
  10256. }
  10257. // Buffer stream implementation
  10258. inline bool BufferStream::is_readable() const { return true; }
  10259. inline bool BufferStream::wait_readable() const { return true; }
  10260. inline bool BufferStream::wait_writable() const { return true; }
  10261. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10262. #if defined(_MSC_VER) && _MSC_VER < 1910
  10263. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10264. #else
  10265. auto len_read = buffer.copy(ptr, size, position);
  10266. #endif
  10267. position += static_cast<size_t>(len_read);
  10268. return static_cast<ssize_t>(len_read);
  10269. }
  10270. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10271. buffer.append(ptr, size);
  10272. return static_cast<ssize_t>(size);
  10273. }
  10274. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10275. int & /*port*/) const {}
  10276. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10277. int & /*port*/) const {}
  10278. inline socket_t BufferStream::socket() const { return 0; }
  10279. inline time_t BufferStream::duration() const { return 0; }
  10280. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10281. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10282. : MatcherBase(pattern) {
  10283. constexpr const char marker[] = "/:";
  10284. // One past the last ending position of a path param substring
  10285. std::size_t last_param_end = 0;
  10286. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10287. // Needed to ensure that parameter names are unique during matcher
  10288. // construction
  10289. // If exceptions are disabled, only last duplicate path
  10290. // parameter will be set
  10291. std::unordered_set<std::string> param_name_set;
  10292. #endif
  10293. while (true) {
  10294. const auto marker_pos = pattern.find(
  10295. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10296. if (marker_pos == std::string::npos) { break; }
  10297. static_fragments_.push_back(
  10298. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10299. const auto param_name_start = marker_pos + str_len(marker);
  10300. auto sep_pos = pattern.find(separator, param_name_start);
  10301. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10302. auto param_name =
  10303. pattern.substr(param_name_start, sep_pos - param_name_start);
  10304. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10305. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10306. std::string msg = "Encountered path parameter '" + param_name +
  10307. "' multiple times in route pattern '" + pattern + "'.";
  10308. throw std::invalid_argument(msg);
  10309. }
  10310. #endif
  10311. param_names_.push_back(std::move(param_name));
  10312. last_param_end = sep_pos + 1;
  10313. }
  10314. if (last_param_end < pattern.length()) {
  10315. static_fragments_.push_back(pattern.substr(last_param_end));
  10316. }
  10317. }
  10318. inline bool PathParamsMatcher::match(Request &request) const {
  10319. request.matches = std::smatch();
  10320. request.path_params.clear();
  10321. // A pattern without parameters is just a literal path to compare against
  10322. if (param_names_.empty()) { return request.path == pattern(); }
  10323. request.path_params.reserve(param_names_.size());
  10324. // One past the position at which the path matched the pattern last time
  10325. std::size_t starting_pos = 0;
  10326. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10327. const auto &fragment = static_fragments_[i];
  10328. if (starting_pos + fragment.length() > request.path.length()) {
  10329. return false;
  10330. }
  10331. // Avoid unnecessary allocation by using strncmp instead of substr +
  10332. // comparison
  10333. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10334. fragment.length()) != 0) {
  10335. return false;
  10336. }
  10337. starting_pos += fragment.length();
  10338. // Should only happen when we have a static fragment after a param
  10339. // Example: '/users/:id/subscriptions'
  10340. // The 'subscriptions' fragment here does not have a corresponding param
  10341. if (i >= param_names_.size()) { continue; }
  10342. auto sep_pos = request.path.find(separator, starting_pos);
  10343. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10344. const auto &param_name = param_names_[i];
  10345. request.path_params.emplace(
  10346. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10347. // Mark everything up to '/' as matched
  10348. starting_pos = sep_pos + 1;
  10349. }
  10350. // Returns false if the path is longer than the pattern
  10351. return starting_pos >= request.path.length();
  10352. }
  10353. inline bool RegexMatcher::match(Request &request) const {
  10354. request.path_params.clear();
  10355. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10356. // a non-match rather than risking a stack overflow in std::regex_match.
  10357. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10358. return false;
  10359. }
  10360. return std::regex_match(request.path, request.matches, regex_);
  10361. }
  10362. // Enclose IPv6 address in brackets if needed
  10363. inline std::string prepare_host_string(const std::string &host) {
  10364. // Enclose IPv6 address in brackets (but not if already enclosed)
  10365. if (host.find(':') == std::string::npos ||
  10366. (!host.empty() && host[0] == '[')) {
  10367. // IPv4, hostname, or already bracketed IPv6
  10368. return host;
  10369. } else {
  10370. // IPv6 address without brackets
  10371. return "[" + host + "]";
  10372. }
  10373. }
  10374. inline std::string make_host_and_port_string(const std::string &host, int port,
  10375. bool is_ssl) {
  10376. auto result = prepare_host_string(host);
  10377. // Append port if not default
  10378. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10379. ; // do nothing
  10380. } else {
  10381. result += ":" + std::to_string(port);
  10382. }
  10383. return result;
  10384. }
  10385. // Create "host:port" string always including port number (for CONNECT method)
  10386. inline std::string
  10387. make_host_and_port_string_always_port(const std::string &host, int port) {
  10388. return prepare_host_string(host) + ":" + std::to_string(port);
  10389. }
  10390. // Value for the Host header a client sends when the caller supplied none.
  10391. // Only the value: callers decide where in their header list it goes.
  10392. inline std::string make_default_host_header_value(const std::string &host,
  10393. int port, bool is_ssl,
  10394. int address_family) {
  10395. if (address_family == AF_UNIX) { return "localhost"; }
  10396. return make_host_and_port_string(host, port, is_ssl);
  10397. }
  10398. inline void add_default_user_agent_header(Request &req) {
  10399. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10400. if (!req.has_header("User-Agent")) {
  10401. req.set_header("User-Agent",
  10402. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10403. }
  10404. #else
  10405. (void)req;
  10406. #endif
  10407. }
  10408. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10409. NormalizedTarget normalize_target(const std::string &host);
  10410. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10411. bool host_matches_no_proxy(const NormalizedTarget &target,
  10412. const std::vector<NoProxyEntry> &entries);
  10413. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10414. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10415. if (prefix_bits == 0) { return true; }
  10416. int full_bytes = prefix_bits / 8;
  10417. int rem_bits = prefix_bits % 8;
  10418. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10419. static_cast<size_t>(full_bytes)) != 0) {
  10420. return false;
  10421. }
  10422. if (rem_bits == 0) { return true; }
  10423. auto i = static_cast<size_t>(full_bytes);
  10424. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10425. return (ip[i] & mask) == (net[i] & mask);
  10426. }
  10427. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10428. if (token.empty()) { return false; }
  10429. if (token == "*") {
  10430. out.kind = NoProxyKind::Wildcard;
  10431. return true;
  10432. }
  10433. auto slash = token.find('/');
  10434. std::string addr_part =
  10435. (slash == std::string::npos) ? token : token.substr(0, slash);
  10436. std::string prefix_part =
  10437. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10438. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10439. // don't silently treat it as a /32 (or /128).
  10440. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10441. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10442. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10443. // when brackets are present.
  10444. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10445. addr_part.back() == ']';
  10446. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10447. if (!bracketed) {
  10448. struct in_addr v4;
  10449. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10450. int prefix = 32;
  10451. if (!prefix_part.empty()) {
  10452. auto r = from_chars(prefix_part.data(),
  10453. prefix_part.data() + prefix_part.size(), prefix);
  10454. if (r.ec != std::errc{} ||
  10455. r.ptr != prefix_part.data() + prefix_part.size()) {
  10456. return false;
  10457. }
  10458. if (prefix < 0 || prefix > 32) { return false; }
  10459. }
  10460. out.kind = NoProxyKind::IPv4Cidr;
  10461. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10462. out.prefix_bits = prefix;
  10463. return true;
  10464. }
  10465. }
  10466. struct in6_addr v6;
  10467. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10468. int prefix = 128;
  10469. if (!prefix_part.empty()) {
  10470. auto r = from_chars(prefix_part.data(),
  10471. prefix_part.data() + prefix_part.size(), prefix);
  10472. if (r.ec != std::errc{} ||
  10473. r.ptr != prefix_part.data() + prefix_part.size()) {
  10474. return false;
  10475. }
  10476. if (prefix < 0 || prefix > 128) { return false; }
  10477. }
  10478. out.kind = NoProxyKind::IPv6Cidr;
  10479. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10480. out.prefix_bits = prefix;
  10481. return true;
  10482. }
  10483. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10484. // the entry is malformed — don't fall through to the hostname branch.
  10485. if (bracketed) { return false; }
  10486. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10487. if (slash != std::string::npos) { return false; }
  10488. // Port-specific entries (host:port) are not supported.
  10489. if (token.find(':') != std::string::npos) { return false; }
  10490. std::string hostname = case_ignore::to_lower(token);
  10491. while (!hostname.empty() && hostname.front() == '.') {
  10492. hostname.erase(hostname.begin());
  10493. }
  10494. while (!hostname.empty() && hostname.back() == '.') {
  10495. hostname.pop_back();
  10496. }
  10497. if (hostname.empty()) { return false; }
  10498. out.kind = NoProxyKind::HostnameSuffix;
  10499. out.hostname_pattern = std::move(hostname);
  10500. return true;
  10501. }
  10502. inline NormalizedTarget normalize_target(const std::string &host) {
  10503. NormalizedTarget t;
  10504. std::string h = host;
  10505. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10506. h = h.substr(1, h.size() - 2);
  10507. }
  10508. // Strip a single trailing dot so "example.com." canonicalizes to
  10509. // "example.com".
  10510. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10511. t.hostname = case_ignore::to_lower(h);
  10512. if (!t.hostname.empty()) {
  10513. struct in_addr v4;
  10514. struct in6_addr v6;
  10515. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10516. t.is_ipv4 = true;
  10517. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10518. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10519. t.is_ipv6 = true;
  10520. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10521. }
  10522. }
  10523. return t;
  10524. }
  10525. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10526. const std::vector<NoProxyEntry> &entries) {
  10527. if (target.hostname.empty()) { return false; }
  10528. for (const auto &e : entries) {
  10529. switch (e.kind) {
  10530. case NoProxyKind::Wildcard: return true;
  10531. case NoProxyKind::IPv4Cidr:
  10532. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10533. return true;
  10534. }
  10535. break;
  10536. case NoProxyKind::IPv6Cidr:
  10537. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10538. return true;
  10539. }
  10540. break;
  10541. case NoProxyKind::HostnameSuffix:
  10542. if (target.is_ipv4 || target.is_ipv6) { break; }
  10543. if (target.hostname == e.hostname_pattern) { return true; }
  10544. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10545. // an entry of "example.com".
  10546. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10547. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10548. if (target.hostname[offset - 1] == '.' &&
  10549. target.hostname.compare(offset, e.hostname_pattern.size(),
  10550. e.hostname_pattern) == 0) {
  10551. return true;
  10552. }
  10553. }
  10554. break;
  10555. }
  10556. }
  10557. return false;
  10558. }
  10559. template <typename T>
  10560. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10561. T header_writer, Error &error) {
  10562. for (const auto &h : headers) {
  10563. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10564. error = Error::InvalidHeaders;
  10565. return false;
  10566. }
  10567. }
  10568. if (header_writer(strm, headers) <= 0) {
  10569. error = Error::Write;
  10570. return false;
  10571. }
  10572. return true;
  10573. }
  10574. } // namespace detail
  10575. /*
  10576. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10577. */
  10578. #ifdef CPPHTTPLIB_SSL_ENABLED
  10579. namespace detail {
  10580. // SSL socket stream implementation
  10581. inline SSLSocketStream::SSLSocketStream(
  10582. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10583. time_t read_timeout_usec, time_t write_timeout_sec,
  10584. time_t write_timeout_usec, time_t max_timeout_msec,
  10585. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10586. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10587. read_timeout_usec_(read_timeout_usec),
  10588. write_timeout_sec_(write_timeout_sec),
  10589. write_timeout_usec_(write_timeout_usec),
  10590. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10591. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10592. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10593. // Note: create_session() also clears this, but SSLClient currently
  10594. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10595. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10596. // SSL session was created.
  10597. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10598. #endif
  10599. }
  10600. inline SSLSocketStream::~SSLSocketStream() = default;
  10601. inline bool SSLSocketStream::is_readable() const {
  10602. return tls::pending(session_) > 0;
  10603. }
  10604. inline bool SSLSocketStream::wait_readable() const {
  10605. if (max_timeout_msec_ <= 0) {
  10606. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10607. }
  10608. time_t read_timeout_sec;
  10609. time_t read_timeout_usec;
  10610. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10611. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10612. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10613. }
  10614. inline bool SSLSocketStream::wait_writable() const {
  10615. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10616. !tls::is_peer_closed(session_, sock_);
  10617. }
  10618. inline bool SSLSocketStream::ensure_readable() {
  10619. if (readable_hint_) {
  10620. readable_hint_ = false;
  10621. return true;
  10622. }
  10623. return wait_readable();
  10624. }
  10625. inline bool SSLSocketStream::is_peer_alive() const {
  10626. return !tls::is_peer_closed(session_, sock_);
  10627. }
  10628. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10629. if (tls::pending(session_) > 0) {
  10630. tls::TlsError err;
  10631. auto ret = tls::read(session_, ptr, size, err);
  10632. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10633. error_ = Error::ConnectionClosed;
  10634. }
  10635. return ret;
  10636. } else if (ensure_readable()) {
  10637. tls::TlsError err;
  10638. auto ret = tls::read(session_, ptr, size, err);
  10639. if (ret < 0) {
  10640. auto n = 1000;
  10641. #ifdef _WIN32
  10642. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10643. (err.code == tls::ErrorCode::SyscallError &&
  10644. WSAGetLastError() == WSAETIMEDOUT))) {
  10645. #else
  10646. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10647. #endif
  10648. if (tls::pending(session_) > 0) {
  10649. return tls::read(session_, ptr, size, err);
  10650. } else if (wait_readable()) {
  10651. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10652. ret = tls::read(session_, ptr, size, err);
  10653. if (ret >= 0) { return ret; }
  10654. } else {
  10655. break;
  10656. }
  10657. }
  10658. assert(ret < 0);
  10659. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10660. error_ = Error::ConnectionClosed;
  10661. }
  10662. return ret;
  10663. } else {
  10664. error_ = Error::Timeout;
  10665. return -1;
  10666. }
  10667. }
  10668. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10669. if (wait_writable()) {
  10670. auto handle_size =
  10671. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10672. tls::TlsError err;
  10673. auto ret = tls::write(session_, ptr, handle_size, err);
  10674. if (ret < 0) {
  10675. auto n = 1000;
  10676. #ifdef _WIN32
  10677. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10678. (err.code == tls::ErrorCode::SyscallError &&
  10679. WSAGetLastError() == WSAETIMEDOUT))) {
  10680. #else
  10681. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10682. #endif
  10683. if (wait_writable()) {
  10684. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10685. ret = tls::write(session_, ptr, handle_size, err);
  10686. if (ret >= 0) { return ret; }
  10687. } else {
  10688. break;
  10689. }
  10690. }
  10691. assert(ret < 0);
  10692. }
  10693. return ret;
  10694. }
  10695. return -1;
  10696. }
  10697. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10698. int &port) const {
  10699. detail::get_remote_ip_and_port(sock_, ip, port);
  10700. }
  10701. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10702. int &port) const {
  10703. detail::get_local_ip_and_port(sock_, ip, port);
  10704. }
  10705. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10706. inline time_t SSLSocketStream::duration() const {
  10707. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10708. std::chrono::steady_clock::now() - start_time_)
  10709. .count();
  10710. }
  10711. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10712. read_timeout_sec_ = sec;
  10713. read_timeout_usec_ = usec;
  10714. }
  10715. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10716. tls::session_t session,
  10717. time_t read_timeout_sec,
  10718. time_t read_timeout_usec,
  10719. time_t write_timeout_sec,
  10720. time_t write_timeout_usec)
  10721. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10722. read_timeout_usec_(read_timeout_usec),
  10723. write_timeout_sec_(write_timeout_sec),
  10724. write_timeout_usec_(write_timeout_usec),
  10725. start_time_(std::chrono::steady_clock::now()) {
  10726. // The receive and send paths run on different threads, so each TLS call is
  10727. // driven in non-blocking mode and readiness is awaited with select()
  10728. // outside the session lock. Set the socket non-blocking once here; it is
  10729. // never flipped back, so no thread races on the flag.
  10730. detail::set_nonblocking(sock_, true);
  10731. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10732. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10733. #endif
  10734. }
  10735. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10736. inline bool WebSocketSSLStream::is_readable() const {
  10737. std::lock_guard<std::mutex> guard(session_mutex_);
  10738. return tls::pending(session_) > 0;
  10739. }
  10740. inline bool WebSocketSSLStream::wait_readable() const {
  10741. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10742. }
  10743. inline bool WebSocketSSLStream::wait_writable() const {
  10744. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10745. // that probe toggles the socket's blocking flag, which would race with the
  10746. // concurrent reader on a permanently non-blocking socket.
  10747. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10748. }
  10749. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10750. tls::TlsError err;
  10751. auto n = 1000;
  10752. while (--n >= 0) {
  10753. {
  10754. std::lock_guard<std::mutex> guard(session_mutex_);
  10755. auto ret = tls::read(session_, ptr, size, err);
  10756. if (ret > 0) { return ret; }
  10757. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10758. error_ = Error::ConnectionClosed;
  10759. return ret;
  10760. }
  10761. }
  10762. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10763. // direction: the send path shares this session, so output it left pending
  10764. // has to be flushed before more input can be decrypted. Anything else is
  10765. // a hard error.
  10766. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10767. #ifdef _WIN32
  10768. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10769. needs_readable =
  10770. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10771. WSAGetLastError() == WSAETIMEDOUT);
  10772. #endif
  10773. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10774. error_ = Error::Read;
  10775. return -1;
  10776. }
  10777. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10778. error_ = Error::Timeout;
  10779. return -1;
  10780. }
  10781. }
  10782. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10783. // to tell a timeout from a close would otherwise see whatever the previous
  10784. // failure left behind (error_ is never cleared on success).
  10785. error_ = Error::Read;
  10786. return -1;
  10787. }
  10788. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10789. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10790. tls::TlsError err;
  10791. auto n = 1000;
  10792. while (--n >= 0) {
  10793. {
  10794. std::lock_guard<std::mutex> guard(session_mutex_);
  10795. auto ret = tls::write(session_, ptr, handle_size, err);
  10796. if (ret >= 0) { return ret; }
  10797. }
  10798. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10799. // or a post-handshake message must be consumed before the record goes
  10800. // out. Anything else is a hard error.
  10801. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10802. #ifdef _WIN32
  10803. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10804. needs_writable =
  10805. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10806. WSAGetLastError() == WSAETIMEDOUT);
  10807. #endif
  10808. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10809. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10810. }
  10811. return -1;
  10812. }
  10813. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10814. int &port) const {
  10815. detail::get_remote_ip_and_port(sock_, ip, port);
  10816. }
  10817. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10818. int &port) const {
  10819. detail::get_local_ip_and_port(sock_, ip, port);
  10820. }
  10821. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10822. inline time_t WebSocketSSLStream::duration() const {
  10823. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10824. std::chrono::steady_clock::now() - start_time_)
  10825. .count();
  10826. }
  10827. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10828. read_timeout_sec_ = sec;
  10829. read_timeout_usec_ = usec;
  10830. }
  10831. } // namespace detail
  10832. #endif // CPPHTTPLIB_SSL_ENABLED
  10833. /*
  10834. * Group 4: Server implementation
  10835. */
  10836. // HTTP server implementation
  10837. inline Server::Server()
  10838. : new_task_queue([] {
  10839. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10840. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10841. }) {
  10842. #ifndef _WIN32
  10843. signal(SIGPIPE, SIG_IGN);
  10844. #endif
  10845. }
  10846. inline Server::~Server() = default;
  10847. inline std::unique_ptr<detail::MatcherBase>
  10848. Server::make_matcher(const std::string &pattern) {
  10849. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10850. // a path params pattern
  10851. if (pattern.find("/:") != std::string::npos) {
  10852. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10853. }
  10854. // A pattern with no regex metacharacter only has to be compared literally,
  10855. // which is what PathParamsMatcher already does when it captures no
  10856. // parameter, so std::regex is only worth building for the patterns that
  10857. // actually need it
  10858. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10859. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10860. }
  10861. return detail::make_unique<detail::RegexMatcher>(pattern);
  10862. }
  10863. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10864. return add_handler(get_handlers_, pattern, std::move(handler));
  10865. }
  10866. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10867. return add_handler(post_handlers_, pattern, std::move(handler));
  10868. }
  10869. inline Server &Server::Post(const std::string &pattern,
  10870. HandlerWithContentReader handler) {
  10871. return add_handler(post_handlers_for_content_reader_, pattern,
  10872. std::move(handler));
  10873. }
  10874. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10875. return add_handler(put_handlers_, pattern, std::move(handler));
  10876. }
  10877. inline Server &Server::Put(const std::string &pattern,
  10878. HandlerWithContentReader handler) {
  10879. return add_handler(put_handlers_for_content_reader_, pattern,
  10880. std::move(handler));
  10881. }
  10882. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10883. return add_handler(patch_handlers_, pattern, std::move(handler));
  10884. }
  10885. inline Server &Server::Patch(const std::string &pattern,
  10886. HandlerWithContentReader handler) {
  10887. return add_handler(patch_handlers_for_content_reader_, pattern,
  10888. std::move(handler));
  10889. }
  10890. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10891. return add_handler(delete_handlers_, pattern, std::move(handler));
  10892. }
  10893. inline Server &Server::Delete(const std::string &pattern,
  10894. HandlerWithContentReader handler) {
  10895. return add_handler(delete_handlers_for_content_reader_, pattern,
  10896. std::move(handler));
  10897. }
  10898. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10899. return add_handler(options_handlers_, pattern, std::move(handler));
  10900. }
  10901. inline const std::set<std::string> &Server::builtin_methods() {
  10902. thread_local const std::set<std::string> methods{
  10903. "GET", "HEAD", "POST", "PUT", "DELETE",
  10904. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10905. return methods;
  10906. }
  10907. inline Server::CustomHandlerEntry *
  10908. Server::custom_entry_for_registration(const std::string &method) {
  10909. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10910. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10911. // routing() before the custom tables are consulted, so a route registered
  10912. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10913. // there and would be reachable, but they carry protocol-level meaning
  10914. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10915. // library does not route.
  10916. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10917. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10918. has_invalid_registration_ = true;
  10919. return nullptr;
  10920. }
  10921. return &custom_handlers_[method];
  10922. }
  10923. inline Server &Server::CustomRoute(const std::string &method,
  10924. const std::string &pattern,
  10925. Handler handler) {
  10926. auto *entry = custom_entry_for_registration(method);
  10927. if (!entry) { return *this; }
  10928. return add_handler(entry->handlers, pattern, std::move(handler));
  10929. }
  10930. inline Server &Server::CustomRoute(const std::string &method,
  10931. const std::string &pattern,
  10932. HandlerWithContentReader handler) {
  10933. auto *entry = custom_entry_for_registration(method);
  10934. if (!entry) { return *this; }
  10935. return add_handler(entry->handlers_for_content_reader, pattern,
  10936. std::move(handler));
  10937. }
  10938. inline const Server::CustomHandlerEntry *
  10939. Server::find_custom_entry(const std::string &method) const {
  10940. // find() alone would be correct here. The empty() check is what keeps the
  10941. // per-request cost off servers that never call CustomRoute(), which is the
  10942. // overwhelmingly common case; keep it rather than walking into the tree.
  10943. if (custom_handlers_.empty()) { return nullptr; }
  10944. auto it = custom_handlers_.find(method);
  10945. return it == custom_handlers_.end() ? nullptr : &it->second;
  10946. }
  10947. inline Server &Server::WebSocket(const std::string &pattern,
  10948. WebSocketHandler handler) {
  10949. websocket_handlers_.push_back(
  10950. {make_matcher(pattern), std::move(handler), nullptr});
  10951. return *this;
  10952. }
  10953. inline Server &Server::WebSocket(const std::string &pattern,
  10954. WebSocketHandler handler,
  10955. SubProtocolSelector sub_protocol_selector) {
  10956. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10957. std::move(sub_protocol_selector)});
  10958. return *this;
  10959. }
  10960. inline bool Server::set_base_dir(const std::string &dir,
  10961. const std::string &mount_point) {
  10962. return set_mount_point(mount_point, dir);
  10963. }
  10964. inline bool Server::set_mount_point(const std::string &mount_point,
  10965. const std::string &dir, Headers headers) {
  10966. detail::FileStat stat(dir);
  10967. if (stat.is_dir()) {
  10968. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10969. if (!mnt.empty() && mnt[0] == '/') {
  10970. std::string resolved_base;
  10971. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10972. #if defined(_WIN32)
  10973. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10974. resolved_base += '\\';
  10975. }
  10976. #else
  10977. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10978. #endif
  10979. }
  10980. base_dirs_.push_back(
  10981. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10982. return true;
  10983. }
  10984. }
  10985. return false;
  10986. }
  10987. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10988. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10989. if (it->mount_point == mount_point) {
  10990. base_dirs_.erase(it);
  10991. return true;
  10992. }
  10993. }
  10994. return false;
  10995. }
  10996. inline Server &
  10997. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10998. const std::string &mime) {
  10999. file_extension_and_mimetype_map_[ext] = mime;
  11000. return *this;
  11001. }
  11002. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  11003. default_file_mimetype_ = mime;
  11004. return *this;
  11005. }
  11006. inline Server &Server::set_file_request_handler(Handler handler) {
  11007. file_request_handler_ = std::move(handler);
  11008. return *this;
  11009. }
  11010. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  11011. std::true_type) {
  11012. error_handler_ = std::move(handler);
  11013. return *this;
  11014. }
  11015. inline Server &Server::set_error_handler_core(Handler handler,
  11016. std::false_type) {
  11017. error_handler_ = [handler](const Request &req, Response &res) {
  11018. handler(req, res);
  11019. return HandlerResponse::Handled;
  11020. };
  11021. return *this;
  11022. }
  11023. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  11024. exception_handler_ = std::move(handler);
  11025. return *this;
  11026. }
  11027. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  11028. pre_routing_handler_ = std::move(handler);
  11029. return *this;
  11030. }
  11031. inline Server &Server::set_post_routing_handler(Handler handler) {
  11032. post_routing_handler_ = std::move(handler);
  11033. return *this;
  11034. }
  11035. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  11036. pre_request_handler_ = std::move(handler);
  11037. return *this;
  11038. }
  11039. inline Server &Server::set_logger(Logger logger) {
  11040. logger_ = std::move(logger);
  11041. return *this;
  11042. }
  11043. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11044. error_logger_ = std::move(error_logger);
  11045. return *this;
  11046. }
  11047. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11048. pre_compression_logger_ = std::move(logger);
  11049. return *this;
  11050. }
  11051. inline Server &
  11052. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11053. expect_100_continue_handler_ = std::move(handler);
  11054. return *this;
  11055. }
  11056. inline Server &Server::set_start_handler(StartHandler handler) {
  11057. start_handler_ = std::move(handler);
  11058. return *this;
  11059. }
  11060. inline Server &Server::set_address_family(int family) {
  11061. address_family_ = family;
  11062. return *this;
  11063. }
  11064. inline Server &Server::set_tcp_nodelay(bool on) {
  11065. tcp_nodelay_ = on;
  11066. return *this;
  11067. }
  11068. inline Server &Server::set_ipv6_v6only(bool on) {
  11069. ipv6_v6only_ = on;
  11070. return *this;
  11071. }
  11072. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11073. socket_options_ = std::move(socket_options);
  11074. return *this;
  11075. }
  11076. inline Server &Server::set_default_headers(Headers headers) {
  11077. default_headers_ = std::move(headers);
  11078. return *this;
  11079. }
  11080. inline Server &Server::set_header_writer(
  11081. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11082. header_writer_ = writer;
  11083. return *this;
  11084. }
  11085. inline Server &
  11086. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11087. trusted_proxies_ = proxies;
  11088. return *this;
  11089. }
  11090. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11091. keep_alive_max_count_ = count;
  11092. return *this;
  11093. }
  11094. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11095. keep_alive_timeout_sec_ = sec;
  11096. return *this;
  11097. }
  11098. template <class Rep, class Period>
  11099. inline Server &Server::set_keep_alive_timeout(
  11100. const std::chrono::duration<Rep, Period> &duration) {
  11101. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11102. set_keep_alive_timeout(sec);
  11103. });
  11104. return *this;
  11105. }
  11106. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11107. read_timeout_sec_ = sec;
  11108. read_timeout_usec_ = usec;
  11109. return *this;
  11110. }
  11111. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11112. write_timeout_sec_ = sec;
  11113. write_timeout_usec_ = usec;
  11114. return *this;
  11115. }
  11116. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11117. idle_interval_sec_ = sec;
  11118. idle_interval_usec_ = usec;
  11119. return *this;
  11120. }
  11121. inline Server &Server::set_payload_max_length(size_t length) {
  11122. payload_max_length_ = length;
  11123. return *this;
  11124. }
  11125. inline Server &Server::set_static_file_compression(bool on) {
  11126. static_file_compression_ = on;
  11127. return *this;
  11128. }
  11129. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11130. static_file_compression_min_length_ = length;
  11131. return *this;
  11132. }
  11133. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11134. static_file_compression_max_length_ = length;
  11135. return *this;
  11136. }
  11137. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11138. websocket_max_missed_pongs_ = count;
  11139. return *this;
  11140. }
  11141. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11142. websocket_ping_interval_sec_ = sec;
  11143. return *this;
  11144. }
  11145. template <class Rep, class Period>
  11146. inline Server &Server::set_websocket_ping_interval(
  11147. const std::chrono::duration<Rep, Period> &duration) {
  11148. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11149. set_websocket_ping_interval(sec);
  11150. });
  11151. return *this;
  11152. }
  11153. inline bool Server::bind_to_port(const std::string &host, int port,
  11154. int socket_flags) {
  11155. auto ret = bind_internal(host, port, socket_flags);
  11156. if (ret == -1) { is_decommissioned = true; }
  11157. return ret >= 0;
  11158. }
  11159. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11160. auto ret = bind_internal(host, 0, socket_flags);
  11161. if (ret == -1) { is_decommissioned = true; }
  11162. return ret;
  11163. }
  11164. inline bool Server::listen_after_bind() { return listen_internal(); }
  11165. inline bool Server::listen(const std::string &host, int port,
  11166. int socket_flags) {
  11167. return bind_to_port(host, port, socket_flags) && listen_internal();
  11168. }
  11169. inline bool Server::is_running() const { return is_running_; }
  11170. inline void Server::wait_until_ready() const {
  11171. while (!is_running_ && !is_decommissioned) {
  11172. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11173. }
  11174. }
  11175. inline void Server::stop() noexcept {
  11176. // Release the listening socket whether or not the accept loop is running:
  11177. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11178. // exchange is what makes this safe to call concurrently with the accept loop.
  11179. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11180. if (sock != INVALID_SOCKET) {
  11181. detail::shutdown_socket(sock);
  11182. detail::close_socket(sock);
  11183. }
  11184. is_decommissioned = false;
  11185. }
  11186. inline void Server::decommission() { is_decommissioned = true; }
  11187. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11188. auto len = strlen(s);
  11189. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11190. len -= 2;
  11191. {
  11192. size_t count = 0;
  11193. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11194. switch (count) {
  11195. case 0: req.method = std::string(b, e); break;
  11196. case 1: req.target = std::string(b, e); break;
  11197. case 2: req.version = std::string(b, e); break;
  11198. default: break;
  11199. }
  11200. count++;
  11201. });
  11202. if (count != 3) { return false; }
  11203. }
  11204. // A method outside the built-in set is accepted only when a handler has been
  11205. // registered for it with CustomRoute().
  11206. const auto &methods = builtin_methods();
  11207. if (methods.find(req.method) == methods.end() &&
  11208. !find_custom_entry(req.method)) {
  11209. output_error_log(Error::InvalidHTTPMethod, &req);
  11210. return false;
  11211. }
  11212. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11213. output_error_log(Error::InvalidHTTPVersion, &req);
  11214. return false;
  11215. }
  11216. {
  11217. // Skip URL fragment
  11218. for (size_t i = 0; i < req.target.size(); i++) {
  11219. if (req.target[i] == '#') {
  11220. req.target.erase(i);
  11221. break;
  11222. }
  11223. }
  11224. detail::divide(req.target, '?',
  11225. [&](const char *lhs_data, std::size_t lhs_size,
  11226. const char *rhs_data, std::size_t rhs_size) {
  11227. req.path =
  11228. decode_path_component(std::string(lhs_data, lhs_size));
  11229. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11230. });
  11231. }
  11232. return true;
  11233. }
  11234. inline bool Server::write_response(Stream &strm, bool close_connection,
  11235. Request &req, Response &res) {
  11236. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11237. // incorrectly to the error content.
  11238. req.ranges.clear();
  11239. return write_response_core(strm, close_connection, req, res, false);
  11240. }
  11241. inline bool Server::write_response_with_content(Stream &strm,
  11242. bool close_connection,
  11243. const Request &req,
  11244. Response &res) {
  11245. return write_response_core(strm, close_connection, req, res, true);
  11246. }
  11247. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11248. const Request &req, Response &res,
  11249. bool need_apply_ranges) {
  11250. assert(res.status != -1);
  11251. if (400 <= res.status && error_handler_ &&
  11252. error_handler_(req, res) == HandlerResponse::Handled) {
  11253. need_apply_ranges = true;
  11254. }
  11255. std::string content_type;
  11256. std::string boundary;
  11257. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11258. // Prepare additional headers
  11259. if (close_connection ||
  11260. detail::has_header_token(req.headers, "Connection", "close") ||
  11261. 400 <= res.status || // Don't leave connections open after errors
  11262. // The client withholds the body until `100 Continue`, which was never
  11263. // sent, so whether and when the body follows is unknown.
  11264. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11265. res.set_header("Connection", "close");
  11266. } else {
  11267. std::string s = "timeout=";
  11268. s += std::to_string(keep_alive_timeout_sec_);
  11269. s += ", max=";
  11270. s += std::to_string(keep_alive_max_count_);
  11271. res.set_header("Keep-Alive", s);
  11272. }
  11273. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11274. !res.has_header("Content-Type")) {
  11275. res.set_header("Content-Type", "text/plain");
  11276. }
  11277. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11278. !res.has_header("Content-Length")) {
  11279. res.set_header("Content-Length", "0");
  11280. }
  11281. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11282. res.set_header("Accept-Ranges", "bytes");
  11283. }
  11284. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11285. // Response line and headers
  11286. detail::BufferStream bstrm;
  11287. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11288. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11289. // Combine a small body with the headers so the whole response leaves in a
  11290. // single write. A large body is written on its own instead: a copy of it
  11291. // costs more than the extra write saves.
  11292. auto send_body = req.method != "HEAD";
  11293. auto body_is_separate = false;
  11294. auto provider_done = false;
  11295. if (send_body && !res.body.empty() && !res.content_provider_) {
  11296. if (res.body.size() < CPPHTTPLIB_SEND_BUFSIZ) {
  11297. bstrm.write(res.body.data(), res.body.size());
  11298. } else {
  11299. body_is_separate = true;
  11300. }
  11301. } else if (send_body && res.content_provider_ &&
  11302. res.is_file_content_provider_ &&
  11303. res.content_length_ < CPPHTTPLIB_SEND_BUFSIZ) {
  11304. // A small file is read into the same buffer. Other providers may produce
  11305. // their data over time, so they are never held back.
  11306. if (!write_content_with_provider(bstrm, req, res, boundary, content_type)) {
  11307. return false;
  11308. }
  11309. provider_done = true;
  11310. }
  11311. // Log before writing to avoid race condition with client-side code that
  11312. // accesses logger-captured data immediately after receiving the response.
  11313. output_log(req, res);
  11314. // Flush buffer
  11315. auto &data = bstrm.get_buffer();
  11316. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11317. if (body_is_separate) {
  11318. return detail::write_data(strm, res.body.data(), res.body.size());
  11319. }
  11320. // Streaming body
  11321. if (send_body && res.content_provider_) {
  11322. if (!provider_done &&
  11323. !write_content_with_provider(strm, req, res, boundary, content_type)) {
  11324. return false;
  11325. }
  11326. res.content_provider_success_ = true;
  11327. }
  11328. return true;
  11329. }
  11330. inline bool
  11331. Server::write_content_with_provider(Stream &strm, const Request &req,
  11332. Response &res, const std::string &boundary,
  11333. const std::string &content_type) {
  11334. auto is_shutting_down = [this]() {
  11335. return this->svr_sock_ == INVALID_SOCKET;
  11336. };
  11337. if (res.content_length_ > 0) {
  11338. // Only a 206 response is served as a partial representation, matching the
  11339. // condition `apply_ranges()` used to decide the Content-Length and the
  11340. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11341. // only for a 2xx status, slicing under any other status would write a body
  11342. // that disagrees with the header already sent, from an unchecked offset.
  11343. auto is_partial =
  11344. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11345. if (!is_partial) {
  11346. return detail::write_content(strm, res.content_provider_, 0,
  11347. res.content_length_, is_shutting_down);
  11348. } else if (req.ranges.size() == 1) {
  11349. auto offset_and_length = detail::get_range_offset_and_length(
  11350. req.ranges[0], res.content_length_);
  11351. return detail::write_content(strm, res.content_provider_,
  11352. offset_and_length.first,
  11353. offset_and_length.second, is_shutting_down);
  11354. } else {
  11355. return detail::write_multipart_ranges_data(
  11356. strm, req, res, boundary, content_type, res.content_length_,
  11357. is_shutting_down);
  11358. }
  11359. } else {
  11360. if (res.is_chunked_content_provider_) {
  11361. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11362. // re-negotiating here would disagree with them, e.g. once a handler's
  11363. // own Content-Encoding header suppresses the negotiation.
  11364. auto compressor = detail::make_compressor(res.content_coding_);
  11365. if (!compressor) {
  11366. compressor = detail::make_unique<detail::nocompressor>();
  11367. }
  11368. return detail::write_content_chunked(strm, res.content_provider_,
  11369. is_shutting_down, *compressor);
  11370. } else {
  11371. return detail::write_content_without_length(strm, res.content_provider_,
  11372. is_shutting_down);
  11373. }
  11374. }
  11375. }
  11376. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11377. FormFields::iterator cur_field;
  11378. FormFiles::iterator cur_file;
  11379. auto is_text_field = false;
  11380. size_t count = 0;
  11381. if (read_content_core(
  11382. strm, req, res,
  11383. // Regular
  11384. [&](const char *buf, size_t n) {
  11385. // Prevent arithmetic overflow when checking sizes.
  11386. // Avoid computing (req.body.size() + n) directly because
  11387. // adding two unsigned `size_t` values can wrap around and
  11388. // produce a small result instead of indicating overflow.
  11389. // Instead, check using subtraction: ensure `n` does not
  11390. // exceed the remaining capacity `max_size() - size()`.
  11391. if (req.body.size() >= req.body.max_size() ||
  11392. n > req.body.max_size() - req.body.size()) {
  11393. return false;
  11394. }
  11395. // Limit decompressed body size to payload_max_length_ to protect
  11396. // against "zip bomb" attacks where a small compressed payload
  11397. // decompresses to a massive size.
  11398. if (payload_max_length_ > 0 &&
  11399. (req.body.size() >= payload_max_length_ ||
  11400. n > payload_max_length_ - req.body.size())) {
  11401. return false;
  11402. }
  11403. req.body.append(buf, n);
  11404. return true;
  11405. },
  11406. // Multipart FormData
  11407. [&](const FormData &file) {
  11408. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11409. output_error_log(Error::TooManyFormDataFiles, &req);
  11410. return false;
  11411. }
  11412. if (file.filename.empty()) {
  11413. cur_field = req.form.fields.emplace(
  11414. file.name, FormField{file.name, file.content, file.headers});
  11415. is_text_field = true;
  11416. } else {
  11417. cur_file = req.form.files.emplace(file.name, file);
  11418. is_text_field = false;
  11419. }
  11420. return true;
  11421. },
  11422. [&](const char *buf, size_t n) {
  11423. if (is_text_field) {
  11424. auto &content = cur_field->second.content;
  11425. if (content.size() + n > content.max_size()) { return false; }
  11426. content.append(buf, n);
  11427. } else {
  11428. auto &content = cur_file->second.content;
  11429. if (content.size() + n > content.max_size()) { return false; }
  11430. content.append(buf, n);
  11431. }
  11432. return true;
  11433. })) {
  11434. const auto &content_type = req.get_header_value("Content-Type");
  11435. if (detail::extract_media_type(content_type) ==
  11436. "application/x-www-form-urlencoded") {
  11437. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11438. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11439. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11440. return false;
  11441. }
  11442. detail::parse_query_text(req.body, req.params);
  11443. }
  11444. return true;
  11445. }
  11446. return false;
  11447. }
  11448. inline bool Server::read_content_with_content_receiver(
  11449. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11450. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11451. return read_content_core(strm, req, res, std::move(receiver),
  11452. std::move(multipart_header),
  11453. std::move(multipart_receiver));
  11454. }
  11455. inline bool Server::read_content_core(
  11456. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11457. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11458. detail::FormDataParser multipart_form_data_parser;
  11459. ContentReceiverWithProgress out;
  11460. if (req.is_multipart_form_data()) {
  11461. const auto &content_type = req.get_header_value("Content-Type");
  11462. std::string boundary;
  11463. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11464. res.status = StatusCode::BadRequest_400;
  11465. output_error_log(Error::MultipartParsing, &req);
  11466. return false;
  11467. }
  11468. multipart_form_data_parser.set_boundary(std::move(boundary));
  11469. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11470. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11471. multipart_receiver);
  11472. };
  11473. } else {
  11474. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11475. size_t /*len*/) { return receiver(buf, n); };
  11476. }
  11477. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11478. // For non-SSL builds we still scan non-persistent connections for stray
  11479. // body bytes so the payload limit is enforced (413). On keep-alive,
  11480. // pending bytes may be the next request (issue #2450), so skip.
  11481. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11482. if (!req.has_header("Content-Length") &&
  11483. !detail::is_chunked_transfer_encoding(req.headers)) {
  11484. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11485. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11486. auto has_data = strm.is_readable();
  11487. if (!has_data) {
  11488. auto s = strm.socket();
  11489. if (s != INVALID_SOCKET) {
  11490. has_data = detail::select_read(s, 0, 0) > 0;
  11491. }
  11492. }
  11493. if (has_data) {
  11494. // Route through the same decompressing reader used by the
  11495. // length-framed and chunked paths below, so payload_max_length_ is
  11496. // enforced on the decompressed size here too instead of only on the
  11497. // compressed wire bytes.
  11498. return detail::read_content(strm, req, payload_max_length_, res.status,
  11499. nullptr, out, true);
  11500. }
  11501. }
  11502. return true;
  11503. }
  11504. #else
  11505. if (!req.has_header("Content-Length") &&
  11506. !detail::is_chunked_transfer_encoding(req.headers)) {
  11507. return true;
  11508. }
  11509. #endif
  11510. // The client is waiting for this before it sends the body.
  11511. if (req.expect_100_continue_pending_) {
  11512. req.expect_100_continue_pending_ = false;
  11513. detail::write_response_line(strm, StatusCode::Continue_100);
  11514. strm.write("\r\n");
  11515. }
  11516. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11517. out, true)) {
  11518. return false;
  11519. }
  11520. req.body_consumed_ = true;
  11521. if (req.is_multipart_form_data()) {
  11522. if (!multipart_form_data_parser.is_valid()) {
  11523. res.status = StatusCode::BadRequest_400;
  11524. output_error_log(Error::MultipartParsing, &req);
  11525. return false;
  11526. }
  11527. }
  11528. return true;
  11529. }
  11530. inline bool Server::handle_file_request(Request &req, Response &res) {
  11531. for (const auto &entry : base_dirs_) {
  11532. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11533. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11534. // One that already ends in '/' (the root mount among them) carries its own
  11535. // boundary; set_mount_point() guarantees the mount point is not empty.
  11536. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11537. (entry.mount_point.back() == '/' ||
  11538. req.path.size() == entry.mount_point.size() ||
  11539. req.path[entry.mount_point.size()] == '/')) {
  11540. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11541. if (detail::is_valid_path(sub_path)) {
  11542. auto path = entry.base_dir + sub_path;
  11543. if (path.back() == '/') { path += "index.html"; }
  11544. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11545. // but symlinks/junctions can still escape the base directory.
  11546. if (!entry.resolved_base_dir.empty()) {
  11547. std::string resolved_path;
  11548. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11549. !detail::is_path_within_base(resolved_path,
  11550. entry.resolved_base_dir)) {
  11551. res.status = StatusCode::Forbidden_403;
  11552. return true;
  11553. }
  11554. }
  11555. detail::FileStat stat(path);
  11556. if (stat.is_dir()) {
  11557. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11558. return true;
  11559. }
  11560. if (stat.is_file()) {
  11561. for (const auto &kv : entry.headers) {
  11562. res.set_header(kv.first, kv.second);
  11563. }
  11564. auto content_type_of = [&]() {
  11565. return detail::find_content_type(
  11566. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11567. };
  11568. // Only the ETag needs the content type this early, and only to name
  11569. // the coding. Deciding it here would otherwise put a regex in front
  11570. // of the 304 below, which serving a file never used to pay for.
  11571. std::string content_type;
  11572. auto encoding = detail::EncodingType::None;
  11573. if (static_file_compression_) {
  11574. content_type = content_type_of();
  11575. encoding =
  11576. static_file_encoding(req, res, content_type, stat.size());
  11577. }
  11578. // The ETag names the representation actually sent, so a client that
  11579. // cached the compressed form revalidates against the compressed ETag
  11580. // and still gets a 304, while one that took identity keeps the plain
  11581. // ETag.
  11582. auto etag = detail::compute_etag(
  11583. stat, encoding == detail::EncodingType::None
  11584. ? std::string()
  11585. : std::string("-") + detail::encoding_name(encoding));
  11586. if (!etag.empty()) { res.set_header("ETag", etag); }
  11587. auto mtime = stat.mtime();
  11588. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11589. if (!last_modified.empty()) {
  11590. res.set_header("Last-Modified", last_modified);
  11591. }
  11592. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11593. check_if_range(req, etag, mtime);
  11594. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11595. if (!mm->is_open()) {
  11596. output_error_log(Error::OpenFile, &req);
  11597. return false;
  11598. }
  11599. if (!static_file_compression_) { content_type = content_type_of(); }
  11600. detail::set_file_content_provider(res, mm, content_type, encoding);
  11601. if (req.method != "HEAD" && file_request_handler_) {
  11602. file_request_handler_(req, res);
  11603. }
  11604. return true;
  11605. } else {
  11606. output_error_log(Error::OpenFile, &req);
  11607. }
  11608. }
  11609. }
  11610. }
  11611. return false;
  11612. }
  11613. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11614. const std::string &etag,
  11615. time_t mtime) const {
  11616. // Handle conditional GET:
  11617. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11618. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11619. if (req.has_header("If-None-Match")) {
  11620. if (!etag.empty()) {
  11621. auto val =
  11622. detail::get_combined_header_value(req.headers, "If-None-Match");
  11623. // NOTE: We use exact string matching here. This works correctly
  11624. // because our server always generates weak ETags (W/"..."), and
  11625. // clients typically send back the same ETag they received.
  11626. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11627. // If-None-Match, where W/"x" and "x" would match, but this
  11628. // simplified implementation requires exact matches.
  11629. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11630. [&](const char *b, const char *e) {
  11631. auto seg_len = static_cast<size_t>(e - b);
  11632. return (seg_len == 1 && *b == '*') ||
  11633. (seg_len == etag.size() &&
  11634. std::equal(b, e, etag.begin()));
  11635. });
  11636. if (ret) {
  11637. res.status = StatusCode::NotModified_304;
  11638. return true;
  11639. }
  11640. }
  11641. } else if (req.has_header("If-Modified-Since")) {
  11642. auto val = req.get_header_value("If-Modified-Since");
  11643. auto t = detail::parse_http_date(val);
  11644. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11645. res.status = StatusCode::NotModified_304;
  11646. return true;
  11647. }
  11648. }
  11649. return false;
  11650. }
  11651. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11652. time_t mtime) const {
  11653. // Handle If-Range for partial content requests (RFC 9110
  11654. // Section 13.1.5). If-Range is only evaluated when Range header is
  11655. // present. If the validator matches, serve partial content; otherwise
  11656. // serve full content.
  11657. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11658. auto val = req.get_header_value("If-Range");
  11659. auto is_valid_range = [&]() {
  11660. if (detail::is_strong_etag(val)) {
  11661. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11662. // comparison.
  11663. return (!etag.empty() && val == etag);
  11664. } else if (detail::is_weak_etag(val)) {
  11665. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11666. return false;
  11667. } else {
  11668. // HTTP-date comparison
  11669. auto t = detail::parse_http_date(val);
  11670. return (t != static_cast<time_t>(-1) && mtime <= t);
  11671. }
  11672. };
  11673. if (!is_valid_range()) {
  11674. // Validator doesn't match: ignore Range and serve full content
  11675. req.ranges.clear();
  11676. return false;
  11677. }
  11678. }
  11679. return true;
  11680. }
  11681. inline socket_t
  11682. Server::create_server_socket(const std::string &host, int port,
  11683. int socket_flags,
  11684. SocketOptions socket_options) const {
  11685. return detail::create_socket(
  11686. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11687. ipv6_v6only_, std::move(socket_options),
  11688. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11689. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11690. output_error_log(Error::BindIPAddress, nullptr);
  11691. return false;
  11692. }
  11693. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11694. output_error_log(Error::Listen, nullptr);
  11695. return false;
  11696. }
  11697. return true;
  11698. });
  11699. }
  11700. inline int Server::bind_internal(const std::string &host, int port,
  11701. int socket_flags) {
  11702. if (is_decommissioned) { return -1; }
  11703. if (!is_valid()) { return -1; }
  11704. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11705. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11706. if (port == 0) {
  11707. struct sockaddr_storage addr;
  11708. socklen_t addr_len = sizeof(addr);
  11709. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11710. &addr_len) == -1) {
  11711. output_error_log(Error::GetSockName, nullptr);
  11712. return -1;
  11713. }
  11714. if (addr.ss_family == AF_INET) {
  11715. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11716. } else if (addr.ss_family == AF_INET6) {
  11717. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11718. } else {
  11719. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11720. return -1;
  11721. }
  11722. } else {
  11723. return port;
  11724. }
  11725. }
  11726. inline bool Server::listen_internal() {
  11727. // A stop() between bind and listen leaves nothing to accept on. Report
  11728. // failure instead of returning success without ever serving, and mark the
  11729. // server decommissioned the way any failed listen does so that a concurrent
  11730. // wait_until_ready() wakes up instead of spinning forever.
  11731. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11732. is_decommissioned = true;
  11733. return false;
  11734. }
  11735. auto ret = true;
  11736. is_running_ = true;
  11737. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11738. if (start_handler_) { start_handler_(); }
  11739. {
  11740. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11741. while (svr_sock_ != INVALID_SOCKET) {
  11742. #ifndef _WIN32
  11743. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11744. #endif
  11745. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11746. idle_interval_usec_);
  11747. if (val == 0) { // Timeout
  11748. task_queue->on_idle();
  11749. continue;
  11750. }
  11751. #ifndef _WIN32
  11752. }
  11753. #endif
  11754. #if defined _WIN32
  11755. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11756. // OVERLAPPED
  11757. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11758. #elif defined SOCK_CLOEXEC
  11759. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11760. #else
  11761. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11762. #endif
  11763. if (sock == INVALID_SOCKET) {
  11764. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11765. // touches the CRT errno, so the two have to be asked platform by
  11766. // platform rather than by testing errno here.
  11767. if (detail::is_accept_resource_error()) {
  11768. // The per-process descriptor limit or the network stack's buffer
  11769. // space has been reached. Try to accept new connections after a
  11770. // short sleep.
  11771. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11772. continue;
  11773. } else if (detail::is_accept_transient_error()) {
  11774. continue;
  11775. }
  11776. // Take the descriptor out of svr_sock_ before closing it: a later
  11777. // stop() would otherwise shutdown()/close() a value the OS may have
  11778. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11779. // gone. The exchange also settles the race with a concurrent stop(),
  11780. // since whichever side takes the descriptor closes it exactly once.
  11781. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11782. if (listen_sock != INVALID_SOCKET) {
  11783. detail::close_socket(listen_sock);
  11784. ret = false;
  11785. output_error_log(Error::Connection, nullptr);
  11786. } else {
  11787. ; // The server socket was closed by user.
  11788. }
  11789. break;
  11790. }
  11791. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11792. read_timeout_sec_, read_timeout_usec_);
  11793. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11794. write_timeout_sec_, write_timeout_usec_);
  11795. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11796. if (!task_queue->enqueue(
  11797. [this, sock]() { process_and_close_socket(sock); })) {
  11798. output_error_log(Error::ResourceExhaustion, nullptr);
  11799. detail::shutdown_socket(sock);
  11800. detail::close_socket(sock);
  11801. }
  11802. }
  11803. task_queue->shutdown();
  11804. }
  11805. is_decommissioned = !ret;
  11806. return ret;
  11807. }
  11808. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11809. if (pre_routing_handler_ &&
  11810. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11811. return true;
  11812. }
  11813. // File handler
  11814. if ((req.method == "GET" || req.method == "HEAD") &&
  11815. handle_file_request(req, res)) {
  11816. return true;
  11817. }
  11818. const auto *custom = find_custom_entry(req.method);
  11819. // The second clause mirrors what expect_content() does unconditionally for
  11820. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11821. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11822. // `allprop`) would skip its handler and fall through to 404.
  11823. if (detail::expect_content(req) ||
  11824. (custom && !custom->handlers_for_content_reader.empty())) {
  11825. // Content reader handler
  11826. {
  11827. // Track whether the ContentReader was aborted due to the decompressed
  11828. // payload exceeding `payload_max_length_`.
  11829. // The user handler runs after the lambda returns, so we must restore the
  11830. // 413 status if the handler overwrites it.
  11831. bool content_reader_payload_too_large = false;
  11832. ContentReader reader(
  11833. [&](ContentReceiver receiver) {
  11834. auto result = read_content_with_content_receiver(
  11835. strm, req, res, std::move(receiver), nullptr, nullptr);
  11836. if (!result) {
  11837. output_error_log(Error::Read, &req);
  11838. if (res.status == StatusCode::PayloadTooLarge_413) {
  11839. content_reader_payload_too_large = true;
  11840. }
  11841. }
  11842. return result;
  11843. },
  11844. [&](FormDataHeader header, ContentReceiver receiver) {
  11845. auto result = read_content_with_content_receiver(
  11846. strm, req, res, nullptr, std::move(header),
  11847. std::move(receiver));
  11848. if (!result) {
  11849. output_error_log(Error::Read, &req);
  11850. if (res.status == StatusCode::PayloadTooLarge_413) {
  11851. content_reader_payload_too_large = true;
  11852. }
  11853. }
  11854. return result;
  11855. });
  11856. bool dispatched = false;
  11857. if (req.method == "POST") {
  11858. dispatched = dispatch_request_for_content_reader(
  11859. req, res, std::move(reader), post_handlers_for_content_reader_);
  11860. } else if (req.method == "PUT") {
  11861. dispatched = dispatch_request_for_content_reader(
  11862. req, res, std::move(reader), put_handlers_for_content_reader_);
  11863. } else if (req.method == "PATCH") {
  11864. dispatched = dispatch_request_for_content_reader(
  11865. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11866. } else if (req.method == "DELETE") {
  11867. dispatched = dispatch_request_for_content_reader(
  11868. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11869. } else if (custom) {
  11870. dispatched = dispatch_request_for_content_reader(
  11871. req, res, std::move(reader), custom->handlers_for_content_reader);
  11872. }
  11873. if (dispatched) {
  11874. if (content_reader_payload_too_large) {
  11875. // Enforce the limit: override any status the handler may have set
  11876. // and return false so the error path sends a plain 413 response.
  11877. res.status = StatusCode::PayloadTooLarge_413;
  11878. res.body.clear();
  11879. res.content_length_ = 0;
  11880. res.content_provider_ = nullptr;
  11881. return false;
  11882. }
  11883. return true;
  11884. }
  11885. }
  11886. // NOTE: `req.body` is not read here. For a regular handler the body is
  11887. // read inside dispatch_request(), after the route has matched and the
  11888. // pre-request handler has approved the request, so that a rejected
  11889. // request (e.g. failed authentication) never forces us to buffer a
  11890. // potentially large body.
  11891. }
  11892. // Regular handler
  11893. if (req.method == "GET" || req.method == "HEAD") {
  11894. return dispatch_request(req, res, get_handlers_, strm);
  11895. } else if (req.method == "POST") {
  11896. return dispatch_request(req, res, post_handlers_, strm);
  11897. } else if (req.method == "PUT") {
  11898. return dispatch_request(req, res, put_handlers_, strm);
  11899. } else if (req.method == "DELETE") {
  11900. return dispatch_request(req, res, delete_handlers_, strm);
  11901. } else if (req.method == "OPTIONS") {
  11902. return dispatch_request(req, res, options_handlers_, strm);
  11903. } else if (req.method == "PATCH") {
  11904. return dispatch_request(req, res, patch_handlers_, strm);
  11905. } else if (custom) {
  11906. return dispatch_request(req, res, custom->handlers, strm);
  11907. }
  11908. res.status = StatusCode::BadRequest_400;
  11909. return false;
  11910. }
  11911. inline bool Server::dispatch_request(Request &req, Response &res,
  11912. const Handlers &handlers, Stream &strm) {
  11913. for (const auto &x : handlers) {
  11914. const auto &matcher = x.first;
  11915. const auto &handler = x.second;
  11916. if (matcher->match(req)) {
  11917. req.matched_route = matcher->pattern();
  11918. // Run the pre-request handler before reading the body so a rejected
  11919. // request (e.g. failed authentication) never forces us to buffer a
  11920. // potentially large body. `req.matched_route` is available here.
  11921. if (pre_request_handler_ &&
  11922. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11923. return true;
  11924. }
  11925. // The route matched and the request was approved; read the body now.
  11926. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11927. output_error_log(Error::Read, &req);
  11928. return false;
  11929. }
  11930. handler(req, res);
  11931. return true;
  11932. }
  11933. }
  11934. return false;
  11935. }
  11936. // Decides the content coding for a response served straight from a file. Both
  11937. // the ETag, which has to name the representation actually sent, and
  11938. // `apply_static_file_compression()` go through this, so the two cannot drift
  11939. // apart.
  11940. inline detail::EncodingType
  11941. Server::static_file_encoding(const Request &req, const Response &res,
  11942. const std::string &content_type,
  11943. size_t length) const {
  11944. if (!static_file_compression_) { return detail::EncodingType::None; }
  11945. // Nothing to compress, and an empty file already answers with
  11946. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11947. // turn an empty body into a 20-byte gzip stream.
  11948. if (length == 0) { return detail::EncodingType::None; }
  11949. // A file that already fits in a single packet gains nothing from being made
  11950. // smaller, since it still travels in that one segment, and a file of a few
  11951. // bytes comes out larger than it went in.
  11952. if (length < static_file_compression_min_length_) {
  11953. return detail::EncodingType::None;
  11954. }
  11955. // RFC 9110 applies Range to the representation after content coding, so a
  11956. // compressed 206 would mean compressing the whole file and then slicing it.
  11957. // Serve ranges from the identity representation instead.
  11958. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11959. if (static_file_compression_max_length_ > 0 &&
  11960. length > static_file_compression_max_length_) {
  11961. return detail::EncodingType::None;
  11962. }
  11963. return detail::encoding_type(req, res, content_type);
  11964. }
  11965. // Compresses a file-backed content provider into `res.body` and takes over the
  11966. // framing headers. Returns false when the response is left untouched.
  11967. inline bool Server::apply_static_file_compression(const Request &req,
  11968. Response &res) const {
  11969. auto type = res.content_coding_;
  11970. if (type == detail::EncodingType::None || !res.content_provider_) {
  11971. return false;
  11972. }
  11973. auto compressor = detail::make_compressor(type);
  11974. if (!compressor) { return false; }
  11975. output_pre_compression_log(req, res);
  11976. std::string compressed;
  11977. if (!detail::compress_content_provider(res.content_provider_,
  11978. res.content_length_, *compressor,
  11979. compressed)) {
  11980. return false;
  11981. }
  11982. res.body.swap(compressed);
  11983. // The provider was consumed in full, so a resource releaser registered with
  11984. // it should hear about a success when the response goes away.
  11985. res.content_provider_success_ = true;
  11986. res.content_provider_ = nullptr;
  11987. res.content_length_ = 0;
  11988. res.content_coding_ = detail::EncodingType::None;
  11989. res.set_header("Content-Encoding", detail::encoding_name(type));
  11990. res.set_header("Vary", "Accept-Encoding");
  11991. res.set_header("Content-Length", std::to_string(res.body.size()));
  11992. return true;
  11993. }
  11994. inline void Server::apply_ranges(const Request &req, Response &res,
  11995. std::string &content_type,
  11996. std::string &boundary) const {
  11997. // A known-length content provider leaves `res.body` empty, so the compressor
  11998. // at the end of this function never runs for one (issue #2545). A file-backed
  11999. // provider is fully readable right here, so compress it and answer with an
  12000. // ordinary body: `Content-Length` and HEAD keep working, and the response
  12001. // takes the same path as `set_content()` from here on. Range requests never
  12002. // get a content coding, so `Content-Range` still names identity bytes and
  12003. // none of the framing below applies.
  12004. if (apply_static_file_compression(req, res)) { return; }
  12005. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  12006. auto it = res.headers.find("Content-Type");
  12007. if (it != res.headers.end()) {
  12008. content_type = it->second;
  12009. res.headers.erase(it);
  12010. }
  12011. boundary = detail::make_multipart_data_boundary();
  12012. res.set_header("Content-Type",
  12013. "multipart/byteranges; boundary=" + boundary);
  12014. }
  12015. auto type = detail::encoding_type(req, res);
  12016. if (res.body.empty()) {
  12017. if (res.content_length_ > 0) {
  12018. size_t length = 0;
  12019. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12020. length = res.content_length_;
  12021. } else if (req.ranges.size() == 1) {
  12022. auto offset_and_length = detail::get_range_offset_and_length(
  12023. req.ranges[0], res.content_length_);
  12024. length = offset_and_length.second;
  12025. auto content_range = detail::make_content_range_header_field(
  12026. offset_and_length, res.content_length_);
  12027. res.set_header("Content-Range", content_range);
  12028. } else {
  12029. length = detail::get_multipart_ranges_data_length(
  12030. req, boundary, content_type, res.content_length_);
  12031. }
  12032. res.set_header("Content-Length", std::to_string(length));
  12033. } else {
  12034. if (res.content_provider_) {
  12035. if (res.is_chunked_content_provider_) {
  12036. res.set_header("Transfer-Encoding", "chunked");
  12037. res.content_coding_ = type;
  12038. if (type != detail::EncodingType::None) {
  12039. res.set_header("Content-Encoding", detail::encoding_name(type));
  12040. res.set_header("Vary", "Accept-Encoding");
  12041. }
  12042. }
  12043. }
  12044. }
  12045. } else {
  12046. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  12047. ;
  12048. } else if (req.ranges.size() == 1) {
  12049. auto offset_and_length =
  12050. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  12051. auto offset = offset_and_length.first;
  12052. auto length = offset_and_length.second;
  12053. auto content_range = detail::make_content_range_header_field(
  12054. offset_and_length, res.body.size());
  12055. res.set_header("Content-Range", content_range);
  12056. assert(offset + length <= res.body.size());
  12057. res.body = res.body.substr(offset, length);
  12058. } else {
  12059. std::string data;
  12060. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12061. res.body.size(), data);
  12062. res.body.swap(data);
  12063. }
  12064. if (type != detail::EncodingType::None) {
  12065. output_pre_compression_log(req, res);
  12066. if (auto compressor = detail::make_compressor(type)) {
  12067. std::string compressed;
  12068. if (compressor->compress(res.body.data(), res.body.size(), true,
  12069. [&](const char *data, size_t data_len) {
  12070. compressed.append(data, data_len);
  12071. return true;
  12072. })) {
  12073. res.body.swap(compressed);
  12074. res.set_header("Content-Encoding", detail::encoding_name(type));
  12075. res.set_header("Vary", "Accept-Encoding");
  12076. }
  12077. }
  12078. }
  12079. res.content_length_ = res.body.size();
  12080. res.set_header("Content-Length", std::to_string(res.content_length_));
  12081. }
  12082. }
  12083. inline bool Server::dispatch_request_for_content_reader(
  12084. Request &req, Response &res, ContentReader content_reader,
  12085. const HandlersForContentReader &handlers) const {
  12086. for (const auto &x : handlers) {
  12087. const auto &matcher = x.first;
  12088. const auto &handler = x.second;
  12089. if (matcher->match(req)) {
  12090. req.matched_route = matcher->pattern();
  12091. if (!pre_request_handler_ ||
  12092. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12093. handler(req, res, content_reader);
  12094. }
  12095. return true;
  12096. }
  12097. }
  12098. return false;
  12099. }
  12100. inline std::string
  12101. get_client_ip(const std::string &x_forwarded_for,
  12102. const std::vector<std::string> &trusted_proxies) {
  12103. // X-Forwarded-For is a comma-separated list per RFC 7239
  12104. std::vector<std::string> ip_list;
  12105. detail::split(x_forwarded_for.data(),
  12106. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12107. [&](const char *b, const char *e) {
  12108. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12109. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12110. });
  12111. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12112. // no segments. Signal "no client IP derived" with an empty string so the
  12113. // caller can fall back to the connection-level remote address.
  12114. if (ip_list.empty()) { return std::string(); }
  12115. // Each hop appends the address it received the request from, so the rightmost
  12116. // entries are the ones written by our own infrastructure while the leftmost
  12117. // are whatever the original client chose to send. Walk from the right and
  12118. // skip trusted proxies; the first address that is not a trusted proxy is the
  12119. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12120. // from the left instead lets a client forge an arbitrary address by following
  12121. // it with a trusted proxy's address, which the left-to-right scan then
  12122. // returned as the client.
  12123. for (size_t i = ip_list.size(); i-- > 0;) {
  12124. const auto &ip = ip_list[i];
  12125. auto is_trusted_proxy =
  12126. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12127. [&](const std::string &proxy) { return ip == proxy; });
  12128. if (!is_trusted_proxy) { return ip; }
  12129. }
  12130. // Every hop was a trusted proxy; fall back to the first entry.
  12131. return ip_list.front();
  12132. }
  12133. inline bool
  12134. Server::process_request(Stream &strm, const std::string &remote_addr,
  12135. int remote_port, const std::string &local_addr,
  12136. int local_port, bool close_connection,
  12137. bool &connection_closed,
  12138. const std::function<void(Request &)> &setup_request,
  12139. bool *websocket_upgraded) {
  12140. std::array<char, 2048> buf{};
  12141. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12142. // Connection has been closed on client
  12143. if (!line_reader.getline()) { return false; }
  12144. Request req;
  12145. req.start_time_ = std::chrono::steady_clock::now();
  12146. req.remote_addr = remote_addr;
  12147. req.remote_port = remote_port;
  12148. req.local_addr = local_addr;
  12149. req.local_port = local_port;
  12150. Response res;
  12151. res.version = "HTTP/1.1";
  12152. res.headers = default_headers_;
  12153. // Request line and headers
  12154. if (!parse_request_line(line_reader.ptr(), req)) {
  12155. res.status = StatusCode::BadRequest_400;
  12156. output_error_log(Error::InvalidRequestLine, &req);
  12157. return write_response(strm, close_connection, req, res);
  12158. }
  12159. // Request headers
  12160. if (!detail::read_headers(strm, req.headers)) {
  12161. res.status = StatusCode::BadRequest_400;
  12162. output_error_log(Error::InvalidHeaders, &req);
  12163. return write_response(strm, close_connection, req, res);
  12164. }
  12165. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  12166. // otherwise let an intermediary and this parser disagree on where the body
  12167. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  12168. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  12169. // compatibility with existing clients), and a Transfer-Encoding whose final
  12170. // coding is not chunked, which leaves the body length undeterminable. The
  12171. // latter must not fall through to the "no body" path, or the body bytes are
  12172. // parsed as the next request on a persistent connection.
  12173. if (detail::has_conflicting_content_length(req.headers) ||
  12174. (req.has_header("Transfer-Encoding") &&
  12175. !detail::is_chunked_transfer_encoding(req.headers))) {
  12176. connection_closed = true;
  12177. res.status = StatusCode::BadRequest_400;
  12178. return write_response(strm, close_connection, req, res);
  12179. }
  12180. // Check if the request URI doesn't exceed the limit
  12181. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12182. connection_closed = true;
  12183. res.status = StatusCode::UriTooLong_414;
  12184. output_error_log(Error::ExceedUriMaxLength, &req);
  12185. return write_response(strm, close_connection, req, res);
  12186. }
  12187. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12188. connection_closed = true;
  12189. }
  12190. if (req.version == "HTTP/1.0" &&
  12191. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12192. connection_closed = true;
  12193. }
  12194. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12195. // itself a trusted proxy. Otherwise any direct client could spoof
  12196. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12197. auto is_trusted_peer = std::any_of(
  12198. trusted_proxies_.begin(), trusted_proxies_.end(),
  12199. [&](const std::string &proxy) { return proxy == remote_addr; });
  12200. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12201. // Some proxies append the address they observed as a separate
  12202. // X-Forwarded-For field line instead of extending the one the client sent
  12203. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12204. // be scanned. Reading only the first occurrence would hand back the
  12205. // client-supplied, and therefore forgeable, value.
  12206. auto x_forwarded_for =
  12207. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12208. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12209. req.remote_addr = derived.empty() ? remote_addr : derived;
  12210. } else {
  12211. req.remote_addr = remote_addr;
  12212. }
  12213. req.remote_port = remote_port;
  12214. req.local_addr = local_addr;
  12215. req.local_port = local_port;
  12216. if (req.has_header("Accept")) {
  12217. auto accept_header =
  12218. detail::get_combined_header_value(req.headers, "Accept");
  12219. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12220. connection_closed = true;
  12221. res.status = StatusCode::BadRequest_400;
  12222. output_error_log(Error::HTTPParsing, &req);
  12223. return write_response(strm, close_connection, req, res);
  12224. }
  12225. }
  12226. if (req.has_header("Range")) {
  12227. const auto &range_header_value = req.get_header_value("Range");
  12228. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12229. connection_closed = true;
  12230. res.status = StatusCode::RangeNotSatisfiable_416;
  12231. output_error_log(Error::InvalidRangeHeader, &req);
  12232. return write_response(strm, close_connection, req, res);
  12233. }
  12234. }
  12235. if (setup_request) { setup_request(req); }
  12236. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12237. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12238. // must be ignored. An expectation we do not recognize is left alone; the
  12239. // 417 the section allows for one is a MAY, not a requirement.
  12240. //
  12241. // `100 Continue` itself is deferred until the body is actually read (see
  12242. // read_content_core), so a request rejected by a later handler never
  12243. // invites the client to send a body nobody will read.
  12244. if (req.version != "HTTP/1.0" &&
  12245. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12246. int status = StatusCode::Continue_100;
  12247. if (expect_100_continue_handler_) {
  12248. status = expect_100_continue_handler_(req, res);
  12249. }
  12250. if (status == StatusCode::Continue_100) {
  12251. req.expect_100_continue_pending_ = true;
  12252. } else {
  12253. if (res.status == -1) { res.status = status; }
  12254. connection_closed = true;
  12255. return write_response(strm, true, req, res);
  12256. }
  12257. }
  12258. // Setup `is_connection_closed` method
  12259. auto sock = strm.socket();
  12260. req.is_connection_closed = [sock]() {
  12261. return !detail::is_socket_alive(sock);
  12262. };
  12263. // WebSocket upgrade
  12264. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12265. // that authentication and other middleware can reject the request with an
  12266. // HTTP response (e.g., 401) before the protocol switches.
  12267. if (detail::is_websocket_upgrade(req)) {
  12268. if (pre_routing_handler_ &&
  12269. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12270. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12271. return write_response_with_content(strm, close_connection, req, res);
  12272. }
  12273. // Find matching WebSocket handler
  12274. for (const auto &entry : websocket_handlers_) {
  12275. if (entry.matcher->match(req)) {
  12276. req.matched_route = entry.matcher->pattern();
  12277. if (pre_request_handler_ &&
  12278. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12279. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12280. return write_response_with_content(strm, close_connection, req, res);
  12281. }
  12282. // Compute accept key
  12283. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12284. auto accept_key = detail::websocket_accept_key(client_key);
  12285. // Negotiate subprotocol
  12286. std::string selected_subprotocol;
  12287. if (entry.sub_protocol_selector) {
  12288. auto protocol_header = detail::get_combined_header_value(
  12289. req.headers, "Sec-WebSocket-Protocol");
  12290. if (!protocol_header.empty()) {
  12291. std::vector<std::string> protocols;
  12292. detail::split(protocol_header.data(),
  12293. protocol_header.data() + protocol_header.size(), ',',
  12294. [&](const char *b, const char *e) {
  12295. protocols.emplace_back(b, e);
  12296. });
  12297. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12298. }
  12299. }
  12300. // Send 101 Switching Protocols
  12301. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12302. "Upgrade: websocket\r\n"
  12303. "Connection: Upgrade\r\n"
  12304. "Sec-WebSocket-Accept: " +
  12305. accept_key + "\r\n";
  12306. if (!selected_subprotocol.empty()) {
  12307. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12308. return false;
  12309. }
  12310. handshake_response +=
  12311. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12312. }
  12313. handshake_response += "\r\n";
  12314. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12315. 0) {
  12316. return false;
  12317. }
  12318. connection_closed = true;
  12319. if (websocket_upgraded) { *websocket_upgraded = true; }
  12320. {
  12321. #ifdef CPPHTTPLIB_SSL_ENABLED
  12322. if (req.ssl) {
  12323. // wss: the heartbeat ping thread and the read path enter the same
  12324. // TLS session from different threads. Hand the WebSocket a stream
  12325. // that serializes every TLS call, so the shared SSLSocketStream on
  12326. // the plain HTTP/HTTPS paths stays untouched.
  12327. auto ws_strm =
  12328. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12329. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12330. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12331. write_timeout_sec_, write_timeout_usec_));
  12332. ws::WebSocket ws(std::move(ws_strm), req, true,
  12333. websocket_ping_interval_sec_,
  12334. websocket_max_missed_pongs_);
  12335. entry.handler(req, ws);
  12336. return true;
  12337. }
  12338. #endif
  12339. // Use WebSocket-specific read timeout instead of HTTP timeout
  12340. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12341. 0);
  12342. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12343. websocket_max_missed_pongs_);
  12344. entry.handler(req, ws);
  12345. }
  12346. return true;
  12347. }
  12348. }
  12349. // No matching handler - fall through to 404
  12350. }
  12351. // Routing
  12352. auto routed = false;
  12353. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12354. routed = routing(req, res, strm);
  12355. #else
  12356. try {
  12357. routed = routing(req, res, strm);
  12358. } catch (std::exception &) {
  12359. if (exception_handler_) {
  12360. auto ep = std::current_exception();
  12361. exception_handler_(req, res, ep);
  12362. routed = true;
  12363. } else {
  12364. res.status = StatusCode::InternalServerError_500;
  12365. }
  12366. } catch (...) {
  12367. if (exception_handler_) {
  12368. auto ep = std::current_exception();
  12369. exception_handler_(req, res, ep);
  12370. routed = true;
  12371. } else {
  12372. res.status = StatusCode::InternalServerError_500;
  12373. }
  12374. }
  12375. #endif
  12376. auto ret = false;
  12377. if (routed) {
  12378. if (res.status == -1) {
  12379. res.status = req.ranges.empty() ? StatusCode::OK_200
  12380. : StatusCode::PartialContent_206;
  12381. }
  12382. // Serve file content by using a content provider
  12383. auto file_open_error = false;
  12384. if (!res.file_content_path_.empty()) {
  12385. const auto &path = res.file_content_path_;
  12386. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12387. if (!mm->is_open()) {
  12388. res.body.clear();
  12389. res.content_length_ = 0;
  12390. res.content_provider_ = nullptr;
  12391. res.status = StatusCode::NotFound_404;
  12392. output_error_log(Error::OpenFile, &req);
  12393. file_open_error = true;
  12394. } else {
  12395. auto content_type = res.file_content_content_type_;
  12396. if (content_type.empty()) {
  12397. content_type = detail::find_content_type(
  12398. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12399. }
  12400. detail::set_file_content_provider(
  12401. res, mm, content_type,
  12402. static_file_encoding(req, res, content_type, mm->size()));
  12403. }
  12404. }
  12405. if (file_open_error) {
  12406. ret = write_response(strm, close_connection, req, res);
  12407. } else if (detail::range_error(req, res)) {
  12408. res.body.clear();
  12409. res.content_length_ = 0;
  12410. res.content_provider_ = nullptr;
  12411. res.status = StatusCode::RangeNotSatisfiable_416;
  12412. ret = write_response(strm, close_connection, req, res);
  12413. } else {
  12414. ret = write_response_with_content(strm, close_connection, req, res);
  12415. }
  12416. } else {
  12417. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12418. ret = write_response(strm, close_connection, req, res);
  12419. }
  12420. // Drain any unconsumed framed body to prevent request smuggling on
  12421. // keep-alive. Without framing there is no body to drain — reading would
  12422. // consume the next request (issue #2450). If the response has committed the
  12423. // connection to close, there is no next request to protect.
  12424. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12425. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12426. connection_closed = true;
  12427. } else {
  12428. int dummy_status;
  12429. if (!detail::read_content(
  12430. strm, req, payload_max_length_, dummy_status, nullptr,
  12431. [](const char *, size_t, size_t, size_t) { return true; },
  12432. false)) {
  12433. connection_closed = true;
  12434. }
  12435. }
  12436. }
  12437. return ret;
  12438. }
  12439. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12440. inline bool Server::process_and_close_socket(socket_t sock) {
  12441. std::string remote_addr;
  12442. int remote_port = 0;
  12443. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12444. std::string local_addr;
  12445. int local_port = 0;
  12446. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12447. bool websocket_upgraded = false;
  12448. auto ret = serve_guarded([&]() {
  12449. return detail::process_server_socket(
  12450. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12451. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12452. write_timeout_usec_,
  12453. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12454. return process_request(strm, remote_addr, remote_port, local_addr,
  12455. local_port, close_connection,
  12456. connection_closed, nullptr,
  12457. &websocket_upgraded);
  12458. });
  12459. });
  12460. detail::drain_and_close_socket(sock);
  12461. return ret;
  12462. }
  12463. inline void Server::output_log(const Request &req, const Response &res) const {
  12464. if (logger_) {
  12465. std::lock_guard<std::mutex> guard(logger_mutex_);
  12466. logger_(req, res);
  12467. }
  12468. }
  12469. inline void Server::output_pre_compression_log(const Request &req,
  12470. const Response &res) const {
  12471. if (pre_compression_logger_) {
  12472. std::lock_guard<std::mutex> guard(logger_mutex_);
  12473. pre_compression_logger_(req, res);
  12474. }
  12475. }
  12476. inline void Server::output_error_log(const Error &err,
  12477. const Request *req) const {
  12478. if (error_logger_) {
  12479. std::lock_guard<std::mutex> guard(logger_mutex_);
  12480. error_logger_(err, req);
  12481. }
  12482. }
  12483. /*
  12484. * Group 5: ClientImpl and Client (Universal) implementation
  12485. */
  12486. // HTTP client implementation
  12487. inline ClientImpl::ClientImpl(const std::string &host)
  12488. : ClientImpl(host, 80, std::string(), std::string()) {}
  12489. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12490. : ClientImpl(host, port, std::string(), std::string()) {}
  12491. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12492. const std::string &client_cert_path,
  12493. const std::string &client_key_path)
  12494. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12495. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12496. inline ClientImpl::~ClientImpl() {
  12497. // Wait until all the requests in flight are handled.
  12498. size_t retry_count = 10;
  12499. while (retry_count-- > 0) {
  12500. {
  12501. std::lock_guard<std::mutex> guard(socket_mutex_);
  12502. if (socket_requests_in_flight_ == 0) { break; }
  12503. }
  12504. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12505. }
  12506. std::lock_guard<std::mutex> guard(socket_mutex_);
  12507. shutdown_socket(socket_);
  12508. close_socket(socket_);
  12509. }
  12510. inline bool ClientImpl::is_valid() const { return true; }
  12511. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12512. client_cert_path_ = rhs.client_cert_path_;
  12513. client_key_path_ = rhs.client_key_path_;
  12514. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12515. read_timeout_sec_ = rhs.read_timeout_sec_;
  12516. read_timeout_usec_ = rhs.read_timeout_usec_;
  12517. write_timeout_sec_ = rhs.write_timeout_sec_;
  12518. write_timeout_usec_ = rhs.write_timeout_usec_;
  12519. max_timeout_msec_ = rhs.max_timeout_msec_;
  12520. basic_auth_username_ = rhs.basic_auth_username_;
  12521. basic_auth_password_ = rhs.basic_auth_password_;
  12522. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12523. keep_alive_ = rhs.keep_alive_;
  12524. follow_location_ = rhs.follow_location_;
  12525. path_encode_ = rhs.path_encode_;
  12526. address_family_ = rhs.address_family_;
  12527. tcp_nodelay_ = rhs.tcp_nodelay_;
  12528. ipv6_v6only_ = rhs.ipv6_v6only_;
  12529. socket_options_ = rhs.socket_options_;
  12530. compress_ = rhs.compress_;
  12531. decompress_ = rhs.decompress_;
  12532. payload_max_length_ = rhs.payload_max_length_;
  12533. has_payload_max_length_ = rhs.has_payload_max_length_;
  12534. interface_ = rhs.interface_;
  12535. proxy_host_ = rhs.proxy_host_;
  12536. proxy_port_ = rhs.proxy_port_;
  12537. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12538. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12539. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12540. no_proxy_entries_ = rhs.no_proxy_entries_;
  12541. logger_ = rhs.logger_;
  12542. error_logger_ = rhs.error_logger_;
  12543. #ifdef CPPHTTPLIB_SSL_ENABLED
  12544. digest_auth_username_ = rhs.digest_auth_username_;
  12545. digest_auth_password_ = rhs.digest_auth_password_;
  12546. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12547. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12548. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12549. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12550. server_certificate_verification_ = rhs.server_certificate_verification_;
  12551. server_hostname_verification_ = rhs.server_hostname_verification_;
  12552. system_ca_mode_ = rhs.system_ca_mode_;
  12553. #endif
  12554. }
  12555. inline bool
  12556. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12557. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12558. if (no_proxy_entries_.empty()) { return true; }
  12559. // host_ is const so its normalized form is invariant; cache it. The
  12560. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12561. if (host == host_) {
  12562. if (!host_normalized_valid_) {
  12563. host_normalized_ = detail::normalize_target(host_);
  12564. host_normalized_valid_ = true;
  12565. }
  12566. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12567. }
  12568. auto target = detail::normalize_target(host);
  12569. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12570. }
  12571. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12572. if (is_proxy_enabled_for_host(host_)) {
  12573. return detail::create_client_socket(
  12574. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12575. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12576. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12577. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12578. }
  12579. // Check is custom IP or hostname specified for host_
  12580. std::string connect_host;
  12581. std::string ip;
  12582. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12583. return detail::create_client_socket(
  12584. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12585. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12586. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12587. write_timeout_usec_, interface_, error);
  12588. }
  12589. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12590. Error &error) {
  12591. auto sock = create_client_socket(error);
  12592. if (sock == INVALID_SOCKET) { return false; }
  12593. socket.sock = sock;
  12594. return true;
  12595. }
  12596. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12597. return create_and_connect_socket(socket, error);
  12598. }
  12599. inline bool ClientImpl::setup_proxy_connection(
  12600. Socket & /*socket*/,
  12601. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12602. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12603. return true;
  12604. }
  12605. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12606. bool /*shutdown_gracefully*/) {
  12607. // If there are any requests in flight from threads other than us, then it's
  12608. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12609. assert(socket_requests_in_flight_ == 0 ||
  12610. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12611. }
  12612. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12613. if (socket.sock == INVALID_SOCKET) { return; }
  12614. detail::shutdown_socket(socket.sock);
  12615. }
  12616. inline void ClientImpl::close_socket(Socket &socket) {
  12617. // If there are requests in flight in another thread, usually closing
  12618. // the socket will be fine and they will simply receive an error when
  12619. // using the closed socket, but it is still a bug since rarely the OS
  12620. // may reassign the socket id to be used for a new socket, and then
  12621. // suddenly they will be operating on a live socket that is different
  12622. // than the one they intended!
  12623. assert(socket_requests_in_flight_ == 0 ||
  12624. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12625. // It is also a bug if this happens while SSL is still active
  12626. #ifdef CPPHTTPLIB_SSL_ENABLED
  12627. assert(socket.ssl == nullptr);
  12628. #endif
  12629. if (socket.sock == INVALID_SOCKET) { return; }
  12630. detail::close_socket(socket.sock);
  12631. socket.sock = INVALID_SOCKET;
  12632. }
  12633. inline void ClientImpl::disconnect(bool gracefully) {
  12634. shutdown_ssl(socket_, gracefully);
  12635. shutdown_socket(socket_);
  12636. close_socket(socket_);
  12637. }
  12638. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12639. Response &res,
  12640. bool skip_100_continue) const {
  12641. std::array<char, 2048> buf{};
  12642. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12643. if (!line_reader.getline()) { return false; }
  12644. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12645. res.reason)) {
  12646. return req.method == "CONNECT";
  12647. }
  12648. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12649. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12650. if (!line_reader.getline()) { return false; } // CRLF
  12651. if (!line_reader.getline()) { return false; } // next response line
  12652. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12653. res.reason)) {
  12654. return false;
  12655. }
  12656. }
  12657. return true;
  12658. }
  12659. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12660. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12661. auto ret = send_(req, res, error);
  12662. if (error == Error::SSLPeerCouldBeClosed_) {
  12663. assert(!ret);
  12664. ret = send_(req, res, error);
  12665. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12666. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12667. }
  12668. return ret;
  12669. }
  12670. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12671. {
  12672. std::lock_guard<std::mutex> guard(socket_mutex_);
  12673. // Set this to false immediately - if it ever gets set to true by the end
  12674. // of the request, we know another thread instructed us to close the
  12675. // socket.
  12676. socket_should_be_closed_when_request_is_done_ = false;
  12677. auto is_alive = false;
  12678. if (socket_.is_open()) {
  12679. is_alive = detail::is_socket_alive(socket_.sock);
  12680. #ifdef CPPHTTPLIB_SSL_ENABLED
  12681. if (is_alive && is_ssl()) {
  12682. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12683. is_alive = false;
  12684. }
  12685. }
  12686. #endif
  12687. if (!is_alive) {
  12688. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12689. disconnect(/*gracefully=*/false);
  12690. }
  12691. }
  12692. if (!is_alive) {
  12693. if (!ensure_socket_connection(socket_, error)) {
  12694. output_error_log(error, &req);
  12695. return false;
  12696. }
  12697. {
  12698. auto success = true;
  12699. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12700. error)) {
  12701. if (!success) { output_error_log(error, &req); }
  12702. return success;
  12703. }
  12704. }
  12705. }
  12706. // Mark the current socket as being in use so that it cannot be closed by
  12707. // anyone else while this request is ongoing, even though we will be
  12708. // releasing the mutex.
  12709. if (socket_requests_in_flight_ > 1) {
  12710. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12711. }
  12712. socket_requests_in_flight_ += 1;
  12713. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12714. }
  12715. for (const auto &header : default_headers_) {
  12716. if (req.headers.find(header.first) == req.headers.end()) {
  12717. req.headers.insert(header);
  12718. }
  12719. }
  12720. auto ret = false;
  12721. auto close_connection = !keep_alive_;
  12722. auto se = detail::scope_exit([&]() {
  12723. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12724. std::lock_guard<std::mutex> guard(socket_mutex_);
  12725. socket_requests_in_flight_ -= 1;
  12726. if (socket_requests_in_flight_ <= 0) {
  12727. assert(socket_requests_in_flight_ == 0);
  12728. socket_requests_are_from_thread_ = std::thread::id();
  12729. }
  12730. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12731. !ret) {
  12732. disconnect(/*gracefully=*/true);
  12733. }
  12734. });
  12735. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12736. return handle_request(strm, req, res, close_connection, error);
  12737. });
  12738. if (!ret) {
  12739. if (error == Error::Success) {
  12740. error = Error::Unknown;
  12741. output_error_log(error, &req);
  12742. }
  12743. }
  12744. return ret;
  12745. }
  12746. inline Result ClientImpl::send(const Request &req) {
  12747. auto req2 = req;
  12748. return send_(std::move(req2));
  12749. }
  12750. inline Result ClientImpl::send_(Request &&req) {
  12751. auto res = detail::make_unique<Response>();
  12752. auto error = Error::Success;
  12753. auto ret = send(req, *res, error);
  12754. #ifdef CPPHTTPLIB_SSL_ENABLED
  12755. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12756. last_ssl_error_, last_backend_error_};
  12757. #else
  12758. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12759. #endif
  12760. }
  12761. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12762. const std::string &ct) {
  12763. (void)for_stream;
  12764. // Default headers are meant for the origin and may carry its credentials, so
  12765. // keep them off the CONNECT request the proxy reads.
  12766. if (r.method != "CONNECT") {
  12767. for (const auto &header : default_headers_) {
  12768. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12769. }
  12770. }
  12771. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12772. // prepend it rather than appending it after the caller's own fields.
  12773. if (!r.has_header("Host")) {
  12774. r.headers.emplace_front(
  12775. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12776. address_family_));
  12777. }
  12778. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12779. if (!r.content_receiver) {
  12780. if (!r.has_header("Accept-Encoding")) {
  12781. std::string accept_encoding;
  12782. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12783. accept_encoding = "br";
  12784. #endif
  12785. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12786. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12787. accept_encoding += "gzip, deflate";
  12788. #endif
  12789. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12790. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12791. accept_encoding += "zstd";
  12792. #endif
  12793. r.set_header("Accept-Encoding", accept_encoding);
  12794. }
  12795. detail::add_default_user_agent_header(r);
  12796. }
  12797. if (!r.body.empty()) {
  12798. if (!ct.empty() && !r.has_header("Content-Type")) {
  12799. r.headers.emplace("Content-Type", ct);
  12800. }
  12801. if (!r.has_header("Content-Length")) {
  12802. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12803. }
  12804. }
  12805. }
  12806. inline ClientImpl::StreamHandle
  12807. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12808. const Params &params, const Headers &headers,
  12809. const std::string &body,
  12810. const std::string &content_type) {
  12811. StreamHandle handle;
  12812. handle.response = detail::make_unique<Response>();
  12813. handle.error = Error::Success;
  12814. // Encode the target exactly like the buffered send path does, so that the
  12815. // same `path` produces the same request line through either API.
  12816. auto raw_query_path =
  12817. params.empty() ? path : append_query_params(path, params);
  12818. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12819. handle.connection_ = detail::make_unique<ClientConnection>();
  12820. {
  12821. std::lock_guard<std::mutex> guard(socket_mutex_);
  12822. auto is_alive = false;
  12823. if (socket_.is_open()) {
  12824. is_alive = detail::is_socket_alive(socket_.sock);
  12825. #ifdef CPPHTTPLIB_SSL_ENABLED
  12826. if (is_alive && is_ssl()) {
  12827. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12828. is_alive = false;
  12829. }
  12830. }
  12831. #endif
  12832. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12833. }
  12834. if (!is_alive) {
  12835. if (!ensure_socket_connection(socket_, handle.error)) {
  12836. handle.response.reset();
  12837. return handle;
  12838. }
  12839. {
  12840. auto success = true;
  12841. auto start_time = std::chrono::steady_clock::now();
  12842. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12843. success, handle.error)) {
  12844. if (!success) { handle.response.reset(); }
  12845. return handle;
  12846. }
  12847. }
  12848. }
  12849. transfer_socket_ownership_to_handle(handle);
  12850. }
  12851. #ifdef CPPHTTPLIB_SSL_ENABLED
  12852. if (is_ssl() && handle.connection_->session) {
  12853. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12854. handle.connection_->sock, handle.connection_->session,
  12855. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12856. write_timeout_usec_);
  12857. } else {
  12858. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12859. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12860. write_timeout_sec_, write_timeout_usec_);
  12861. }
  12862. #else
  12863. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12864. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12865. write_timeout_sec_, write_timeout_usec_);
  12866. #endif
  12867. handle.stream_ = handle.socket_stream_.get();
  12868. Request req;
  12869. req.method = method;
  12870. req.path = query_path;
  12871. req.headers = headers;
  12872. req.body = body;
  12873. prepare_default_headers(req, true, content_type);
  12874. auto &strm = *handle.stream_;
  12875. // Build the request line and headers in memory first, like write_request()
  12876. // does, so that a rejected header leaves nothing on the wire.
  12877. {
  12878. detail::BufferStream bstrm;
  12879. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12880. handle.error = Error::Write;
  12881. handle.response.reset();
  12882. return handle;
  12883. }
  12884. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12885. handle.error)) {
  12886. handle.response.reset();
  12887. return handle;
  12888. }
  12889. const auto &data = bstrm.get_buffer();
  12890. if (!detail::write_data(strm, data.data(), data.size())) {
  12891. handle.error = Error::Write;
  12892. handle.response.reset();
  12893. return handle;
  12894. }
  12895. }
  12896. if (!body.empty()) {
  12897. if (strm.write(body.data(), body.size()) < 0) {
  12898. handle.error = Error::Write;
  12899. handle.response.reset();
  12900. return handle;
  12901. }
  12902. }
  12903. if (!read_response_line(strm, req, *handle.response) ||
  12904. !detail::read_headers(strm, handle.response->headers)) {
  12905. handle.error = Error::Read;
  12906. handle.response.reset();
  12907. return handle;
  12908. }
  12909. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12910. // (204/304) response legitimately carries framing headers with no body.
  12911. if (method != "HEAD" &&
  12912. handle.response->status != StatusCode::NoContent_204 &&
  12913. handle.response->status != StatusCode::NotModified_304 &&
  12914. detail::has_conflicting_content_length(handle.response->headers)) {
  12915. handle.error = Error::Read;
  12916. handle.response.reset();
  12917. return handle;
  12918. }
  12919. handle.body_reader_.stream = handle.stream_;
  12920. handle.body_reader_.payload_max_length = payload_max_length_;
  12921. if (handle.response->has_header("Content-Length")) {
  12922. bool is_invalid = false;
  12923. auto content_length = detail::get_header_value_u64(
  12924. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12925. if (is_invalid) {
  12926. handle.error = Error::Read;
  12927. handle.response.reset();
  12928. return handle;
  12929. }
  12930. handle.body_reader_.has_content_length = true;
  12931. handle.body_reader_.content_length = content_length;
  12932. }
  12933. handle.body_reader_.chunked =
  12934. detail::is_chunked_transfer_encoding(handle.response->headers);
  12935. auto content_encoding = detail::get_combined_header_value(
  12936. handle.response->headers, "Content-Encoding");
  12937. if (!content_encoding.empty()) {
  12938. // Same policy as prepare_content_receiver(): reject a coding we know about
  12939. // but were not built with, pass an unrecognized one through as-is.
  12940. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12941. if (!handle.decompressor_) {
  12942. if (detail::is_known_content_encoding(content_encoding)) {
  12943. handle.error = Error::UnsupportedContentEncoding;
  12944. handle.response.reset();
  12945. return handle;
  12946. }
  12947. } else if (!handle.decompressor_->is_valid()) {
  12948. handle.error = Error::Compression;
  12949. handle.response.reset();
  12950. return handle;
  12951. }
  12952. }
  12953. return handle;
  12954. }
  12955. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12956. if (!is_valid() || !response) { return -1; }
  12957. if (decompressor_) { return read_with_decompression(buf, len); }
  12958. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12959. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12960. trailers_parsed_ = true;
  12961. if (body_reader_.chunked_decoder) {
  12962. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12963. response->trailers, response->headers)) {
  12964. return n;
  12965. }
  12966. } else {
  12967. detail::ChunkedDecoder dec(*stream_);
  12968. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12969. return n;
  12970. }
  12971. }
  12972. }
  12973. return n;
  12974. }
  12975. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12976. size_t len) {
  12977. if (decompress_offset_ < decompress_buffer_.size()) {
  12978. auto available = decompress_buffer_.size() - decompress_offset_;
  12979. auto to_copy = (std::min)(len, available);
  12980. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12981. decompress_offset_ += to_copy;
  12982. decompressed_bytes_read_ += to_copy;
  12983. return static_cast<ssize_t>(to_copy);
  12984. }
  12985. decompress_buffer_.clear();
  12986. decompress_offset_ = 0;
  12987. constexpr size_t kDecompressionBufferSize = 8192;
  12988. char compressed_buf[kDecompressionBufferSize];
  12989. while (true) {
  12990. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12991. sizeof(compressed_buf));
  12992. if (n <= 0) { return n; }
  12993. bool decompress_ok = decompressor_->decompress(
  12994. compressed_buf, static_cast<size_t>(n),
  12995. [this](const char *data, size_t data_len) {
  12996. decompress_buffer_.append(data, data_len);
  12997. auto limit = body_reader_.payload_max_length;
  12998. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12999. return false;
  13000. }
  13001. return true;
  13002. });
  13003. if (!decompress_ok) {
  13004. body_reader_.last_error = Error::Read;
  13005. return -1;
  13006. }
  13007. if (!decompress_buffer_.empty()) { break; }
  13008. }
  13009. auto to_copy = (std::min)(len, decompress_buffer_.size());
  13010. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  13011. decompress_offset_ = to_copy;
  13012. decompressed_bytes_read_ += to_copy;
  13013. return static_cast<ssize_t>(to_copy);
  13014. }
  13015. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  13016. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  13017. return;
  13018. }
  13019. trailers_parsed_ = true;
  13020. const auto bufsiz = 128;
  13021. char line_buf[bufsiz];
  13022. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  13023. if (!line_reader.getline()) { return; }
  13024. if (!detail::parse_trailers(line_reader, response->trailers,
  13025. response->headers)) {
  13026. return;
  13027. }
  13028. }
  13029. namespace detail {
  13030. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  13031. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  13032. size_t &out_chunk_offset,
  13033. size_t &out_chunk_total) {
  13034. if (finished) { return 0; }
  13035. if (chunk_remaining == 0) {
  13036. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13037. if (!lr.getline()) { return -1; }
  13038. // Everything below is bounded by eol rather than by the buffer's NUL, so
  13039. // the line terminator is never mistaken for line content.
  13040. const char *eol = lr.ptr() + lr.size();
  13041. if (lr.end_with_crlf()) {
  13042. eol -= 2;
  13043. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  13044. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  13045. // getline() ends the line on a bare LF. That LF is the terminator, so it
  13046. // has to come off here or the check below would reject the line.
  13047. eol -= 1;
  13048. }
  13049. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  13050. const char *p = lr.ptr();
  13051. int v = 0;
  13052. if (p == eol || !is_hex(*p, v)) { return -1; }
  13053. size_t chunk_len = 0;
  13054. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  13055. for (; p < eol && is_hex(*p, v); ++p) {
  13056. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  13057. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  13058. }
  13059. while (p < eol && is_space_or_tab(*p)) {
  13060. ++p;
  13061. }
  13062. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13063. // terminator, and it is built from tokens and quoted-strings, so it never
  13064. // holds a CR, LF or any other control character. getline() reads up to the
  13065. // CRLF, so a bare LF left in here would be swallowed as extension text
  13066. // while an intermediary that ends the line on it delimits the chunks
  13067. // differently, and the two disagree on where the body ends (request
  13068. // smuggling).
  13069. if (p < eol && *p != ';') { return -1; }
  13070. for (; p < eol; ++p) {
  13071. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13072. }
  13073. if (chunk_len == 0) {
  13074. chunk_remaining = 0;
  13075. finished = true;
  13076. out_chunk_offset = 0;
  13077. out_chunk_total = 0;
  13078. return 0;
  13079. }
  13080. chunk_remaining = chunk_len;
  13081. last_chunk_total = chunk_remaining;
  13082. last_chunk_offset = 0;
  13083. }
  13084. auto to_read = (std::min)(chunk_remaining, len);
  13085. auto n = strm.read(buf, to_read);
  13086. if (n <= 0) { return -1; }
  13087. auto offset_before = last_chunk_offset;
  13088. last_chunk_offset += static_cast<size_t>(n);
  13089. chunk_remaining -= static_cast<size_t>(n);
  13090. out_chunk_offset = offset_before;
  13091. out_chunk_total = last_chunk_total;
  13092. if (chunk_remaining == 0) {
  13093. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13094. if (!lr.getline()) { return -1; }
  13095. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13096. }
  13097. return n;
  13098. }
  13099. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13100. const Headers &src_headers) {
  13101. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13102. if (!lr.getline()) { return false; }
  13103. return parse_trailers(lr, dest, src_headers);
  13104. }
  13105. } // namespace detail
  13106. inline void
  13107. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13108. handle.connection_->sock = socket_.sock;
  13109. #ifdef CPPHTTPLIB_SSL_ENABLED
  13110. handle.connection_->session = socket_.ssl;
  13111. socket_.ssl = nullptr;
  13112. #endif
  13113. socket_.sock = INVALID_SOCKET;
  13114. }
  13115. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13116. Response &res, bool close_connection,
  13117. Error &error) {
  13118. if (req.path.empty()) {
  13119. error = Error::Connection;
  13120. output_error_log(error, &req);
  13121. return false;
  13122. }
  13123. auto req_save = req;
  13124. bool ret;
  13125. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13126. auto req2 = req;
  13127. req2.path = "http://" +
  13128. detail::make_host_and_port_string(host_, port_, false) +
  13129. req.path;
  13130. ret = process_request(strm, req2, res, close_connection, error);
  13131. req = std::move(req2);
  13132. req.path = req_save.path;
  13133. } else {
  13134. ret = process_request(strm, req, res, close_connection, error);
  13135. }
  13136. if (!ret) { return false; }
  13137. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13138. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13139. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13140. // for this to be safe.
  13141. // This is safe to call because handle_request is only called by send_
  13142. // which locks the request mutex during the process. It would be a bug
  13143. // to call it from a different thread since it's a thread-safety issue
  13144. // to do these things to the socket if another thread is using the socket.
  13145. std::lock_guard<std::mutex> guard(socket_mutex_);
  13146. disconnect(/*gracefully=*/true);
  13147. }
  13148. if (300 < res.status && res.status < 400 && follow_location_) {
  13149. req = std::move(req_save);
  13150. ret = redirect(req, res, error);
  13151. }
  13152. #ifdef CPPHTTPLIB_SSL_ENABLED
  13153. if ((res.status == StatusCode::Unauthorized_401 ||
  13154. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13155. req.authorization_count_ < 5) {
  13156. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13157. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13158. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13159. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13160. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13161. return ret;
  13162. }
  13163. const auto &username =
  13164. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13165. const auto &password =
  13166. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13167. if (!username.empty() && !password.empty()) {
  13168. std::map<std::string, std::string> auth;
  13169. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13170. Request new_req = req;
  13171. new_req.authorization_count_ += 1;
  13172. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13173. : "Authorization");
  13174. new_req.headers.insert(detail::make_digest_authentication_header(
  13175. req, auth, new_req.authorization_count_, detail::random_string(10),
  13176. username, password, is_proxy));
  13177. Response new_res;
  13178. ret = send(new_req, new_res, error);
  13179. if (ret) { res = std::move(new_res); }
  13180. }
  13181. }
  13182. }
  13183. #endif
  13184. return ret;
  13185. }
  13186. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13187. if (req.redirect_count_ == 0) {
  13188. error = Error::ExceedRedirectCount;
  13189. output_error_log(error, &req);
  13190. return false;
  13191. }
  13192. auto location = res.get_header_value("location");
  13193. if (location.empty()) { return false; }
  13194. detail::UrlComponents uc;
  13195. if (!detail::parse_url(detail::resolve_relative_location(location, req.path),
  13196. uc)) {
  13197. return false;
  13198. }
  13199. // Only follow http/https redirects
  13200. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13201. return false;
  13202. }
  13203. auto scheme = is_ssl() ? "https" : "http";
  13204. auto next_scheme = std::move(uc.scheme);
  13205. auto next_host = std::move(uc.host);
  13206. auto port_str = std::move(uc.port);
  13207. auto next_path = std::move(uc.path);
  13208. auto next_query = std::move(uc.query);
  13209. auto next_port = port_;
  13210. if (!port_str.empty()) {
  13211. if (!detail::parse_port(port_str, next_port)) { return false; }
  13212. } else if (!next_scheme.empty()) {
  13213. next_port = next_scheme == "https" ? 443 : 80;
  13214. }
  13215. if (next_scheme.empty()) { next_scheme = scheme; }
  13216. if (next_host.empty()) { next_host = host_; }
  13217. if (next_path.empty()) { next_path = "/"; }
  13218. auto path = decode_path_component(next_path) + next_query;
  13219. // Same host redirect - use current client
  13220. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13221. return detail::redirect(*this, req, res, path, location, error);
  13222. }
  13223. // Cross-host/scheme redirect - create new client with robust setup
  13224. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13225. path, location, error);
  13226. }
  13227. // New method for robust redirect client creation
  13228. inline bool ClientImpl::create_redirect_client(
  13229. const std::string &scheme, const std::string &host, int port, Request &req,
  13230. Response &res, const std::string &path, const std::string &location,
  13231. Error &error) {
  13232. // Determine if we need SSL
  13233. auto need_ssl = (scheme == "https");
  13234. // Clean up request headers that are host/client specific
  13235. // Remove headers that should not be carried over to new host
  13236. auto headers_to_remove = std::vector<std::string>{
  13237. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13238. for (const auto &header_name : headers_to_remove) {
  13239. auto it = req.headers.find(header_name);
  13240. while (it != req.headers.end()) {
  13241. it = req.headers.erase(it);
  13242. it = req.headers.find(header_name);
  13243. }
  13244. }
  13245. // Create appropriate client type and handle redirect
  13246. if (need_ssl) {
  13247. #ifdef CPPHTTPLIB_SSL_ENABLED
  13248. // Create SSL client for HTTPS redirect
  13249. SSLClient redirect_client(host, port);
  13250. // Setup basic client configuration first
  13251. setup_redirect_client(redirect_client);
  13252. redirect_client.enable_server_certificate_verification(
  13253. server_certificate_verification_);
  13254. redirect_client.enable_server_hostname_verification(
  13255. server_hostname_verification_);
  13256. redirect_client.system_ca_mode_ = system_ca_mode_;
  13257. // Transfer CA certificate to redirect client
  13258. if (!ca_cert_pem_.empty()) {
  13259. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13260. ca_cert_pem_.size());
  13261. }
  13262. if (!ca_cert_file_path_.empty()) {
  13263. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13264. }
  13265. // Client certificates are set through constructor for SSLClient
  13266. // NOTE: SSLClient constructor already takes client_cert_path and
  13267. // client_key_path so we need to create it properly if client certs are
  13268. // needed
  13269. // Execute the redirect
  13270. return detail::redirect(redirect_client, req, res, path, location, error);
  13271. #else
  13272. // SSL not supported - set appropriate error
  13273. error = Error::SSLConnection;
  13274. output_error_log(error, &req);
  13275. return false;
  13276. #endif
  13277. } else {
  13278. // HTTP redirect
  13279. ClientImpl redirect_client(host, port);
  13280. // Setup client with robust configuration
  13281. setup_redirect_client(redirect_client);
  13282. // Execute the redirect
  13283. return detail::redirect(redirect_client, req, res, path, location, error);
  13284. }
  13285. }
  13286. // New method for robust client setup (based on basic_manual_redirect.cpp
  13287. // logic)
  13288. template <typename ClientType>
  13289. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13290. // Copy basic settings first
  13291. client.set_connection_timeout(connection_timeout_sec_);
  13292. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13293. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13294. client.set_keep_alive(keep_alive_);
  13295. client.set_follow_location(
  13296. true); // Enable redirects to handle multi-step redirects
  13297. client.set_path_encode(path_encode_);
  13298. client.set_compress(compress_);
  13299. client.set_decompress(decompress_);
  13300. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13301. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13302. // 15.4, credentials must not be forwarded when redirecting to a different
  13303. // host. This function is only called for cross-host redirects; same-host
  13304. // redirects are handled directly in ClientImpl::redirect().
  13305. // Copy the proxy configuration unconditionally; the per-target bypass is
  13306. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13307. // still use the proxy.
  13308. client.no_proxy_entries_ = no_proxy_entries_;
  13309. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13310. client.set_proxy(proxy_host_, proxy_port_);
  13311. if (!proxy_basic_auth_username_.empty()) {
  13312. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13313. proxy_basic_auth_password_);
  13314. }
  13315. if (!proxy_bearer_token_auth_token_.empty()) {
  13316. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13317. }
  13318. #ifdef CPPHTTPLIB_SSL_ENABLED
  13319. if (!proxy_digest_auth_username_.empty()) {
  13320. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13321. proxy_digest_auth_password_);
  13322. }
  13323. #endif
  13324. }
  13325. // Copy network and socket settings
  13326. client.set_address_family(address_family_);
  13327. client.set_tcp_nodelay(tcp_nodelay_);
  13328. client.set_ipv6_v6only(ipv6_v6only_);
  13329. if (socket_options_) { client.set_socket_options(socket_options_); }
  13330. if (!interface_.empty()) { client.set_interface(interface_); }
  13331. // Copy logging and headers
  13332. if (logger_) { client.set_logger(logger_); }
  13333. if (error_logger_) { client.set_error_logger(error_logger_); }
  13334. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13335. // Each new client should generate its own headers based on its target host
  13336. }
  13337. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13338. const Request &req,
  13339. Error &error) const {
  13340. auto is_shutting_down = []() { return false; };
  13341. if (req.is_chunked_content_provider_) {
  13342. auto compressor = compress_ ? detail::create_compressor().first
  13343. : std::unique_ptr<detail::compressor>();
  13344. if (!compressor) {
  13345. compressor = detail::make_unique<detail::nocompressor>();
  13346. }
  13347. return detail::write_content_chunked(strm, req.content_provider_,
  13348. is_shutting_down, *compressor, error);
  13349. } else {
  13350. return detail::write_content_with_progress(
  13351. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13352. req.upload_progress, error);
  13353. }
  13354. }
  13355. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13356. bool close_connection, Error &error,
  13357. bool skip_body, bool &rejected_locally) {
  13358. rejected_locally = false;
  13359. // Prepare additional headers
  13360. if (close_connection) {
  13361. if (!req.has_header("Connection")) {
  13362. req.set_header("Connection", "close");
  13363. }
  13364. }
  13365. std::string ct_for_defaults;
  13366. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13367. ct_for_defaults = "text/plain";
  13368. }
  13369. prepare_default_headers(req, false, ct_for_defaults);
  13370. if (req.body.empty()) {
  13371. if (req.content_provider_) {
  13372. if (!req.is_chunked_content_provider_) {
  13373. if (!req.has_header("Content-Length")) {
  13374. auto length = std::to_string(req.content_length_);
  13375. req.set_header("Content-Length", length);
  13376. }
  13377. }
  13378. } else {
  13379. if (req.method == "POST" || req.method == "PUT" ||
  13380. req.method == "PATCH") {
  13381. req.set_header("Content-Length", "0");
  13382. }
  13383. }
  13384. }
  13385. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13386. // it opens is read by the origin. Each credential goes only to its own hop.
  13387. auto is_connect = req.method == "CONNECT";
  13388. if (!is_connect && !req.has_header("Authorization")) {
  13389. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13390. req.headers.insert(make_basic_authentication_header(
  13391. basic_auth_username_, basic_auth_password_, false));
  13392. } else if (!bearer_token_auth_token_.empty()) {
  13393. req.headers.insert(make_bearer_token_authentication_header(
  13394. bearer_token_auth_token_, false));
  13395. }
  13396. }
  13397. // Proxy-Authorization is only sent when the proxy reads this message —
  13398. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13399. // would leak proxy credentials to the destination server.
  13400. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13401. if (!proxy_basic_auth_username_.empty() &&
  13402. !proxy_basic_auth_password_.empty() &&
  13403. !req.has_header("Proxy-Authorization")) {
  13404. req.headers.insert(make_basic_authentication_header(
  13405. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13406. }
  13407. if (!proxy_bearer_token_auth_token_.empty() &&
  13408. !req.has_header("Proxy-Authorization")) {
  13409. req.headers.insert(make_bearer_token_authentication_header(
  13410. proxy_bearer_token_auth_token_, true));
  13411. }
  13412. }
  13413. // Request line and headers
  13414. {
  13415. detail::BufferStream bstrm;
  13416. // Extract the query from req.path. The encoding itself is delegated to
  13417. // `encode_request_target`; the raw query is still needed here to decide
  13418. // between populating `req.params` from it and falling back to building a
  13419. // query out of caller-supplied `req.params`.
  13420. auto query_pos = req.path.find('?');
  13421. auto query_part = query_pos == std::string::npos
  13422. ? std::string()
  13423. : req.path.substr(query_pos + 1);
  13424. auto path_with_query =
  13425. detail::encode_request_target(req.path, path_encode_);
  13426. if (!query_part.empty()) {
  13427. // The query already came in through `req.path`; still populate
  13428. // `req.params` for handlers/users who read them.
  13429. detail::parse_query_text(query_part, req.params);
  13430. } else if (!req.params.empty()) {
  13431. // No query in `req.path`; build one from `req.params` so existing
  13432. // callers that pass `Params` separately continue to work.
  13433. path_with_query = append_query_params(path_with_query, req.params);
  13434. }
  13435. // Write request line and headers
  13436. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13437. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13438. // CR/LF smuggled in via a decoded redirect Location under
  13439. // set_path_encode(false)) must fail the request cleanly instead of
  13440. // emitting a request-line-less, header-injecting request.
  13441. error = Error::Write;
  13442. rejected_locally = true;
  13443. output_error_log(error, &req);
  13444. return false;
  13445. }
  13446. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13447. error)) {
  13448. rejected_locally = true;
  13449. output_error_log(error, &req);
  13450. return false;
  13451. }
  13452. // Flush buffer
  13453. auto &data = bstrm.get_buffer();
  13454. if (!detail::write_data(strm, data.data(), data.size())) {
  13455. error = Error::Write;
  13456. output_error_log(error, &req);
  13457. return false;
  13458. }
  13459. }
  13460. // After sending request line and headers, wait briefly for an early server
  13461. // response (e.g. 4xx) and avoid sending a potentially large request body
  13462. // unnecessarily. This workaround is only enabled on Windows because Unix
  13463. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13464. // buffering can accept large writes even when the peer already responded.
  13465. // Check the stream first (which covers SSL via `is_readable()`), then
  13466. // fall back to select on the socket. Only perform the wait for very large
  13467. // request bodies to avoid interfering with normal small requests and
  13468. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13469. // response. Skip this check when using Expect: 100-continue, as the protocol
  13470. // handles early responses properly.
  13471. #if defined(_WIN32)
  13472. if (!skip_body &&
  13473. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13474. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13475. auto start = std::chrono::high_resolution_clock::now();
  13476. for (;;) {
  13477. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13478. // from SSL internals. If the underlying socket is readable, assume an
  13479. // early response may be present.
  13480. auto sock = strm.socket();
  13481. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13482. return false;
  13483. }
  13484. // Fallback to stream-level check for non-socket streams or when the
  13485. // socket isn't reporting readable. Avoid using `is_readable()` for
  13486. // SSL, since `SSL_pending()` may report buffered records that do not
  13487. // indicate a complete application-level response yet.
  13488. if (!is_ssl() && strm.is_readable()) { return false; }
  13489. auto now = std::chrono::high_resolution_clock::now();
  13490. auto elapsed =
  13491. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13492. .count();
  13493. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13494. break;
  13495. }
  13496. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13497. }
  13498. }
  13499. #endif
  13500. // Body
  13501. if (skip_body) { return true; }
  13502. return write_request_body(strm, req, error);
  13503. }
  13504. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13505. Error &error) {
  13506. if (req.body.empty()) {
  13507. return write_content_with_provider(strm, req, error);
  13508. }
  13509. if (req.upload_progress) {
  13510. auto body_size = req.body.size();
  13511. size_t written = 0;
  13512. auto data = req.body.data();
  13513. while (written < body_size) {
  13514. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13515. if (!detail::write_data(strm, data + written, to_write)) {
  13516. error = Error::Write;
  13517. output_error_log(error, &req);
  13518. return false;
  13519. }
  13520. written += to_write;
  13521. if (!req.upload_progress(written, body_size)) {
  13522. error = Error::Canceled;
  13523. output_error_log(error, &req);
  13524. return false;
  13525. }
  13526. }
  13527. } else {
  13528. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13529. error = Error::Write;
  13530. output_error_log(error, &req);
  13531. return false;
  13532. }
  13533. }
  13534. return true;
  13535. }
  13536. inline std::unique_ptr<Response>
  13537. ClientImpl::send_with_content_provider_and_receiver(
  13538. Request &req, const char *body, size_t content_length,
  13539. ContentProvider content_provider,
  13540. ContentProviderWithoutLength content_provider_without_length,
  13541. const std::string &content_type, ContentReceiver content_receiver,
  13542. Error &error) {
  13543. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13544. auto enc = compress_
  13545. ? detail::create_compressor()
  13546. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13547. nullptr, nullptr);
  13548. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13549. if (enc.first && !content_provider_without_length) {
  13550. auto &compressor = enc.first;
  13551. if (content_provider) {
  13552. auto ok = true;
  13553. auto finished = false;
  13554. size_t offset = 0;
  13555. DataSink data_sink;
  13556. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13557. if (ok) {
  13558. auto last = offset + data_len == content_length;
  13559. auto ret = compressor->compress(
  13560. data, data_len, last,
  13561. [&](const char *compressed_data, size_t compressed_data_len) {
  13562. req.body.append(compressed_data, compressed_data_len);
  13563. return true;
  13564. });
  13565. if (ret) {
  13566. offset += data_len;
  13567. } else {
  13568. ok = false;
  13569. }
  13570. }
  13571. return ok;
  13572. };
  13573. // As in detail::write_content_with_progress(): the body is framed by
  13574. // content_length, so a provider that finishes early has truncated it.
  13575. // Stop and report that instead of calling the provider forever.
  13576. data_sink.done = [&]() { finished = true; };
  13577. while (ok && !finished && offset < content_length) {
  13578. if (!content_provider(offset, content_length - offset, data_sink)) {
  13579. error = Error::Canceled;
  13580. output_error_log(error, &req);
  13581. return nullptr;
  13582. }
  13583. }
  13584. // A short body here means either the provider stopped early or the
  13585. // compressor gave up. The branch below reports a failing compressor as
  13586. // Error::Compression, so keep the two distinguishable.
  13587. if (offset < content_length) {
  13588. error = ok ? Error::Write : Error::Compression;
  13589. output_error_log(error, &req);
  13590. return nullptr;
  13591. }
  13592. } else {
  13593. if (!compressor->compress(body, content_length, true,
  13594. [&](const char *data, size_t data_len) {
  13595. req.body.append(data, data_len);
  13596. return true;
  13597. })) {
  13598. error = Error::Compression;
  13599. output_error_log(error, &req);
  13600. return nullptr;
  13601. }
  13602. }
  13603. } else {
  13604. if (content_provider) {
  13605. req.content_length_ = content_length;
  13606. req.content_provider_ = std::move(content_provider);
  13607. req.is_chunked_content_provider_ = false;
  13608. } else if (content_provider_without_length) {
  13609. req.content_length_ = 0;
  13610. req.content_provider_ = detail::ContentProviderAdapter(
  13611. std::move(content_provider_without_length));
  13612. req.is_chunked_content_provider_ = true;
  13613. req.set_header("Transfer-Encoding", "chunked");
  13614. } else {
  13615. req.body.assign(body, content_length);
  13616. }
  13617. }
  13618. if (content_receiver) {
  13619. req.content_receiver =
  13620. [content_receiver](const char *data, size_t data_length,
  13621. size_t /*offset*/, size_t /*total_length*/) {
  13622. return content_receiver(data, data_length);
  13623. };
  13624. }
  13625. auto res = detail::make_unique<Response>();
  13626. return send(req, *res, error) ? std::move(res) : nullptr;
  13627. }
  13628. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13629. const std::string &method, const std::string &path, const Headers &headers,
  13630. const char *body, size_t content_length, ContentProvider content_provider,
  13631. ContentProviderWithoutLength content_provider_without_length,
  13632. const std::string &content_type, ContentReceiver content_receiver,
  13633. UploadProgress progress) {
  13634. Request req;
  13635. req.method = method;
  13636. req.headers = headers;
  13637. req.path = path;
  13638. req.upload_progress = std::move(progress);
  13639. if (max_timeout_msec_ > 0) {
  13640. req.start_time_ = std::chrono::steady_clock::now();
  13641. }
  13642. auto error = Error::Success;
  13643. auto res = send_with_content_provider_and_receiver(
  13644. req, body, content_length, std::move(content_provider),
  13645. std::move(content_provider_without_length), content_type,
  13646. std::move(content_receiver), error);
  13647. #ifdef CPPHTTPLIB_SSL_ENABLED
  13648. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13649. last_backend_error_};
  13650. #else
  13651. return Result{std::move(res), error, std::move(req.headers)};
  13652. #endif
  13653. }
  13654. inline void ClientImpl::output_log(const Request &req,
  13655. const Response &res) const {
  13656. if (logger_) {
  13657. std::lock_guard<std::mutex> guard(logger_mutex_);
  13658. logger_(req, res);
  13659. }
  13660. }
  13661. inline void ClientImpl::output_error_log(const Error &err,
  13662. const Request *req) const {
  13663. if (error_logger_) {
  13664. std::lock_guard<std::mutex> guard(logger_mutex_);
  13665. error_logger_(err, req);
  13666. }
  13667. }
  13668. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13669. Response &res, bool close_connection,
  13670. Error &error) {
  13671. // Auto-add Expect: 100-continue for large bodies
  13672. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13673. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13674. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13675. req.set_header("Expect", "100-continue");
  13676. }
  13677. }
  13678. // Check for Expect: 100-continue
  13679. auto expect_100_continue =
  13680. detail::has_header_token(req.headers, "Expect", "100-continue");
  13681. // Send request (skip body if using Expect: 100-continue)
  13682. auto rejected_locally = false;
  13683. auto write_request_success =
  13684. write_request(strm, req, close_connection, error, expect_100_continue,
  13685. rejected_locally);
  13686. // A failed write normally still reads the response below, since the server
  13687. // may have answered early (e.g. 413/414) and closed while the body was being
  13688. // sent. A request rejected before any byte reached the socket gets no such
  13689. // response, and waiting for one would block until the read timeout.
  13690. if (rejected_locally) { return false; }
  13691. #ifdef CPPHTTPLIB_SSL_ENABLED
  13692. if (is_ssl() && !expect_100_continue) {
  13693. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13694. if (!is_proxy_enabled) {
  13695. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13696. error = Error::SSLPeerCouldBeClosed_;
  13697. output_error_log(error, &req);
  13698. return false;
  13699. }
  13700. }
  13701. }
  13702. #endif
  13703. // Handle Expect: 100-continue.
  13704. //
  13705. // Wait for an interim/early response by attempting to read the status line
  13706. // under a short timeout, instead of trusting raw socket readability. Over
  13707. // TLS, post-handshake records (e.g. session tickets) make the socket
  13708. // readable without any HTTP response being available; relying on
  13709. // `select_read` there caused the body to be withheld forever and the
  13710. // request to fail with `Read` (#2458). If no status line arrives within the
  13711. // timeout, send the body anyway (matching curl's behavior).
  13712. auto status_line_read = false;
  13713. if (expect_100_continue && write_request_success) {
  13714. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13715. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13716. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13717. strm.set_read_timeout(sec, usec);
  13718. status_line_read = read_response_line(strm, req, res, false);
  13719. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13720. }
  13721. if (!status_line_read) {
  13722. // No interim response within the timeout: send the body and handle the
  13723. // response as usual.
  13724. if (!write_request_body(strm, req, error)) { return false; }
  13725. expect_100_continue = false; // Switch to normal response handling
  13726. }
  13727. }
  13728. // Receive response and headers
  13729. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13730. if ((!status_line_read &&
  13731. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13732. !detail::read_headers(strm, res.headers)) {
  13733. if (write_request_success) { error = Error::Read; }
  13734. output_error_log(error, &req);
  13735. return false;
  13736. }
  13737. if (!write_request_success) { return false; }
  13738. // Handle Expect: 100-continue response
  13739. if (expect_100_continue) {
  13740. if (res.status == StatusCode::Continue_100) {
  13741. // Server accepted, send the body
  13742. if (!write_request_body(strm, req, error)) { return false; }
  13743. // Read the actual response
  13744. res.headers.clear();
  13745. res.body.clear();
  13746. if (!read_response_line(strm, req, res) ||
  13747. !detail::read_headers(strm, res.headers)) {
  13748. error = Error::Read;
  13749. output_error_log(error, &req);
  13750. return false;
  13751. }
  13752. }
  13753. // If not 100 Continue, server returned an error; proceed with that response
  13754. }
  13755. // Body
  13756. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13757. req.method != "CONNECT") {
  13758. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13759. // whose final transfer coding is not chunked is not ambiguous: its body
  13760. // runs until the server closes the connection, so it is not rejected.
  13761. // HEAD/204 are excluded above and a 304 carries no body.
  13762. if (res.status != StatusCode::NotModified_304 &&
  13763. detail::has_conflicting_content_length(res.headers)) {
  13764. error = Error::Read;
  13765. output_error_log(error, &req);
  13766. return false;
  13767. }
  13768. auto redirect = 300 < res.status && res.status < 400 &&
  13769. res.status != StatusCode::NotModified_304 &&
  13770. follow_location_;
  13771. if (req.response_handler && !redirect) {
  13772. if (!req.response_handler(res)) {
  13773. error = Error::Canceled;
  13774. output_error_log(error, &req);
  13775. return false;
  13776. }
  13777. }
  13778. auto out =
  13779. req.content_receiver
  13780. ? static_cast<ContentReceiverWithProgress>(
  13781. [&](const char *buf, size_t n, size_t off, size_t len) {
  13782. if (redirect) { return true; }
  13783. auto ret = req.content_receiver(buf, n, off, len);
  13784. if (!ret) {
  13785. error = Error::Canceled;
  13786. output_error_log(error, &req);
  13787. }
  13788. return ret;
  13789. })
  13790. : static_cast<ContentReceiverWithProgress>(
  13791. [&](const char *buf, size_t n, size_t /*off*/,
  13792. size_t /*len*/) {
  13793. assert(res.body.size() + n <= res.body.max_size());
  13794. if (payload_max_length_ > 0 &&
  13795. (res.body.size() >= payload_max_length_ ||
  13796. n > payload_max_length_ - res.body.size())) {
  13797. return false;
  13798. }
  13799. res.body.append(buf, n);
  13800. return true;
  13801. });
  13802. auto progress = [&](size_t current, size_t total) {
  13803. if (!req.download_progress || redirect) { return true; }
  13804. auto ret = req.download_progress(current, total);
  13805. if (!ret) {
  13806. error = Error::Canceled;
  13807. output_error_log(error, &req);
  13808. }
  13809. return ret;
  13810. };
  13811. if (res.has_header("Content-Length")) {
  13812. if (!req.content_receiver) {
  13813. auto len = res.get_header_value_u64("Content-Length");
  13814. if (len > res.body.max_size()) {
  13815. error = Error::Read;
  13816. output_error_log(error, &req);
  13817. return false;
  13818. }
  13819. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13820. // hostile or malformed server sends an enormous Content-Length.
  13821. // The actual body read below is bounded by payload_max_length_,
  13822. // so reserving more than that is never useful.
  13823. auto reserve_len = static_cast<size_t>(len);
  13824. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13825. reserve_len = payload_max_length_;
  13826. }
  13827. res.body.reserve(reserve_len);
  13828. }
  13829. }
  13830. if (res.status != StatusCode::NotModified_304) {
  13831. auto content_status = 0;
  13832. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13833. ? (std::numeric_limits<size_t>::max)()
  13834. : payload_max_length_;
  13835. if (!detail::read_content(strm, res, max_length, content_status,
  13836. std::move(progress), std::move(out),
  13837. decompress_)) {
  13838. if (error != Error::Canceled) {
  13839. // Tell the caller apart from a plain read failure when the body could
  13840. // not be decoded because of its Content-Encoding.
  13841. switch (content_status) {
  13842. case StatusCode::UnsupportedMediaType_415:
  13843. error = Error::UnsupportedContentEncoding;
  13844. break;
  13845. case StatusCode::InternalServerError_500:
  13846. error = Error::Compression;
  13847. break;
  13848. default: error = Error::Read; break;
  13849. }
  13850. }
  13851. output_error_log(error, &req);
  13852. return false;
  13853. }
  13854. }
  13855. }
  13856. // Log
  13857. output_log(req, res);
  13858. return true;
  13859. }
  13860. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13861. const std::string &boundary, const UploadFormDataItems &items,
  13862. const FormDataProviderItems &provider_items) const {
  13863. size_t cur_item = 0;
  13864. size_t cur_start = 0;
  13865. // cur_item and cur_start are copied to within the std::function and
  13866. // maintain state between successive calls
  13867. return [&, cur_item, cur_start](size_t offset,
  13868. DataSink &sink) mutable -> bool {
  13869. if (!offset && !items.empty()) {
  13870. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13871. return true;
  13872. } else if (cur_item < provider_items.size()) {
  13873. if (!cur_start) {
  13874. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13875. provider_items[cur_item], boundary);
  13876. offset += begin.size();
  13877. cur_start = offset;
  13878. sink.os << begin;
  13879. }
  13880. DataSink cur_sink;
  13881. auto has_data = true;
  13882. cur_sink.write = sink.write;
  13883. // Forward is_writable so a provider item asking whether it may keep
  13884. // going gets the outer sink's answer rather than the default `true`.
  13885. cur_sink.is_writable = sink.is_writable;
  13886. cur_sink.done = [&]() { has_data = false; };
  13887. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13888. return false;
  13889. }
  13890. if (!has_data) {
  13891. sink.os << detail::serialize_multipart_formdata_item_end();
  13892. cur_item++;
  13893. cur_start = 0;
  13894. }
  13895. return true;
  13896. } else {
  13897. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13898. sink.done();
  13899. return true;
  13900. }
  13901. };
  13902. }
  13903. inline bool ClientImpl::process_socket(
  13904. const Socket &socket,
  13905. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13906. std::function<bool(Stream &strm)> callback) {
  13907. return detail::process_client_socket(
  13908. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13909. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13910. }
  13911. inline bool ClientImpl::is_ssl() const { return false; }
  13912. inline Result ClientImpl::Get(const std::string &path,
  13913. DownloadProgress progress) {
  13914. return Get(path, Headers(), std::move(progress));
  13915. }
  13916. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13917. DownloadProgress progress) {
  13918. return Get(path, params, Headers(), std::move(progress));
  13919. }
  13920. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13921. const Headers &headers,
  13922. DownloadProgress progress) {
  13923. if (params.empty()) { return Get(path, headers); }
  13924. std::string path_with_query = append_query_params(path, params);
  13925. return Get(path_with_query, headers, std::move(progress));
  13926. }
  13927. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13928. DownloadProgress progress) {
  13929. Request req;
  13930. req.method = "GET";
  13931. req.path = path;
  13932. req.headers = headers;
  13933. req.download_progress = std::move(progress);
  13934. if (max_timeout_msec_ > 0) {
  13935. req.start_time_ = std::chrono::steady_clock::now();
  13936. }
  13937. return send_(std::move(req));
  13938. }
  13939. inline Result ClientImpl::Get(const std::string &path,
  13940. ContentReceiver content_receiver,
  13941. DownloadProgress progress) {
  13942. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13943. std::move(progress));
  13944. }
  13945. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13946. ContentReceiver content_receiver,
  13947. DownloadProgress progress) {
  13948. return Get(path, headers, nullptr, std::move(content_receiver),
  13949. std::move(progress));
  13950. }
  13951. inline Result ClientImpl::Get(const std::string &path,
  13952. ResponseHandler response_handler,
  13953. ContentReceiver content_receiver,
  13954. DownloadProgress progress) {
  13955. return Get(path, Headers(), std::move(response_handler),
  13956. std::move(content_receiver), std::move(progress));
  13957. }
  13958. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13959. ResponseHandler response_handler,
  13960. ContentReceiver content_receiver,
  13961. DownloadProgress progress) {
  13962. Request req;
  13963. req.method = "GET";
  13964. req.path = path;
  13965. req.headers = headers;
  13966. req.response_handler = std::move(response_handler);
  13967. req.content_receiver =
  13968. [content_receiver](const char *data, size_t data_length,
  13969. size_t /*offset*/, size_t /*total_length*/) {
  13970. return content_receiver(data, data_length);
  13971. };
  13972. req.download_progress = std::move(progress);
  13973. if (max_timeout_msec_ > 0) {
  13974. req.start_time_ = std::chrono::steady_clock::now();
  13975. }
  13976. return send_(std::move(req));
  13977. }
  13978. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13979. const Headers &headers,
  13980. ContentReceiver content_receiver,
  13981. DownloadProgress progress) {
  13982. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13983. std::move(progress));
  13984. }
  13985. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13986. const Headers &headers,
  13987. ResponseHandler response_handler,
  13988. ContentReceiver content_receiver,
  13989. DownloadProgress progress) {
  13990. if (params.empty()) {
  13991. return Get(path, headers, std::move(response_handler),
  13992. std::move(content_receiver), std::move(progress));
  13993. }
  13994. std::string path_with_query = append_query_params(path, params);
  13995. return Get(path_with_query, headers, std::move(response_handler),
  13996. std::move(content_receiver), std::move(progress));
  13997. }
  13998. inline Result ClientImpl::Head(const std::string &path) {
  13999. return Head(path, Headers());
  14000. }
  14001. inline Result ClientImpl::Head(const std::string &path,
  14002. const Headers &headers) {
  14003. Request req;
  14004. req.method = "HEAD";
  14005. req.headers = headers;
  14006. req.path = path;
  14007. if (max_timeout_msec_ > 0) {
  14008. req.start_time_ = std::chrono::steady_clock::now();
  14009. }
  14010. return send_(std::move(req));
  14011. }
  14012. inline Result ClientImpl::Post(const std::string &path) {
  14013. return Post(path, std::string(), std::string());
  14014. }
  14015. inline Result ClientImpl::Post(const std::string &path,
  14016. const Headers &headers) {
  14017. return Post(path, headers, nullptr, 0, std::string());
  14018. }
  14019. inline Result ClientImpl::Post(const std::string &path, const char *body,
  14020. size_t content_length,
  14021. const std::string &content_type,
  14022. UploadProgress progress) {
  14023. return Post(path, Headers(), body, content_length, content_type, progress);
  14024. }
  14025. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  14026. const std::string &content_type,
  14027. UploadProgress progress) {
  14028. return Post(path, Headers(), body, content_type, progress);
  14029. }
  14030. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  14031. return Post(path, Headers(), params);
  14032. }
  14033. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14034. ContentProvider content_provider,
  14035. const std::string &content_type,
  14036. UploadProgress progress) {
  14037. return Post(path, Headers(), content_length, std::move(content_provider),
  14038. content_type, progress);
  14039. }
  14040. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  14041. ContentProvider content_provider,
  14042. const std::string &content_type,
  14043. ContentReceiver content_receiver,
  14044. UploadProgress progress) {
  14045. return Post(path, Headers(), content_length, std::move(content_provider),
  14046. content_type, std::move(content_receiver), progress);
  14047. }
  14048. inline Result ClientImpl::Post(const std::string &path,
  14049. ContentProviderWithoutLength content_provider,
  14050. const std::string &content_type,
  14051. UploadProgress progress) {
  14052. return Post(path, Headers(), std::move(content_provider), content_type,
  14053. progress);
  14054. }
  14055. inline Result ClientImpl::Post(const std::string &path,
  14056. ContentProviderWithoutLength content_provider,
  14057. const std::string &content_type,
  14058. ContentReceiver content_receiver,
  14059. UploadProgress progress) {
  14060. return Post(path, Headers(), std::move(content_provider), content_type,
  14061. std::move(content_receiver), progress);
  14062. }
  14063. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14064. const Params &params) {
  14065. auto query = detail::params_to_query_str(params);
  14066. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14067. }
  14068. inline Result ClientImpl::Post(const std::string &path,
  14069. const UploadFormDataItems &items,
  14070. UploadProgress progress) {
  14071. return Post(path, Headers(), items, progress);
  14072. }
  14073. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14074. const UploadFormDataItems &items,
  14075. UploadProgress progress) {
  14076. const auto &boundary = detail::make_multipart_data_boundary();
  14077. const auto &content_type =
  14078. detail::serialize_multipart_formdata_get_content_type(boundary);
  14079. auto content_length = detail::get_multipart_content_length(items, boundary);
  14080. return Post(path, headers, content_length,
  14081. detail::make_multipart_content_provider(items, boundary),
  14082. content_type, progress);
  14083. }
  14084. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14085. const UploadFormDataItems &items,
  14086. const std::string &boundary,
  14087. UploadProgress progress) {
  14088. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14089. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14090. }
  14091. const auto &content_type =
  14092. detail::serialize_multipart_formdata_get_content_type(boundary);
  14093. auto content_length = detail::get_multipart_content_length(items, boundary);
  14094. return Post(path, headers, content_length,
  14095. detail::make_multipart_content_provider(items, boundary),
  14096. content_type, progress);
  14097. }
  14098. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14099. const char *body, size_t content_length,
  14100. const std::string &content_type,
  14101. UploadProgress progress) {
  14102. return send_with_content_provider_and_receiver(
  14103. "POST", path, headers, body, content_length, nullptr, nullptr,
  14104. content_type, nullptr, progress);
  14105. }
  14106. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14107. const std::string &body,
  14108. const std::string &content_type,
  14109. UploadProgress progress) {
  14110. return send_with_content_provider_and_receiver(
  14111. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14112. content_type, nullptr, progress);
  14113. }
  14114. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14115. size_t content_length,
  14116. ContentProvider content_provider,
  14117. const std::string &content_type,
  14118. UploadProgress progress) {
  14119. return send_with_content_provider_and_receiver(
  14120. "POST", path, headers, nullptr, content_length,
  14121. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14122. }
  14123. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14124. size_t content_length,
  14125. ContentProvider content_provider,
  14126. const std::string &content_type,
  14127. ContentReceiver content_receiver,
  14128. DownloadProgress progress) {
  14129. return send_with_content_provider_and_receiver(
  14130. "POST", path, headers, nullptr, content_length,
  14131. std::move(content_provider), nullptr, content_type,
  14132. std::move(content_receiver), std::move(progress));
  14133. }
  14134. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14135. ContentProviderWithoutLength content_provider,
  14136. const std::string &content_type,
  14137. UploadProgress progress) {
  14138. return send_with_content_provider_and_receiver(
  14139. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14140. content_type, nullptr, progress);
  14141. }
  14142. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14143. ContentProviderWithoutLength content_provider,
  14144. const std::string &content_type,
  14145. ContentReceiver content_receiver,
  14146. DownloadProgress progress) {
  14147. return send_with_content_provider_and_receiver(
  14148. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14149. content_type, std::move(content_receiver), std::move(progress));
  14150. }
  14151. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14152. const UploadFormDataItems &items,
  14153. const FormDataProviderItems &provider_items,
  14154. UploadProgress progress) {
  14155. const auto &boundary = detail::make_multipart_data_boundary();
  14156. const auto &content_type =
  14157. detail::serialize_multipart_formdata_get_content_type(boundary);
  14158. return send_with_content_provider_and_receiver(
  14159. "POST", path, headers, nullptr, 0, nullptr,
  14160. get_multipart_content_provider(boundary, items, provider_items),
  14161. content_type, nullptr, progress);
  14162. }
  14163. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14164. const std::string &body,
  14165. const std::string &content_type,
  14166. ContentReceiver content_receiver,
  14167. DownloadProgress progress) {
  14168. Request req;
  14169. req.method = "POST";
  14170. req.path = path;
  14171. req.headers = headers;
  14172. req.body = body;
  14173. req.content_receiver =
  14174. [content_receiver](const char *data, size_t data_length,
  14175. size_t /*offset*/, size_t /*total_length*/) {
  14176. return content_receiver(data, data_length);
  14177. };
  14178. req.download_progress = std::move(progress);
  14179. if (max_timeout_msec_ > 0) {
  14180. req.start_time_ = std::chrono::steady_clock::now();
  14181. }
  14182. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14183. return send_(std::move(req));
  14184. }
  14185. inline Result ClientImpl::Put(const std::string &path) {
  14186. return Put(path, std::string(), std::string());
  14187. }
  14188. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14189. return Put(path, headers, nullptr, 0, std::string());
  14190. }
  14191. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14192. size_t content_length,
  14193. const std::string &content_type,
  14194. UploadProgress progress) {
  14195. return Put(path, Headers(), body, content_length, content_type, progress);
  14196. }
  14197. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14198. const std::string &content_type,
  14199. UploadProgress progress) {
  14200. return Put(path, Headers(), body, content_type, progress);
  14201. }
  14202. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14203. return Put(path, Headers(), params);
  14204. }
  14205. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14206. ContentProvider content_provider,
  14207. const std::string &content_type,
  14208. UploadProgress progress) {
  14209. return Put(path, Headers(), content_length, std::move(content_provider),
  14210. content_type, progress);
  14211. }
  14212. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14213. ContentProvider content_provider,
  14214. const std::string &content_type,
  14215. ContentReceiver content_receiver,
  14216. UploadProgress progress) {
  14217. return Put(path, Headers(), content_length, std::move(content_provider),
  14218. content_type, std::move(content_receiver), progress);
  14219. }
  14220. inline Result ClientImpl::Put(const std::string &path,
  14221. ContentProviderWithoutLength content_provider,
  14222. const std::string &content_type,
  14223. UploadProgress progress) {
  14224. return Put(path, Headers(), std::move(content_provider), content_type,
  14225. progress);
  14226. }
  14227. inline Result ClientImpl::Put(const std::string &path,
  14228. ContentProviderWithoutLength content_provider,
  14229. const std::string &content_type,
  14230. ContentReceiver content_receiver,
  14231. UploadProgress progress) {
  14232. return Put(path, Headers(), std::move(content_provider), content_type,
  14233. std::move(content_receiver), progress);
  14234. }
  14235. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14236. const Params &params) {
  14237. auto query = detail::params_to_query_str(params);
  14238. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14239. }
  14240. inline Result ClientImpl::Put(const std::string &path,
  14241. const UploadFormDataItems &items,
  14242. UploadProgress progress) {
  14243. return Put(path, Headers(), items, progress);
  14244. }
  14245. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14246. const UploadFormDataItems &items,
  14247. UploadProgress progress) {
  14248. const auto &boundary = detail::make_multipart_data_boundary();
  14249. const auto &content_type =
  14250. detail::serialize_multipart_formdata_get_content_type(boundary);
  14251. auto content_length = detail::get_multipart_content_length(items, boundary);
  14252. return Put(path, headers, content_length,
  14253. detail::make_multipart_content_provider(items, boundary),
  14254. content_type, progress);
  14255. }
  14256. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14257. const UploadFormDataItems &items,
  14258. const std::string &boundary,
  14259. UploadProgress progress) {
  14260. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14261. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14262. }
  14263. const auto &content_type =
  14264. detail::serialize_multipart_formdata_get_content_type(boundary);
  14265. auto content_length = detail::get_multipart_content_length(items, boundary);
  14266. return Put(path, headers, content_length,
  14267. detail::make_multipart_content_provider(items, boundary),
  14268. content_type, progress);
  14269. }
  14270. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14271. const char *body, size_t content_length,
  14272. const std::string &content_type,
  14273. UploadProgress progress) {
  14274. return send_with_content_provider_and_receiver(
  14275. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14276. content_type, nullptr, progress);
  14277. }
  14278. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14279. const std::string &body,
  14280. const std::string &content_type,
  14281. UploadProgress progress) {
  14282. return send_with_content_provider_and_receiver(
  14283. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14284. content_type, nullptr, progress);
  14285. }
  14286. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14287. size_t content_length,
  14288. ContentProvider content_provider,
  14289. const std::string &content_type,
  14290. UploadProgress progress) {
  14291. return send_with_content_provider_and_receiver(
  14292. "PUT", path, headers, nullptr, content_length,
  14293. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14294. }
  14295. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14296. size_t content_length,
  14297. ContentProvider content_provider,
  14298. const std::string &content_type,
  14299. ContentReceiver content_receiver,
  14300. UploadProgress progress) {
  14301. return send_with_content_provider_and_receiver(
  14302. "PUT", path, headers, nullptr, content_length,
  14303. std::move(content_provider), nullptr, content_type,
  14304. std::move(content_receiver), progress);
  14305. }
  14306. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14307. ContentProviderWithoutLength content_provider,
  14308. const std::string &content_type,
  14309. UploadProgress progress) {
  14310. return send_with_content_provider_and_receiver(
  14311. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14312. content_type, nullptr, progress);
  14313. }
  14314. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14315. ContentProviderWithoutLength content_provider,
  14316. const std::string &content_type,
  14317. ContentReceiver content_receiver,
  14318. UploadProgress progress) {
  14319. return send_with_content_provider_and_receiver(
  14320. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14321. content_type, std::move(content_receiver), progress);
  14322. }
  14323. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14324. const UploadFormDataItems &items,
  14325. const FormDataProviderItems &provider_items,
  14326. UploadProgress progress) {
  14327. const auto &boundary = detail::make_multipart_data_boundary();
  14328. const auto &content_type =
  14329. detail::serialize_multipart_formdata_get_content_type(boundary);
  14330. return send_with_content_provider_and_receiver(
  14331. "PUT", path, headers, nullptr, 0, nullptr,
  14332. get_multipart_content_provider(boundary, items, provider_items),
  14333. content_type, nullptr, progress);
  14334. }
  14335. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14336. const std::string &body,
  14337. const std::string &content_type,
  14338. ContentReceiver content_receiver,
  14339. DownloadProgress progress) {
  14340. Request req;
  14341. req.method = "PUT";
  14342. req.path = path;
  14343. req.headers = headers;
  14344. req.body = body;
  14345. req.content_receiver =
  14346. [content_receiver](const char *data, size_t data_length,
  14347. size_t /*offset*/, size_t /*total_length*/) {
  14348. return content_receiver(data, data_length);
  14349. };
  14350. req.download_progress = std::move(progress);
  14351. if (max_timeout_msec_ > 0) {
  14352. req.start_time_ = std::chrono::steady_clock::now();
  14353. }
  14354. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14355. return send_(std::move(req));
  14356. }
  14357. inline Result ClientImpl::Patch(const std::string &path) {
  14358. return Patch(path, std::string(), std::string());
  14359. }
  14360. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14361. UploadProgress progress) {
  14362. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14363. }
  14364. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14365. size_t content_length,
  14366. const std::string &content_type,
  14367. UploadProgress progress) {
  14368. return Patch(path, Headers(), body, content_length, content_type, progress);
  14369. }
  14370. inline Result ClientImpl::Patch(const std::string &path,
  14371. const std::string &body,
  14372. const std::string &content_type,
  14373. UploadProgress progress) {
  14374. return Patch(path, Headers(), body, content_type, progress);
  14375. }
  14376. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14377. return Patch(path, Headers(), params);
  14378. }
  14379. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14380. ContentProvider content_provider,
  14381. const std::string &content_type,
  14382. UploadProgress progress) {
  14383. return Patch(path, Headers(), content_length, std::move(content_provider),
  14384. content_type, progress);
  14385. }
  14386. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14387. ContentProvider content_provider,
  14388. const std::string &content_type,
  14389. ContentReceiver content_receiver,
  14390. UploadProgress progress) {
  14391. return Patch(path, Headers(), content_length, std::move(content_provider),
  14392. content_type, std::move(content_receiver), progress);
  14393. }
  14394. inline Result ClientImpl::Patch(const std::string &path,
  14395. ContentProviderWithoutLength content_provider,
  14396. const std::string &content_type,
  14397. UploadProgress progress) {
  14398. return Patch(path, Headers(), std::move(content_provider), content_type,
  14399. progress);
  14400. }
  14401. inline Result ClientImpl::Patch(const std::string &path,
  14402. ContentProviderWithoutLength content_provider,
  14403. const std::string &content_type,
  14404. ContentReceiver content_receiver,
  14405. UploadProgress progress) {
  14406. return Patch(path, Headers(), std::move(content_provider), content_type,
  14407. std::move(content_receiver), progress);
  14408. }
  14409. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14410. const Params &params) {
  14411. auto query = detail::params_to_query_str(params);
  14412. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14413. }
  14414. inline Result ClientImpl::Patch(const std::string &path,
  14415. const UploadFormDataItems &items,
  14416. UploadProgress progress) {
  14417. return Patch(path, Headers(), items, progress);
  14418. }
  14419. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14420. const UploadFormDataItems &items,
  14421. UploadProgress progress) {
  14422. const auto &boundary = detail::make_multipart_data_boundary();
  14423. const auto &content_type =
  14424. detail::serialize_multipart_formdata_get_content_type(boundary);
  14425. auto content_length = detail::get_multipart_content_length(items, boundary);
  14426. return Patch(path, headers, content_length,
  14427. detail::make_multipart_content_provider(items, boundary),
  14428. content_type, progress);
  14429. }
  14430. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14431. const UploadFormDataItems &items,
  14432. const std::string &boundary,
  14433. UploadProgress progress) {
  14434. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14435. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14436. }
  14437. const auto &content_type =
  14438. detail::serialize_multipart_formdata_get_content_type(boundary);
  14439. auto content_length = detail::get_multipart_content_length(items, boundary);
  14440. return Patch(path, headers, content_length,
  14441. detail::make_multipart_content_provider(items, boundary),
  14442. content_type, progress);
  14443. }
  14444. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14445. const char *body, size_t content_length,
  14446. const std::string &content_type,
  14447. UploadProgress progress) {
  14448. return send_with_content_provider_and_receiver(
  14449. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14450. content_type, nullptr, progress);
  14451. }
  14452. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14453. const std::string &body,
  14454. const std::string &content_type,
  14455. UploadProgress progress) {
  14456. return send_with_content_provider_and_receiver(
  14457. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14458. content_type, nullptr, progress);
  14459. }
  14460. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14461. size_t content_length,
  14462. ContentProvider content_provider,
  14463. const std::string &content_type,
  14464. UploadProgress progress) {
  14465. return send_with_content_provider_and_receiver(
  14466. "PATCH", path, headers, nullptr, content_length,
  14467. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14468. }
  14469. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14470. size_t content_length,
  14471. ContentProvider content_provider,
  14472. const std::string &content_type,
  14473. ContentReceiver content_receiver,
  14474. UploadProgress progress) {
  14475. return send_with_content_provider_and_receiver(
  14476. "PATCH", path, headers, nullptr, content_length,
  14477. std::move(content_provider), nullptr, content_type,
  14478. std::move(content_receiver), progress);
  14479. }
  14480. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14481. ContentProviderWithoutLength content_provider,
  14482. const std::string &content_type,
  14483. UploadProgress progress) {
  14484. return send_with_content_provider_and_receiver(
  14485. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14486. content_type, nullptr, progress);
  14487. }
  14488. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14489. ContentProviderWithoutLength content_provider,
  14490. const std::string &content_type,
  14491. ContentReceiver content_receiver,
  14492. UploadProgress progress) {
  14493. return send_with_content_provider_and_receiver(
  14494. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14495. content_type, std::move(content_receiver), progress);
  14496. }
  14497. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14498. const UploadFormDataItems &items,
  14499. const FormDataProviderItems &provider_items,
  14500. UploadProgress progress) {
  14501. const auto &boundary = detail::make_multipart_data_boundary();
  14502. const auto &content_type =
  14503. detail::serialize_multipart_formdata_get_content_type(boundary);
  14504. return send_with_content_provider_and_receiver(
  14505. "PATCH", path, headers, nullptr, 0, nullptr,
  14506. get_multipart_content_provider(boundary, items, provider_items),
  14507. content_type, nullptr, progress);
  14508. }
  14509. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14510. const std::string &body,
  14511. const std::string &content_type,
  14512. ContentReceiver content_receiver,
  14513. DownloadProgress progress) {
  14514. Request req;
  14515. req.method = "PATCH";
  14516. req.path = path;
  14517. req.headers = headers;
  14518. req.body = body;
  14519. req.content_receiver =
  14520. [content_receiver](const char *data, size_t data_length,
  14521. size_t /*offset*/, size_t /*total_length*/) {
  14522. return content_receiver(data, data_length);
  14523. };
  14524. req.download_progress = std::move(progress);
  14525. if (max_timeout_msec_ > 0) {
  14526. req.start_time_ = std::chrono::steady_clock::now();
  14527. }
  14528. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14529. return send_(std::move(req));
  14530. }
  14531. inline Result ClientImpl::Delete(const std::string &path,
  14532. DownloadProgress progress) {
  14533. return Delete(path, Headers(), std::string(), std::string(), progress);
  14534. }
  14535. inline Result ClientImpl::Delete(const std::string &path,
  14536. const Headers &headers,
  14537. DownloadProgress progress) {
  14538. return Delete(path, headers, std::string(), std::string(), progress);
  14539. }
  14540. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14541. size_t content_length,
  14542. const std::string &content_type,
  14543. DownloadProgress progress) {
  14544. return Delete(path, Headers(), body, content_length, content_type, progress);
  14545. }
  14546. inline Result ClientImpl::Delete(const std::string &path,
  14547. const std::string &body,
  14548. const std::string &content_type,
  14549. DownloadProgress progress) {
  14550. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14551. progress);
  14552. }
  14553. inline Result ClientImpl::Delete(const std::string &path,
  14554. const Headers &headers,
  14555. const std::string &body,
  14556. const std::string &content_type,
  14557. DownloadProgress progress) {
  14558. return Delete(path, headers, body.data(), body.size(), content_type,
  14559. progress);
  14560. }
  14561. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14562. DownloadProgress progress) {
  14563. return Delete(path, Headers(), params, progress);
  14564. }
  14565. inline Result ClientImpl::Delete(const std::string &path,
  14566. const Headers &headers, const Params &params,
  14567. DownloadProgress progress) {
  14568. auto query = detail::params_to_query_str(params);
  14569. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14570. progress);
  14571. }
  14572. inline Result ClientImpl::Delete(const std::string &path,
  14573. const Headers &headers, const char *body,
  14574. size_t content_length,
  14575. const std::string &content_type,
  14576. DownloadProgress progress) {
  14577. Request req;
  14578. req.method = "DELETE";
  14579. req.headers = headers;
  14580. req.path = path;
  14581. req.download_progress = std::move(progress);
  14582. if (max_timeout_msec_ > 0) {
  14583. req.start_time_ = std::chrono::steady_clock::now();
  14584. }
  14585. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14586. req.body.assign(body, content_length);
  14587. return send_(std::move(req));
  14588. }
  14589. inline Result ClientImpl::Options(const std::string &path) {
  14590. return Options(path, Headers());
  14591. }
  14592. inline Result ClientImpl::Options(const std::string &path,
  14593. const Headers &headers) {
  14594. Request req;
  14595. req.method = "OPTIONS";
  14596. req.headers = headers;
  14597. req.path = path;
  14598. if (max_timeout_msec_ > 0) {
  14599. req.start_time_ = std::chrono::steady_clock::now();
  14600. }
  14601. return send_(std::move(req));
  14602. }
  14603. inline void ClientImpl::stop() {
  14604. std::lock_guard<std::mutex> guard(socket_mutex_);
  14605. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14606. // do is to shutdown_socket, so that threads using this socket suddenly
  14607. // discover they can't read/write any more and error out. Everything else
  14608. // (closing the socket, shutting ssl down) is unsafe because these actions
  14609. // are not thread-safe.
  14610. if (socket_requests_in_flight_ > 0) {
  14611. shutdown_socket(socket_);
  14612. // Aside from that, we set a flag for the socket to be closed when we're
  14613. // done.
  14614. socket_should_be_closed_when_request_is_done_ = true;
  14615. return;
  14616. }
  14617. disconnect(/*gracefully=*/true);
  14618. }
  14619. inline std::string ClientImpl::host() const { return host_; }
  14620. inline int ClientImpl::port() const { return port_; }
  14621. inline size_t ClientImpl::is_socket_open() const {
  14622. std::lock_guard<std::mutex> guard(socket_mutex_);
  14623. return socket_.is_open();
  14624. }
  14625. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14626. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14627. connection_timeout_sec_ = sec;
  14628. connection_timeout_usec_ = usec;
  14629. }
  14630. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14631. read_timeout_sec_ = sec;
  14632. read_timeout_usec_ = usec;
  14633. }
  14634. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14635. write_timeout_sec_ = sec;
  14636. write_timeout_usec_ = usec;
  14637. }
  14638. inline void ClientImpl::set_max_timeout(time_t msec) {
  14639. max_timeout_msec_ = msec;
  14640. }
  14641. inline void ClientImpl::set_basic_auth(const std::string &username,
  14642. const std::string &password) {
  14643. basic_auth_username_ = username;
  14644. basic_auth_password_ = password;
  14645. }
  14646. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14647. bearer_token_auth_token_ = token;
  14648. }
  14649. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14650. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14651. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14652. inline void
  14653. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14654. addr_map_ = std::move(addr_map);
  14655. }
  14656. inline void ClientImpl::set_default_headers(Headers headers) {
  14657. default_headers_ = std::move(headers);
  14658. }
  14659. inline void ClientImpl::set_header_writer(
  14660. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14661. header_writer_ = writer;
  14662. }
  14663. inline void ClientImpl::set_address_family(int family) {
  14664. address_family_ = family;
  14665. }
  14666. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14667. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14668. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14669. socket_options_ = std::move(socket_options);
  14670. }
  14671. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14672. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14673. inline void ClientImpl::set_payload_max_length(size_t length) {
  14674. payload_max_length_ = length;
  14675. has_payload_max_length_ = true;
  14676. }
  14677. inline void ClientImpl::set_interface(const std::string &intf) {
  14678. interface_ = intf;
  14679. }
  14680. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14681. proxy_host_ = host;
  14682. proxy_port_ = port;
  14683. std::lock_guard<std::mutex> guard(socket_mutex_);
  14684. disconnect(/*gracefully=*/true);
  14685. }
  14686. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14687. const std::string &password) {
  14688. proxy_basic_auth_username_ = username;
  14689. proxy_basic_auth_password_ = password;
  14690. }
  14691. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14692. proxy_bearer_token_auth_token_ = token;
  14693. }
  14694. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14695. std::vector<detail::NoProxyEntry> parsed;
  14696. parsed.reserve(patterns.size());
  14697. for (const auto &p : patterns) {
  14698. auto trimmed = detail::trim_copy(p);
  14699. if (trimmed.empty()) { continue; }
  14700. detail::NoProxyEntry entry;
  14701. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14702. parsed.push_back(std::move(entry));
  14703. }
  14704. }
  14705. no_proxy_entries_ = std::move(parsed);
  14706. std::lock_guard<std::mutex> guard(socket_mutex_);
  14707. disconnect(/*gracefully=*/true);
  14708. }
  14709. #ifdef CPPHTTPLIB_SSL_ENABLED
  14710. inline void ClientImpl::set_digest_auth(const std::string &username,
  14711. const std::string &password) {
  14712. digest_auth_username_ = username;
  14713. digest_auth_password_ = password;
  14714. }
  14715. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14716. const std::string &ca_cert_dir_path) {
  14717. ca_cert_file_path_ = ca_cert_file_path;
  14718. ca_cert_dir_path_ = ca_cert_dir_path;
  14719. }
  14720. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14721. const std::string &password) {
  14722. proxy_digest_auth_username_ = username;
  14723. proxy_digest_auth_password_ = password;
  14724. }
  14725. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14726. server_certificate_verification_ = enabled;
  14727. }
  14728. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14729. server_hostname_verification_ = enabled;
  14730. }
  14731. inline void ClientImpl::enable_system_ca(bool enabled) {
  14732. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14733. }
  14734. #endif
  14735. inline void ClientImpl::set_logger(Logger logger) {
  14736. logger_ = std::move(logger);
  14737. }
  14738. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14739. error_logger_ = std::move(error_logger);
  14740. }
  14741. /*
  14742. * SSL/TLS Common Implementation
  14743. */
  14744. inline ClientConnection::~ClientConnection() {
  14745. #ifdef CPPHTTPLIB_SSL_ENABLED
  14746. if (session) {
  14747. tls::shutdown(session, true);
  14748. tls::free_session(session);
  14749. session = nullptr;
  14750. }
  14751. #endif
  14752. if (sock != INVALID_SOCKET) {
  14753. detail::close_socket(sock);
  14754. sock = INVALID_SOCKET;
  14755. }
  14756. }
  14757. // Universal client implementation
  14758. inline Client::Client(const std::string &scheme_host_port)
  14759. : Client(scheme_host_port, std::string(), std::string()) {}
  14760. inline Client::Client(const std::string &scheme_host_port,
  14761. const std::string &client_cert_path,
  14762. const std::string &client_key_path) {
  14763. detail::UrlComponents uc;
  14764. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14765. auto &scheme = uc.scheme;
  14766. #ifdef CPPHTTPLIB_SSL_ENABLED
  14767. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14768. #else
  14769. if (!scheme.empty() && scheme != "http") {
  14770. #endif
  14771. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14772. std::string msg = "'" + scheme + "' scheme is not supported.";
  14773. throw std::invalid_argument(msg);
  14774. #endif
  14775. return;
  14776. }
  14777. auto is_ssl = scheme == "https";
  14778. auto host = std::move(uc.host);
  14779. auto port = is_ssl ? 443 : 80;
  14780. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14781. if (is_ssl) {
  14782. #ifdef CPPHTTPLIB_SSL_ENABLED
  14783. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14784. client_key_path);
  14785. is_ssl_ = is_ssl;
  14786. #endif
  14787. } else {
  14788. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14789. client_key_path);
  14790. }
  14791. } else {
  14792. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14793. // if port param below changes.
  14794. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14795. client_cert_path, client_key_path);
  14796. }
  14797. }
  14798. inline Client::Client(const std::string &host, int port)
  14799. : Client(host, port, std::string(), std::string()) {}
  14800. inline Client::Client(const std::string &host, int port,
  14801. const std::string &client_cert_path,
  14802. const std::string &client_key_path)
  14803. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14804. client_key_path)) {}
  14805. inline Client::~Client() = default;
  14806. inline bool Client::is_valid() const {
  14807. return cli_ != nullptr && cli_->is_valid();
  14808. }
  14809. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14810. return cli_->Get(path, std::move(progress));
  14811. }
  14812. inline Result Client::Get(const std::string &path, const Headers &headers,
  14813. DownloadProgress progress) {
  14814. return cli_->Get(path, headers, std::move(progress));
  14815. }
  14816. inline Result Client::Get(const std::string &path,
  14817. ContentReceiver content_receiver,
  14818. DownloadProgress progress) {
  14819. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14820. }
  14821. inline Result Client::Get(const std::string &path, const Headers &headers,
  14822. ContentReceiver content_receiver,
  14823. DownloadProgress progress) {
  14824. return cli_->Get(path, headers, std::move(content_receiver),
  14825. std::move(progress));
  14826. }
  14827. inline Result Client::Get(const std::string &path,
  14828. ResponseHandler response_handler,
  14829. ContentReceiver content_receiver,
  14830. DownloadProgress progress) {
  14831. return cli_->Get(path, std::move(response_handler),
  14832. std::move(content_receiver), std::move(progress));
  14833. }
  14834. inline Result Client::Get(const std::string &path, const Headers &headers,
  14835. ResponseHandler response_handler,
  14836. ContentReceiver content_receiver,
  14837. DownloadProgress progress) {
  14838. return cli_->Get(path, headers, std::move(response_handler),
  14839. std::move(content_receiver), std::move(progress));
  14840. }
  14841. inline Result Client::Get(const std::string &path, const Params &params,
  14842. DownloadProgress progress) {
  14843. return cli_->Get(path, params, std::move(progress));
  14844. }
  14845. inline Result Client::Get(const std::string &path, const Params &params,
  14846. const Headers &headers, DownloadProgress progress) {
  14847. return cli_->Get(path, params, headers, std::move(progress));
  14848. }
  14849. inline Result Client::Get(const std::string &path, const Params &params,
  14850. const Headers &headers,
  14851. ContentReceiver content_receiver,
  14852. DownloadProgress progress) {
  14853. return cli_->Get(path, params, headers, std::move(content_receiver),
  14854. std::move(progress));
  14855. }
  14856. inline Result Client::Get(const std::string &path, const Params &params,
  14857. const Headers &headers,
  14858. ResponseHandler response_handler,
  14859. ContentReceiver content_receiver,
  14860. DownloadProgress progress) {
  14861. return cli_->Get(path, params, headers, std::move(response_handler),
  14862. std::move(content_receiver), std::move(progress));
  14863. }
  14864. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14865. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14866. return cli_->Head(path, headers);
  14867. }
  14868. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14869. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14870. return cli_->Post(path, headers);
  14871. }
  14872. inline Result Client::Post(const std::string &path, const char *body,
  14873. size_t content_length,
  14874. const std::string &content_type,
  14875. UploadProgress progress) {
  14876. return cli_->Post(path, body, content_length, content_type, progress);
  14877. }
  14878. inline Result Client::Post(const std::string &path, const Headers &headers,
  14879. const char *body, size_t content_length,
  14880. const std::string &content_type,
  14881. UploadProgress progress) {
  14882. return cli_->Post(path, headers, body, content_length, content_type,
  14883. progress);
  14884. }
  14885. inline Result Client::Post(const std::string &path, const std::string &body,
  14886. const std::string &content_type,
  14887. UploadProgress progress) {
  14888. return cli_->Post(path, body, content_type, progress);
  14889. }
  14890. inline Result Client::Post(const std::string &path, const Headers &headers,
  14891. const std::string &body,
  14892. const std::string &content_type,
  14893. UploadProgress progress) {
  14894. return cli_->Post(path, headers, body, content_type, progress);
  14895. }
  14896. inline Result Client::Post(const std::string &path, size_t content_length,
  14897. ContentProvider content_provider,
  14898. const std::string &content_type,
  14899. UploadProgress progress) {
  14900. return cli_->Post(path, content_length, std::move(content_provider),
  14901. content_type, progress);
  14902. }
  14903. inline Result Client::Post(const std::string &path, size_t content_length,
  14904. ContentProvider content_provider,
  14905. const std::string &content_type,
  14906. ContentReceiver content_receiver,
  14907. UploadProgress progress) {
  14908. return cli_->Post(path, content_length, std::move(content_provider),
  14909. content_type, std::move(content_receiver), progress);
  14910. }
  14911. inline Result Client::Post(const std::string &path,
  14912. ContentProviderWithoutLength content_provider,
  14913. const std::string &content_type,
  14914. UploadProgress progress) {
  14915. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14916. }
  14917. inline Result Client::Post(const std::string &path,
  14918. ContentProviderWithoutLength content_provider,
  14919. const std::string &content_type,
  14920. ContentReceiver content_receiver,
  14921. UploadProgress progress) {
  14922. return cli_->Post(path, std::move(content_provider), content_type,
  14923. std::move(content_receiver), progress);
  14924. }
  14925. inline Result Client::Post(const std::string &path, const Headers &headers,
  14926. size_t content_length,
  14927. ContentProvider content_provider,
  14928. const std::string &content_type,
  14929. UploadProgress progress) {
  14930. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14931. content_type, progress);
  14932. }
  14933. inline Result Client::Post(const std::string &path, const Headers &headers,
  14934. size_t content_length,
  14935. ContentProvider content_provider,
  14936. const std::string &content_type,
  14937. ContentReceiver content_receiver,
  14938. DownloadProgress progress) {
  14939. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14940. content_type, std::move(content_receiver), progress);
  14941. }
  14942. inline Result Client::Post(const std::string &path, const Headers &headers,
  14943. ContentProviderWithoutLength content_provider,
  14944. const std::string &content_type,
  14945. UploadProgress progress) {
  14946. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14947. progress);
  14948. }
  14949. inline Result Client::Post(const std::string &path, const Headers &headers,
  14950. ContentProviderWithoutLength content_provider,
  14951. const std::string &content_type,
  14952. ContentReceiver content_receiver,
  14953. DownloadProgress progress) {
  14954. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14955. std::move(content_receiver), progress);
  14956. }
  14957. inline Result Client::Post(const std::string &path, const Params &params) {
  14958. return cli_->Post(path, params);
  14959. }
  14960. inline Result Client::Post(const std::string &path, const Headers &headers,
  14961. const Params &params) {
  14962. return cli_->Post(path, headers, params);
  14963. }
  14964. inline Result Client::Post(const std::string &path,
  14965. const UploadFormDataItems &items,
  14966. UploadProgress progress) {
  14967. return cli_->Post(path, items, progress);
  14968. }
  14969. inline Result Client::Post(const std::string &path, const Headers &headers,
  14970. const UploadFormDataItems &items,
  14971. UploadProgress progress) {
  14972. return cli_->Post(path, headers, items, progress);
  14973. }
  14974. inline Result Client::Post(const std::string &path, const Headers &headers,
  14975. const UploadFormDataItems &items,
  14976. const std::string &boundary,
  14977. UploadProgress progress) {
  14978. return cli_->Post(path, headers, items, boundary, progress);
  14979. }
  14980. inline Result Client::Post(const std::string &path, const Headers &headers,
  14981. const UploadFormDataItems &items,
  14982. const FormDataProviderItems &provider_items,
  14983. UploadProgress progress) {
  14984. return cli_->Post(path, headers, items, provider_items, progress);
  14985. }
  14986. inline Result Client::Post(const std::string &path, const Headers &headers,
  14987. const std::string &body,
  14988. const std::string &content_type,
  14989. ContentReceiver content_receiver,
  14990. DownloadProgress progress) {
  14991. return cli_->Post(path, headers, body, content_type,
  14992. std::move(content_receiver), progress);
  14993. }
  14994. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14995. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14996. return cli_->Put(path, headers);
  14997. }
  14998. inline Result Client::Put(const std::string &path, const char *body,
  14999. size_t content_length,
  15000. const std::string &content_type,
  15001. UploadProgress progress) {
  15002. return cli_->Put(path, body, content_length, content_type, progress);
  15003. }
  15004. inline Result Client::Put(const std::string &path, const Headers &headers,
  15005. const char *body, size_t content_length,
  15006. const std::string &content_type,
  15007. UploadProgress progress) {
  15008. return cli_->Put(path, headers, body, content_length, content_type, progress);
  15009. }
  15010. inline Result Client::Put(const std::string &path, const std::string &body,
  15011. const std::string &content_type,
  15012. UploadProgress progress) {
  15013. return cli_->Put(path, body, content_type, progress);
  15014. }
  15015. inline Result Client::Put(const std::string &path, const Headers &headers,
  15016. const std::string &body,
  15017. const std::string &content_type,
  15018. UploadProgress progress) {
  15019. return cli_->Put(path, headers, body, content_type, progress);
  15020. }
  15021. inline Result Client::Put(const std::string &path, size_t content_length,
  15022. ContentProvider content_provider,
  15023. const std::string &content_type,
  15024. UploadProgress progress) {
  15025. return cli_->Put(path, content_length, std::move(content_provider),
  15026. content_type, progress);
  15027. }
  15028. inline Result Client::Put(const std::string &path, size_t content_length,
  15029. ContentProvider content_provider,
  15030. const std::string &content_type,
  15031. ContentReceiver content_receiver,
  15032. UploadProgress progress) {
  15033. return cli_->Put(path, content_length, std::move(content_provider),
  15034. content_type, std::move(content_receiver), progress);
  15035. }
  15036. inline Result Client::Put(const std::string &path,
  15037. ContentProviderWithoutLength content_provider,
  15038. const std::string &content_type,
  15039. UploadProgress progress) {
  15040. return cli_->Put(path, std::move(content_provider), content_type, progress);
  15041. }
  15042. inline Result Client::Put(const std::string &path,
  15043. ContentProviderWithoutLength content_provider,
  15044. const std::string &content_type,
  15045. ContentReceiver content_receiver,
  15046. UploadProgress progress) {
  15047. return cli_->Put(path, std::move(content_provider), content_type,
  15048. std::move(content_receiver), progress);
  15049. }
  15050. inline Result Client::Put(const std::string &path, const Headers &headers,
  15051. size_t content_length,
  15052. ContentProvider content_provider,
  15053. const std::string &content_type,
  15054. UploadProgress progress) {
  15055. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15056. content_type, progress);
  15057. }
  15058. inline Result Client::Put(const std::string &path, const Headers &headers,
  15059. size_t content_length,
  15060. ContentProvider content_provider,
  15061. const std::string &content_type,
  15062. ContentReceiver content_receiver,
  15063. UploadProgress progress) {
  15064. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15065. content_type, std::move(content_receiver), progress);
  15066. }
  15067. inline Result Client::Put(const std::string &path, const Headers &headers,
  15068. ContentProviderWithoutLength content_provider,
  15069. const std::string &content_type,
  15070. UploadProgress progress) {
  15071. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15072. progress);
  15073. }
  15074. inline Result Client::Put(const std::string &path, const Headers &headers,
  15075. ContentProviderWithoutLength content_provider,
  15076. const std::string &content_type,
  15077. ContentReceiver content_receiver,
  15078. UploadProgress progress) {
  15079. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15080. std::move(content_receiver), progress);
  15081. }
  15082. inline Result Client::Put(const std::string &path, const Params &params) {
  15083. return cli_->Put(path, params);
  15084. }
  15085. inline Result Client::Put(const std::string &path, const Headers &headers,
  15086. const Params &params) {
  15087. return cli_->Put(path, headers, params);
  15088. }
  15089. inline Result Client::Put(const std::string &path,
  15090. const UploadFormDataItems &items,
  15091. UploadProgress progress) {
  15092. return cli_->Put(path, items, progress);
  15093. }
  15094. inline Result Client::Put(const std::string &path, const Headers &headers,
  15095. const UploadFormDataItems &items,
  15096. UploadProgress progress) {
  15097. return cli_->Put(path, headers, items, progress);
  15098. }
  15099. inline Result Client::Put(const std::string &path, const Headers &headers,
  15100. const UploadFormDataItems &items,
  15101. const std::string &boundary,
  15102. UploadProgress progress) {
  15103. return cli_->Put(path, headers, items, boundary, progress);
  15104. }
  15105. inline Result Client::Put(const std::string &path, const Headers &headers,
  15106. const UploadFormDataItems &items,
  15107. const FormDataProviderItems &provider_items,
  15108. UploadProgress progress) {
  15109. return cli_->Put(path, headers, items, provider_items, progress);
  15110. }
  15111. inline Result Client::Put(const std::string &path, const Headers &headers,
  15112. const std::string &body,
  15113. const std::string &content_type,
  15114. ContentReceiver content_receiver,
  15115. DownloadProgress progress) {
  15116. return cli_->Put(path, headers, body, content_type, content_receiver,
  15117. progress);
  15118. }
  15119. inline Result Client::Patch(const std::string &path) {
  15120. return cli_->Patch(path);
  15121. }
  15122. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15123. return cli_->Patch(path, headers);
  15124. }
  15125. inline Result Client::Patch(const std::string &path, const char *body,
  15126. size_t content_length,
  15127. const std::string &content_type,
  15128. UploadProgress progress) {
  15129. return cli_->Patch(path, body, content_length, content_type, progress);
  15130. }
  15131. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15132. const char *body, size_t content_length,
  15133. const std::string &content_type,
  15134. UploadProgress progress) {
  15135. return cli_->Patch(path, headers, body, content_length, content_type,
  15136. progress);
  15137. }
  15138. inline Result Client::Patch(const std::string &path, const std::string &body,
  15139. const std::string &content_type,
  15140. UploadProgress progress) {
  15141. return cli_->Patch(path, body, content_type, progress);
  15142. }
  15143. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15144. const std::string &body,
  15145. const std::string &content_type,
  15146. UploadProgress progress) {
  15147. return cli_->Patch(path, headers, body, content_type, progress);
  15148. }
  15149. inline Result Client::Patch(const std::string &path, size_t content_length,
  15150. ContentProvider content_provider,
  15151. const std::string &content_type,
  15152. UploadProgress progress) {
  15153. return cli_->Patch(path, content_length, std::move(content_provider),
  15154. content_type, progress);
  15155. }
  15156. inline Result Client::Patch(const std::string &path, size_t content_length,
  15157. ContentProvider content_provider,
  15158. const std::string &content_type,
  15159. ContentReceiver content_receiver,
  15160. UploadProgress progress) {
  15161. return cli_->Patch(path, content_length, std::move(content_provider),
  15162. content_type, std::move(content_receiver), progress);
  15163. }
  15164. inline Result Client::Patch(const std::string &path,
  15165. ContentProviderWithoutLength content_provider,
  15166. const std::string &content_type,
  15167. UploadProgress progress) {
  15168. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15169. }
  15170. inline Result Client::Patch(const std::string &path,
  15171. ContentProviderWithoutLength content_provider,
  15172. const std::string &content_type,
  15173. ContentReceiver content_receiver,
  15174. UploadProgress progress) {
  15175. return cli_->Patch(path, std::move(content_provider), content_type,
  15176. std::move(content_receiver), progress);
  15177. }
  15178. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15179. size_t content_length,
  15180. ContentProvider content_provider,
  15181. const std::string &content_type,
  15182. UploadProgress progress) {
  15183. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15184. content_type, progress);
  15185. }
  15186. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15187. size_t content_length,
  15188. ContentProvider content_provider,
  15189. const std::string &content_type,
  15190. ContentReceiver content_receiver,
  15191. UploadProgress progress) {
  15192. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15193. content_type, std::move(content_receiver), progress);
  15194. }
  15195. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15196. ContentProviderWithoutLength content_provider,
  15197. const std::string &content_type,
  15198. UploadProgress progress) {
  15199. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15200. progress);
  15201. }
  15202. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15203. ContentProviderWithoutLength content_provider,
  15204. const std::string &content_type,
  15205. ContentReceiver content_receiver,
  15206. UploadProgress progress) {
  15207. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15208. std::move(content_receiver), progress);
  15209. }
  15210. inline Result Client::Patch(const std::string &path, const Params &params) {
  15211. return cli_->Patch(path, params);
  15212. }
  15213. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15214. const Params &params) {
  15215. return cli_->Patch(path, headers, params);
  15216. }
  15217. inline Result Client::Patch(const std::string &path,
  15218. const UploadFormDataItems &items,
  15219. UploadProgress progress) {
  15220. return cli_->Patch(path, items, progress);
  15221. }
  15222. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15223. const UploadFormDataItems &items,
  15224. UploadProgress progress) {
  15225. return cli_->Patch(path, headers, items, progress);
  15226. }
  15227. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15228. const UploadFormDataItems &items,
  15229. const std::string &boundary,
  15230. UploadProgress progress) {
  15231. return cli_->Patch(path, headers, items, boundary, progress);
  15232. }
  15233. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15234. const UploadFormDataItems &items,
  15235. const FormDataProviderItems &provider_items,
  15236. UploadProgress progress) {
  15237. return cli_->Patch(path, headers, items, provider_items, progress);
  15238. }
  15239. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15240. const std::string &body,
  15241. const std::string &content_type,
  15242. ContentReceiver content_receiver,
  15243. DownloadProgress progress) {
  15244. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15245. progress);
  15246. }
  15247. inline Result Client::Delete(const std::string &path,
  15248. DownloadProgress progress) {
  15249. return cli_->Delete(path, progress);
  15250. }
  15251. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15252. DownloadProgress progress) {
  15253. return cli_->Delete(path, headers, progress);
  15254. }
  15255. inline Result Client::Delete(const std::string &path, const char *body,
  15256. size_t content_length,
  15257. const std::string &content_type,
  15258. DownloadProgress progress) {
  15259. return cli_->Delete(path, body, content_length, content_type, progress);
  15260. }
  15261. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15262. const char *body, size_t content_length,
  15263. const std::string &content_type,
  15264. DownloadProgress progress) {
  15265. return cli_->Delete(path, headers, body, content_length, content_type,
  15266. progress);
  15267. }
  15268. inline Result Client::Delete(const std::string &path, const std::string &body,
  15269. const std::string &content_type,
  15270. DownloadProgress progress) {
  15271. return cli_->Delete(path, body, content_type, progress);
  15272. }
  15273. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15274. const std::string &body,
  15275. const std::string &content_type,
  15276. DownloadProgress progress) {
  15277. return cli_->Delete(path, headers, body, content_type, progress);
  15278. }
  15279. inline Result Client::Delete(const std::string &path, const Params &params,
  15280. DownloadProgress progress) {
  15281. return cli_->Delete(path, params, progress);
  15282. }
  15283. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15284. const Params &params, DownloadProgress progress) {
  15285. return cli_->Delete(path, headers, params, progress);
  15286. }
  15287. inline Result Client::Options(const std::string &path) {
  15288. return cli_->Options(path);
  15289. }
  15290. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15291. return cli_->Options(path, headers);
  15292. }
  15293. inline ClientImpl::StreamHandle
  15294. Client::open_stream(const std::string &method, const std::string &path,
  15295. const Params &params, const Headers &headers,
  15296. const std::string &body, const std::string &content_type) {
  15297. return cli_->open_stream(method, path, params, headers, body, content_type);
  15298. }
  15299. inline bool Client::send(Request &req, Response &res, Error &error) {
  15300. return cli_->send(req, res, error);
  15301. }
  15302. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15303. inline void Client::stop() { cli_->stop(); }
  15304. inline std::string Client::host() const { return cli_->host(); }
  15305. inline int Client::port() const { return cli_->port(); }
  15306. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15307. inline socket_t Client::socket() const { return cli_->socket(); }
  15308. inline void
  15309. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15310. cli_->set_hostname_addr_map(std::move(addr_map));
  15311. }
  15312. inline void Client::set_default_headers(Headers headers) {
  15313. cli_->set_default_headers(std::move(headers));
  15314. }
  15315. inline void Client::set_header_writer(
  15316. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15317. cli_->set_header_writer(writer);
  15318. }
  15319. inline void Client::set_address_family(int family) {
  15320. cli_->set_address_family(family);
  15321. }
  15322. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15323. inline void Client::set_socket_options(SocketOptions socket_options) {
  15324. cli_->set_socket_options(std::move(socket_options));
  15325. }
  15326. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15327. cli_->set_connection_timeout(sec, usec);
  15328. }
  15329. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15330. cli_->set_read_timeout(sec, usec);
  15331. }
  15332. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15333. cli_->set_write_timeout(sec, usec);
  15334. }
  15335. inline void Client::set_basic_auth(const std::string &username,
  15336. const std::string &password) {
  15337. cli_->set_basic_auth(username, password);
  15338. }
  15339. inline void Client::set_bearer_token_auth(const std::string &token) {
  15340. cli_->set_bearer_token_auth(token);
  15341. }
  15342. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15343. inline void Client::set_follow_location(bool on) {
  15344. cli_->set_follow_location(on);
  15345. }
  15346. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15347. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15348. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15349. inline void Client::set_payload_max_length(size_t length) {
  15350. cli_->set_payload_max_length(length);
  15351. }
  15352. inline void Client::set_interface(const std::string &intf) {
  15353. cli_->set_interface(intf);
  15354. }
  15355. inline void Client::set_proxy(const std::string &host, int port) {
  15356. cli_->set_proxy(host, port);
  15357. }
  15358. inline void Client::set_proxy_basic_auth(const std::string &username,
  15359. const std::string &password) {
  15360. cli_->set_proxy_basic_auth(username, password);
  15361. }
  15362. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15363. cli_->set_proxy_bearer_token_auth(token);
  15364. }
  15365. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15366. cli_->set_no_proxy(patterns);
  15367. }
  15368. inline void Client::set_logger(Logger logger) {
  15369. cli_->set_logger(std::move(logger));
  15370. }
  15371. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15372. cli_->set_error_logger(std::move(error_logger));
  15373. }
  15374. /*
  15375. * Group 6: SSL Server and Client implementation
  15376. */
  15377. #ifdef CPPHTTPLIB_SSL_ENABLED
  15378. // SSL HTTP server implementation
  15379. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15380. const char *client_ca_cert_file_path,
  15381. const char *client_ca_cert_dir_path,
  15382. const char *private_key_password) {
  15383. using namespace tls;
  15384. ctx_ = create_server_context();
  15385. if (!ctx_) { return; }
  15386. // Load server certificate and private key
  15387. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15388. private_key_password)) {
  15389. last_ssl_error_ = static_cast<int>(get_error());
  15390. free_context(ctx_);
  15391. ctx_ = nullptr;
  15392. return;
  15393. }
  15394. // Load client CA certificates for client authentication
  15395. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15396. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15397. client_ca_cert_dir_path)) {
  15398. last_ssl_error_ = static_cast<int>(get_error());
  15399. free_context(ctx_);
  15400. ctx_ = nullptr;
  15401. return;
  15402. }
  15403. // Enable client certificate verification
  15404. set_verify_client(ctx_, true);
  15405. }
  15406. }
  15407. inline SSLServer::SSLServer(const PemMemory &pem) {
  15408. using namespace tls;
  15409. ctx_ = create_server_context();
  15410. if (ctx_) {
  15411. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15412. pem.private_key_password)) {
  15413. last_ssl_error_ = static_cast<int>(get_error());
  15414. free_context(ctx_);
  15415. ctx_ = nullptr;
  15416. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15417. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15418. last_ssl_error_ = static_cast<int>(get_error());
  15419. free_context(ctx_);
  15420. ctx_ = nullptr;
  15421. } else {
  15422. set_verify_client(ctx_, true);
  15423. }
  15424. }
  15425. }
  15426. }
  15427. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15428. using namespace tls;
  15429. ctx_ = create_server_context();
  15430. if (ctx_) {
  15431. if (!setup_callback(ctx_)) {
  15432. free_context(ctx_);
  15433. ctx_ = nullptr;
  15434. }
  15435. }
  15436. }
  15437. inline SSLServer::~SSLServer() {
  15438. if (ctx_) { tls::free_context(ctx_); }
  15439. }
  15440. inline bool SSLServer::is_valid() const {
  15441. return ctx_ != nullptr && Server::is_valid();
  15442. }
  15443. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15444. using namespace tls;
  15445. // Create TLS session with mutex protection
  15446. session_t session = nullptr;
  15447. {
  15448. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15449. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15450. }
  15451. if (!session) {
  15452. last_ssl_error_ = static_cast<int>(get_error());
  15453. detail::shutdown_socket(sock);
  15454. detail::close_socket(sock);
  15455. return false;
  15456. }
  15457. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15458. bool handshake_done = false;
  15459. bool ret = false;
  15460. bool websocket_upgraded = false;
  15461. auto cleanup = detail::scope_exit([&] {
  15462. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15463. free_session(session);
  15464. detail::shutdown_socket(sock);
  15465. detail::close_socket(sock);
  15466. });
  15467. // Perform TLS accept handshake with timeout
  15468. TlsError tls_err;
  15469. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15470. &tls_err)) {
  15471. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15472. // Map TlsError to legacy ssl_error for backward compatibility
  15473. if (tls_err.code == ErrorCode::WantRead) {
  15474. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15475. } else if (tls_err.code == ErrorCode::WantWrite) {
  15476. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15477. } else {
  15478. last_ssl_error_ = SSL_ERROR_SSL;
  15479. }
  15480. #else
  15481. last_ssl_error_ = static_cast<int>(get_error());
  15482. #endif
  15483. return false;
  15484. }
  15485. handshake_done = true;
  15486. std::string remote_addr;
  15487. int remote_port = 0;
  15488. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15489. std::string local_addr;
  15490. int local_port = 0;
  15491. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15492. ret = serve_guarded([&]() {
  15493. return detail::process_server_socket_ssl(
  15494. svr_sock_, session, sock, keep_alive_max_count_,
  15495. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15496. write_timeout_sec_, write_timeout_usec_,
  15497. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15498. return process_request(
  15499. strm, remote_addr, remote_port, local_addr, local_port,
  15500. close_connection, connection_closed,
  15501. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15502. });
  15503. });
  15504. return ret;
  15505. }
  15506. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15507. const char *key_pem,
  15508. const char *client_ca_pem,
  15509. const char *password) {
  15510. if (!ctx_) { return false; }
  15511. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15512. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15513. return false;
  15514. }
  15515. if (client_ca_pem) {
  15516. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15517. }
  15518. return true;
  15519. }
  15520. // SSL HTTP client implementation
  15521. inline SSLClient::~SSLClient() {
  15522. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15523. // base function rather than the derived function once we get to the
  15524. // base class destructor, and won't free the SSL (causing a leak).
  15525. // This must happen before the context is freed below: some backends
  15526. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15527. // context, so freeing the context first leaves close_notify reading
  15528. // freed memory.
  15529. shutdown_ssl_impl(socket_, true);
  15530. if (ctx_) {
  15531. tls::free_context(ctx_);
  15532. ctx_ = nullptr;
  15533. }
  15534. }
  15535. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15536. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15537. shutdown_ssl_impl(socket, shutdown_gracefully);
  15538. }
  15539. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15540. bool shutdown_gracefully) {
  15541. if (socket.sock == INVALID_SOCKET) {
  15542. assert(socket.ssl == nullptr);
  15543. return;
  15544. }
  15545. if (socket.ssl) {
  15546. tls::shutdown(socket.ssl, shutdown_gracefully);
  15547. {
  15548. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15549. tls::free_session(socket.ssl);
  15550. }
  15551. socket.ssl = nullptr;
  15552. }
  15553. assert(socket.ssl == nullptr);
  15554. }
  15555. inline bool SSLClient::process_socket(
  15556. const Socket &socket,
  15557. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15558. std::function<bool(Stream &strm)> callback) {
  15559. assert(socket.ssl);
  15560. return detail::process_client_socket_ssl(
  15561. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15562. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15563. std::move(callback));
  15564. }
  15565. inline bool SSLClient::is_ssl() const { return true; }
  15566. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15567. if (!is_valid()) {
  15568. error = Error::SSLConnection;
  15569. return false;
  15570. }
  15571. return ClientImpl::create_and_connect_socket(socket, error);
  15572. }
  15573. inline bool SSLClient::setup_proxy_connection(
  15574. Socket &socket,
  15575. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15576. Response &res, bool &success, Error &error) {
  15577. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15578. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15579. return false;
  15580. }
  15581. if (!initialize_ssl(socket, error)) {
  15582. success = false;
  15583. return false;
  15584. }
  15585. return true;
  15586. }
  15587. // Assumes that socket_mutex_ is locked and that there are no requests in
  15588. // flight
  15589. inline bool SSLClient::connect_with_proxy(
  15590. Socket &socket,
  15591. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15592. Response &res, bool &success, Error &error) {
  15593. success = true;
  15594. Response proxy_res;
  15595. if (!detail::process_client_socket(
  15596. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15597. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15598. start_time, [&](Stream &strm) {
  15599. Request req2;
  15600. req2.method = "CONNECT";
  15601. req2.path =
  15602. detail::make_host_and_port_string_always_port(host_, port_);
  15603. if (max_timeout_msec_ > 0) {
  15604. req2.start_time_ = std::chrono::steady_clock::now();
  15605. }
  15606. return process_request(strm, req2, proxy_res, false, error);
  15607. })) {
  15608. // Thread-safe to close everything because we are assuming there are no
  15609. // requests in flight
  15610. shutdown_ssl(socket, true);
  15611. shutdown_socket(socket);
  15612. close_socket(socket);
  15613. success = false;
  15614. return false;
  15615. }
  15616. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15617. if (!proxy_digest_auth_username_.empty() &&
  15618. !proxy_digest_auth_password_.empty()) {
  15619. std::map<std::string, std::string> auth;
  15620. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15621. // Close the current socket and create a new one for the authenticated
  15622. // request
  15623. shutdown_ssl(socket, true);
  15624. shutdown_socket(socket);
  15625. close_socket(socket);
  15626. // Create a new socket for the authenticated CONNECT request
  15627. if (!ensure_socket_connection(socket, error)) {
  15628. success = false;
  15629. output_error_log(error, nullptr);
  15630. return false;
  15631. }
  15632. proxy_res = Response();
  15633. if (!detail::process_client_socket(
  15634. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15635. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15636. start_time, [&](Stream &strm) {
  15637. Request req3;
  15638. req3.method = "CONNECT";
  15639. req3.path = detail::make_host_and_port_string_always_port(
  15640. host_, port_);
  15641. req3.headers.insert(detail::make_digest_authentication_header(
  15642. req3, auth, 1, detail::random_string(10),
  15643. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15644. true));
  15645. if (max_timeout_msec_ > 0) {
  15646. req3.start_time_ = std::chrono::steady_clock::now();
  15647. }
  15648. return process_request(strm, req3, proxy_res, false, error);
  15649. })) {
  15650. // Thread-safe to close everything because we are assuming there are
  15651. // no requests in flight
  15652. shutdown_ssl(socket, true);
  15653. shutdown_socket(socket);
  15654. close_socket(socket);
  15655. success = false;
  15656. return false;
  15657. }
  15658. }
  15659. }
  15660. }
  15661. // If status code is not 200, proxy request is failed.
  15662. // Set error to ProxyConnection and return proxy response
  15663. // as the response of the request
  15664. if (proxy_res.status != StatusCode::OK_200) {
  15665. error = Error::ProxyConnection;
  15666. output_error_log(error, nullptr);
  15667. res = std::move(proxy_res);
  15668. // Thread-safe to close everything because we are assuming there are
  15669. // no requests in flight
  15670. shutdown_ssl(socket, true);
  15671. shutdown_socket(socket);
  15672. close_socket(socket);
  15673. return false;
  15674. }
  15675. return true;
  15676. }
  15677. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15678. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15679. if (is_proxy_enabled_for_host(host_)) { return true; }
  15680. if (!initialize_ssl(socket, error)) {
  15681. shutdown_socket(socket);
  15682. close_socket(socket);
  15683. return false;
  15684. }
  15685. return true;
  15686. }
  15687. // SSL HTTP client implementation
  15688. inline SSLClient::SSLClient(const std::string &host)
  15689. : SSLClient(host, 443, std::string(), std::string()) {}
  15690. inline SSLClient::SSLClient(const std::string &host, int port)
  15691. : SSLClient(host, port, std::string(), std::string()) {}
  15692. inline void SSLClient::init_ctx() {
  15693. ctx_ = tls::create_client_context();
  15694. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15695. }
  15696. inline void SSLClient::reset_ctx_on_error() {
  15697. last_backend_error_ = tls::get_error();
  15698. tls::free_context(ctx_);
  15699. ctx_ = nullptr;
  15700. }
  15701. inline SSLClient::SSLClient(const std::string &host, int port,
  15702. const std::string &client_cert_path,
  15703. const std::string &client_key_path,
  15704. const std::string &private_key_password)
  15705. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15706. init_ctx();
  15707. if (!ctx_) { return; }
  15708. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15709. const char *password =
  15710. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15711. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15712. client_key_path.c_str(), password)) {
  15713. reset_ctx_on_error();
  15714. }
  15715. }
  15716. }
  15717. inline SSLClient::SSLClient(const std::string &host, int port,
  15718. const PemMemory &pem)
  15719. : ClientImpl(host, port) {
  15720. init_ctx();
  15721. if (!ctx_) { return; }
  15722. if (pem.cert_pem && pem.key_pem) {
  15723. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15724. pem.private_key_password)) {
  15725. reset_ctx_on_error();
  15726. }
  15727. }
  15728. }
  15729. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15730. if (ca_cert_store && ctx_) {
  15731. // set_ca_store takes ownership of ca_cert_store
  15732. tls::set_ca_store(ctx_, ca_cert_store);
  15733. ca_cert_store_set_ = true;
  15734. } else if (ca_cert_store) {
  15735. tls::free_ca_store(ca_cert_store);
  15736. }
  15737. }
  15738. inline void
  15739. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15740. if (!ctx_) { return; }
  15741. tls::set_verify_callback(ctx_, verifier);
  15742. }
  15743. inline void SSLClient::set_session_verifier(
  15744. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15745. session_verifier_ = std::move(verifier);
  15746. }
  15747. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15748. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15749. enable_windows_cert_verification_ = enabled;
  15750. }
  15751. #endif
  15752. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15753. std::size_t size) {
  15754. if (ctx_ && ca_cert && size > 0) {
  15755. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15756. tls::load_ca_pem(ctx_, ca_cert, size);
  15757. }
  15758. }
  15759. inline bool SSLClient::load_certs() {
  15760. auto ret = true;
  15761. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15762. // one client is shared across concurrent requests here.
  15763. std::call_once(initialize_cert_, [&]() {
  15764. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15765. ret = detail::load_client_ca_config(
  15766. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15767. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15768. last_backend_error_);
  15769. });
  15770. return ret;
  15771. }
  15772. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15773. // Load CA certificates if server verification is enabled
  15774. if (server_certificate_verification_) {
  15775. if (!load_certs()) {
  15776. error = Error::SSLLoadingCerts;
  15777. output_error_log(error, nullptr);
  15778. return false;
  15779. }
  15780. }
  15781. detail::ClientTlsSessionOptions options;
  15782. options.server_hostname_verification = server_hostname_verification_;
  15783. options.session_verifier = session_verifier_;
  15784. options.ctx_mutex = &ctx_mutex_;
  15785. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15786. // Skip Schannel when a custom CA cert is specified, as the Windows
  15787. // certificate store would not know about user-provided CA certificates.
  15788. // Also skip when system CA trust is explicitly disabled.
  15789. options.windows_cert_verification =
  15790. enable_windows_cert_verification_ &&
  15791. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15792. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15793. #endif
  15794. tls::session_t session = nullptr;
  15795. // Use scope_exit to ensure session is freed on error paths
  15796. bool success = false;
  15797. auto session_guard = detail::scope_exit([&] {
  15798. if (!success) { tls::free_session(session); }
  15799. });
  15800. detail::ClientTlsSessionError tls_error;
  15801. if (!detail::setup_client_tls_session(
  15802. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15803. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15804. options)) {
  15805. error = tls_error.error;
  15806. last_ssl_error_ = tls_error.ssl_error;
  15807. last_backend_error_ = tls_error.backend_error;
  15808. output_error_log(error, nullptr);
  15809. return false;
  15810. }
  15811. success = true;
  15812. socket.ssl = session;
  15813. return true;
  15814. }
  15815. inline void Client::set_digest_auth(const std::string &username,
  15816. const std::string &password) {
  15817. cli_->set_digest_auth(username, password);
  15818. }
  15819. inline void Client::set_proxy_digest_auth(const std::string &username,
  15820. const std::string &password) {
  15821. cli_->set_proxy_digest_auth(username, password);
  15822. }
  15823. inline void Client::enable_server_certificate_verification(bool enabled) {
  15824. cli_->enable_server_certificate_verification(enabled);
  15825. }
  15826. inline void Client::enable_server_hostname_verification(bool enabled) {
  15827. cli_->enable_server_hostname_verification(enabled);
  15828. }
  15829. inline void Client::enable_system_ca(bool enabled) {
  15830. cli_->enable_system_ca(enabled);
  15831. }
  15832. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15833. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15834. if (is_ssl_) {
  15835. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15836. enabled);
  15837. }
  15838. }
  15839. #endif
  15840. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15841. const std::string &ca_cert_dir_path) {
  15842. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15843. }
  15844. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15845. if (is_ssl_) {
  15846. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15847. } else if (ca_cert_store) {
  15848. tls::free_ca_store(ca_cert_store);
  15849. }
  15850. }
  15851. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15852. if (is_ssl_) {
  15853. // Use the PEM-based path so the CA data is retained for redirect transfer
  15854. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15855. }
  15856. }
  15857. inline void
  15858. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15859. if (is_ssl_) {
  15860. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15861. std::move(verifier));
  15862. }
  15863. }
  15864. inline void Client::set_session_verifier(
  15865. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15866. if (is_ssl_) {
  15867. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15868. }
  15869. }
  15870. inline tls::ctx_t Client::tls_context() const {
  15871. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15872. return nullptr;
  15873. }
  15874. #endif // CPPHTTPLIB_SSL_ENABLED
  15875. /*
  15876. * Group 7: TLS abstraction layer - Common API
  15877. */
  15878. #ifdef CPPHTTPLIB_SSL_ENABLED
  15879. namespace tls {
  15880. // Helper for PeerCert construction
  15881. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15882. return PeerCert(get_peer_cert(session));
  15883. }
  15884. namespace impl {
  15885. inline VerifyCallback &get_verify_callback() {
  15886. static thread_local VerifyCallback callback;
  15887. return callback;
  15888. }
  15889. inline VerifyCallback &get_mbedtls_verify_callback() {
  15890. static thread_local VerifyCallback callback;
  15891. return callback;
  15892. }
  15893. // Check if a string is an IPv4 address
  15894. inline bool is_ipv4_address(const std::string &str) {
  15895. int dots = 0;
  15896. for (char c : str) {
  15897. if (c == '.') {
  15898. dots++;
  15899. } else if (!detail::is_ascii_digit(c)) {
  15900. return false;
  15901. }
  15902. }
  15903. return dots == 3;
  15904. }
  15905. // Parse IPv4 address string to bytes
  15906. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15907. const char *p = str.c_str();
  15908. for (int i = 0; i < 4; i++) {
  15909. if (i > 0) {
  15910. if (*p != '.') { return false; }
  15911. p++;
  15912. }
  15913. int val = 0;
  15914. int digits = 0;
  15915. while (detail::is_ascii_digit(*p)) {
  15916. val = val * 10 + (*p - '0');
  15917. if (val > 255) { return false; }
  15918. p++;
  15919. digits++;
  15920. }
  15921. if (digits == 0) { return false; }
  15922. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15923. if (digits > 1 && *(p - digits) == '0') { return false; }
  15924. out[i] = static_cast<unsigned char>(val);
  15925. }
  15926. return *p == '\0';
  15927. }
  15928. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15929. // `out` must have room for at least 16 bytes. Returns the address length
  15930. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15931. // literal. Used to match a host against iPAddress SANs the same way the
  15932. // OpenSSL backend does via X509_check_ip.
  15933. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15934. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15935. struct in6_addr addr6 = {};
  15936. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15937. memcpy(out, &addr6, 16);
  15938. return 16;
  15939. }
  15940. return 0;
  15941. }
  15942. #ifdef _WIN32
  15943. // Enumerate Windows system certificates and call callback with DER data
  15944. template <typename Callback>
  15945. inline bool enumerate_windows_system_certs(Callback cb) {
  15946. bool loaded = false;
  15947. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15948. for (auto store_name : store_names) {
  15949. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15950. if (hStore) {
  15951. PCCERT_CONTEXT pContext = nullptr;
  15952. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15953. nullptr) {
  15954. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15955. loaded = true;
  15956. }
  15957. }
  15958. CertCloseStore(hStore, 0);
  15959. }
  15960. }
  15961. return loaded;
  15962. }
  15963. #endif
  15964. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15965. // Enumerate macOS Keychain certificates and call callback with DER data
  15966. template <typename Callback>
  15967. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15968. bool loaded = false;
  15969. const SecTrustSettingsDomain domains[] = {
  15970. kSecTrustSettingsDomainSystem,
  15971. kSecTrustSettingsDomainAdmin,
  15972. kSecTrustSettingsDomainUser,
  15973. };
  15974. for (auto domain : domains) {
  15975. CFArrayRef certs = nullptr;
  15976. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15977. if (status != errSecSuccess || !certs) {
  15978. if (certs) CFRelease(certs);
  15979. continue;
  15980. }
  15981. CFIndex count = CFArrayGetCount(certs);
  15982. for (CFIndex i = 0; i < count; i++) {
  15983. SecCertificateRef cert =
  15984. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15985. CFDataRef data = SecCertificateCopyData(cert);
  15986. if (data) {
  15987. if (cb(CFDataGetBytePtr(data),
  15988. static_cast<size_t>(CFDataGetLength(data)))) {
  15989. loaded = true;
  15990. }
  15991. CFRelease(data);
  15992. }
  15993. }
  15994. CFRelease(certs);
  15995. }
  15996. return loaded;
  15997. }
  15998. #endif
  15999. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  16000. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  16001. // Common CA certificate file paths on Linux/Unix
  16002. inline const char **system_ca_paths() {
  16003. static const char *paths[] = {
  16004. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  16005. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  16006. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  16007. "/etc/pki/tls/cacert.pem", // OpenELEC
  16008. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  16009. nullptr};
  16010. return paths;
  16011. }
  16012. // Common CA certificate directory paths on Linux/Unix
  16013. inline const char **system_ca_dirs() {
  16014. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  16015. "/etc/pki/tls/certs", // RHEL/CentOS
  16016. "/usr/share/ca-certificates", // Other
  16017. nullptr};
  16018. return dirs;
  16019. }
  16020. #endif
  16021. } // namespace impl
  16022. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  16023. const char *ca_dir) {
  16024. if (!ctx) { return false; }
  16025. bool success = true;
  16026. if (ca_file && *ca_file) {
  16027. if (!load_ca_file(ctx, ca_file)) { success = false; }
  16028. }
  16029. if (ca_dir && *ca_dir) {
  16030. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  16031. }
  16032. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16033. // Set CA list for client certificate request (CertificateRequest message)
  16034. if (ca_file && *ca_file) {
  16035. auto list = SSL_load_client_CA_file(ca_file);
  16036. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  16037. }
  16038. #endif
  16039. return success;
  16040. }
  16041. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16042. const char *password) {
  16043. return set_client_cert_pem(ctx, cert, key, password);
  16044. }
  16045. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  16046. const char *key_path, const char *password) {
  16047. return set_client_cert_file(ctx, cert_path, key_path, password);
  16048. }
  16049. // PeerCert implementation
  16050. inline PeerCert::PeerCert() = default;
  16051. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  16052. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  16053. other.cert_ = nullptr;
  16054. }
  16055. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  16056. if (this != &other) {
  16057. if (cert_) { free_cert(cert_); }
  16058. cert_ = other.cert_;
  16059. other.cert_ = nullptr;
  16060. }
  16061. return *this;
  16062. }
  16063. inline PeerCert::~PeerCert() {
  16064. if (cert_) { free_cert(cert_); }
  16065. }
  16066. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16067. inline std::string PeerCert::subject_cn() const {
  16068. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16069. }
  16070. inline std::string PeerCert::issuer_name() const {
  16071. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16072. }
  16073. inline bool PeerCert::check_hostname(const char *hostname) const {
  16074. return cert_ ? verify_hostname(cert_, hostname) : false;
  16075. }
  16076. inline std::vector<SanEntry> PeerCert::sans() const {
  16077. std::vector<SanEntry> result;
  16078. if (cert_) { get_cert_sans(cert_, result); }
  16079. return result;
  16080. }
  16081. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16082. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16083. }
  16084. inline std::string PeerCert::serial() const {
  16085. return cert_ ? get_cert_serial(cert_) : std::string();
  16086. }
  16087. // VerifyContext method implementations
  16088. inline std::string VerifyContext::subject_cn() const {
  16089. return cert ? get_cert_subject_cn(cert) : std::string();
  16090. }
  16091. inline std::string VerifyContext::issuer_name() const {
  16092. return cert ? get_cert_issuer_name(cert) : std::string();
  16093. }
  16094. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16095. return cert ? verify_hostname(cert, hostname) : false;
  16096. }
  16097. inline std::vector<SanEntry> VerifyContext::sans() const {
  16098. std::vector<SanEntry> result;
  16099. if (cert) { get_cert_sans(cert, result); }
  16100. return result;
  16101. }
  16102. inline bool VerifyContext::validity(time_t &not_before,
  16103. time_t &not_after) const {
  16104. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16105. }
  16106. inline std::string VerifyContext::serial() const {
  16107. return cert ? get_cert_serial(cert) : std::string();
  16108. }
  16109. // TlsError static method implementation
  16110. inline std::string TlsError::verify_error_to_string(long error_code) {
  16111. return verify_error_string(error_code);
  16112. }
  16113. } // namespace tls
  16114. // Request::peer_cert() implementation
  16115. inline tls::PeerCert Request::peer_cert() const {
  16116. return tls::get_peer_cert_from_session(ssl);
  16117. }
  16118. // Request::sni() implementation
  16119. inline std::string Request::sni() const {
  16120. if (!ssl) { return std::string(); }
  16121. const char *s = tls::get_sni(ssl);
  16122. return s ? std::string(s) : std::string();
  16123. }
  16124. #endif // CPPHTTPLIB_SSL_ENABLED
  16125. /*
  16126. * Group 8: TLS abstraction layer - OpenSSL backend
  16127. */
  16128. /*
  16129. * OpenSSL Backend Implementation
  16130. */
  16131. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16132. namespace tls {
  16133. namespace impl {
  16134. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16135. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16136. switch (ssl_error) {
  16137. case SSL_ERROR_NONE: return ErrorCode::Success;
  16138. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16139. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16140. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16141. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16142. case SSL_ERROR_SSL:
  16143. default: return ErrorCode::Fatal;
  16144. }
  16145. }
  16146. // Helper: Create client CA list from PEM string
  16147. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16148. // Caller takes ownership of returned list
  16149. inline STACK_OF(X509_NAME) *
  16150. create_client_ca_list_from_pem(const char *ca_pem) {
  16151. if (!ca_pem) { return nullptr; }
  16152. auto ca_list = sk_X509_NAME_new_null();
  16153. if (!ca_list) { return nullptr; }
  16154. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16155. if (!bio) {
  16156. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16157. return nullptr;
  16158. }
  16159. X509 *cert = nullptr;
  16160. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16161. nullptr) {
  16162. const X509_NAME *name = X509_get_subject_name(cert);
  16163. if (name) {
  16164. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16165. }
  16166. X509_free(cert);
  16167. }
  16168. BIO_free(bio);
  16169. return ca_list;
  16170. }
  16171. // OpenSSL verify callback wrapper
  16172. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16173. auto &callback = get_verify_callback();
  16174. if (!callback) { return preverify_ok; }
  16175. // Get SSL object from X509_STORE_CTX
  16176. auto ssl = static_cast<SSL *>(
  16177. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16178. if (!ssl) { return preverify_ok; }
  16179. // Get current certificate and depth
  16180. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16181. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16182. int error = X509_STORE_CTX_get_error(ctx);
  16183. // Build context
  16184. VerifyContext verify_ctx;
  16185. verify_ctx.session = static_cast<session_t>(ssl);
  16186. verify_ctx.cert = static_cast<cert_t>(cert);
  16187. verify_ctx.depth = depth;
  16188. verify_ctx.preverify_ok = (preverify_ok != 0);
  16189. verify_ctx.error_code = error;
  16190. verify_ctx.error_string =
  16191. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16192. return callback(verify_ctx) ? 1 : 0;
  16193. }
  16194. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16195. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16196. // that must be released with release_store_objects
  16197. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16198. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16199. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16200. #endif
  16201. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16202. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16203. return X509_STORE_get1_objects(store);
  16204. #else
  16205. return X509_STORE_get0_objects(store);
  16206. #endif
  16207. }
  16208. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16209. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16210. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16211. #else
  16212. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16213. #endif
  16214. }
  16215. } // namespace impl
  16216. inline ctx_t create_client_context() {
  16217. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16218. if (ctx) {
  16219. // Disable auto-retry to properly handle non-blocking I/O
  16220. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16221. // Set minimum TLS version
  16222. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16223. }
  16224. return static_cast<ctx_t>(ctx);
  16225. }
  16226. inline void free_context(ctx_t ctx) {
  16227. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16228. }
  16229. inline bool set_min_version(ctx_t ctx, Version version) {
  16230. if (!ctx) return false;
  16231. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16232. static_cast<int>(version)) == 1;
  16233. }
  16234. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16235. if (!ctx || !pem || len == 0) return false;
  16236. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16237. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16238. if (!store) return false;
  16239. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16240. if (!bio) return false;
  16241. bool ok = true;
  16242. X509 *cert = nullptr;
  16243. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16244. nullptr) {
  16245. if (X509_STORE_add_cert(store, cert) != 1) {
  16246. // Ignore duplicate errors
  16247. auto err = ERR_peek_last_error();
  16248. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16249. ok = false;
  16250. }
  16251. }
  16252. X509_free(cert);
  16253. if (!ok) break;
  16254. }
  16255. BIO_free(bio);
  16256. // Clear any "no more certificates" errors
  16257. ERR_clear_error();
  16258. return ok;
  16259. }
  16260. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16261. if (!ctx || !file_path) return false;
  16262. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16263. nullptr) == 1;
  16264. }
  16265. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16266. if (!ctx || !dir_path) return false;
  16267. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16268. dir_path) == 1;
  16269. }
  16270. inline bool load_system_certs(ctx_t ctx) {
  16271. if (!ctx) return false;
  16272. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16273. #ifdef _WIN32
  16274. // Windows: Load from system certificate store (ROOT and CA)
  16275. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16276. if (!store) return false;
  16277. bool loaded_any = false;
  16278. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16279. for (auto store_name : store_names) {
  16280. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16281. if (!hStore) continue;
  16282. PCCERT_CONTEXT pContext = nullptr;
  16283. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16284. nullptr) {
  16285. const unsigned char *data = pContext->pbCertEncoded;
  16286. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16287. if (x509) {
  16288. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16289. X509_free(x509);
  16290. }
  16291. }
  16292. CertCloseStore(hStore, 0);
  16293. }
  16294. return loaded_any;
  16295. #elif defined(__APPLE__)
  16296. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16297. // macOS: Load from Keychain
  16298. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16299. if (!store) return false;
  16300. bool loaded_any = false;
  16301. const SecTrustSettingsDomain domains[] = {
  16302. kSecTrustSettingsDomainSystem,
  16303. kSecTrustSettingsDomainAdmin,
  16304. kSecTrustSettingsDomainUser,
  16305. };
  16306. for (auto domain : domains) {
  16307. CFArrayRef certs = nullptr;
  16308. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16309. !certs) {
  16310. if (certs) CFRelease(certs);
  16311. continue;
  16312. }
  16313. auto count = CFArrayGetCount(certs);
  16314. for (CFIndex i = 0; i < count; i++) {
  16315. auto cert = reinterpret_cast<SecCertificateRef>(
  16316. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16317. CFDataRef der = SecCertificateCopyData(cert);
  16318. if (der) {
  16319. const unsigned char *data = CFDataGetBytePtr(der);
  16320. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16321. if (x509) {
  16322. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16323. X509_free(x509);
  16324. }
  16325. CFRelease(der);
  16326. }
  16327. }
  16328. CFRelease(certs);
  16329. }
  16330. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16331. #else
  16332. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16333. #endif
  16334. #else
  16335. // Other Unix: use default verify paths
  16336. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16337. #endif
  16338. }
  16339. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16340. const char *password) {
  16341. if (!ctx || !cert || !key) return false;
  16342. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16343. // Load certificate
  16344. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16345. if (!cert_bio) return false;
  16346. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16347. BIO_free(cert_bio);
  16348. if (!x509) return false;
  16349. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16350. X509_free(x509);
  16351. if (!cert_ok) return false;
  16352. // Load private key
  16353. auto key_bio = BIO_new_mem_buf(key, -1);
  16354. if (!key_bio) return false;
  16355. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16356. password ? const_cast<char *>(password)
  16357. : nullptr);
  16358. BIO_free(key_bio);
  16359. if (!pkey) return false;
  16360. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16361. EVP_PKEY_free(pkey);
  16362. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16363. }
  16364. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16365. const char *key_path, const char *password) {
  16366. if (!ctx || !cert_path || !key_path) return false;
  16367. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16368. if (password && password[0] != '\0') {
  16369. SSL_CTX_set_default_passwd_cb_userdata(
  16370. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16371. }
  16372. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16373. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16374. }
  16375. inline ctx_t create_server_context() {
  16376. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16377. if (ctx) {
  16378. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16379. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16380. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16381. }
  16382. return static_cast<ctx_t>(ctx);
  16383. }
  16384. inline void set_verify_client(ctx_t ctx, bool require) {
  16385. if (!ctx) return;
  16386. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16387. require
  16388. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16389. : SSL_VERIFY_NONE,
  16390. nullptr);
  16391. }
  16392. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16393. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16394. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16395. SSL *ssl = SSL_new(ssl_ctx);
  16396. if (!ssl) return nullptr;
  16397. // Disable auto-retry for proper non-blocking I/O handling
  16398. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16399. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16400. if (!bio) {
  16401. SSL_free(ssl);
  16402. return nullptr;
  16403. }
  16404. SSL_set_bio(ssl, bio, bio);
  16405. return static_cast<session_t>(ssl);
  16406. }
  16407. inline void free_session(session_t session) {
  16408. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16409. }
  16410. inline bool set_sni(session_t session, const char *hostname,
  16411. bool /*verify_hostname*/) {
  16412. if (!session || !hostname) return false;
  16413. auto ssl = static_cast<SSL *>(session);
  16414. // Set SNI (Server Name Indication) only - does not enable verification.
  16415. // OpenSSL never binds identity checking to SNI (that happens post-
  16416. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16417. #if defined(OPENSSL_IS_BORINGSSL)
  16418. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16419. #else
  16420. // Direct call instead of macro to suppress -Wold-style-cast warning
  16421. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16422. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16423. #endif
  16424. }
  16425. inline TlsError connect(session_t session) {
  16426. if (!session) { return TlsError(); }
  16427. auto ssl = static_cast<SSL *>(session);
  16428. auto ret = SSL_connect(ssl);
  16429. TlsError err;
  16430. if (ret == 1) {
  16431. err.code = ErrorCode::Success;
  16432. } else {
  16433. auto ssl_err = SSL_get_error(ssl, ret);
  16434. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16435. err.backend_code = ERR_get_error();
  16436. }
  16437. return err;
  16438. }
  16439. inline TlsError accept(session_t session) {
  16440. if (!session) { return TlsError(); }
  16441. auto ssl = static_cast<SSL *>(session);
  16442. auto ret = SSL_accept(ssl);
  16443. TlsError err;
  16444. if (ret == 1) {
  16445. err.code = ErrorCode::Success;
  16446. } else {
  16447. auto ssl_err = SSL_get_error(ssl, ret);
  16448. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16449. err.backend_code = ERR_get_error();
  16450. }
  16451. return err;
  16452. }
  16453. inline bool connect_nonblocking(session_t session, socket_t sock,
  16454. time_t timeout_sec, time_t timeout_usec,
  16455. TlsError *err) {
  16456. if (!session) {
  16457. if (err) { err->code = ErrorCode::Fatal; }
  16458. return false;
  16459. }
  16460. auto ssl = static_cast<SSL *>(session);
  16461. auto bio = SSL_get_rbio(ssl);
  16462. // Set non-blocking mode for handshake
  16463. detail::set_nonblocking(sock, true);
  16464. if (bio) { BIO_set_nbio(bio, 1); }
  16465. auto cleanup = detail::scope_exit([&]() {
  16466. // Restore blocking mode after handshake
  16467. if (bio) { BIO_set_nbio(bio, 0); }
  16468. detail::set_nonblocking(sock, false);
  16469. });
  16470. auto res = 0;
  16471. while ((res = SSL_connect(ssl)) != 1) {
  16472. auto ssl_err = SSL_get_error(ssl, res);
  16473. switch (ssl_err) {
  16474. case SSL_ERROR_WANT_READ:
  16475. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16476. continue;
  16477. }
  16478. break;
  16479. case SSL_ERROR_WANT_WRITE:
  16480. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16481. continue;
  16482. }
  16483. break;
  16484. default: break;
  16485. }
  16486. if (err) {
  16487. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16488. err->backend_code = ERR_get_error();
  16489. }
  16490. return false;
  16491. }
  16492. if (err) { err->code = ErrorCode::Success; }
  16493. return true;
  16494. }
  16495. inline bool accept_nonblocking(session_t session, socket_t sock,
  16496. time_t timeout_sec, time_t timeout_usec,
  16497. TlsError *err) {
  16498. if (!session) {
  16499. if (err) { err->code = ErrorCode::Fatal; }
  16500. return false;
  16501. }
  16502. auto ssl = static_cast<SSL *>(session);
  16503. auto bio = SSL_get_rbio(ssl);
  16504. // Set non-blocking mode for handshake
  16505. detail::set_nonblocking(sock, true);
  16506. if (bio) { BIO_set_nbio(bio, 1); }
  16507. auto cleanup = detail::scope_exit([&]() {
  16508. // Restore blocking mode after handshake
  16509. if (bio) { BIO_set_nbio(bio, 0); }
  16510. detail::set_nonblocking(sock, false);
  16511. });
  16512. auto res = 0;
  16513. while ((res = SSL_accept(ssl)) != 1) {
  16514. auto ssl_err = SSL_get_error(ssl, res);
  16515. switch (ssl_err) {
  16516. case SSL_ERROR_WANT_READ:
  16517. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16518. continue;
  16519. }
  16520. break;
  16521. case SSL_ERROR_WANT_WRITE:
  16522. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16523. continue;
  16524. }
  16525. break;
  16526. default: break;
  16527. }
  16528. if (err) {
  16529. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16530. err->backend_code = ERR_get_error();
  16531. }
  16532. return false;
  16533. }
  16534. if (err) { err->code = ErrorCode::Success; }
  16535. return true;
  16536. }
  16537. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16538. if (!session || !buf) {
  16539. err.code = ErrorCode::Fatal;
  16540. return -1;
  16541. }
  16542. auto ssl = static_cast<SSL *>(session);
  16543. constexpr auto max_len =
  16544. static_cast<size_t>((std::numeric_limits<int>::max)());
  16545. if (len > max_len) { len = max_len; }
  16546. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16547. if (ret > 0) {
  16548. err.code = ErrorCode::Success;
  16549. return ret;
  16550. }
  16551. auto ssl_err = SSL_get_error(ssl, ret);
  16552. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16553. if (err.code == ErrorCode::PeerClosed) {
  16554. return 0;
  16555. } // Gracefully handle the peer closed state.
  16556. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16557. return -1;
  16558. }
  16559. inline ssize_t write(session_t session, const void *buf, size_t len,
  16560. TlsError &err) {
  16561. if (!session || !buf) {
  16562. err.code = ErrorCode::Fatal;
  16563. return -1;
  16564. }
  16565. auto ssl = static_cast<SSL *>(session);
  16566. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16567. if (ret > 0) {
  16568. err.code = ErrorCode::Success;
  16569. return ret;
  16570. }
  16571. auto ssl_err = SSL_get_error(ssl, ret);
  16572. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16573. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16574. return -1;
  16575. }
  16576. inline int pending(const_session_t session) {
  16577. if (!session) return 0;
  16578. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16579. }
  16580. inline void shutdown(session_t session, bool graceful) {
  16581. if (!session) return;
  16582. auto ssl = static_cast<SSL *>(session);
  16583. if (graceful) {
  16584. // Send close_notify without waiting for the peer's. The connection is
  16585. // closed right after this, so a unidirectional shutdown is enough, and an
  16586. // idle peer that never answers would otherwise hold this thread until the
  16587. // read timeout. The other backends do not wait either.
  16588. SSL_shutdown(ssl);
  16589. }
  16590. }
  16591. inline bool is_peer_closed(session_t session, socket_t sock) {
  16592. if (!session) return true;
  16593. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16594. detail::set_nonblocking(sock, true);
  16595. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16596. auto ssl = static_cast<SSL *>(session);
  16597. char buf;
  16598. auto ret = SSL_peek(ssl, &buf, 1);
  16599. if (ret > 0) return false;
  16600. auto err = SSL_get_error(ssl, ret);
  16601. return err == SSL_ERROR_ZERO_RETURN;
  16602. }
  16603. inline cert_t get_peer_cert(const_session_t session) {
  16604. if (!session) return nullptr;
  16605. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16606. static_cast<SSL *>(const_cast<void *>(session))));
  16607. }
  16608. inline void free_cert(cert_t cert) {
  16609. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16610. }
  16611. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16612. if (!cert || !hostname) return false;
  16613. auto x509 = static_cast<X509 *>(cert);
  16614. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16615. if (detail::is_ip_address(hostname)) {
  16616. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16617. }
  16618. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16619. }
  16620. inline uint64_t hostname_mismatch_code() {
  16621. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16622. }
  16623. inline long get_verify_result(const_session_t session) {
  16624. if (!session) return X509_V_ERR_UNSPECIFIED;
  16625. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16626. }
  16627. inline std::string get_cert_subject_cn(cert_t cert) {
  16628. if (!cert) return "";
  16629. auto x509 = static_cast<X509 *>(cert);
  16630. auto subject_name = X509_get_subject_name(x509);
  16631. if (!subject_name) return "";
  16632. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16633. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16634. if (idx < 0) return "";
  16635. auto entry = X509_NAME_get_entry(subject_name, idx);
  16636. if (!entry) return "";
  16637. auto data = X509_NAME_ENTRY_get_data(entry);
  16638. if (!data) return "";
  16639. return std::string(
  16640. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16641. static_cast<size_t>(ASN1_STRING_length(data)));
  16642. }
  16643. inline std::string get_cert_issuer_name(cert_t cert) {
  16644. if (!cert) return "";
  16645. auto x509 = static_cast<X509 *>(cert);
  16646. auto issuer_name = X509_get_issuer_name(x509);
  16647. if (!issuer_name) return "";
  16648. char buf[256];
  16649. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16650. return std::string(buf);
  16651. }
  16652. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16653. sans.clear();
  16654. if (!cert) return false;
  16655. auto x509 = static_cast<X509 *>(cert);
  16656. auto names = static_cast<GENERAL_NAMES *>(
  16657. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16658. if (!names) return true; // No SANs is valid
  16659. auto count = sk_GENERAL_NAME_num(names);
  16660. for (decltype(count) i = 0; i < count; i++) {
  16661. auto gen = sk_GENERAL_NAME_value(names, i);
  16662. if (!gen) continue;
  16663. SanEntry entry;
  16664. switch (gen->type) {
  16665. case GEN_DNS:
  16666. entry.type = SanType::DNS;
  16667. if (gen->d.dNSName) {
  16668. entry.value = std::string(
  16669. reinterpret_cast<const char *>(
  16670. ASN1_STRING_get0_data(gen->d.dNSName)),
  16671. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16672. }
  16673. break;
  16674. case GEN_IPADD:
  16675. entry.type = SanType::IP;
  16676. if (gen->d.iPAddress) {
  16677. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16678. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16679. if (len == 4) {
  16680. // IPv4
  16681. char buf[INET_ADDRSTRLEN];
  16682. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16683. entry.value = buf;
  16684. } else if (len == 16) {
  16685. // IPv6
  16686. char buf[INET6_ADDRSTRLEN];
  16687. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16688. entry.value = buf;
  16689. }
  16690. }
  16691. break;
  16692. case GEN_EMAIL:
  16693. entry.type = SanType::EMAIL;
  16694. if (gen->d.rfc822Name) {
  16695. entry.value = std::string(
  16696. reinterpret_cast<const char *>(
  16697. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16698. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16699. }
  16700. break;
  16701. case GEN_URI:
  16702. entry.type = SanType::URI;
  16703. if (gen->d.uniformResourceIdentifier) {
  16704. entry.value = std::string(
  16705. reinterpret_cast<const char *>(
  16706. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16707. static_cast<size_t>(
  16708. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16709. }
  16710. break;
  16711. default: entry.type = SanType::OTHER; break;
  16712. }
  16713. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16714. }
  16715. GENERAL_NAMES_free(names);
  16716. return true;
  16717. }
  16718. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16719. time_t &not_after) {
  16720. if (!cert) return false;
  16721. auto x509 = static_cast<X509 *>(cert);
  16722. auto nb = X509_get0_notBefore(x509);
  16723. auto na = X509_get0_notAfter(x509);
  16724. if (!nb || !na) return false;
  16725. ASN1_TIME *epoch = ASN1_TIME_new();
  16726. if (!epoch) return false;
  16727. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16728. if (!ASN1_TIME_set(epoch, 0)) return false;
  16729. int pday, psec;
  16730. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16731. not_before = 86400 * (time_t)pday + psec;
  16732. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16733. not_after = 86400 * (time_t)pday + psec;
  16734. return true;
  16735. }
  16736. inline std::string get_cert_serial(cert_t cert) {
  16737. if (!cert) return "";
  16738. auto x509 = static_cast<X509 *>(cert);
  16739. auto serial = X509_get_serialNumber(x509);
  16740. if (!serial) return "";
  16741. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16742. if (!bn) return "";
  16743. auto hex = BN_bn2hex(bn);
  16744. BN_free(bn);
  16745. if (!hex) return "";
  16746. std::string result(hex);
  16747. OPENSSL_free(hex);
  16748. return result;
  16749. }
  16750. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16751. if (!cert) return false;
  16752. auto x509 = static_cast<X509 *>(cert);
  16753. auto len = i2d_X509(x509, nullptr);
  16754. if (len < 0) return false;
  16755. der.resize(static_cast<size_t>(len));
  16756. auto p = der.data();
  16757. i2d_X509(x509, &p);
  16758. return true;
  16759. }
  16760. inline const char *get_sni(const_session_t session) {
  16761. if (!session) return nullptr;
  16762. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16763. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16764. }
  16765. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16766. inline uint64_t get_error() { return ERR_get_error(); }
  16767. inline std::string error_string(uint64_t code) {
  16768. char buf[256];
  16769. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16770. return std::string(buf);
  16771. }
  16772. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16773. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16774. if (!mem) { return nullptr; }
  16775. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16776. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16777. if (!inf) { return nullptr; }
  16778. auto store = X509_STORE_new();
  16779. if (store) {
  16780. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16781. auto itmp = sk_X509_INFO_value(inf, i);
  16782. if (!itmp) { continue; }
  16783. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16784. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16785. }
  16786. }
  16787. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16788. return static_cast<ca_store_t>(store);
  16789. }
  16790. inline void free_ca_store(ca_store_t store) {
  16791. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16792. }
  16793. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16794. if (!ctx || !store) { return false; }
  16795. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16796. auto x509_store = static_cast<X509_STORE *>(store);
  16797. // Check if same store is already set
  16798. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16799. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16800. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16801. return true;
  16802. }
  16803. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16804. certs.clear();
  16805. if (!ctx) { return 0; }
  16806. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16807. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16808. if (!store) { return 0; }
  16809. auto objs = impl::get_store_objects(store);
  16810. if (!objs) { return 0; }
  16811. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16812. auto count = sk_X509_OBJECT_num(objs);
  16813. for (decltype(count) i = 0; i < count; i++) {
  16814. auto obj = sk_X509_OBJECT_value(objs, i);
  16815. if (!obj) { continue; }
  16816. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16817. auto x509 = X509_OBJECT_get0_X509(obj);
  16818. if (x509) {
  16819. // Increment reference count so caller can free it
  16820. X509_up_ref(x509);
  16821. certs.push_back(static_cast<cert_t>(x509));
  16822. }
  16823. }
  16824. }
  16825. return certs.size();
  16826. }
  16827. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16828. std::vector<std::string> names;
  16829. if (!ctx) { return names; }
  16830. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16831. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16832. if (!store) { return names; }
  16833. auto objs = impl::get_store_objects(store);
  16834. if (!objs) { return names; }
  16835. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16836. auto count = sk_X509_OBJECT_num(objs);
  16837. for (decltype(count) i = 0; i < count; i++) {
  16838. auto obj = sk_X509_OBJECT_value(objs, i);
  16839. if (!obj) { continue; }
  16840. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16841. auto x509 = X509_OBJECT_get0_X509(obj);
  16842. if (x509) {
  16843. auto subject = X509_get_subject_name(x509);
  16844. if (subject) {
  16845. char buf[512];
  16846. X509_NAME_oneline(subject, buf, sizeof(buf));
  16847. names.push_back(buf);
  16848. }
  16849. }
  16850. }
  16851. }
  16852. return names;
  16853. }
  16854. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16855. const char *key_pem, const char *password) {
  16856. if (!ctx || !cert_pem || !key_pem) { return false; }
  16857. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16858. // Load certificate from PEM
  16859. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16860. if (!cert_bio) { return false; }
  16861. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16862. BIO_free(cert_bio);
  16863. if (!cert) { return false; }
  16864. // Load private key from PEM
  16865. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16866. if (!key_bio) {
  16867. X509_free(cert);
  16868. return false;
  16869. }
  16870. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16871. password ? const_cast<char *>(password)
  16872. : nullptr);
  16873. BIO_free(key_bio);
  16874. if (!key) {
  16875. X509_free(cert);
  16876. return false;
  16877. }
  16878. // Update certificate and key
  16879. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16880. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16881. X509_free(cert);
  16882. EVP_PKEY_free(key);
  16883. return ret;
  16884. }
  16885. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16886. if (!ctx || !ca_pem) { return false; }
  16887. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16888. // Create new X509_STORE from PEM
  16889. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16890. if (!store) { return false; }
  16891. // SSL_CTX_set_cert_store takes ownership
  16892. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16893. // Set client CA list for client certificate request
  16894. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16895. if (ca_list) {
  16896. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16897. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16898. }
  16899. return true;
  16900. }
  16901. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16902. if (!ctx) { return false; }
  16903. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16904. impl::get_verify_callback() = std::move(callback);
  16905. if (impl::get_verify_callback()) {
  16906. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16907. } else {
  16908. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16909. }
  16910. return true;
  16911. }
  16912. inline long get_verify_error(const_session_t session) {
  16913. if (!session) { return -1; }
  16914. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16915. return SSL_get_verify_result(ssl);
  16916. }
  16917. inline std::string verify_error_string(long error_code) {
  16918. if (error_code == X509_V_OK) { return ""; }
  16919. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16920. return str ? str : "unknown error";
  16921. }
  16922. } // namespace tls
  16923. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16924. /*
  16925. * Group 9: TLS abstraction layer - Mbed TLS backend
  16926. */
  16927. /*
  16928. * Mbed TLS Backend Implementation
  16929. */
  16930. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16931. namespace tls {
  16932. namespace impl {
  16933. // Mbed TLS session wrapper
  16934. struct MbedTlsSession {
  16935. mbedtls_ssl_context ssl;
  16936. socket_t sock = INVALID_SOCKET;
  16937. std::string hostname; // For client: set via set_sni
  16938. std::string sni_hostname; // For server: received from client via SNI callback
  16939. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16940. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16941. // (e.g. a response that arrived while this side was still in its post-write
  16942. // check), the byte is pushed back here and served by the next read().
  16943. unsigned char peeked_byte = 0;
  16944. bool has_peeked_byte = false;
  16945. // Set by set_sni() when the caller disabled hostname verification, so the
  16946. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16947. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16948. // OpenSSL and wolfSSL keep them independent).
  16949. bool suppress_hostname_mismatch = false;
  16950. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16951. // decide which verify callback to install when hostname verification is
  16952. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16953. // wired for this context, or a self-contained one otherwise, so a session
  16954. // that never opted into a callback never consults the process-wide
  16955. // set_verify_callback() slot (which some other, unrelated client may have
  16956. // populated).
  16957. bool has_verify_callback = false;
  16958. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16959. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16960. MbedTlsSession(const MbedTlsSession &) = delete;
  16961. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16962. };
  16963. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16964. // queue)
  16965. inline int &mbedtls_last_error() {
  16966. static thread_local int err = 0;
  16967. return err;
  16968. }
  16969. // Helper to map Mbed TLS error to ErrorCode
  16970. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16971. uint32_t verify_flags) {
  16972. if (ret == 0) { return ErrorCode::Success; }
  16973. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16974. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16975. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16976. return ErrorCode::PeerClosed;
  16977. }
  16978. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16979. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16980. out_errno = errno;
  16981. return ErrorCode::SyscallError;
  16982. }
  16983. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16984. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16985. // the handshake's chain verification (see set_sni()); a mismatch there
  16986. // is reported the same way as any other verify_flags bit. Report it as
  16987. // HostnameMismatch, matching the other backends and the post-handshake
  16988. // identity check below, but only when naming is the sole problem -
  16989. // if the chain itself is also untrusted/expired/etc., that takes
  16990. // priority over the naming detail.
  16991. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16992. return ErrorCode::HostnameMismatch;
  16993. }
  16994. return ErrorCode::CertVerifyFailed;
  16995. }
  16996. return ErrorCode::Fatal;
  16997. }
  16998. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16999. // return value, including the verify-flags-dependent HostnameMismatch
  17000. // mapping; shared by connect() and connect_nonblocking() so the
  17001. // backend_code policy for that mapping only lives in one place.
  17002. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  17003. int ret) {
  17004. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  17005. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  17006. err.backend_code = err.code == ErrorCode::HostnameMismatch
  17007. ? static_cast<uint64_t>(verify_flags)
  17008. : static_cast<uint64_t>(-ret);
  17009. }
  17010. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  17011. // non-fatal notification delivered between records, not an error and not
  17012. // application data, so I/O calls that see it should just be retried. Kept in
  17013. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  17014. // splitting the closing brace across an #if.
  17015. inline bool mbedtls_is_session_ticket(int ret) {
  17016. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  17017. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  17018. #else
  17019. (void)ret;
  17020. return false;
  17021. #endif
  17022. }
  17023. // BIO-like send callback for Mbed TLS
  17024. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  17025. size_t len) {
  17026. auto sock = *static_cast<socket_t *>(ctx);
  17027. #ifdef _WIN32
  17028. auto ret =
  17029. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  17030. if (ret == SOCKET_ERROR) {
  17031. int err = WSAGetLastError();
  17032. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  17033. return MBEDTLS_ERR_NET_SEND_FAILED;
  17034. }
  17035. #else
  17036. auto ret = send(sock, buf, len, 0);
  17037. if (ret < 0) {
  17038. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17039. return MBEDTLS_ERR_SSL_WANT_WRITE;
  17040. }
  17041. return MBEDTLS_ERR_NET_SEND_FAILED;
  17042. }
  17043. #endif
  17044. return static_cast<int>(ret);
  17045. }
  17046. // BIO-like recv callback for Mbed TLS
  17047. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  17048. auto sock = *static_cast<socket_t *>(ctx);
  17049. #ifdef _WIN32
  17050. auto ret =
  17051. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  17052. if (ret == SOCKET_ERROR) {
  17053. int err = WSAGetLastError();
  17054. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  17055. return MBEDTLS_ERR_NET_RECV_FAILED;
  17056. }
  17057. #else
  17058. auto ret = recv(sock, buf, len, 0);
  17059. if (ret < 0) {
  17060. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  17061. return MBEDTLS_ERR_SSL_WANT_READ;
  17062. }
  17063. return MBEDTLS_ERR_NET_RECV_FAILED;
  17064. }
  17065. #endif
  17066. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17067. return static_cast<int>(ret);
  17068. }
  17069. // MbedTlsContext constructor/destructor implementations
  17070. inline MbedTlsContext::MbedTlsContext() {
  17071. mbedtls_ssl_config_init(&conf);
  17072. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17073. mbedtls_entropy_init(&entropy);
  17074. mbedtls_ctr_drbg_init(&ctr_drbg);
  17075. #endif
  17076. mbedtls_x509_crt_init(&ca_chain);
  17077. mbedtls_x509_crt_init(&own_cert);
  17078. mbedtls_pk_init(&own_key);
  17079. }
  17080. inline MbedTlsContext::~MbedTlsContext() {
  17081. mbedtls_pk_free(&own_key);
  17082. mbedtls_x509_crt_free(&own_cert);
  17083. mbedtls_x509_crt_free(&ca_chain);
  17084. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17085. mbedtls_ctr_drbg_free(&ctr_drbg);
  17086. mbedtls_entropy_free(&entropy);
  17087. #endif
  17088. mbedtls_ssl_config_free(&conf);
  17089. }
  17090. // Thread-local storage for SNI captured during handshake
  17091. // This is needed because the SNI callback doesn't have a way to pass
  17092. // session-specific data before the session is fully set up
  17093. inline std::string &mbedpending_sni() {
  17094. static thread_local std::string sni;
  17095. return sni;
  17096. }
  17097. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17098. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17099. const unsigned char *name, size_t name_len) {
  17100. (void)p_ctx;
  17101. (void)ssl;
  17102. // Store SNI name in thread-local storage
  17103. // It will be retrieved and stored in the session after handshake
  17104. if (name && name_len > 0) {
  17105. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17106. } else {
  17107. mbedpending_sni().clear();
  17108. }
  17109. return 0; // Accept any SNI
  17110. }
  17111. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17112. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17113. }
  17114. // Verify callback used when hostname verification is disabled for a session
  17115. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17116. // has_verify_callback is false). Deliberately does not consult
  17117. // get_verify_callback(): that slot is process-wide, so reading it here would
  17118. // pick up whatever another, unrelated client last installed there.
  17119. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17120. mbedtls_x509_crt *, int,
  17121. uint32_t *flags) {
  17122. (void)data;
  17123. mbedtls_clear_cn_mismatch(flags);
  17124. return 0;
  17125. }
  17126. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17127. int cert_depth, uint32_t *flags);
  17128. // MbedTLS verify callback wrapper
  17129. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17130. int cert_depth, uint32_t *flags) {
  17131. // data points to the MbedTlsSession
  17132. auto *session = static_cast<MbedTlsSession *>(data);
  17133. // set_sni() disabled hostname verification for this session: drop the
  17134. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17135. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17136. // SNI. The final pass/fail decision still comes from the remaining flags
  17137. // (or, below, from the user's own verify callback).
  17138. if (session && session->suppress_hostname_mismatch) {
  17139. mbedtls_clear_cn_mismatch(flags);
  17140. }
  17141. auto &callback = get_verify_callback();
  17142. if (!callback) { return 0; } // Continue with default verification
  17143. // Build context
  17144. VerifyContext verify_ctx;
  17145. verify_ctx.session = static_cast<session_t>(session);
  17146. verify_ctx.cert = static_cast<cert_t>(crt);
  17147. verify_ctx.depth = cert_depth;
  17148. verify_ctx.preverify_ok = (*flags == 0);
  17149. verify_ctx.error_code = static_cast<long>(*flags);
  17150. // Convert Mbed TLS flags to error string
  17151. static thread_local char error_buf[256];
  17152. if (*flags != 0) {
  17153. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17154. verify_ctx.error_string = error_buf;
  17155. } else {
  17156. verify_ctx.error_string = nullptr;
  17157. }
  17158. bool accepted = callback(verify_ctx);
  17159. if (accepted) {
  17160. *flags = 0; // Clear all error flags
  17161. return 0;
  17162. }
  17163. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17164. }
  17165. } // namespace impl
  17166. inline ctx_t create_client_context() {
  17167. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17168. if (!ctx) { return nullptr; }
  17169. ctx->is_server = false;
  17170. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17171. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17172. if (!detail::ensure_mbedtls_psa_crypto()) {
  17173. delete ctx;
  17174. return nullptr;
  17175. }
  17176. int ret;
  17177. #else
  17178. // Seed the random number generator
  17179. const char *pers = "httplib_client";
  17180. int ret = mbedtls_ctr_drbg_seed(
  17181. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17182. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17183. if (ret != 0) {
  17184. impl::mbedtls_last_error() = ret;
  17185. delete ctx;
  17186. return nullptr;
  17187. }
  17188. #endif
  17189. // Set up SSL config for client
  17190. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17191. MBEDTLS_SSL_TRANSPORT_STREAM,
  17192. MBEDTLS_SSL_PRESET_DEFAULT);
  17193. if (ret != 0) {
  17194. impl::mbedtls_last_error() = ret;
  17195. delete ctx;
  17196. return nullptr;
  17197. }
  17198. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17199. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17200. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17201. #endif
  17202. // Default: verify peer certificate
  17203. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17204. // Set minimum TLS version to 1.2
  17205. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17206. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17207. #else
  17208. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17209. MBEDTLS_SSL_MINOR_VERSION_3);
  17210. #endif
  17211. return static_cast<ctx_t>(ctx);
  17212. }
  17213. inline ctx_t create_server_context() {
  17214. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17215. if (!ctx) { return nullptr; }
  17216. ctx->is_server = true;
  17217. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17218. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17219. if (!detail::ensure_mbedtls_psa_crypto()) {
  17220. delete ctx;
  17221. return nullptr;
  17222. }
  17223. int ret;
  17224. #else
  17225. // Seed the random number generator
  17226. const char *pers = "httplib_server";
  17227. int ret = mbedtls_ctr_drbg_seed(
  17228. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17229. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17230. if (ret != 0) {
  17231. impl::mbedtls_last_error() = ret;
  17232. delete ctx;
  17233. return nullptr;
  17234. }
  17235. #endif
  17236. // Set up SSL config for server
  17237. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17238. MBEDTLS_SSL_TRANSPORT_STREAM,
  17239. MBEDTLS_SSL_PRESET_DEFAULT);
  17240. if (ret != 0) {
  17241. impl::mbedtls_last_error() = ret;
  17242. delete ctx;
  17243. return nullptr;
  17244. }
  17245. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17246. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17247. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17248. #endif
  17249. // Default: don't verify client
  17250. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17251. // Set minimum TLS version to 1.2
  17252. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17253. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17254. #else
  17255. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17256. MBEDTLS_SSL_MINOR_VERSION_3);
  17257. #endif
  17258. // Set SNI callback to capture client's SNI hostname
  17259. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17260. return static_cast<ctx_t>(ctx);
  17261. }
  17262. inline void free_context(ctx_t ctx) {
  17263. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17264. }
  17265. inline bool set_min_version(ctx_t ctx, Version version) {
  17266. if (!ctx) { return false; }
  17267. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17268. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17269. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17270. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17271. if (version >= Version::TLS1_3) {
  17272. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17273. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17274. #endif
  17275. }
  17276. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17277. #else
  17278. // Mbed TLS 2.x uses major/minor version numbers
  17279. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17280. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17281. if (version >= Version::TLS1_3) {
  17282. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17283. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17284. #else
  17285. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17286. #endif
  17287. }
  17288. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17289. #endif
  17290. return true;
  17291. }
  17292. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17293. if (!ctx || !pem) { return false; }
  17294. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17295. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17296. // Add null terminator if not present
  17297. std::string pem_str(pem, len);
  17298. int ret = mbedtls_x509_crt_parse(
  17299. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17300. pem_str.size() + 1);
  17301. if (ret != 0) {
  17302. impl::mbedtls_last_error() = ret;
  17303. return false;
  17304. }
  17305. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17306. return true;
  17307. }
  17308. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17309. if (!ctx || !file_path) { return false; }
  17310. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17311. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17312. if (ret != 0) {
  17313. impl::mbedtls_last_error() = ret;
  17314. return false;
  17315. }
  17316. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17317. return true;
  17318. }
  17319. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17320. if (!ctx || !dir_path) { return false; }
  17321. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17322. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17323. if (ret < 0) { // Returns number of certs on success, negative on error
  17324. impl::mbedtls_last_error() = ret;
  17325. return false;
  17326. }
  17327. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17328. return true;
  17329. }
  17330. inline bool load_system_certs(ctx_t ctx) {
  17331. if (!ctx) { return false; }
  17332. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17333. bool loaded = false;
  17334. #ifdef _WIN32
  17335. loaded = impl::enumerate_windows_system_certs(
  17336. [&](const unsigned char *data, size_t len) {
  17337. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17338. });
  17339. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17340. loaded = impl::enumerate_macos_keychain_certs(
  17341. [&](const unsigned char *data, size_t len) {
  17342. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17343. });
  17344. #else
  17345. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17346. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17347. loaded = true;
  17348. break;
  17349. }
  17350. }
  17351. if (!loaded) {
  17352. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17353. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17354. loaded = true;
  17355. break;
  17356. }
  17357. }
  17358. }
  17359. #endif
  17360. if (loaded) {
  17361. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17362. }
  17363. return loaded;
  17364. }
  17365. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17366. const char *password) {
  17367. if (!ctx || !cert || !key) { return false; }
  17368. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17369. // Parse certificate
  17370. std::string cert_str(cert);
  17371. int ret = mbedtls_x509_crt_parse(
  17372. &mctx->own_cert,
  17373. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17374. cert_str.size() + 1);
  17375. if (ret != 0) {
  17376. impl::mbedtls_last_error() = ret;
  17377. return false;
  17378. }
  17379. // Parse private key
  17380. std::string key_str(key);
  17381. const unsigned char *pwd =
  17382. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17383. size_t pwd_len = password ? strlen(password) : 0;
  17384. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17385. ret = mbedtls_pk_parse_key(
  17386. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17387. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17388. &mctx->ctr_drbg);
  17389. #else
  17390. ret = mbedtls_pk_parse_key(
  17391. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17392. key_str.size() + 1, pwd, pwd_len);
  17393. #endif
  17394. if (ret != 0) {
  17395. impl::mbedtls_last_error() = ret;
  17396. return false;
  17397. }
  17398. // Verify that the certificate and private key match.
  17399. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17400. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17401. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17402. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17403. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17404. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17405. #else
  17406. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17407. #endif
  17408. if (ret != 0) {
  17409. impl::mbedtls_last_error() = ret;
  17410. return false;
  17411. }
  17412. #endif
  17413. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17414. if (ret != 0) {
  17415. impl::mbedtls_last_error() = ret;
  17416. return false;
  17417. }
  17418. return true;
  17419. }
  17420. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17421. const char *key_path, const char *password) {
  17422. if (!ctx || !cert_path || !key_path) { return false; }
  17423. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17424. // Parse certificate file
  17425. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17426. if (ret != 0) {
  17427. impl::mbedtls_last_error() = ret;
  17428. return false;
  17429. }
  17430. // Parse private key file
  17431. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17432. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17433. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17434. #else
  17435. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17436. #endif
  17437. if (ret != 0) {
  17438. impl::mbedtls_last_error() = ret;
  17439. return false;
  17440. }
  17441. // Verify that the certificate and private key match.
  17442. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17443. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17444. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17445. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17446. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17447. #else
  17448. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17449. #endif
  17450. if (ret != 0) {
  17451. impl::mbedtls_last_error() = ret;
  17452. return false;
  17453. }
  17454. #endif
  17455. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17456. if (ret != 0) {
  17457. impl::mbedtls_last_error() = ret;
  17458. return false;
  17459. }
  17460. return true;
  17461. }
  17462. inline void set_verify_client(ctx_t ctx, bool require) {
  17463. if (!ctx) { return; }
  17464. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17465. mctx->verify_client = require;
  17466. if (require) {
  17467. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17468. } else {
  17469. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17470. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17471. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17472. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17473. : MBEDTLS_SSL_VERIFY_NONE);
  17474. }
  17475. }
  17476. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17477. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17478. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17479. auto session = new (std::nothrow) impl::MbedTlsSession();
  17480. if (!session) { return nullptr; }
  17481. session->sock = sock;
  17482. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17483. if (ret != 0) {
  17484. impl::mbedtls_last_error() = ret;
  17485. delete session;
  17486. return nullptr;
  17487. }
  17488. // Explicitly opt out of in-handshake hostname verification by default;
  17489. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17490. // fails outright when no hostname was set. set_sni() installs the real
  17491. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17492. // caller verifies the certificate identity post-handshake via
  17493. // verify_hostname().
  17494. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17495. // Set BIO callbacks
  17496. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17497. impl::mbedtls_net_recv_cb, nullptr);
  17498. // Set per-session verify callback with session pointer if callback is
  17499. // registered
  17500. session->has_verify_callback = mctx->has_verify_callback;
  17501. if (mctx->has_verify_callback) {
  17502. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17503. session);
  17504. }
  17505. return static_cast<session_t>(session);
  17506. }
  17507. inline void free_session(session_t session) {
  17508. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17509. }
  17510. inline bool set_sni(session_t session, const char *hostname,
  17511. bool verify_hostname) {
  17512. if (!session || !hostname) { return false; }
  17513. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17514. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17515. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17516. // independently, so a disabled hostname check is handled below by masking
  17517. // the resulting mismatch flag instead of skipping this call.
  17518. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17519. if (ret != 0) {
  17520. impl::mbedtls_last_error() = ret;
  17521. return false;
  17522. }
  17523. msession->hostname = hostname;
  17524. if (!verify_hostname) {
  17525. msession->suppress_hostname_mismatch = true;
  17526. // If a user verify callback is already wired for this session,
  17527. // mbedtls_verify_callback() masks the mismatch flag itself before
  17528. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17529. // here would be redundant. Otherwise install the self-contained masking
  17530. // callback, which never touches the process-wide callback slot.
  17531. if (!msession->has_verify_callback) {
  17532. mbedtls_ssl_set_verify(&msession->ssl,
  17533. impl::mbedtls_mask_hostname_mismatch_callback,
  17534. msession);
  17535. }
  17536. }
  17537. return true;
  17538. }
  17539. inline TlsError connect(session_t session) {
  17540. TlsError err;
  17541. if (!session) {
  17542. err.code = ErrorCode::Fatal;
  17543. return err;
  17544. }
  17545. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17546. int ret;
  17547. do {
  17548. ret = mbedtls_ssl_handshake(&msession->ssl);
  17549. } while (impl::mbedtls_is_session_ticket(ret));
  17550. if (ret == 0) {
  17551. err.code = ErrorCode::Success;
  17552. } else {
  17553. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17554. impl::mbedtls_last_error() = ret;
  17555. }
  17556. return err;
  17557. }
  17558. inline TlsError accept(session_t session) {
  17559. // Same as connect for Mbed TLS - handshake works for both client and server
  17560. auto result = connect(session);
  17561. // After successful handshake, capture SNI from thread-local storage
  17562. if (result.code == ErrorCode::Success && session) {
  17563. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17564. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17565. impl::mbedpending_sni().clear();
  17566. }
  17567. return result;
  17568. }
  17569. inline bool connect_nonblocking(session_t session, socket_t sock,
  17570. time_t timeout_sec, time_t timeout_usec,
  17571. TlsError *err) {
  17572. if (!session) {
  17573. if (err) { err->code = ErrorCode::Fatal; }
  17574. return false;
  17575. }
  17576. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17577. // Set socket to non-blocking mode
  17578. detail::set_nonblocking(sock, true);
  17579. auto cleanup =
  17580. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17581. int ret;
  17582. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17583. // Non-fatal TLS 1.3 ticket; retry immediately.
  17584. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17585. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17586. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17587. continue;
  17588. }
  17589. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17590. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17591. continue;
  17592. }
  17593. }
  17594. // TlsError or timeout
  17595. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17596. impl::mbedtls_last_error() = ret;
  17597. return false;
  17598. }
  17599. if (err) { err->code = ErrorCode::Success; }
  17600. return true;
  17601. }
  17602. inline bool accept_nonblocking(session_t session, socket_t sock,
  17603. time_t timeout_sec, time_t timeout_usec,
  17604. TlsError *err) {
  17605. // Same implementation as connect for Mbed TLS
  17606. bool result =
  17607. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17608. // After successful handshake, capture SNI from thread-local storage
  17609. if (result && session) {
  17610. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17611. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17612. impl::mbedpending_sni().clear();
  17613. }
  17614. return result;
  17615. }
  17616. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17617. if (!session || !buf) {
  17618. err.code = ErrorCode::Fatal;
  17619. return -1;
  17620. }
  17621. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17622. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17623. if (msession->has_peeked_byte) {
  17624. if (len == 0) { return 0; }
  17625. auto p = static_cast<unsigned char *>(buf);
  17626. p[0] = msession->peeked_byte;
  17627. msession->has_peeked_byte = false;
  17628. size_t n = 1;
  17629. // Top up with any already-decrypted bytes without risking a block.
  17630. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17631. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17632. if (extra > 0) { n += static_cast<size_t>(extra); }
  17633. }
  17634. err.code = ErrorCode::Success;
  17635. return static_cast<ssize_t>(n);
  17636. }
  17637. int ret;
  17638. do {
  17639. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17640. len);
  17641. } while (impl::mbedtls_is_session_ticket(ret));
  17642. if (ret > 0) {
  17643. err.code = ErrorCode::Success;
  17644. return static_cast<ssize_t>(ret);
  17645. }
  17646. if (ret == 0) {
  17647. err.code = ErrorCode::PeerClosed;
  17648. return 0;
  17649. }
  17650. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17651. err.backend_code = static_cast<uint64_t>(-ret);
  17652. impl::mbedtls_last_error() = ret;
  17653. // mbedTLS signals a clean close_notify via a negative error code rather
  17654. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17655. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17656. return -1;
  17657. }
  17658. inline ssize_t write(session_t session, const void *buf, size_t len,
  17659. TlsError &err) {
  17660. if (!session || !buf) {
  17661. err.code = ErrorCode::Fatal;
  17662. return -1;
  17663. }
  17664. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17665. int ret;
  17666. do {
  17667. ret = mbedtls_ssl_write(&msession->ssl,
  17668. static_cast<const unsigned char *>(buf), len);
  17669. } while (impl::mbedtls_is_session_ticket(ret));
  17670. if (ret > 0) {
  17671. err.code = ErrorCode::Success;
  17672. return static_cast<ssize_t>(ret);
  17673. }
  17674. if (ret == 0) {
  17675. err.code = ErrorCode::PeerClosed;
  17676. return 0;
  17677. }
  17678. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17679. err.backend_code = static_cast<uint64_t>(-ret);
  17680. impl::mbedtls_last_error() = ret;
  17681. return -1;
  17682. }
  17683. inline int pending(const_session_t session) {
  17684. if (!session) { return 0; }
  17685. auto msession =
  17686. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17687. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17688. (msession->has_peeked_byte ? 1 : 0);
  17689. }
  17690. inline void shutdown(session_t session, bool graceful) {
  17691. if (!session) { return; }
  17692. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17693. if (graceful) {
  17694. // Try to send close_notify, but don't block forever
  17695. int ret;
  17696. int attempts = 0;
  17697. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17698. attempts < 3) {
  17699. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17700. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17701. break;
  17702. }
  17703. attempts++;
  17704. }
  17705. }
  17706. }
  17707. inline bool is_peer_closed(session_t session, socket_t sock) {
  17708. if (!session || sock == INVALID_SOCKET) { return true; }
  17709. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17710. // Check if there's already decrypted or pushed-back data available.
  17711. // If so, the connection is definitely alive.
  17712. if (msession->has_peeked_byte ||
  17713. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17714. return false;
  17715. }
  17716. // Set socket to non-blocking to avoid blocking on read
  17717. detail::set_nonblocking(sock, true);
  17718. auto cleanup =
  17719. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17720. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17721. // on application data — e.g. a response that already arrived — push the
  17722. // byte back so the next read() delivers it instead of losing it.
  17723. unsigned char buf;
  17724. int ret;
  17725. do {
  17726. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17727. } while (impl::mbedtls_is_session_ticket(ret));
  17728. // If we got data or WANT_READ (would block), connection is alive
  17729. if (ret > 0) {
  17730. msession->peeked_byte = buf;
  17731. msession->has_peeked_byte = true;
  17732. return false;
  17733. }
  17734. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17735. // If we get a peer close notify or a connection reset, the peer is closed
  17736. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17737. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17738. }
  17739. inline cert_t get_peer_cert(const_session_t session) {
  17740. if (!session) { return nullptr; }
  17741. auto msession =
  17742. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17743. // Mbed TLS returns a pointer to the internal peer cert chain.
  17744. // WARNING: This pointer is only valid while the session is active.
  17745. // Do not use the certificate after calling free_session().
  17746. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17747. return const_cast<mbedtls_x509_crt *>(cert);
  17748. }
  17749. inline void free_cert(cert_t cert) {
  17750. // Mbed TLS: peer certificate is owned by the SSL context.
  17751. // No-op here, but callers should still call this for cross-backend
  17752. // portability.
  17753. (void)cert;
  17754. }
  17755. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17756. if (!cert || !hostname) { return false; }
  17757. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17758. std::string host_str(hostname);
  17759. // Check if hostname is an IP address (IPv4 or IPv6)
  17760. unsigned char ip_bytes[16];
  17761. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17762. auto is_ip = ip_len > 0;
  17763. // Check Subject Alternative Names (SAN)
  17764. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17765. // - DNS names: raw string bytes
  17766. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17767. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17768. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17769. const unsigned char *p = san->buf.p;
  17770. size_t len = san->buf.len;
  17771. if (is_ip) {
  17772. // For an IP host, only a matching iPAddress SAN of the same family
  17773. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17774. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17775. } else {
  17776. // Check if this SAN is a DNS name (printable ASCII string)
  17777. bool is_dns = len > 0;
  17778. for (size_t i = 0; i < len && is_dns; i++) {
  17779. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17780. }
  17781. if (is_dns) {
  17782. std::string san_name(reinterpret_cast<const char *>(p), len);
  17783. if (detail::match_hostname(san_name, host_str)) { return true; }
  17784. }
  17785. }
  17786. san = san->next;
  17787. }
  17788. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17789. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17790. // the OpenSSL backend's X509_check_ip behaves the same way).
  17791. if (!is_ip) {
  17792. char cn[256];
  17793. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17794. if (ret > 0) {
  17795. std::string cn_str(cn);
  17796. // Look for "CN=" in the DN string
  17797. size_t cn_pos = cn_str.find("CN=");
  17798. if (cn_pos != std::string::npos) {
  17799. size_t start = cn_pos + 3;
  17800. size_t end = cn_str.find(',', start);
  17801. std::string cn_value =
  17802. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17803. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17804. }
  17805. }
  17806. }
  17807. return false;
  17808. }
  17809. inline uint64_t hostname_mismatch_code() {
  17810. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17811. }
  17812. inline long get_verify_result(const_session_t session) {
  17813. if (!session) { return -1; }
  17814. auto msession =
  17815. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17816. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17817. // Return 0 (X509_V_OK equivalent) if verification passed
  17818. return flags == 0 ? 0 : static_cast<long>(flags);
  17819. }
  17820. inline std::string get_cert_subject_cn(cert_t cert) {
  17821. if (!cert) return "";
  17822. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17823. // Find the CN in the subject
  17824. const mbedtls_x509_name *name = &x509->subject;
  17825. while (name != nullptr) {
  17826. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17827. return std::string(reinterpret_cast<const char *>(name->val.p),
  17828. name->val.len);
  17829. }
  17830. name = name->next;
  17831. }
  17832. return "";
  17833. }
  17834. inline std::string get_cert_issuer_name(cert_t cert) {
  17835. if (!cert) return "";
  17836. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17837. // Build a human-readable issuer name string
  17838. char buf[512];
  17839. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17840. if (ret < 0) return "";
  17841. return std::string(buf);
  17842. }
  17843. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17844. sans.clear();
  17845. if (!cert) return false;
  17846. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17847. // Parse the Subject Alternative Name extension
  17848. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17849. while (cur != nullptr) {
  17850. if (cur->buf.len > 0) {
  17851. // Mbed TLS stores SAN as ASN.1 sequences
  17852. // The tag byte indicates the type
  17853. const unsigned char *p = cur->buf.p;
  17854. size_t len = cur->buf.len;
  17855. // First byte is the tag
  17856. unsigned char tag = *p;
  17857. p++;
  17858. len--;
  17859. // Parse length (simple single-byte length assumed)
  17860. if (len > 0 && *p < 0x80) {
  17861. size_t value_len = *p;
  17862. p++;
  17863. len--;
  17864. if (value_len <= len) {
  17865. SanEntry entry;
  17866. // ASN.1 context tags for GeneralName
  17867. switch (tag & 0x1F) {
  17868. case 2: // dNSName
  17869. entry.type = SanType::DNS;
  17870. entry.value =
  17871. std::string(reinterpret_cast<const char *>(p), value_len);
  17872. break;
  17873. case 7: // iPAddress
  17874. entry.type = SanType::IP;
  17875. if (value_len == 4) {
  17876. // IPv4
  17877. char buf[16];
  17878. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17879. entry.value = buf;
  17880. } else if (value_len == 16) {
  17881. // IPv6
  17882. char buf[64];
  17883. snprintf(buf, sizeof(buf),
  17884. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17885. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17886. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17887. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17888. entry.value = buf;
  17889. }
  17890. break;
  17891. case 1: // rfc822Name (email)
  17892. entry.type = SanType::EMAIL;
  17893. entry.value =
  17894. std::string(reinterpret_cast<const char *>(p), value_len);
  17895. break;
  17896. case 6: // uniformResourceIdentifier
  17897. entry.type = SanType::URI;
  17898. entry.value =
  17899. std::string(reinterpret_cast<const char *>(p), value_len);
  17900. break;
  17901. default: entry.type = SanType::OTHER; break;
  17902. }
  17903. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17904. }
  17905. }
  17906. }
  17907. cur = cur->next;
  17908. }
  17909. return true;
  17910. }
  17911. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17912. time_t &not_after) {
  17913. if (!cert) return false;
  17914. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17915. // Convert mbedtls_x509_time to time_t
  17916. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17917. struct tm tm_time = {};
  17918. tm_time.tm_year = t.year - 1900;
  17919. tm_time.tm_mon = t.mon - 1;
  17920. tm_time.tm_mday = t.day;
  17921. tm_time.tm_hour = t.hour;
  17922. tm_time.tm_min = t.min;
  17923. tm_time.tm_sec = t.sec;
  17924. #ifdef _WIN32
  17925. return _mkgmtime(&tm_time);
  17926. #else
  17927. return timegm(&tm_time);
  17928. #endif
  17929. };
  17930. not_before = to_time_t(x509->valid_from);
  17931. not_after = to_time_t(x509->valid_to);
  17932. return true;
  17933. }
  17934. inline std::string get_cert_serial(cert_t cert) {
  17935. if (!cert) return "";
  17936. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17937. // Convert serial number to hex string
  17938. std::string result;
  17939. result.reserve(x509->serial.len * 2);
  17940. for (size_t i = 0; i < x509->serial.len; i++) {
  17941. char hex[3];
  17942. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17943. result += hex;
  17944. }
  17945. return result;
  17946. }
  17947. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17948. if (!cert) return false;
  17949. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17950. if (!crt->raw.p || crt->raw.len == 0) return false;
  17951. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17952. return true;
  17953. }
  17954. inline const char *get_sni(const_session_t session) {
  17955. if (!session) return nullptr;
  17956. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17957. // For server: return SNI received from client during handshake
  17958. if (!msession->sni_hostname.empty()) {
  17959. return msession->sni_hostname.c_str();
  17960. }
  17961. // For client: return the hostname set via set_sni
  17962. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17963. return nullptr;
  17964. }
  17965. inline uint64_t peek_error() {
  17966. // Mbed TLS doesn't have an error queue, return the last error
  17967. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17968. }
  17969. inline uint64_t get_error() {
  17970. // Mbed TLS doesn't have an error queue, return and clear the last error
  17971. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17972. impl::mbedtls_last_error() = 0;
  17973. return err;
  17974. }
  17975. inline std::string error_string(uint64_t code) {
  17976. char buf[256];
  17977. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17978. return std::string(buf);
  17979. }
  17980. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17981. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17982. if (!ca_chain) { return nullptr; }
  17983. mbedtls_x509_crt_init(ca_chain);
  17984. // mbedtls_x509_crt_parse expects null-terminated PEM
  17985. int ret = mbedtls_x509_crt_parse(ca_chain,
  17986. reinterpret_cast<const unsigned char *>(pem),
  17987. len + 1); // +1 for null terminator
  17988. if (ret != 0) {
  17989. // Try without +1 in case PEM is already null-terminated
  17990. ret = mbedtls_x509_crt_parse(
  17991. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17992. if (ret != 0) {
  17993. mbedtls_x509_crt_free(ca_chain);
  17994. delete ca_chain;
  17995. return nullptr;
  17996. }
  17997. }
  17998. return static_cast<ca_store_t>(ca_chain);
  17999. }
  18000. inline void free_ca_store(ca_store_t store) {
  18001. if (store) {
  18002. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18003. mbedtls_x509_crt_free(ca_chain);
  18004. delete ca_chain;
  18005. }
  18006. }
  18007. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18008. if (!ctx || !store) { return false; }
  18009. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18010. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  18011. // Free existing CA chain
  18012. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18013. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18014. // Copy the CA chain (deep copy)
  18015. // Parse from the raw data of the source cert
  18016. mbedtls_x509_crt *src = ca_chain;
  18017. while (src != nullptr) {
  18018. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  18019. src->raw.len);
  18020. if (ret != 0) {
  18021. free_ca_store(store);
  18022. return false;
  18023. }
  18024. src = src->next;
  18025. }
  18026. // This function takes ownership of the store; the chain was deep-copied
  18027. // above, so release the source
  18028. free_ca_store(store);
  18029. // Update the SSL config to use the new CA chain
  18030. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18031. return true;
  18032. }
  18033. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18034. certs.clear();
  18035. if (!ctx) { return 0; }
  18036. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18037. // Iterate through the CA chain
  18038. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18039. while (cert != nullptr && cert->raw.len > 0) {
  18040. // Create a copy of the certificate for the caller
  18041. auto *copy = new mbedtls_x509_crt;
  18042. mbedtls_x509_crt_init(copy);
  18043. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  18044. if (ret == 0) {
  18045. certs.push_back(static_cast<cert_t>(copy));
  18046. } else {
  18047. mbedtls_x509_crt_free(copy);
  18048. delete copy;
  18049. }
  18050. cert = cert->next;
  18051. }
  18052. return certs.size();
  18053. }
  18054. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18055. std::vector<std::string> names;
  18056. if (!ctx) { return names; }
  18057. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18058. // Iterate through the CA chain
  18059. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  18060. while (cert != nullptr && cert->raw.len > 0) {
  18061. char buf[512];
  18062. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  18063. if (ret > 0) { names.push_back(buf); }
  18064. cert = cert->next;
  18065. }
  18066. return names;
  18067. }
  18068. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18069. const char *key_pem, const char *password) {
  18070. if (!ctx || !cert_pem || !key_pem) { return false; }
  18071. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18072. // Free existing certificate and key
  18073. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18074. mbedtls_pk_free(&mbed_ctx->own_key);
  18075. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18076. mbedtls_pk_init(&mbed_ctx->own_key);
  18077. // Parse certificate PEM
  18078. int ret = mbedtls_x509_crt_parse(
  18079. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18080. strlen(cert_pem) + 1);
  18081. if (ret != 0) {
  18082. impl::mbedtls_last_error() = ret;
  18083. return false;
  18084. }
  18085. // Parse private key PEM
  18086. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18087. ret = mbedtls_pk_parse_key(
  18088. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18089. strlen(key_pem) + 1,
  18090. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18091. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18092. &mbed_ctx->ctr_drbg);
  18093. #else
  18094. ret = mbedtls_pk_parse_key(
  18095. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18096. strlen(key_pem) + 1,
  18097. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18098. password ? strlen(password) : 0);
  18099. #endif
  18100. if (ret != 0) {
  18101. impl::mbedtls_last_error() = ret;
  18102. return false;
  18103. }
  18104. // Configure SSL to use the new certificate and key
  18105. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18106. &mbed_ctx->own_key);
  18107. if (ret != 0) {
  18108. impl::mbedtls_last_error() = ret;
  18109. return false;
  18110. }
  18111. return true;
  18112. }
  18113. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18114. if (!ctx || !ca_pem) { return false; }
  18115. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18116. // Free existing CA chain
  18117. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18118. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18119. // Parse CA PEM
  18120. int ret = mbedtls_x509_crt_parse(
  18121. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18122. strlen(ca_pem) + 1);
  18123. if (ret != 0) {
  18124. impl::mbedtls_last_error() = ret;
  18125. return false;
  18126. }
  18127. // Update SSL config to use new CA chain
  18128. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18129. return true;
  18130. }
  18131. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18132. if (!ctx) { return false; }
  18133. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18134. impl::get_verify_callback() = std::move(callback);
  18135. mbed_ctx->has_verify_callback =
  18136. static_cast<bool>(impl::get_verify_callback());
  18137. if (mbed_ctx->has_verify_callback) {
  18138. // Set OPTIONAL mode to ensure callback is called even when verification
  18139. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18140. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18141. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18142. nullptr);
  18143. } else {
  18144. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18145. }
  18146. return true;
  18147. }
  18148. inline long get_verify_error(const_session_t session) {
  18149. if (!session) { return -1; }
  18150. auto *msession =
  18151. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18152. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18153. }
  18154. inline std::string verify_error_string(long error_code) {
  18155. if (error_code == 0) { return ""; }
  18156. char buf[256];
  18157. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18158. static_cast<uint32_t>(error_code));
  18159. // Remove trailing newline if present
  18160. std::string result(buf);
  18161. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18162. result.pop_back();
  18163. }
  18164. return result;
  18165. }
  18166. } // namespace tls
  18167. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18168. /*
  18169. * Group 10: TLS abstraction layer - wolfSSL backend
  18170. */
  18171. /*
  18172. * wolfSSL Backend Implementation
  18173. */
  18174. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18175. namespace tls {
  18176. namespace impl {
  18177. // wolfSSL session wrapper
  18178. struct WolfSSLSession {
  18179. WOLFSSL *ssl = nullptr;
  18180. socket_t sock = INVALID_SOCKET;
  18181. std::string hostname; // For client: set via set_sni
  18182. std::string sni_hostname; // For server: received from client via SNI callback
  18183. WolfSSLSession() = default;
  18184. ~WolfSSLSession() {
  18185. if (ssl) { wolfSSL_free(ssl); }
  18186. }
  18187. WolfSSLSession(const WolfSSLSession &) = delete;
  18188. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18189. };
  18190. // Thread-local error code accessor for wolfSSL
  18191. inline uint64_t &wolfssl_last_error() {
  18192. static thread_local uint64_t err = 0;
  18193. return err;
  18194. }
  18195. // Helper to map wolfSSL error to ErrorCode.
  18196. // ssl_error is the value from wolfSSL_get_error().
  18197. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18198. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18199. int &out_errno) {
  18200. switch (ssl_error) {
  18201. case SSL_ERROR_NONE: return ErrorCode::Success;
  18202. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18203. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18204. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18205. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18206. default:
  18207. if (ssl) {
  18208. // wolfSSL stores the low-level error code as a negative value.
  18209. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18210. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18211. if (low_err == DOMAIN_NAME_MISMATCH) {
  18212. return ErrorCode::HostnameMismatch;
  18213. }
  18214. // Check verify result to distinguish cert verification from generic SSL
  18215. // errors.
  18216. long vr = wolfSSL_get_verify_result(ssl);
  18217. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18218. }
  18219. return ErrorCode::Fatal;
  18220. }
  18221. }
  18222. // WolfSSLContext constructor/destructor implementations
  18223. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18224. inline WolfSSLContext::~WolfSSLContext() {
  18225. if (ctx) { wolfSSL_CTX_free(ctx); }
  18226. }
  18227. // Thread-local storage for SNI captured during handshake
  18228. inline std::string &wolfssl_pending_sni() {
  18229. static thread_local std::string sni;
  18230. return sni;
  18231. }
  18232. // SNI callback for wolfSSL server to capture client's SNI hostname
  18233. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18234. (void)ret;
  18235. (void)exArg;
  18236. void *name_data = nullptr;
  18237. unsigned short name_len =
  18238. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18239. if (name_data && name_len > 0) {
  18240. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18241. name_len);
  18242. } else {
  18243. wolfssl_pending_sni().clear();
  18244. }
  18245. return 0; // Continue regardless
  18246. }
  18247. // wolfSSL verify callback wrapper
  18248. inline int wolfssl_verify_callback(int preverify_ok,
  18249. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18250. auto &callback = get_verify_callback();
  18251. if (!callback) { return preverify_ok; }
  18252. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18253. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18254. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18255. // Get the WOLFSSL object from the X509_STORE_CTX
  18256. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18257. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18258. VerifyContext verify_ctx;
  18259. verify_ctx.session = static_cast<session_t>(ssl);
  18260. verify_ctx.cert = static_cast<cert_t>(cert);
  18261. verify_ctx.depth = depth;
  18262. verify_ctx.preverify_ok = (preverify_ok != 0);
  18263. verify_ctx.error_code = static_cast<long>(err);
  18264. if (err != 0) {
  18265. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18266. } else {
  18267. verify_ctx.error_string = nullptr;
  18268. }
  18269. bool accepted = callback(verify_ctx);
  18270. return accepted ? 1 : 0;
  18271. }
  18272. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18273. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18274. wolfSSL_CTX_set_default_passwd_cb(
  18275. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18276. auto *pwd = static_cast<const char *>(userdata);
  18277. if (!pwd) return 0;
  18278. auto len = static_cast<int>(strlen(pwd));
  18279. if (len > size) len = size;
  18280. memcpy(buf, pwd, static_cast<size_t>(len));
  18281. return len;
  18282. });
  18283. }
  18284. } // namespace impl
  18285. inline ctx_t create_client_context() {
  18286. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18287. if (!ctx) { return nullptr; }
  18288. ctx->is_server = false;
  18289. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18290. if (!method) {
  18291. delete ctx;
  18292. return nullptr;
  18293. }
  18294. ctx->ctx = wolfSSL_CTX_new(method);
  18295. if (!ctx->ctx) {
  18296. delete ctx;
  18297. return nullptr;
  18298. }
  18299. // Default: verify peer certificate
  18300. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18301. return static_cast<ctx_t>(ctx);
  18302. }
  18303. inline ctx_t create_server_context() {
  18304. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18305. if (!ctx) { return nullptr; }
  18306. ctx->is_server = true;
  18307. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18308. if (!method) {
  18309. delete ctx;
  18310. return nullptr;
  18311. }
  18312. ctx->ctx = wolfSSL_CTX_new(method);
  18313. if (!ctx->ctx) {
  18314. delete ctx;
  18315. return nullptr;
  18316. }
  18317. // Default: don't verify client
  18318. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18319. // Enable SNI on server
  18320. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18321. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18322. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18323. return static_cast<ctx_t>(ctx);
  18324. }
  18325. inline void free_context(ctx_t ctx) {
  18326. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18327. }
  18328. inline bool set_min_version(ctx_t ctx, Version version) {
  18329. if (!ctx) { return false; }
  18330. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18331. int min_ver = WOLFSSL_TLSV1_2;
  18332. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18333. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18334. }
  18335. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18336. if (!ctx || !pem) { return false; }
  18337. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18338. int ret = wolfSSL_CTX_load_verify_buffer(
  18339. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18340. static_cast<long>(len), SSL_FILETYPE_PEM);
  18341. if (ret != SSL_SUCCESS) {
  18342. impl::wolfssl_last_error() =
  18343. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18344. return false;
  18345. }
  18346. wctx->ca_pem_data_.append(pem, len);
  18347. return true;
  18348. }
  18349. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18350. if (!ctx || !file_path) { return false; }
  18351. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18352. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18353. if (ret != SSL_SUCCESS) {
  18354. impl::wolfssl_last_error() =
  18355. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18356. return false;
  18357. }
  18358. return true;
  18359. }
  18360. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18361. if (!ctx || !dir_path) { return false; }
  18362. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18363. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18364. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18365. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18366. // immediately. Return true even on failure since the CA file may have
  18367. // already been loaded, matching OpenSSL's lenient behavior.
  18368. (void)ret;
  18369. return true;
  18370. }
  18371. inline bool load_system_certs(ctx_t ctx) {
  18372. if (!ctx) { return false; }
  18373. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18374. bool loaded = false;
  18375. #ifdef _WIN32
  18376. loaded = impl::enumerate_windows_system_certs(
  18377. [&](const unsigned char *data, size_t len) {
  18378. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18379. static_cast<long>(len),
  18380. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18381. });
  18382. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18383. loaded = impl::enumerate_macos_keychain_certs(
  18384. [&](const unsigned char *data, size_t len) {
  18385. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18386. static_cast<long>(len),
  18387. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18388. });
  18389. #else
  18390. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18391. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18392. SSL_SUCCESS) {
  18393. loaded = true;
  18394. break;
  18395. }
  18396. }
  18397. if (!loaded) {
  18398. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18399. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18400. SSL_SUCCESS) {
  18401. loaded = true;
  18402. break;
  18403. }
  18404. }
  18405. }
  18406. #endif
  18407. return loaded;
  18408. }
  18409. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18410. const char *password) {
  18411. if (!ctx || !cert || !key) { return false; }
  18412. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18413. // Load certificate
  18414. int ret = wolfSSL_CTX_use_certificate_buffer(
  18415. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18416. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18417. if (ret != SSL_SUCCESS) {
  18418. impl::wolfssl_last_error() =
  18419. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18420. return false;
  18421. }
  18422. // Set password callback if password is provided
  18423. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18424. // Load private key
  18425. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18426. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18427. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18428. if (ret != SSL_SUCCESS) {
  18429. impl::wolfssl_last_error() =
  18430. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18431. return false;
  18432. }
  18433. // Verify that the certificate and private key match
  18434. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18435. }
  18436. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18437. const char *key_path, const char *password) {
  18438. if (!ctx || !cert_path || !key_path) { return false; }
  18439. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18440. // Load certificate file
  18441. int ret =
  18442. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18443. if (ret != SSL_SUCCESS) {
  18444. impl::wolfssl_last_error() =
  18445. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18446. return false;
  18447. }
  18448. // Set password callback if password is provided
  18449. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18450. // Load private key file
  18451. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18452. if (ret != SSL_SUCCESS) {
  18453. impl::wolfssl_last_error() =
  18454. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18455. return false;
  18456. }
  18457. // Verify that the certificate and private key match
  18458. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18459. }
  18460. inline void set_verify_client(ctx_t ctx, bool require) {
  18461. if (!ctx) { return; }
  18462. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18463. wctx->verify_client = require;
  18464. if (require) {
  18465. wolfSSL_CTX_set_verify(
  18466. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18467. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18468. } else {
  18469. if (wctx->has_verify_callback) {
  18470. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18471. impl::wolfssl_verify_callback);
  18472. } else {
  18473. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18474. }
  18475. }
  18476. }
  18477. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18478. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18479. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18480. auto session = new (std::nothrow) impl::WolfSSLSession();
  18481. if (!session) { return nullptr; }
  18482. session->sock = sock;
  18483. session->ssl = wolfSSL_new(wctx->ctx);
  18484. if (!session->ssl) {
  18485. impl::wolfssl_last_error() =
  18486. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18487. delete session;
  18488. return nullptr;
  18489. }
  18490. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18491. return static_cast<session_t>(session);
  18492. }
  18493. inline void free_session(session_t session) {
  18494. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18495. }
  18496. inline bool set_sni(session_t session, const char *hostname,
  18497. bool verify_hostname) {
  18498. if (!session || !hostname) { return false; }
  18499. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18500. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18501. static_cast<word16>(strlen(hostname)));
  18502. if (ret != WOLFSSL_SUCCESS) {
  18503. impl::wolfssl_last_error() =
  18504. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18505. return false;
  18506. }
  18507. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18508. // separately from the SNI extension sent above; skip it when hostname
  18509. // verification is disabled so only the chain is checked, matching OpenSSL.
  18510. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18511. wsession->hostname = hostname;
  18512. return true;
  18513. }
  18514. inline TlsError connect(session_t session) {
  18515. TlsError err;
  18516. if (!session) {
  18517. err.code = ErrorCode::Fatal;
  18518. return err;
  18519. }
  18520. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18521. int ret = wolfSSL_connect(wsession->ssl);
  18522. if (ret == SSL_SUCCESS) {
  18523. err.code = ErrorCode::Success;
  18524. } else {
  18525. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18526. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18527. err.backend_code = static_cast<uint64_t>(ssl_error);
  18528. impl::wolfssl_last_error() = err.backend_code;
  18529. }
  18530. return err;
  18531. }
  18532. inline TlsError accept(session_t session) {
  18533. TlsError err;
  18534. if (!session) {
  18535. err.code = ErrorCode::Fatal;
  18536. return err;
  18537. }
  18538. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18539. int ret = wolfSSL_accept(wsession->ssl);
  18540. if (ret == SSL_SUCCESS) {
  18541. err.code = ErrorCode::Success;
  18542. // Capture SNI from thread-local storage after successful handshake
  18543. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18544. impl::wolfssl_pending_sni().clear();
  18545. } else {
  18546. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18547. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18548. err.backend_code = static_cast<uint64_t>(ssl_error);
  18549. impl::wolfssl_last_error() = err.backend_code;
  18550. }
  18551. return err;
  18552. }
  18553. inline bool connect_nonblocking(session_t session, socket_t sock,
  18554. time_t timeout_sec, time_t timeout_usec,
  18555. TlsError *err) {
  18556. if (!session) {
  18557. if (err) { err->code = ErrorCode::Fatal; }
  18558. return false;
  18559. }
  18560. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18561. // Set socket to non-blocking mode
  18562. detail::set_nonblocking(sock, true);
  18563. auto cleanup =
  18564. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18565. int ret;
  18566. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18567. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18568. if (ssl_error == SSL_ERROR_WANT_READ) {
  18569. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18570. continue;
  18571. }
  18572. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18573. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18574. continue;
  18575. }
  18576. }
  18577. // Error or timeout
  18578. if (err) {
  18579. err->code =
  18580. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18581. err->backend_code = static_cast<uint64_t>(ssl_error);
  18582. }
  18583. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18584. return false;
  18585. }
  18586. if (err) { err->code = ErrorCode::Success; }
  18587. return true;
  18588. }
  18589. inline bool accept_nonblocking(session_t session, socket_t sock,
  18590. time_t timeout_sec, time_t timeout_usec,
  18591. TlsError *err) {
  18592. if (!session) {
  18593. if (err) { err->code = ErrorCode::Fatal; }
  18594. return false;
  18595. }
  18596. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18597. // Set socket to non-blocking mode
  18598. detail::set_nonblocking(sock, true);
  18599. auto cleanup =
  18600. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18601. int ret;
  18602. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18603. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18604. if (ssl_error == SSL_ERROR_WANT_READ) {
  18605. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18606. continue;
  18607. }
  18608. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18609. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18610. continue;
  18611. }
  18612. }
  18613. // Error or timeout
  18614. if (err) {
  18615. err->code =
  18616. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18617. err->backend_code = static_cast<uint64_t>(ssl_error);
  18618. }
  18619. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18620. return false;
  18621. }
  18622. if (err) { err->code = ErrorCode::Success; }
  18623. // Capture SNI from thread-local storage after successful handshake
  18624. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18625. impl::wolfssl_pending_sni().clear();
  18626. return true;
  18627. }
  18628. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18629. if (!session || !buf) {
  18630. err.code = ErrorCode::Fatal;
  18631. return -1;
  18632. }
  18633. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18634. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18635. if (ret > 0) {
  18636. err.code = ErrorCode::Success;
  18637. return static_cast<ssize_t>(ret);
  18638. }
  18639. if (ret == 0) {
  18640. err.code = ErrorCode::PeerClosed;
  18641. return 0;
  18642. }
  18643. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18644. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18645. err.backend_code = static_cast<uint64_t>(ssl_error);
  18646. impl::wolfssl_last_error() = err.backend_code;
  18647. return -1;
  18648. }
  18649. inline ssize_t write(session_t session, const void *buf, size_t len,
  18650. TlsError &err) {
  18651. if (!session || !buf) {
  18652. err.code = ErrorCode::Fatal;
  18653. return -1;
  18654. }
  18655. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18656. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18657. if (ret > 0) {
  18658. err.code = ErrorCode::Success;
  18659. return static_cast<ssize_t>(ret);
  18660. }
  18661. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18662. // Treat this as an error (return -1) so callers don't spin in a
  18663. // write loop adding zero to the offset.
  18664. if (ret == 0) {
  18665. err.code = ErrorCode::PeerClosed;
  18666. return -1;
  18667. }
  18668. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18669. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18670. err.backend_code = static_cast<uint64_t>(ssl_error);
  18671. impl::wolfssl_last_error() = err.backend_code;
  18672. return -1;
  18673. }
  18674. inline int pending(const_session_t session) {
  18675. if (!session) { return 0; }
  18676. auto wsession =
  18677. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18678. return wolfSSL_pending(wsession->ssl);
  18679. }
  18680. inline void shutdown(session_t session, bool graceful) {
  18681. if (!session) { return; }
  18682. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18683. if (graceful) {
  18684. int ret;
  18685. int attempts = 0;
  18686. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18687. attempts < 3) {
  18688. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18689. if (ssl_error != SSL_ERROR_WANT_READ &&
  18690. ssl_error != SSL_ERROR_WANT_WRITE) {
  18691. break;
  18692. }
  18693. attempts++;
  18694. }
  18695. } else {
  18696. wolfSSL_shutdown(wsession->ssl);
  18697. }
  18698. }
  18699. inline bool is_peer_closed(session_t session, socket_t sock) {
  18700. if (!session || sock == INVALID_SOCKET) { return true; }
  18701. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18702. // Check if there's already decrypted data available
  18703. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18704. // Set socket to non-blocking to avoid blocking on read
  18705. detail::set_nonblocking(sock, true);
  18706. auto cleanup =
  18707. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18708. // Peek 1 byte to check connection status without consuming data
  18709. unsigned char buf;
  18710. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18711. // If we got data or WANT_READ (would block), connection is alive
  18712. if (ret > 0) { return false; }
  18713. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18714. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18715. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18716. ret == 0;
  18717. }
  18718. inline cert_t get_peer_cert(const_session_t session) {
  18719. if (!session) { return nullptr; }
  18720. auto wsession =
  18721. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18722. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18723. return static_cast<cert_t>(cert);
  18724. }
  18725. inline void free_cert(cert_t cert) {
  18726. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18727. }
  18728. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18729. if (!cert || !hostname) { return false; }
  18730. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18731. std::string host_str(hostname);
  18732. // Check if hostname is an IP address (IPv4 or IPv6)
  18733. unsigned char ip_bytes[16];
  18734. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18735. auto is_ip = ip_len > 0;
  18736. // Check Subject Alternative Names
  18737. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18738. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18739. if (san_names) {
  18740. int san_count = wolfSSL_sk_num(san_names);
  18741. for (int i = 0; i < san_count; i++) {
  18742. auto *names =
  18743. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18744. if (!names) continue;
  18745. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18746. // DNS name
  18747. unsigned char *dns_name = nullptr;
  18748. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18749. if (dns_name && dns_len > 0) {
  18750. std::string san_name(reinterpret_cast<char *>(dns_name),
  18751. static_cast<size_t>(dns_len));
  18752. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18753. if (detail::match_hostname(san_name, host_str)) {
  18754. wolfSSL_sk_free(san_names);
  18755. return true;
  18756. }
  18757. }
  18758. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18759. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18760. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18761. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18762. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18763. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18764. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18765. wolfSSL_sk_free(san_names);
  18766. return true;
  18767. }
  18768. }
  18769. }
  18770. wolfSSL_sk_free(san_names);
  18771. }
  18772. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18773. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18774. // the OpenSSL backend's X509_check_ip behaves the same way).
  18775. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18776. if (subject) {
  18777. char cn[256] = {};
  18778. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18779. sizeof(cn));
  18780. if (cn_len > 0) {
  18781. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18782. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18783. }
  18784. }
  18785. return false;
  18786. }
  18787. inline uint64_t hostname_mismatch_code() {
  18788. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18789. }
  18790. inline long get_verify_result(const_session_t session) {
  18791. if (!session) { return -1; }
  18792. auto wsession =
  18793. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18794. long result = wolfSSL_get_verify_result(wsession->ssl);
  18795. return result;
  18796. }
  18797. inline std::string get_cert_subject_cn(cert_t cert) {
  18798. if (!cert) return "";
  18799. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18800. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18801. if (!subject) return "";
  18802. char cn[256] = {};
  18803. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18804. sizeof(cn));
  18805. if (cn_len <= 0) return "";
  18806. return std::string(cn, static_cast<size_t>(cn_len));
  18807. }
  18808. inline std::string get_cert_issuer_name(cert_t cert) {
  18809. if (!cert) return "";
  18810. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18811. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18812. if (!issuer) return "";
  18813. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18814. if (!name_str) return "";
  18815. std::string result(name_str);
  18816. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18817. return result;
  18818. }
  18819. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18820. sans.clear();
  18821. if (!cert) return false;
  18822. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18823. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18824. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18825. if (!san_names) return true; // No SANs is not an error
  18826. int count = wolfSSL_sk_num(san_names);
  18827. for (int i = 0; i < count; i++) {
  18828. auto *name =
  18829. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18830. if (!name) continue;
  18831. SanEntry entry;
  18832. switch (name->type) {
  18833. case WOLFSSL_GEN_DNS: {
  18834. entry.type = SanType::DNS;
  18835. unsigned char *dns_name = nullptr;
  18836. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18837. if (dns_name && dns_len > 0) {
  18838. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18839. static_cast<size_t>(dns_len));
  18840. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18841. }
  18842. break;
  18843. }
  18844. case WOLFSSL_GEN_IPADD: {
  18845. entry.type = SanType::IP;
  18846. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18847. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18848. if (ip_data && ip_len == 4) {
  18849. char buf[16];
  18850. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18851. ip_data[2], ip_data[3]);
  18852. entry.value = buf;
  18853. } else if (ip_data && ip_len == 16) {
  18854. char buf[64];
  18855. snprintf(buf, sizeof(buf),
  18856. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18857. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18858. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18859. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18860. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18861. ip_data[14], ip_data[15]);
  18862. entry.value = buf;
  18863. }
  18864. break;
  18865. }
  18866. case WOLFSSL_GEN_EMAIL:
  18867. entry.type = SanType::EMAIL;
  18868. {
  18869. unsigned char *email = nullptr;
  18870. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18871. if (email && email_len > 0) {
  18872. entry.value = std::string(reinterpret_cast<char *>(email),
  18873. static_cast<size_t>(email_len));
  18874. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18875. }
  18876. }
  18877. break;
  18878. case WOLFSSL_GEN_URI:
  18879. entry.type = SanType::URI;
  18880. {
  18881. unsigned char *uri = nullptr;
  18882. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18883. &uri, name->d.uniformResourceIdentifier);
  18884. if (uri && uri_len > 0) {
  18885. entry.value = std::string(reinterpret_cast<char *>(uri),
  18886. static_cast<size_t>(uri_len));
  18887. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18888. }
  18889. }
  18890. break;
  18891. default: entry.type = SanType::OTHER; break;
  18892. }
  18893. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18894. }
  18895. wolfSSL_sk_free(san_names);
  18896. return true;
  18897. }
  18898. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18899. time_t &not_after) {
  18900. if (!cert) return false;
  18901. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18902. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18903. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18904. if (!nb || !na) return false;
  18905. // wolfSSL_ASN1_TIME_to_tm is available
  18906. struct tm tm_nb = {}, tm_na = {};
  18907. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18908. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18909. #ifdef _WIN32
  18910. not_before = _mkgmtime(&tm_nb);
  18911. not_after = _mkgmtime(&tm_na);
  18912. #else
  18913. not_before = timegm(&tm_nb);
  18914. not_after = timegm(&tm_na);
  18915. #endif
  18916. return true;
  18917. }
  18918. inline std::string get_cert_serial(cert_t cert) {
  18919. if (!cert) return "";
  18920. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18921. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18922. if (!serial_asn1) return "";
  18923. // Get the serial number data
  18924. int len = serial_asn1->length;
  18925. unsigned char *data = serial_asn1->data;
  18926. if (!data || len <= 0) return "";
  18927. std::string result;
  18928. result.reserve(static_cast<size_t>(len) * 2);
  18929. for (int i = 0; i < len; i++) {
  18930. char hex[3];
  18931. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18932. result += hex;
  18933. }
  18934. return result;
  18935. }
  18936. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18937. if (!cert) return false;
  18938. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18939. int der_len = 0;
  18940. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18941. if (!der_data || der_len <= 0) return false;
  18942. der.assign(der_data, der_data + der_len);
  18943. return true;
  18944. }
  18945. inline const char *get_sni(const_session_t session) {
  18946. if (!session) return nullptr;
  18947. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18948. // For server: return SNI received from client during handshake
  18949. if (!wsession->sni_hostname.empty()) {
  18950. return wsession->sni_hostname.c_str();
  18951. }
  18952. // For client: return the hostname set via set_sni
  18953. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18954. return nullptr;
  18955. }
  18956. inline uint64_t peek_error() {
  18957. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18958. }
  18959. inline uint64_t get_error() {
  18960. uint64_t err = impl::wolfssl_last_error();
  18961. impl::wolfssl_last_error() = 0;
  18962. return err;
  18963. }
  18964. inline std::string error_string(uint64_t code) {
  18965. char buf[256];
  18966. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18967. return std::string(buf);
  18968. }
  18969. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18970. if (!pem || len == 0) { return nullptr; }
  18971. // Validate by attempting to load into a temporary ctx
  18972. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18973. if (!tmp_ctx) { return nullptr; }
  18974. int ret = wolfSSL_CTX_load_verify_buffer(
  18975. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18976. static_cast<long>(len), SSL_FILETYPE_PEM);
  18977. wolfSSL_CTX_free(tmp_ctx);
  18978. if (ret != SSL_SUCCESS) { return nullptr; }
  18979. return static_cast<ca_store_t>(
  18980. new impl::WolfSSLCAStore{std::string(pem, len)});
  18981. }
  18982. inline void free_ca_store(ca_store_t store) {
  18983. delete static_cast<impl::WolfSSLCAStore *>(store);
  18984. }
  18985. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18986. if (!ctx || !store) { return false; }
  18987. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18988. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18989. int ret = wolfSSL_CTX_load_verify_buffer(
  18990. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18991. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18992. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18993. // This function takes ownership of the store; the PEM data was copied into
  18994. // the context, so release the source
  18995. free_ca_store(store);
  18996. return ret == SSL_SUCCESS;
  18997. }
  18998. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18999. certs.clear();
  19000. if (!ctx) { return 0; }
  19001. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19002. if (wctx->ca_pem_data_.empty()) { return 0; }
  19003. const std::string &pem = wctx->ca_pem_data_;
  19004. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19005. const std::string end_marker = "-----END CERTIFICATE-----";
  19006. size_t pos = 0;
  19007. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19008. size_t end_pos = pem.find(end_marker, pos);
  19009. if (end_pos == std::string::npos) { break; }
  19010. end_pos += end_marker.size();
  19011. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19012. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19013. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19014. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19015. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  19016. pos = end_pos;
  19017. }
  19018. return certs.size();
  19019. }
  19020. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  19021. std::vector<std::string> names;
  19022. if (!ctx) { return names; }
  19023. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19024. if (wctx->ca_pem_data_.empty()) { return names; }
  19025. const std::string &pem = wctx->ca_pem_data_;
  19026. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  19027. const std::string end_marker = "-----END CERTIFICATE-----";
  19028. size_t pos = 0;
  19029. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  19030. size_t end_pos = pem.find(end_marker, pos);
  19031. if (end_pos == std::string::npos) { break; }
  19032. end_pos += end_marker.size();
  19033. std::string cert_pem = pem.substr(pos, end_pos - pos);
  19034. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  19035. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  19036. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  19037. if (x509) {
  19038. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  19039. if (subject) {
  19040. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  19041. if (name_str) {
  19042. names.push_back(name_str);
  19043. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  19044. }
  19045. }
  19046. wolfSSL_X509_free(x509);
  19047. }
  19048. pos = end_pos;
  19049. }
  19050. return names;
  19051. }
  19052. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  19053. const char *key_pem, const char *password) {
  19054. if (!ctx || !cert_pem || !key_pem) { return false; }
  19055. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19056. // Load new certificate
  19057. int ret = wolfSSL_CTX_use_certificate_buffer(
  19058. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  19059. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  19060. if (ret != SSL_SUCCESS) {
  19061. impl::wolfssl_last_error() =
  19062. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19063. return false;
  19064. }
  19065. // Set password if provided
  19066. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19067. // Load new private key
  19068. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19069. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19070. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19071. if (ret != SSL_SUCCESS) {
  19072. impl::wolfssl_last_error() =
  19073. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19074. return false;
  19075. }
  19076. return true;
  19077. }
  19078. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19079. if (!ctx || !ca_pem) { return false; }
  19080. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19081. int ret = wolfSSL_CTX_load_verify_buffer(
  19082. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19083. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19084. if (ret != SSL_SUCCESS) {
  19085. impl::wolfssl_last_error() =
  19086. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19087. return false;
  19088. }
  19089. return true;
  19090. }
  19091. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19092. if (!ctx) { return false; }
  19093. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19094. impl::get_verify_callback() = std::move(callback);
  19095. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19096. if (wctx->has_verify_callback) {
  19097. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19098. impl::wolfssl_verify_callback);
  19099. } else {
  19100. wolfSSL_CTX_set_verify(
  19101. wctx->ctx,
  19102. wctx->verify_client
  19103. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19104. : SSL_VERIFY_NONE,
  19105. nullptr);
  19106. }
  19107. return true;
  19108. }
  19109. inline long get_verify_error(const_session_t session) {
  19110. if (!session) { return -1; }
  19111. auto *wsession =
  19112. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19113. return wolfSSL_get_verify_result(wsession->ssl);
  19114. }
  19115. inline std::string verify_error_string(long error_code) {
  19116. if (error_code == 0) { return ""; }
  19117. const char *str =
  19118. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19119. return str ? std::string(str) : std::string();
  19120. }
  19121. } // namespace tls
  19122. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19123. // WebSocket implementation
  19124. namespace ws {
  19125. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19126. bool fin) {
  19127. std::lock_guard<std::mutex> lock(write_mutex_);
  19128. if (closed_) { return false; }
  19129. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19130. }
  19131. inline ReadResult WebSocket::read(std::string &msg) {
  19132. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19133. while (!closed_) {
  19134. Opcode opcode;
  19135. std::string payload;
  19136. bool fin;
  19137. impl::FrameRead r =
  19138. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19139. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19140. // A timeout landed on a frame boundary: the connection is untouched and
  19141. // still usable, so hand control back without closing it. That is only
  19142. // useful to a caller who asked for the timeout; the compile-time default
  19143. // is a backstop against a peer gone quiet, and elapsing it closes the
  19144. // connection so a plain `while (ws.read(msg))` loop ends.
  19145. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19146. if (r != impl::FrameRead::Ok) {
  19147. closed_ = true;
  19148. return Fail;
  19149. }
  19150. switch (opcode) {
  19151. case Opcode::Ping: {
  19152. std::lock_guard<std::mutex> lock(write_mutex_);
  19153. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19154. payload.size(), true, !is_server_);
  19155. continue;
  19156. }
  19157. case Opcode::Pong: {
  19158. std::lock_guard<std::mutex> lock(ping_mutex_);
  19159. unacked_pings_ = 0;
  19160. continue;
  19161. }
  19162. case Opcode::Close: {
  19163. if (!closed_.exchange(true)) {
  19164. // Echo close frame back
  19165. std::lock_guard<std::mutex> lock(write_mutex_);
  19166. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19167. payload.size(), true, !is_server_);
  19168. }
  19169. return Fail;
  19170. }
  19171. case Opcode::Text:
  19172. case Opcode::Binary: {
  19173. auto result = opcode == Opcode::Text ? Text : Binary;
  19174. msg = std::move(payload);
  19175. // Handle fragmentation
  19176. if (!fin) {
  19177. while (true) {
  19178. Opcode cont_opcode;
  19179. std::string cont_payload;
  19180. bool cont_fin;
  19181. // A timeout is not reportable here: half of a fragmented message is
  19182. // already in `msg` and read() has no way to resume it, so it is a
  19183. // failure like any other. Timeouts are only ever seen on a message
  19184. // boundary.
  19185. if (impl::read_websocket_frame(
  19186. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19187. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19188. impl::FrameRead::Ok) {
  19189. closed_ = true;
  19190. return Fail;
  19191. }
  19192. if (cont_opcode == Opcode::Ping) {
  19193. std::lock_guard<std::mutex> lock(write_mutex_);
  19194. detail::write_websocket_frame(
  19195. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19196. true, !is_server_);
  19197. continue;
  19198. }
  19199. if (cont_opcode == Opcode::Pong) {
  19200. std::lock_guard<std::mutex> lock(ping_mutex_);
  19201. unacked_pings_ = 0;
  19202. continue;
  19203. }
  19204. if (cont_opcode == Opcode::Close) {
  19205. if (!closed_.exchange(true)) {
  19206. std::lock_guard<std::mutex> lock(write_mutex_);
  19207. detail::write_websocket_frame(
  19208. strm_, Opcode::Close, cont_payload.data(),
  19209. cont_payload.size(), true, !is_server_);
  19210. }
  19211. return Fail;
  19212. }
  19213. // RFC 6455: continuation frames must use opcode 0x0
  19214. if (cont_opcode != Opcode::Continuation) {
  19215. closed_ = true;
  19216. return Fail;
  19217. }
  19218. msg += cont_payload;
  19219. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19220. closed_ = true;
  19221. return Fail;
  19222. }
  19223. if (cont_fin) { break; }
  19224. }
  19225. }
  19226. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19227. if (result == Text && !impl::is_valid_utf8(msg)) {
  19228. // close() takes the read lock to wait for the peer's Close reply, so
  19229. // it must not run while this thread still holds it.
  19230. read_lock.unlock();
  19231. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19232. return Fail;
  19233. }
  19234. return result;
  19235. }
  19236. default: closed_ = true; return Fail;
  19237. }
  19238. }
  19239. return Fail;
  19240. }
  19241. inline bool WebSocket::send(const std::string &data) {
  19242. return send_frame(Opcode::Text, data.data(), data.size());
  19243. }
  19244. inline bool WebSocket::send(const char *data, size_t len) {
  19245. return send_frame(Opcode::Binary, data, len);
  19246. }
  19247. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19248. if (closed_.exchange(true)) { return; }
  19249. ping_cv_.notify_all();
  19250. std::string payload;
  19251. auto code = static_cast<uint16_t>(status);
  19252. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19253. payload.push_back(static_cast<char>(code & 0xFF));
  19254. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19255. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19256. payload += reason.substr(0, 123);
  19257. {
  19258. std::lock_guard<std::mutex> lock(write_mutex_);
  19259. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19260. payload.size(), true, !is_server_);
  19261. }
  19262. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19263. // Close response before closing the TCP connection.
  19264. //
  19265. // Wait only when no other thread is parsing frames. When one is, it is the
  19266. // thread positioned to see the peer's reply, and reading here would take
  19267. // bytes out of the message it is assembling. Bailing out also leaves the
  19268. // stream, including its read timeout, entirely to that thread.
  19269. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19270. if (!read_lock.owns_lock()) { return; }
  19271. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19272. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19273. Opcode op;
  19274. std::string resp;
  19275. bool fin;
  19276. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19277. impl::FrameRead::Ok) {
  19278. if (op == Opcode::Close) { break; }
  19279. }
  19280. }
  19281. inline WebSocket::~WebSocket() {
  19282. {
  19283. std::lock_guard<std::mutex> lock(ping_mutex_);
  19284. closed_ = true;
  19285. }
  19286. ping_cv_.notify_all();
  19287. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19288. }
  19289. inline void WebSocket::start_heartbeat() {
  19290. if (ping_interval_sec_ == 0) { return; }
  19291. ping_thread_ = std::thread([this]() {
  19292. std::unique_lock<std::mutex> lock(ping_mutex_);
  19293. while (!closed_) {
  19294. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19295. if (closed_) { break; }
  19296. // If the peer has failed to respond to the previous pings, give up.
  19297. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19298. // opt-in liveness check controlled by max_missed_pongs_.
  19299. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19300. lock.unlock();
  19301. close(CloseStatus::GoingAway, "pong timeout");
  19302. return;
  19303. }
  19304. lock.unlock();
  19305. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19306. lock.lock();
  19307. closed_ = true;
  19308. break;
  19309. }
  19310. lock.lock();
  19311. unacked_pings_++;
  19312. }
  19313. });
  19314. }
  19315. inline const Request &WebSocket::request() const { return req_; }
  19316. inline bool WebSocket::is_open() const { return !closed_; }
  19317. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19318. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19319. // poll(), where 0 would instead mean "return immediately", so hand it the
  19320. // negative poll uses for an unbounded wait.
  19321. if (sec == 0 && usec == 0) { sec = -1; }
  19322. strm_.set_read_timeout(sec, usec);
  19323. read_timeout_set_ = true;
  19324. }
  19325. // WebSocketClient implementation
  19326. inline WebSocketClient::WebSocketClient(
  19327. const std::string &scheme_host_port_path, const Headers &headers)
  19328. : headers_(headers) {
  19329. detail::UrlComponents uc;
  19330. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19331. !uc.host.empty() && !uc.path.empty()) {
  19332. auto &scheme = uc.scheme;
  19333. #ifdef CPPHTTPLIB_SSL_ENABLED
  19334. if (scheme != "ws" && scheme != "wss") {
  19335. #else
  19336. if (scheme != "ws") {
  19337. #endif
  19338. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19339. std::string msg = "'" + scheme + "' scheme is not supported.";
  19340. throw std::invalid_argument(msg);
  19341. #endif
  19342. return;
  19343. }
  19344. auto is_ssl = scheme == "wss";
  19345. host_ = std::move(uc.host);
  19346. port_ = is_ssl ? 443 : 80;
  19347. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19348. path_ = std::move(uc.path);
  19349. if (!uc.query.empty()) { path_ += uc.query; }
  19350. #ifdef CPPHTTPLIB_SSL_ENABLED
  19351. is_ssl_ = is_ssl;
  19352. if (is_ssl_) {
  19353. // The context lives as long as the client so that CA configuration
  19354. // survives reconnects; sessions are created per connection.
  19355. tls_ctx_ = tls::create_client_context();
  19356. if (!tls_ctx_) { return; }
  19357. }
  19358. #else
  19359. if (is_ssl) { return; }
  19360. #endif
  19361. is_valid_ = true;
  19362. }
  19363. }
  19364. #ifdef CPPHTTPLIB_SSL_ENABLED
  19365. inline WebSocketClient::WebSocketClient(
  19366. const std::string &scheme_host_port_path, const PemMemory &pem,
  19367. const Headers &headers)
  19368. : WebSocketClient(scheme_host_port_path, headers) {
  19369. // For ws:// URLs the client certificate is silently ignored, consistent
  19370. // with the TLS-only setters such as set_ca_cert_path().
  19371. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19372. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19373. pem.private_key_password)) {
  19374. tls::free_context(tls_ctx_);
  19375. tls_ctx_ = nullptr;
  19376. is_valid_ = false;
  19377. }
  19378. }
  19379. }
  19380. #endif
  19381. inline WebSocketClient::~WebSocketClient() {
  19382. shutdown_and_close();
  19383. #ifdef CPPHTTPLIB_SSL_ENABLED
  19384. if (tls_ctx_) {
  19385. tls::free_context(tls_ctx_);
  19386. tls_ctx_ = nullptr;
  19387. }
  19388. #endif
  19389. }
  19390. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19391. inline void WebSocketClient::shutdown_and_close() {
  19392. // Send the close frame while the TLS session is still alive: ws_ holds an
  19393. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19394. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19395. if (ws_ && ws_->is_open()) { ws_->close(); }
  19396. ws_.reset();
  19397. #ifdef CPPHTTPLIB_SSL_ENABLED
  19398. if (is_ssl_) {
  19399. if (tls_session_) {
  19400. tls::shutdown(tls_session_, true);
  19401. tls::free_session(tls_session_);
  19402. tls_session_ = nullptr;
  19403. }
  19404. }
  19405. #endif
  19406. if (sock_ != INVALID_SOCKET) {
  19407. detail::shutdown_socket(sock_);
  19408. detail::close_socket(sock_);
  19409. sock_ = INVALID_SOCKET;
  19410. }
  19411. }
  19412. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19413. Error &error, int &ssl_error,
  19414. uint64_t &ssl_backend_error) {
  19415. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19416. // The streams wait with poll(), where 0 instead means "return immediately",
  19417. // so they are given the negative poll uses for an unbounded wait.
  19418. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19419. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19420. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19421. // The handshake belongs to establishing the connection, so an unset read
  19422. // timeout leaves it bounded by the connection timeout instead of forever.
  19423. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19424. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19425. #ifdef CPPHTTPLIB_SSL_ENABLED
  19426. if (is_ssl_) {
  19427. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19428. // is not safe to call concurrently on one client to begin with, since
  19429. // nothing else here is guarded either.
  19430. if (server_certificate_verification_ && !certs_loaded_) {
  19431. uint64_t backend_error = 0;
  19432. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19433. ca_cert_dir_path_, custom_ca_loaded_,
  19434. system_ca_mode_, backend_error);
  19435. certs_loaded_ = true;
  19436. }
  19437. detail::ClientTlsSessionOptions options;
  19438. options.server_hostname_verification = server_hostname_verification_;
  19439. detail::ClientTlsSessionError tls_error;
  19440. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19441. server_certificate_verification_,
  19442. hs_sec, hs_usec, &tls_error,
  19443. options)) {
  19444. error = tls_error.error;
  19445. ssl_error = tls_error.ssl_error;
  19446. ssl_backend_error = tls_error.backend_error;
  19447. return false;
  19448. }
  19449. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19450. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19451. write_timeout_usec_));
  19452. return true;
  19453. }
  19454. #else
  19455. (void)error;
  19456. (void)ssl_error;
  19457. (void)ssl_backend_error;
  19458. (void)hs_sec;
  19459. (void)hs_usec;
  19460. #endif
  19461. strm = std::unique_ptr<Stream>(
  19462. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19463. write_timeout_sec_, write_timeout_usec_));
  19464. return true;
  19465. }
  19466. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19467. #ifdef CPPHTTPLIB_SSL_ENABLED
  19468. auto is_ssl = is_ssl_;
  19469. #else
  19470. auto is_ssl = false;
  19471. #endif
  19472. if (!req.has_header("Host")) {
  19473. req.headers.emplace("Host", detail::make_default_host_header_value(
  19474. host_, port_, is_ssl, address_family_));
  19475. }
  19476. detail::add_default_user_agent_header(req);
  19477. }
  19478. inline Result WebSocketClient::connect() {
  19479. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19480. shutdown_and_close();
  19481. // Check is custom IP or hostname specified for host_
  19482. std::string connect_host;
  19483. std::string ip;
  19484. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19485. auto error = Error::Success;
  19486. sock_ = detail::create_client_socket(
  19487. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19488. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19489. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19490. write_timeout_usec_, interface_, error);
  19491. if (sock_ == INVALID_SOCKET) {
  19492. if (error == Error::Success) { error = Error::Connection; }
  19493. return Result{error, -1, Headers{}};
  19494. }
  19495. std::unique_ptr<Stream> strm;
  19496. auto stream_error = Error::SSLConnection;
  19497. int ssl_error = 0;
  19498. uint64_t ssl_backend_error = 0;
  19499. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19500. shutdown_and_close();
  19501. #ifdef CPPHTTPLIB_SSL_ENABLED
  19502. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19503. #else
  19504. return Result{stream_error, -1, Headers{}};
  19505. #endif
  19506. }
  19507. Request req;
  19508. req.method = "GET";
  19509. req.path = path_;
  19510. req.headers = headers_;
  19511. prepare_default_headers(req);
  19512. detail::WebSocketUpgradeResponse upgrade;
  19513. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19514. shutdown_and_close();
  19515. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19516. }
  19517. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19518. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19519. websocket_ping_interval_sec_,
  19520. websocket_max_missed_pongs_));
  19521. // The stream was created with the timeout already; tell the WebSocket
  19522. // whether it came from the caller, so read() knows to report it as Timeout.
  19523. ws_->read_timeout_set_ = read_timeout_set_;
  19524. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19525. }
  19526. inline ReadResult WebSocketClient::read(std::string &msg) {
  19527. if (!ws_) { return Fail; }
  19528. return ws_->read(msg);
  19529. }
  19530. inline bool WebSocketClient::send(const std::string &data) {
  19531. if (!ws_) { return false; }
  19532. return ws_->send(data);
  19533. }
  19534. inline bool WebSocketClient::send(const char *data, size_t len) {
  19535. if (!ws_) { return false; }
  19536. return ws_->send(data, len);
  19537. }
  19538. inline void WebSocketClient::close(CloseStatus status,
  19539. const std::string &reason) {
  19540. if (ws_) { ws_->close(status, reason); }
  19541. }
  19542. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19543. inline const std::string &WebSocketClient::subprotocol() const {
  19544. return subprotocol_;
  19545. }
  19546. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19547. read_timeout_sec_ = sec;
  19548. read_timeout_usec_ = usec;
  19549. read_timeout_set_ = true;
  19550. // The members above only seed the next connect(); read() consults the
  19551. // stream, so an already-open connection has to be told directly.
  19552. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19553. }
  19554. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19555. write_timeout_sec_ = sec;
  19556. write_timeout_usec_ = usec;
  19557. }
  19558. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19559. websocket_ping_interval_sec_ = sec;
  19560. }
  19561. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19562. websocket_max_missed_pongs_ = count;
  19563. }
  19564. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19565. inline void WebSocketClient::set_address_family(int family) {
  19566. address_family_ = family;
  19567. }
  19568. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19569. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19570. socket_options_ = std::move(socket_options);
  19571. }
  19572. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19573. connection_timeout_sec_ = sec;
  19574. connection_timeout_usec_ = usec;
  19575. }
  19576. inline void WebSocketClient::set_interface(const std::string &intf) {
  19577. interface_ = intf;
  19578. }
  19579. inline void WebSocketClient::set_hostname_addr_map(
  19580. std::map<std::string, std::string> addr_map) {
  19581. addr_map_ = std::move(addr_map);
  19582. }
  19583. #ifdef CPPHTTPLIB_SSL_ENABLED
  19584. inline void
  19585. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19586. const std::string &ca_cert_dir_path) {
  19587. ca_cert_file_path_ = ca_cert_file_path;
  19588. ca_cert_dir_path_ = ca_cert_dir_path;
  19589. }
  19590. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19591. if (store && tls_ctx_) {
  19592. // set_ca_store takes ownership of store
  19593. tls::set_ca_store(tls_ctx_, store);
  19594. custom_ca_loaded_ = true;
  19595. } else if (store) {
  19596. tls::free_ca_store(store);
  19597. }
  19598. }
  19599. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19600. std::size_t size) {
  19601. if (tls_ctx_ && ca_cert && size > 0) {
  19602. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19603. custom_ca_loaded_ = true;
  19604. }
  19605. }
  19606. inline void
  19607. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19608. server_certificate_verification_ = enabled;
  19609. }
  19610. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19611. server_hostname_verification_ = enabled;
  19612. }
  19613. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19614. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19615. }
  19616. #endif // CPPHTTPLIB_SSL_ENABLED
  19617. } // namespace ws
  19618. // ----------------------------------------------------------------------------
  19619. } // namespace httplib
  19620. #endif // CPPHTTPLIB_HTTPLIB_H