httplib.h 774 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812
  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.54.1"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003601"
  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).
  189. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  190. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  191. #endif
  192. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  202. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  203. #endif
  204. /*
  205. * Headers
  206. */
  207. #ifdef _WIN32
  208. #ifndef _CRT_SECURE_NO_WARNINGS
  209. #define _CRT_SECURE_NO_WARNINGS
  210. #endif //_CRT_SECURE_NO_WARNINGS
  211. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  212. #define _CRT_NONSTDC_NO_DEPRECATE
  213. #endif //_CRT_NONSTDC_NO_DEPRECATE
  214. #if defined(_MSC_VER)
  215. #if _MSC_VER < 1900
  216. #error Sorry, Visual Studio versions prior to 2015 are not supported
  217. #endif
  218. #pragma comment(lib, "ws2_32.lib")
  219. #ifndef _SSIZE_T_DEFINED
  220. using ssize_t = __int64;
  221. #define _SSIZE_T_DEFINED
  222. #endif
  223. #endif // _MSC_VER
  224. #ifndef S_ISREG
  225. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  226. #endif // S_ISREG
  227. #ifndef S_ISDIR
  228. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  229. #endif // S_ISDIR
  230. #ifndef NOMINMAX
  231. #define NOMINMAX
  232. #endif // NOMINMAX
  233. #include <io.h>
  234. #include <winsock2.h>
  235. #include <ws2tcpip.h>
  236. #if defined(__has_include)
  237. #if __has_include(<afunix.h>)
  238. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  239. #include <afunix.h>
  240. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  241. #endif
  242. #endif
  243. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  244. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  245. #endif
  246. using nfds_t = unsigned long;
  247. using socket_t = SOCKET;
  248. using socklen_t = int;
  249. #else // not _WIN32
  250. #include <arpa/inet.h>
  251. #if !defined(_AIX) && !defined(__MVS__)
  252. #include <ifaddrs.h>
  253. #endif
  254. #ifdef __MVS__
  255. #include <strings.h>
  256. #ifndef NI_MAXHOST
  257. #define NI_MAXHOST 1025
  258. #endif
  259. #endif
  260. #include <net/if.h>
  261. #include <netdb.h>
  262. #include <netinet/in.h>
  263. #ifdef __linux__
  264. #include <resolv.h>
  265. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  266. #endif
  267. #include <csignal>
  268. #include <netinet/tcp.h>
  269. #include <poll.h>
  270. #include <pthread.h>
  271. #include <sys/mman.h>
  272. #include <sys/socket.h>
  273. #include <sys/un.h>
  274. #include <unistd.h>
  275. using socket_t = int;
  276. #ifndef INVALID_SOCKET
  277. #define INVALID_SOCKET (-1)
  278. #endif
  279. #endif //_WIN32
  280. #if defined(__APPLE__)
  281. #include <TargetConditionals.h>
  282. #endif
  283. #include <algorithm>
  284. #include <array>
  285. #include <atomic>
  286. #include <cassert>
  287. #include <chrono>
  288. #include <climits>
  289. #include <condition_variable>
  290. #include <cstdlib>
  291. #include <cstring>
  292. #include <errno.h>
  293. #include <exception>
  294. #include <fcntl.h>
  295. #include <fstream>
  296. #include <functional>
  297. #include <iomanip>
  298. #include <iostream>
  299. #include <iterator>
  300. #include <list>
  301. #include <map>
  302. #include <memory>
  303. #include <mutex>
  304. #include <random>
  305. #include <regex>
  306. #include <set>
  307. #include <sstream>
  308. #include <string>
  309. #include <sys/stat.h>
  310. #include <system_error>
  311. #include <thread>
  312. #include <type_traits>
  313. #include <unordered_map>
  314. #include <unordered_set>
  315. #include <utility>
  316. #include <vector>
  317. // On macOS with a TLS backend, enable Keychain root certificates by default
  318. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  319. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  320. // only; on those platforms the user must provide a CA bundle explicitly.
  321. #if defined(__APPLE__) && defined(__clang__) && \
  322. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  323. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  324. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  325. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  326. #if TARGET_OS_OSX
  327. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  328. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  329. #endif
  330. #endif
  331. #endif
  332. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  333. defined(__APPLE__) && !TARGET_OS_OSX
  334. #error \
  335. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  336. #endif
  337. // On Windows, enable Schannel certificate verification by default
  338. // unless the user explicitly opts out.
  339. #if defined(_WIN32) && \
  340. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  341. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  342. #endif
  343. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  344. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  345. #if TARGET_OS_MAC && defined(__clang__)
  346. #include <CFNetwork/CFHost.h>
  347. #include <CoreFoundation/CoreFoundation.h>
  348. #endif
  349. #endif
  350. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  351. #ifdef _WIN32
  352. #include <wincrypt.h>
  353. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  354. // used
  355. #undef X509_NAME
  356. #undef X509_CERT_PAIR
  357. #undef X509_EXTENSIONS
  358. #undef PKCS7_SIGNER_INFO
  359. #ifdef _MSC_VER
  360. #pragma comment(lib, "crypt32.lib")
  361. #endif
  362. #endif // _WIN32
  363. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  364. #if TARGET_OS_OSX
  365. #include <Security/Security.h>
  366. #endif
  367. #endif
  368. #include <openssl/err.h>
  369. #include <openssl/evp.h>
  370. #include <openssl/ssl.h>
  371. #include <openssl/x509v3.h>
  372. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  373. #include <openssl/applink.c>
  374. #endif
  375. #include <iostream>
  376. #include <sstream>
  377. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  378. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  379. #error Please use OpenSSL or a current version of BoringSSL
  380. #endif
  381. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  382. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  383. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  384. #endif
  385. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  386. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  387. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  388. // in with this first include group so the version gating below can use it.
  389. #include <mbedtls/error.h>
  390. #include <mbedtls/net_sockets.h>
  391. #include <mbedtls/oid.h>
  392. #include <mbedtls/pk.h>
  393. #include <mbedtls/ssl.h>
  394. #include <mbedtls/version.h>
  395. #include <mbedtls/x509_crt.h>
  396. #if MBEDTLS_VERSION_MAJOR >= 4
  397. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  398. #include <psa/crypto.h>
  399. #else
  400. #include <mbedtls/ctr_drbg.h>
  401. #include <mbedtls/entropy.h>
  402. #include <mbedtls/md5.h>
  403. #include <mbedtls/sha1.h>
  404. #include <mbedtls/sha256.h>
  405. #include <mbedtls/sha512.h>
  406. #endif
  407. #ifdef _WIN32
  408. #include <wincrypt.h>
  409. #ifdef _MSC_VER
  410. #pragma comment(lib, "crypt32.lib")
  411. #endif
  412. #endif // _WIN32
  413. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  414. #if TARGET_OS_OSX
  415. #include <Security/Security.h>
  416. #endif
  417. #endif
  418. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  419. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  420. #if MBEDTLS_VERSION_MAJOR >= 4
  421. #define CPPHTTPLIB_MBEDTLS_V4
  422. #endif
  423. #if MBEDTLS_VERSION_MAJOR >= 3
  424. #define CPPHTTPLIB_MBEDTLS_V3
  425. #endif
  426. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  427. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  428. #include <wolfssl/options.h>
  429. #include <wolfssl/openssl/x509v3.h>
  430. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  431. #ifndef WOLFSSL_GEN_EMAIL
  432. #define WOLFSSL_GEN_EMAIL 1
  433. #endif
  434. #ifndef WOLFSSL_GEN_DNS
  435. #define WOLFSSL_GEN_DNS 2
  436. #endif
  437. #ifndef WOLFSSL_GEN_URI
  438. #define WOLFSSL_GEN_URI 6
  439. #endif
  440. #ifndef WOLFSSL_GEN_IPADD
  441. #define WOLFSSL_GEN_IPADD 7
  442. #endif
  443. #include <wolfssl/ssl.h>
  444. #include <wolfssl/wolfcrypt/hash.h>
  445. #include <wolfssl/wolfcrypt/md5.h>
  446. #include <wolfssl/wolfcrypt/sha256.h>
  447. #include <wolfssl/wolfcrypt/sha512.h>
  448. #ifdef _WIN32
  449. #include <wincrypt.h>
  450. #ifdef _MSC_VER
  451. #pragma comment(lib, "crypt32.lib")
  452. #endif
  453. #endif // _WIN32
  454. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  455. #if TARGET_OS_OSX
  456. #include <Security/Security.h>
  457. #endif
  458. #endif
  459. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  460. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  461. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  462. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  463. #define CPPHTTPLIB_SSL_ENABLED
  464. #endif
  465. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  466. #include <zlib.h>
  467. #endif
  468. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  469. #include <brotli/decode.h>
  470. #include <brotli/encode.h>
  471. #endif
  472. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  473. #include <zstd.h>
  474. #endif
  475. /*
  476. * Declaration
  477. */
  478. namespace httplib {
  479. namespace ws {
  480. class WebSocket;
  481. } // namespace ws
  482. namespace detail {
  483. /*
  484. * Backport std::make_unique from C++14.
  485. *
  486. * NOTE: This code came up with the following stackoverflow post:
  487. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  488. *
  489. */
  490. template <class T, class... Args>
  491. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  492. make_unique(Args &&...args) {
  493. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  494. }
  495. template <class T>
  496. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  497. make_unique(std::size_t n) {
  498. typedef typename std::remove_extent<T>::type RT;
  499. return std::unique_ptr<T>(new RT[n]);
  500. }
  501. // Locale-independent ASCII character classification. The <cctype>
  502. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  503. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  504. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  505. // classified without regard to the locale.
  506. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  507. inline bool is_ascii_alpha(char c) {
  508. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  509. }
  510. inline bool is_ascii_alnum(char c) {
  511. return is_ascii_digit(c) || is_ascii_alpha(c);
  512. }
  513. namespace case_ignore {
  514. inline unsigned char to_lower(int c) {
  515. const static unsigned char table[256] = {
  516. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  517. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  518. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  519. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  520. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  521. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  522. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  523. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  524. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  525. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  526. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  527. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  528. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  529. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  530. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  531. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  532. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  533. 255,
  534. };
  535. return table[(unsigned char)(char)c];
  536. }
  537. inline std::string to_lower(const std::string &s) {
  538. std::string result = s;
  539. std::transform(
  540. result.begin(), result.end(), result.begin(),
  541. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  542. return result;
  543. }
  544. inline bool equal(const std::string &a, const std::string &b) {
  545. return a.size() == b.size() &&
  546. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  547. return to_lower(ca) == to_lower(cb);
  548. });
  549. }
  550. struct equal_to {
  551. bool operator()(const std::string &a, const std::string &b) const {
  552. return equal(a, b);
  553. }
  554. };
  555. struct hash {
  556. size_t operator()(const std::string &key) const {
  557. return hash_core(key.data(), key.size(), 0);
  558. }
  559. size_t hash_core(const char *s, size_t l, size_t h) const {
  560. return (l == 0) ? h
  561. : hash_core(s + 1, l - 1,
  562. // Unsets the 6 high bits of h, therefore no
  563. // overflow happens
  564. (((std::numeric_limits<size_t>::max)() >> 6) &
  565. h * 33) ^
  566. static_cast<unsigned char>(to_lower(*s)));
  567. }
  568. };
  569. template <typename T>
  570. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  571. detail::case_ignore::equal_to>;
  572. } // namespace case_ignore
  573. // This is based on
  574. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  575. struct scope_exit {
  576. explicit scope_exit(std::function<void(void)> &&f)
  577. : exit_function(std::move(f)), execute_on_destruction{true} {}
  578. scope_exit(scope_exit &&rhs) noexcept
  579. : exit_function(std::move(rhs.exit_function)),
  580. execute_on_destruction{rhs.execute_on_destruction} {
  581. rhs.release();
  582. }
  583. ~scope_exit() {
  584. if (execute_on_destruction) { this->exit_function(); }
  585. }
  586. void release() { this->execute_on_destruction = false; }
  587. private:
  588. scope_exit(const scope_exit &) = delete;
  589. void operator=(const scope_exit &) = delete;
  590. scope_exit &operator=(scope_exit &&) = delete;
  591. std::function<void(void)> exit_function;
  592. bool execute_on_destruction;
  593. };
  594. // Simple from_chars implementation for integer and double types (C++17
  595. // substitute)
  596. template <typename T> struct from_chars_result {
  597. const char *ptr;
  598. std::errc ec;
  599. };
  600. template <typename T>
  601. inline from_chars_result<T> from_chars(const char *first, const char *last,
  602. T &value, int base = 10) {
  603. value = 0;
  604. const char *p = first;
  605. bool negative = false;
  606. if (p != last && *p == '-') {
  607. negative = true;
  608. ++p;
  609. }
  610. if (p == last) { return {first, std::errc::invalid_argument}; }
  611. T result = 0;
  612. for (; p != last; ++p) {
  613. char c = *p;
  614. int digit = -1;
  615. if (is_ascii_digit(c)) {
  616. digit = c - '0';
  617. } else if ('a' <= c && c <= 'z') {
  618. digit = c - 'a' + 10;
  619. } else if ('A' <= c && c <= 'Z') {
  620. digit = c - 'A' + 10;
  621. } else {
  622. break;
  623. }
  624. if (digit < 0 || digit >= base) { break; }
  625. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  626. return {p, std::errc::result_out_of_range};
  627. }
  628. result = result * base + digit;
  629. }
  630. if (p == first || (negative && p == first + 1)) {
  631. return {first, std::errc::invalid_argument};
  632. }
  633. value = negative ? T(0) - result : result;
  634. return {p, std::errc{}};
  635. }
  636. // from_chars for double (hand-written, locale-independent)
  637. //
  638. // The only double consumed by this library is the HTTP quality value, whose
  639. // grammar is (RFC 9110 12.4.2):
  640. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  641. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  642. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  643. // '.' always the decimal separator (std::strtod would instead read it from the
  644. // global C locale, mis-parsing q-values once an embedder calls
  645. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  646. // the result to [0, 1], so inputs outside that range need not be distinguished
  647. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  648. // cases that exponent and wide-range handling would introduce.
  649. inline from_chars_result<double> from_chars(const char *first, const char *last,
  650. double &value) {
  651. value = 0.0;
  652. const char *p = first;
  653. // Each 1eN is exactly representable, so a single final division by the
  654. // matching entry yields a correctly-rounded result.
  655. static const double powers_of_ten[] = {
  656. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  657. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  658. const int max_frac_digits =
  659. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  660. // Accumulate digits into a 64-bit integer and remember how many were
  661. // fractional. Two independent caps keep this bounded and safe:
  662. // * accumulation saturates before mantissa could overflow uint64_t, and
  663. // * frac_digits is capped at max_frac_digits so it is always a valid index
  664. // into powers_of_ten (without this an input like "0.000...0" would never
  665. // grow mantissa, so the saturation cap alone would not bound it).
  666. // Both caps only drop digits far beyond the precision a q-value needs; any
  667. // value they would change is well outside [0, 1] and rejected by the caller.
  668. uint64_t mantissa = 0;
  669. int frac_digits = 0;
  670. bool seen_digit = false;
  671. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  672. auto accumulate = [&](char c) {
  673. if (mantissa <= limit) {
  674. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  675. return true;
  676. }
  677. return false;
  678. };
  679. for (; p != last && is_ascii_digit(*p); ++p) {
  680. seen_digit = true;
  681. accumulate(*p);
  682. }
  683. if (p != last && *p == '.') {
  684. ++p;
  685. for (; p != last && is_ascii_digit(*p); ++p) {
  686. seen_digit = true;
  687. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  688. }
  689. }
  690. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  691. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  692. return {p, std::errc{}};
  693. }
  694. inline bool parse_port(const char *s, size_t len, int &port) {
  695. int val = 0;
  696. auto r = from_chars(s, s + len, val);
  697. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  698. port = val;
  699. return true;
  700. }
  701. inline bool parse_port(const std::string &s, int &port) {
  702. return parse_port(s.data(), s.size(), port);
  703. }
  704. struct UrlComponents {
  705. std::string scheme;
  706. std::string host;
  707. std::string port;
  708. std::string path;
  709. std::string query;
  710. };
  711. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  712. uc = {};
  713. size_t pos = 0;
  714. auto sep = url.find("://");
  715. if (sep != std::string::npos) {
  716. uc.scheme = url.substr(0, sep);
  717. // Scheme must be [a-z]+ only
  718. if (uc.scheme.empty()) { return false; }
  719. for (auto c : uc.scheme) {
  720. if (c < 'a' || c > 'z') { return false; }
  721. }
  722. pos = sep + 3;
  723. } else if (url.compare(0, 2, "//") == 0) {
  724. pos = 2;
  725. }
  726. auto has_authority_prefix = pos > 0;
  727. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  728. url[0] != '?' && url[0] != '#');
  729. if (has_authority) {
  730. if (pos < url.size() && url[pos] == '[') {
  731. auto close = url.find(']', pos);
  732. if (close == std::string::npos) { return false; }
  733. uc.host = url.substr(pos + 1, close - pos - 1);
  734. // IPv6 host must be [a-fA-F0-9:]+ only
  735. if (uc.host.empty()) { return false; }
  736. for (auto c : uc.host) {
  737. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  738. (c >= 'A' && c <= 'F') || c == ':')) {
  739. return false;
  740. }
  741. }
  742. pos = close + 1;
  743. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  744. // path, query or fragment delimiter (or the end of input). Otherwise the
  745. // trailing bytes would be folded into the path while the connection
  746. // still targets the bracketed address.
  747. if (pos < url.size()) {
  748. auto c = url[pos];
  749. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  750. }
  751. } else {
  752. auto end = url.find_first_of(":/?#", pos);
  753. if (end == std::string::npos) { end = url.size(); }
  754. uc.host = url.substr(pos, end - pos);
  755. pos = end;
  756. }
  757. if (pos < url.size() && url[pos] == ':') {
  758. ++pos;
  759. auto end = url.find_first_of("/?#", pos);
  760. if (end == std::string::npos) { end = url.size(); }
  761. uc.port = url.substr(pos, end - pos);
  762. pos = end;
  763. }
  764. // Without :// or //, the entire input must be consumed as host[:port].
  765. // If there is leftover (path, query, etc.), this is not a valid
  766. // host[:port] string — clear and reparse as a plain path.
  767. if (!has_authority_prefix && pos < url.size()) {
  768. uc.host.clear();
  769. uc.port.clear();
  770. pos = 0;
  771. }
  772. }
  773. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  774. auto end = url.find_first_of("?#", pos);
  775. if (end == std::string::npos) { end = url.size(); }
  776. uc.path = url.substr(pos, end - pos);
  777. pos = end;
  778. }
  779. if (pos < url.size() && url[pos] == '?') {
  780. auto end = url.find('#', pos);
  781. if (end == std::string::npos) { end = url.size(); }
  782. uc.query = url.substr(pos, end - pos);
  783. }
  784. return true;
  785. }
  786. } // namespace detail
  787. enum class SSLVerifierResponse {
  788. // no decision has been made, use the built-in certificate verifier
  789. NoDecisionMade,
  790. // connection certificate is verified and accepted
  791. CertificateAccepted,
  792. // connection certificate was processed but is rejected
  793. CertificateRejected
  794. };
  795. // System CA loading policy for SSL clients. Auto (the default) loads system
  796. // CA certs only when no custom CA is configured; enable_system_ca() switches
  797. // to an explicit policy.
  798. enum class SystemCAMode { Auto, Enabled, Disabled };
  799. enum StatusCode {
  800. // Information responses
  801. Continue_100 = 100,
  802. SwitchingProtocol_101 = 101,
  803. Processing_102 = 102,
  804. EarlyHints_103 = 103,
  805. // Successful responses
  806. OK_200 = 200,
  807. Created_201 = 201,
  808. Accepted_202 = 202,
  809. NonAuthoritativeInformation_203 = 203,
  810. NoContent_204 = 204,
  811. ResetContent_205 = 205,
  812. PartialContent_206 = 206,
  813. MultiStatus_207 = 207,
  814. AlreadyReported_208 = 208,
  815. IMUsed_226 = 226,
  816. // Redirection messages
  817. MultipleChoices_300 = 300,
  818. MovedPermanently_301 = 301,
  819. Found_302 = 302,
  820. SeeOther_303 = 303,
  821. NotModified_304 = 304,
  822. UseProxy_305 = 305,
  823. unused_306 = 306,
  824. TemporaryRedirect_307 = 307,
  825. PermanentRedirect_308 = 308,
  826. // Client error responses
  827. BadRequest_400 = 400,
  828. Unauthorized_401 = 401,
  829. PaymentRequired_402 = 402,
  830. Forbidden_403 = 403,
  831. NotFound_404 = 404,
  832. MethodNotAllowed_405 = 405,
  833. NotAcceptable_406 = 406,
  834. ProxyAuthenticationRequired_407 = 407,
  835. RequestTimeout_408 = 408,
  836. Conflict_409 = 409,
  837. Gone_410 = 410,
  838. LengthRequired_411 = 411,
  839. PreconditionFailed_412 = 412,
  840. PayloadTooLarge_413 = 413,
  841. UriTooLong_414 = 414,
  842. UnsupportedMediaType_415 = 415,
  843. RangeNotSatisfiable_416 = 416,
  844. ExpectationFailed_417 = 417,
  845. ImATeapot_418 = 418,
  846. MisdirectedRequest_421 = 421,
  847. UnprocessableContent_422 = 422,
  848. Locked_423 = 423,
  849. FailedDependency_424 = 424,
  850. TooEarly_425 = 425,
  851. UpgradeRequired_426 = 426,
  852. PreconditionRequired_428 = 428,
  853. TooManyRequests_429 = 429,
  854. RequestHeaderFieldsTooLarge_431 = 431,
  855. UnavailableForLegalReasons_451 = 451,
  856. // Server error responses
  857. InternalServerError_500 = 500,
  858. NotImplemented_501 = 501,
  859. BadGateway_502 = 502,
  860. ServiceUnavailable_503 = 503,
  861. GatewayTimeout_504 = 504,
  862. HttpVersionNotSupported_505 = 505,
  863. VariantAlsoNegotiates_506 = 506,
  864. InsufficientStorage_507 = 507,
  865. LoopDetected_508 = 508,
  866. NotExtended_510 = 510,
  867. NetworkAuthenticationRequired_511 = 511,
  868. };
  869. namespace detail {
  870. // A multimap that keeps its entries in the order they were inserted.
  871. //
  872. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  873. // fields sharing a field name significant and forbids a proxy from reordering
  874. // them, and a query string's parameters are meaningful in the order the caller
  875. // wrote them. Neither standard container expresses it: std::unordered_multimap
  876. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  877. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  878. // key, which would drop control data such as Host behind whatever else the
  879. // message carries and alphabetise a query string.
  880. //
  881. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  882. // scan, which beats hashing for the handful of entries a message carries
  883. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  884. //
  885. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  886. // Params, whose parameter names are case-sensitive, not.
  887. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  888. public:
  889. using key_type = std::string;
  890. using mapped_type = Mapped;
  891. using value_type = std::pair<std::string, Mapped>;
  892. using size_type = std::size_t;
  893. using difference_type = std::ptrdiff_t;
  894. using reference = value_type &;
  895. using const_reference = const value_type &;
  896. private:
  897. static size_type npos() { return static_cast<size_type>(-1); }
  898. static bool keys_equal(const std::string &a, const std::string &b) {
  899. return KeyEqual()(a, b);
  900. }
  901. // Iterating yields every entry in insertion order, but equal_range() and
  902. // find() have to walk only the entries sharing one key, which are not
  903. // adjacent. Both are the same iterator type: key_idx_ selects between the
  904. // two traversals, and since equality compares only the position, an iterator
  905. // restricted to one key still compares equal to end().
  906. template <typename V> class iterator_t {
  907. public:
  908. using iterator_category = std::bidirectional_iterator_tag;
  909. using value_type = insertion_ordered_multimap::value_type;
  910. using difference_type = insertion_ordered_multimap::difference_type;
  911. using pointer = V *;
  912. using reference = V &;
  913. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  914. template <typename U,
  915. typename std::enable_if<std::is_convertible<U *, V *>::value,
  916. int>::type = 0>
  917. iterator_t(const iterator_t<U> &rhs)
  918. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  919. key_idx_(rhs.key_idx_) {}
  920. reference operator*() const { return data_[idx_]; }
  921. pointer operator->() const { return data_ + idx_; }
  922. iterator_t &operator++() {
  923. // Saturating, so that advancing past the last entry of a key (which
  924. // get_multimap_value() does when asked for an out-of-range id) stays at
  925. // end() instead of running off the container.
  926. if (idx_ >= size_) { return *this; }
  927. ++idx_;
  928. if (key_idx_ != npos()) {
  929. while (idx_ < size_ && !matches(idx_)) {
  930. ++idx_;
  931. }
  932. }
  933. return *this;
  934. }
  935. iterator_t operator++(int) {
  936. auto tmp = *this;
  937. ++*this;
  938. return tmp;
  939. }
  940. iterator_t &operator--() {
  941. if (idx_ == 0) { return *this; }
  942. --idx_;
  943. if (key_idx_ != npos()) {
  944. while (idx_ > 0 && !matches(idx_)) {
  945. --idx_;
  946. }
  947. }
  948. return *this;
  949. }
  950. iterator_t operator--(int) {
  951. auto tmp = *this;
  952. --*this;
  953. return tmp;
  954. }
  955. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  956. return idx_ == rhs.idx_;
  957. }
  958. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  959. return idx_ != rhs.idx_;
  960. }
  961. private:
  962. friend class insertion_ordered_multimap;
  963. template <typename> friend class iterator_t;
  964. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  965. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  966. bool matches(size_type i) const {
  967. return keys_equal(data_[i].first, data_[key_idx_].first);
  968. }
  969. V *data_;
  970. size_type idx_;
  971. size_type size_;
  972. size_type key_idx_;
  973. };
  974. public:
  975. using iterator = iterator_t<value_type>;
  976. using const_iterator = iterator_t<const value_type>;
  977. insertion_ordered_multimap() = default;
  978. insertion_ordered_multimap(std::initializer_list<value_type> il)
  979. : entries_(il) {}
  980. template <typename InputIt>
  981. insertion_ordered_multimap(InputIt first, InputIt last)
  982. : entries_(first, last) {}
  983. iterator begin() { return make_iter(0, npos()); }
  984. iterator end() { return make_iter(entries_.size(), npos()); }
  985. const_iterator begin() const { return make_citer(0, npos()); }
  986. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  987. const_iterator cbegin() const { return begin(); }
  988. const_iterator cend() const { return end(); }
  989. bool empty() const { return entries_.empty(); }
  990. size_type size() const { return entries_.size(); }
  991. void clear() { entries_.clear(); }
  992. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  993. iterator insert(const value_type &val) {
  994. entries_.push_back(val);
  995. return make_iter(entries_.size() - 1, npos());
  996. }
  997. iterator insert(value_type &&val) {
  998. entries_.push_back(std::move(val));
  999. return make_iter(entries_.size() - 1, npos());
  1000. }
  1001. template <typename... Args> iterator emplace(Args &&...args) {
  1002. entries_.emplace_back(std::forward<Args>(args)...);
  1003. return make_iter(entries_.size() - 1, npos());
  1004. }
  1005. // For entries that have to lead the message, such as the Host header field
  1006. // (RFC 9110 5.3 recommends sending control data first).
  1007. template <typename... Args> iterator emplace_front(Args &&...args) {
  1008. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1009. return make_iter(0, npos());
  1010. }
  1011. iterator find(const std::string &key) {
  1012. auto i = index_of(key);
  1013. return i == npos() ? end() : make_iter(i, i);
  1014. }
  1015. const_iterator find(const std::string &key) const {
  1016. auto i = index_of(key);
  1017. return i == npos() ? end() : make_citer(i, i);
  1018. }
  1019. size_type count(const std::string &key) const {
  1020. size_type n = 0;
  1021. for (const auto &entry : entries_) {
  1022. if (keys_equal(entry.first, key)) { n++; }
  1023. }
  1024. return n;
  1025. }
  1026. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1027. auto i = index_of(key);
  1028. return i == npos() ? std::make_pair(end(), end())
  1029. : std::make_pair(make_iter(i, i), end());
  1030. }
  1031. std::pair<const_iterator, const_iterator>
  1032. equal_range(const std::string &key) const {
  1033. auto i = index_of(key);
  1034. return i == npos() ? std::make_pair(end(), end())
  1035. : std::make_pair(make_citer(i, i), end());
  1036. }
  1037. size_type erase(const std::string &key) {
  1038. auto before = entries_.size();
  1039. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1040. [&](const value_type &entry) {
  1041. return keys_equal(entry.first, key);
  1042. }),
  1043. entries_.end());
  1044. return before - entries_.size();
  1045. }
  1046. iterator erase(const_iterator pos) {
  1047. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1048. return make_iter(pos.idx_, npos());
  1049. }
  1050. // Erases what iterating [first, last) would actually visit, so erasing an
  1051. // equal_range() removes only the entries with that key, not everything
  1052. // positioned between them.
  1053. iterator erase(const_iterator first, const_iterator last) {
  1054. auto from = first.idx_;
  1055. auto to = last.idx_;
  1056. if (from >= to) { return make_iter(from, npos()); }
  1057. auto begin_it = entries_.begin();
  1058. auto from_it = begin_it + static_cast<difference_type>(from);
  1059. auto to_it = begin_it + static_cast<difference_type>(to);
  1060. if (first.key_idx_ == npos()) {
  1061. entries_.erase(from_it, to_it);
  1062. } else {
  1063. auto key = entries_[first.key_idx_].first;
  1064. auto keep = from_it;
  1065. for (auto it = from_it; it != to_it; ++it) {
  1066. if (!keys_equal(it->first, key)) {
  1067. if (keep != it) { *keep = std::move(*it); }
  1068. ++keep;
  1069. }
  1070. }
  1071. if (keep != to_it) {
  1072. keep = std::move(to_it, entries_.end(), keep);
  1073. } else {
  1074. keep = entries_.end();
  1075. }
  1076. entries_.erase(keep, entries_.end());
  1077. }
  1078. return make_iter(from, npos());
  1079. }
  1080. friend bool operator==(const insertion_ordered_multimap &lhs,
  1081. const insertion_ordered_multimap &rhs) {
  1082. return lhs.entries_ == rhs.entries_;
  1083. }
  1084. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1085. const insertion_ordered_multimap &rhs) {
  1086. return !(lhs == rhs);
  1087. }
  1088. private:
  1089. size_type index_of(const std::string &key) const {
  1090. for (size_type i = 0; i < entries_.size(); i++) {
  1091. if (keys_equal(entries_[i].first, key)) { return i; }
  1092. }
  1093. return npos();
  1094. }
  1095. iterator make_iter(size_type idx, size_type key_idx) {
  1096. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1097. }
  1098. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1099. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1100. }
  1101. std::vector<value_type> entries_;
  1102. };
  1103. } // namespace detail
  1104. using Headers =
  1105. detail::insertion_ordered_multimap<std::string,
  1106. detail::case_ignore::equal_to>;
  1107. // Query parameter names are case-sensitive, unlike header field names.
  1108. using Params =
  1109. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1110. using Match = std::smatch;
  1111. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1112. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1113. /*
  1114. * detail: type-erased storage used by UserData.
  1115. * ABI-stable regardless of C++ standard — always uses this custom
  1116. * implementation instead of std::any.
  1117. */
  1118. namespace detail {
  1119. using any_type_id = const void *;
  1120. template <typename T> any_type_id any_typeid() noexcept {
  1121. static const char id = 0;
  1122. return &id;
  1123. }
  1124. struct any_storage {
  1125. virtual ~any_storage() = default;
  1126. virtual std::unique_ptr<any_storage> clone() const = 0;
  1127. virtual any_type_id type_id() const noexcept = 0;
  1128. };
  1129. template <typename T> struct any_value final : any_storage {
  1130. T value;
  1131. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1132. std::unique_ptr<any_storage> clone() const override {
  1133. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1134. }
  1135. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1136. };
  1137. } // namespace detail
  1138. class UserData {
  1139. public:
  1140. UserData() = default;
  1141. UserData(UserData &&) noexcept = default;
  1142. UserData &operator=(UserData &&) noexcept = default;
  1143. UserData(const UserData &o) {
  1144. for (const auto &e : o.entries_) {
  1145. if (e.second) { entries_[e.first] = e.second->clone(); }
  1146. }
  1147. }
  1148. UserData &operator=(const UserData &o) {
  1149. if (this != &o) {
  1150. entries_.clear();
  1151. for (const auto &e : o.entries_) {
  1152. if (e.second) { entries_[e.first] = e.second->clone(); }
  1153. }
  1154. }
  1155. return *this;
  1156. }
  1157. template <typename T> void set(const std::string &key, T &&value) {
  1158. using D = typename std::decay<T>::type;
  1159. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1160. }
  1161. template <typename T> T *get(const std::string &key) noexcept {
  1162. auto it = entries_.find(key);
  1163. if (it == entries_.end() || !it->second) { return nullptr; }
  1164. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1165. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1166. }
  1167. template <typename T> const T *get(const std::string &key) const noexcept {
  1168. auto it = entries_.find(key);
  1169. if (it == entries_.end() || !it->second) { return nullptr; }
  1170. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1171. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1172. }
  1173. bool has(const std::string &key) const noexcept {
  1174. return entries_.find(key) != entries_.end();
  1175. }
  1176. void erase(const std::string &key) { entries_.erase(key); }
  1177. void clear() noexcept { entries_.clear(); }
  1178. private:
  1179. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1180. entries_;
  1181. };
  1182. struct Response;
  1183. using ResponseHandler = std::function<bool(const Response &response)>;
  1184. struct FormData {
  1185. std::string name;
  1186. std::string content;
  1187. std::string filename;
  1188. std::string content_type;
  1189. Headers headers;
  1190. };
  1191. struct FormField {
  1192. std::string name;
  1193. std::string content;
  1194. Headers headers;
  1195. };
  1196. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1197. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1198. // should see the parts as they were sent. A std::multimap sorts by field name
  1199. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1200. // than the case-insensitive predicate Headers uses.
  1201. using FormFields =
  1202. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1203. using FormFiles =
  1204. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1205. struct MultipartFormData {
  1206. FormFields fields; // Text fields from multipart
  1207. FormFiles files; // Files from multipart
  1208. // Text field access
  1209. std::string get_field(const std::string &key, size_t id = 0) const;
  1210. std::vector<std::string> get_fields(const std::string &key) const;
  1211. bool has_field(const std::string &key) const;
  1212. size_t get_field_count(const std::string &key) const;
  1213. // File access
  1214. FormData get_file(const std::string &key, size_t id = 0) const;
  1215. std::vector<FormData> get_files(const std::string &key) const;
  1216. bool has_file(const std::string &key) const;
  1217. size_t get_file_count(const std::string &key) const;
  1218. };
  1219. struct UploadFormData {
  1220. std::string name;
  1221. std::string content;
  1222. std::string filename;
  1223. std::string content_type;
  1224. };
  1225. using UploadFormDataItems = std::vector<UploadFormData>;
  1226. class DataSink {
  1227. public:
  1228. DataSink() : os(&sb_), sb_(*this) {}
  1229. DataSink(const DataSink &) = delete;
  1230. DataSink &operator=(const DataSink &) = delete;
  1231. DataSink(DataSink &&) = delete;
  1232. DataSink &operator=(DataSink &&) = delete;
  1233. std::function<bool(const char *data, size_t data_len)> write;
  1234. // Only `write` is mandatory. The rest are defaulted so that a provider
  1235. // calling one on a writer that does not set it gets sensible behaviour
  1236. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1237. // `this` is safe: DataSink is neither copyable nor movable.
  1238. std::function<bool()> is_writable = []() { return true; };
  1239. std::function<void()> done = []() {};
  1240. std::function<void(const Headers &trailer)> done_with_trailer =
  1241. [this](const Headers & /*trailer*/) { done(); };
  1242. std::ostream os;
  1243. private:
  1244. class data_sink_streambuf final : public std::streambuf {
  1245. public:
  1246. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1247. protected:
  1248. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1249. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1250. return 0;
  1251. }
  1252. private:
  1253. DataSink &sink_;
  1254. };
  1255. data_sink_streambuf sb_;
  1256. };
  1257. using ContentProvider =
  1258. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1259. using ContentProviderWithoutLength =
  1260. std::function<bool(size_t offset, DataSink &sink)>;
  1261. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1262. struct FormDataProvider {
  1263. std::string name;
  1264. ContentProviderWithoutLength provider;
  1265. std::string filename;
  1266. std::string content_type;
  1267. };
  1268. using FormDataProviderItems = std::vector<FormDataProvider>;
  1269. inline FormDataProvider
  1270. make_file_provider(const std::string &name, const std::string &filepath,
  1271. const std::string &filename = std::string(),
  1272. const std::string &content_type = std::string()) {
  1273. FormDataProvider fdp;
  1274. fdp.name = name;
  1275. fdp.filename = filename.empty() ? filepath : filename;
  1276. fdp.content_type = content_type;
  1277. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1278. std::ifstream f(filepath, std::ios::binary);
  1279. if (!f) { return false; }
  1280. if (offset > 0) {
  1281. f.seekg(static_cast<std::streamoff>(offset));
  1282. if (!f.good()) {
  1283. sink.done();
  1284. return true;
  1285. }
  1286. }
  1287. char buf[8192];
  1288. f.read(buf, sizeof(buf));
  1289. auto n = static_cast<size_t>(f.gcount());
  1290. if (n > 0) { return sink.write(buf, n); }
  1291. sink.done(); // EOF
  1292. return true;
  1293. };
  1294. return fdp;
  1295. }
  1296. inline std::pair<size_t, ContentProvider>
  1297. make_file_body(const std::string &filepath) {
  1298. size_t size = 0;
  1299. {
  1300. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1301. if (!f) { return {0, ContentProvider{}}; }
  1302. size = static_cast<size_t>(f.tellg());
  1303. }
  1304. ContentProvider provider = [filepath](size_t offset, size_t length,
  1305. DataSink &sink) -> bool {
  1306. std::ifstream f(filepath, std::ios::binary);
  1307. if (!f) { return false; }
  1308. f.seekg(static_cast<std::streamoff>(offset));
  1309. if (!f.good()) { return false; }
  1310. char buf[8192];
  1311. while (length > 0) {
  1312. auto to_read = (std::min)(sizeof(buf), length);
  1313. f.read(buf, static_cast<std::streamsize>(to_read));
  1314. auto n = static_cast<size_t>(f.gcount());
  1315. // The file is shorter than the size make_file_body() measured, which the
  1316. // caller has already committed to as Content-Length. The body cannot be
  1317. // completed, so fail as every other error here does.
  1318. if (n == 0) { return false; }
  1319. if (!sink.write(buf, n)) { return false; }
  1320. length -= n;
  1321. }
  1322. return true;
  1323. };
  1324. return {size, std::move(provider)};
  1325. }
  1326. using ContentReceiverWithProgress = std::function<bool(
  1327. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1328. using ContentReceiver =
  1329. std::function<bool(const char *data, size_t data_length)>;
  1330. using FormDataHeader = std::function<bool(const FormData &file)>;
  1331. class ContentReader {
  1332. public:
  1333. using Reader = std::function<bool(ContentReceiver receiver)>;
  1334. using FormDataReader =
  1335. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1336. ContentReader(Reader reader, FormDataReader multipart_reader)
  1337. : reader_(std::move(reader)),
  1338. formdata_reader_(std::move(multipart_reader)) {}
  1339. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1340. return formdata_reader_(std::move(header), std::move(receiver));
  1341. }
  1342. bool operator()(ContentReceiver receiver) const {
  1343. return reader_(std::move(receiver));
  1344. }
  1345. Reader reader_;
  1346. FormDataReader formdata_reader_;
  1347. };
  1348. using Range = std::pair<ssize_t, ssize_t>;
  1349. using Ranges = std::vector<Range>;
  1350. #ifdef CPPHTTPLIB_SSL_ENABLED
  1351. // TLS abstraction layer - public type definitions and API
  1352. namespace tls {
  1353. // Opaque handles (defined as void* for abstraction)
  1354. using ctx_t = void *;
  1355. using session_t = void *;
  1356. using const_session_t = const void *; // For read-only session access
  1357. using cert_t = void *;
  1358. using ca_store_t = void *;
  1359. // TLS versions
  1360. enum class Version {
  1361. TLS1_2 = 0x0303,
  1362. TLS1_3 = 0x0304,
  1363. };
  1364. // Subject Alternative Names (SAN) entry types
  1365. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1366. // SAN entry structure
  1367. struct SanEntry {
  1368. SanType type;
  1369. std::string value;
  1370. };
  1371. // Verification context for certificate verification callback
  1372. struct VerifyContext {
  1373. session_t session; // TLS session handle
  1374. cert_t cert; // Current certificate being verified
  1375. int depth; // Certificate chain depth (0 = leaf)
  1376. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1377. long error_code; // Backend-specific error code (0 = no error)
  1378. const char *error_string; // Human-readable error description
  1379. // Certificate introspection methods
  1380. std::string subject_cn() const;
  1381. std::string issuer_name() const;
  1382. bool check_hostname(const char *hostname) const;
  1383. std::vector<SanEntry> sans() const;
  1384. bool validity(time_t &not_before, time_t &not_after) const;
  1385. std::string serial() const;
  1386. };
  1387. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1388. // TlsError codes for TLS operations (backend-independent)
  1389. enum class ErrorCode : int {
  1390. Success = 0,
  1391. WantRead, // Non-blocking: need to wait for read
  1392. WantWrite, // Non-blocking: need to wait for write
  1393. PeerClosed, // Peer closed the connection
  1394. Fatal, // Unrecoverable error
  1395. SyscallError, // System call error (check sys_errno)
  1396. CertVerifyFailed, // Certificate verification failed
  1397. HostnameMismatch, // Hostname verification failed
  1398. };
  1399. // TLS error information
  1400. struct TlsError {
  1401. ErrorCode code = ErrorCode::Fatal;
  1402. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1403. int sys_errno = 0; // errno when SyscallError
  1404. // Convert verification error code to human-readable string
  1405. static std::string verify_error_to_string(long error_code);
  1406. };
  1407. // RAII wrapper for peer certificate
  1408. class PeerCert {
  1409. public:
  1410. PeerCert();
  1411. PeerCert(PeerCert &&other) noexcept;
  1412. PeerCert &operator=(PeerCert &&other) noexcept;
  1413. ~PeerCert();
  1414. PeerCert(const PeerCert &) = delete;
  1415. PeerCert &operator=(const PeerCert &) = delete;
  1416. explicit operator bool() const;
  1417. std::string subject_cn() const;
  1418. std::string issuer_name() const;
  1419. bool check_hostname(const char *hostname) const;
  1420. std::vector<SanEntry> sans() const;
  1421. bool validity(time_t &not_before, time_t &not_after) const;
  1422. std::string serial() const;
  1423. private:
  1424. explicit PeerCert(cert_t cert);
  1425. cert_t cert_ = nullptr;
  1426. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1427. };
  1428. // Callback for TLS context setup (used by SSLServer constructor)
  1429. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1430. } // namespace tls
  1431. #endif
  1432. struct Request {
  1433. std::string method;
  1434. std::string path;
  1435. std::string matched_route;
  1436. Params params;
  1437. Headers headers;
  1438. Headers trailers;
  1439. std::string body;
  1440. std::string remote_addr;
  1441. int remote_port = -1;
  1442. std::string local_addr;
  1443. int local_port = -1;
  1444. // for server
  1445. std::string version;
  1446. std::string target;
  1447. MultipartFormData form;
  1448. Ranges ranges;
  1449. Match matches;
  1450. std::unordered_map<std::string, std::string> path_params;
  1451. std::function<bool()> is_connection_closed = []() { return true; };
  1452. // for client
  1453. std::vector<std::string> accept_content_types;
  1454. ResponseHandler response_handler;
  1455. ContentReceiverWithProgress content_receiver;
  1456. DownloadProgress download_progress;
  1457. UploadProgress upload_progress;
  1458. bool has_header(const std::string &key) const;
  1459. std::string get_header_value(const std::string &key, const char *def = "",
  1460. size_t id = 0) const;
  1461. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1462. size_t id = 0) const;
  1463. size_t get_header_value_count(const std::string &key) const;
  1464. void set_header(const std::string &key, const std::string &val);
  1465. bool has_trailer(const std::string &key) const;
  1466. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1467. size_t get_trailer_value_count(const std::string &key) const;
  1468. bool has_param(const std::string &key) const;
  1469. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1470. std::vector<std::string> get_param_values(const std::string &key) const;
  1471. size_t get_param_value_count(const std::string &key) const;
  1472. bool is_multipart_form_data() const;
  1473. // private members...
  1474. bool body_consumed_ = false;
  1475. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1476. size_t content_length_ = 0;
  1477. ContentProvider content_provider_;
  1478. bool is_chunked_content_provider_ = false;
  1479. size_t authorization_count_ = 0;
  1480. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1481. (std::chrono::steady_clock::time_point::min)();
  1482. #ifdef CPPHTTPLIB_SSL_ENABLED
  1483. tls::const_session_t ssl = nullptr;
  1484. tls::PeerCert peer_cert() const;
  1485. std::string sni() const;
  1486. #endif
  1487. };
  1488. namespace detail {
  1489. // Declared up here, away from the rest of the compression helpers, because
  1490. // `Response` stores one.
  1491. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1492. } // namespace detail
  1493. struct Response {
  1494. std::string version;
  1495. int status = -1;
  1496. std::string reason;
  1497. Headers headers;
  1498. Headers trailers;
  1499. std::string body;
  1500. std::string location; // Redirect location
  1501. // User-defined context — set by pre-routing/pre-request handlers and read
  1502. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1503. UserData user_data;
  1504. bool has_header(const std::string &key) const;
  1505. std::string get_header_value(const std::string &key, const char *def = "",
  1506. size_t id = 0) const;
  1507. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1508. size_t id = 0) const;
  1509. size_t get_header_value_count(const std::string &key) const;
  1510. void set_header(const std::string &key, const std::string &val);
  1511. bool has_trailer(const std::string &key) const;
  1512. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1513. size_t get_trailer_value_count(const std::string &key) const;
  1514. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1515. void set_content(const char *s, size_t n, const std::string &content_type);
  1516. void set_content(const std::string &s, const std::string &content_type);
  1517. void set_content(std::string &&s, const std::string &content_type);
  1518. void set_content_provider(
  1519. size_t length, const std::string &content_type, ContentProvider provider,
  1520. ContentProviderResourceReleaser resource_releaser = nullptr);
  1521. void set_content_provider(
  1522. const std::string &content_type, ContentProviderWithoutLength provider,
  1523. ContentProviderResourceReleaser resource_releaser = nullptr);
  1524. void set_chunked_content_provider(
  1525. const std::string &content_type, ContentProviderWithoutLength provider,
  1526. ContentProviderResourceReleaser resource_releaser = nullptr);
  1527. void set_file_content(const std::string &path,
  1528. const std::string &content_type);
  1529. void set_file_content(const std::string &path);
  1530. Response() = default;
  1531. Response(const Response &) = default;
  1532. Response &operator=(const Response &) = default;
  1533. Response(Response &&) = default;
  1534. Response &operator=(Response &&) = default;
  1535. ~Response() {
  1536. if (content_provider_resource_releaser_) {
  1537. content_provider_resource_releaser_(content_provider_success_);
  1538. }
  1539. }
  1540. // private members...
  1541. size_t content_length_ = 0;
  1542. ContentProvider content_provider_;
  1543. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1544. bool is_chunked_content_provider_ = false;
  1545. bool content_provider_success_ = false;
  1546. std::string file_content_path_;
  1547. std::string file_content_content_type_;
  1548. // Content coding chosen for the response body, decided once so that the
  1549. // headers and the body cannot disagree: where the file is opened for a
  1550. // file-backed content provider (keeping the ETag honest), and in
  1551. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1552. // for every other kind of response.
  1553. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1554. };
  1555. enum class Error {
  1556. Success = 0,
  1557. Unknown,
  1558. Connection,
  1559. BindIPAddress,
  1560. Read,
  1561. Write,
  1562. ExceedRedirectCount,
  1563. Canceled,
  1564. SSLConnection,
  1565. SSLLoadingCerts,
  1566. SSLServerVerification,
  1567. SSLServerHostnameVerification,
  1568. UnsupportedMultipartBoundaryChars,
  1569. Compression,
  1570. ConnectionTimeout,
  1571. ProxyConnection,
  1572. ConnectionClosed,
  1573. Timeout,
  1574. ResourceExhaustion,
  1575. TooManyFormDataFiles,
  1576. ExceedMaxPayloadSize,
  1577. ExceedUriMaxLength,
  1578. ExceedMaxSocketDescriptorCount,
  1579. InvalidRequestLine,
  1580. InvalidHTTPMethod,
  1581. InvalidHTTPVersion,
  1582. InvalidHeaders,
  1583. MultipartParsing,
  1584. OpenFile,
  1585. Listen,
  1586. GetSockName,
  1587. UnsupportedAddressFamily,
  1588. HTTPParsing,
  1589. InvalidRangeHeader,
  1590. UnsupportedContentEncoding,
  1591. WebSocketHandshake,
  1592. UserCallbackException,
  1593. // For internal use only
  1594. SSLPeerCouldBeClosed_,
  1595. };
  1596. std::string to_string(Error error);
  1597. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1598. class Stream {
  1599. public:
  1600. virtual ~Stream() = default;
  1601. virtual bool is_readable() const = 0;
  1602. virtual bool wait_readable() const = 0;
  1603. virtual bool wait_writable() const = 0;
  1604. virtual bool is_peer_alive() const { return wait_writable(); }
  1605. virtual ssize_t read(char *ptr, size_t size) = 0;
  1606. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1607. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1608. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1609. virtual socket_t socket() const = 0;
  1610. virtual time_t duration() const = 0;
  1611. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1612. (void)sec;
  1613. (void)usec;
  1614. }
  1615. // Bytes already pulled off the socket and sitting in this stream's own
  1616. // buffer. Exposing them lets a line reader scan for a terminator in one
  1617. // pass instead of asking for a byte at a time. A stream that does no
  1618. // buffering of its own reports none, and readers fall back to read().
  1619. virtual const char *buffered_data(size_t &size) const {
  1620. size = 0;
  1621. return nullptr;
  1622. }
  1623. // Discards `size` bytes previously returned by buffered_data().
  1624. virtual void consume_buffered(size_t size) { (void)size; }
  1625. ssize_t write(const char *ptr);
  1626. ssize_t write(const std::string &s);
  1627. Error get_error() const { return error_; }
  1628. protected:
  1629. Error error_ = Error::Success;
  1630. };
  1631. class TaskQueue {
  1632. public:
  1633. TaskQueue() = default;
  1634. virtual ~TaskQueue() = default;
  1635. virtual bool enqueue(std::function<void()> fn) = 0;
  1636. virtual void shutdown() = 0;
  1637. virtual void on_idle() {}
  1638. };
  1639. class ThreadPool final : public TaskQueue {
  1640. public:
  1641. explicit ThreadPool(
  1642. size_t n, size_t max_n = 0, size_t mqr = 0,
  1643. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1644. ThreadPool(const ThreadPool &) = delete;
  1645. ~ThreadPool() override = default;
  1646. bool enqueue(std::function<void()> fn) override;
  1647. void shutdown() override;
  1648. private:
  1649. void worker(bool is_dynamic);
  1650. void move_to_finished(std::thread::id id);
  1651. void cleanup_finished_threads();
  1652. size_t base_thread_count_;
  1653. size_t max_thread_count_;
  1654. size_t max_queued_requests_;
  1655. time_t idle_timeout_sec_;
  1656. size_t idle_thread_count_;
  1657. bool shutdown_;
  1658. std::list<std::function<void()>> jobs_;
  1659. std::vector<std::thread> threads_; // base threads
  1660. std::list<std::thread> dynamic_threads_; // dynamic threads
  1661. std::vector<std::thread>
  1662. finished_threads_; // exited dynamic threads awaiting join
  1663. std::condition_variable cond_;
  1664. std::mutex mutex_;
  1665. };
  1666. using Logger = std::function<void(const Request &, const Response &)>;
  1667. // Forward declaration for Error type
  1668. enum class Error;
  1669. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1670. using SocketOptions = std::function<void(socket_t sock)>;
  1671. void default_socket_options(socket_t sock);
  1672. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1673. const char *status_message(int status);
  1674. std::string to_string(Error error);
  1675. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1676. std::string get_bearer_token_auth(const Request &req);
  1677. namespace detail {
  1678. class MatcherBase {
  1679. public:
  1680. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1681. virtual ~MatcherBase() = default;
  1682. const std::string &pattern() const { return pattern_; }
  1683. // Match request path and populate its matches and
  1684. virtual bool match(Request &request) const = 0;
  1685. private:
  1686. std::string pattern_;
  1687. };
  1688. /**
  1689. * Captures parameters in request path and stores them in Request::path_params
  1690. *
  1691. * Capture name is a substring of a pattern from : to /.
  1692. * The rest of the pattern is matched against the request path directly
  1693. * Parameters are captured starting from the next character after
  1694. * the end of the last matched static pattern fragment until the next /.
  1695. *
  1696. * Example pattern:
  1697. * "/path/fragments/:capture/more/fragments/:second_capture"
  1698. * Static fragments:
  1699. * "/path/fragments/", "more/fragments/"
  1700. *
  1701. * Given the following request path:
  1702. * "/path/fragments/:1/more/fragments/:2"
  1703. * the resulting capture will be
  1704. * {{"capture", "1"}, {"second_capture", "2"}}
  1705. */
  1706. class PathParamsMatcher final : public MatcherBase {
  1707. public:
  1708. PathParamsMatcher(const std::string &pattern);
  1709. bool match(Request &request) const override;
  1710. private:
  1711. // Treat segment separators as the end of path parameter capture
  1712. // Does not need to handle query parameters as they are parsed before path
  1713. // matching
  1714. static constexpr char separator = '/';
  1715. // Contains static path fragments to match against, excluding the '/' after
  1716. // path params
  1717. // Fragments are separated by path params
  1718. std::vector<std::string> static_fragments_;
  1719. // Stores the names of the path parameters to be used as keys in the
  1720. // Request::path_params map
  1721. std::vector<std::string> param_names_;
  1722. };
  1723. /**
  1724. * Performs std::regex_match on request path
  1725. * and stores the result in Request::matches
  1726. *
  1727. * Note that regex match is performed directly on the whole request.
  1728. * This means that wildcard patterns may match multiple path segments with /:
  1729. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1730. */
  1731. class RegexMatcher final : public MatcherBase {
  1732. public:
  1733. RegexMatcher(const std::string &pattern)
  1734. : MatcherBase(pattern), regex_(pattern) {}
  1735. bool match(Request &request) const override;
  1736. private:
  1737. std::regex regex_;
  1738. };
  1739. int close_socket(socket_t sock) noexcept;
  1740. bool is_accept_resource_error();
  1741. bool is_accept_transient_error();
  1742. ssize_t write_headers(Stream &strm, const Headers &headers);
  1743. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1744. time_t usec);
  1745. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1746. const std::string &boundary);
  1747. ContentProvider
  1748. make_multipart_content_provider(const UploadFormDataItems &items,
  1749. const std::string &boundary);
  1750. } // namespace detail
  1751. bool is_valid_multipart_boundary(const std::string &boundary);
  1752. // Serializer for multipart/form-data request bodies. The boundary is owned
  1753. // by the writer so that per-part framing and the final terminator always
  1754. // agree. Field names and filenames are escaped following the WHATWG HTML
  1755. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1756. // in content types.
  1757. class MultipartFormDataWriter {
  1758. public:
  1759. MultipartFormDataWriter();
  1760. // precondition: is_valid_multipart_boundary(boundary)
  1761. explicit MultipartFormDataWriter(std::string boundary);
  1762. const std::string &boundary() const;
  1763. std::string content_type() const;
  1764. // In-memory items -> whole body (known length)
  1765. std::string serialize(const UploadFormDataItems &items) const;
  1766. size_t content_length(const UploadFormDataItems &items) const;
  1767. // Per-part framing for streaming via a content provider
  1768. std::string item_begin(const UploadFormData &item) const;
  1769. static std::string item_end();
  1770. std::string finish() const;
  1771. private:
  1772. std::string boundary_;
  1773. };
  1774. class Server {
  1775. public:
  1776. using Handler = std::function<void(const Request &, Response &)>;
  1777. using ExceptionHandler =
  1778. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1779. enum class HandlerResponse {
  1780. Handled,
  1781. Unhandled,
  1782. };
  1783. using HandlerWithResponse =
  1784. std::function<HandlerResponse(const Request &, Response &)>;
  1785. using HandlerWithContentReader = std::function<void(
  1786. const Request &, Response &, const ContentReader &content_reader)>;
  1787. using Expect100ContinueHandler =
  1788. std::function<int(const Request &, Response &)>;
  1789. using StartHandler = std::function<void()>;
  1790. using WebSocketHandler =
  1791. std::function<void(const Request &, ws::WebSocket &)>;
  1792. using SubProtocolSelector =
  1793. std::function<std::string(const std::vector<std::string> &protocols)>;
  1794. Server();
  1795. virtual ~Server();
  1796. virtual bool is_valid() const;
  1797. Server &Get(const std::string &pattern, Handler handler);
  1798. Server &Post(const std::string &pattern, Handler handler);
  1799. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1800. Server &Put(const std::string &pattern, Handler handler);
  1801. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1802. Server &Patch(const std::string &pattern, Handler handler);
  1803. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1804. Server &Delete(const std::string &pattern, Handler handler);
  1805. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1806. Server &Options(const std::string &pattern, Handler handler);
  1807. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1808. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1809. // server accept it; an unregistered method is still rejected with 400.
  1810. // `method` must be a valid HTTP method token and must not be one of the
  1811. // built-in methods, which have their own registration functions above. A
  1812. // rejected registration makes is_valid() return false, so listen() fails.
  1813. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1814. Handler handler);
  1815. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1816. HandlerWithContentReader handler);
  1817. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1818. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1819. SubProtocolSelector sub_protocol_selector);
  1820. bool set_base_dir(const std::string &dir,
  1821. const std::string &mount_point = std::string());
  1822. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1823. Headers headers = Headers());
  1824. bool remove_mount_point(const std::string &mount_point);
  1825. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1826. const std::string &mime);
  1827. Server &set_default_file_mimetype(const std::string &mime);
  1828. Server &set_file_request_handler(Handler handler);
  1829. template <class ErrorHandlerFunc>
  1830. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1831. return set_error_handler_core(
  1832. std::forward<ErrorHandlerFunc>(handler),
  1833. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1834. }
  1835. Server &set_exception_handler(ExceptionHandler handler);
  1836. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1837. Server &set_post_routing_handler(Handler handler);
  1838. Server &set_pre_request_handler(HandlerWithResponse handler);
  1839. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1840. Server &set_start_handler(StartHandler handler);
  1841. Server &set_logger(Logger logger);
  1842. Server &set_pre_compression_logger(Logger logger);
  1843. Server &set_error_logger(ErrorLogger error_logger);
  1844. Server &set_address_family(int family);
  1845. Server &set_tcp_nodelay(bool on);
  1846. Server &set_ipv6_v6only(bool on);
  1847. Server &set_socket_options(SocketOptions socket_options);
  1848. Server &set_default_headers(Headers headers);
  1849. Server &
  1850. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1851. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1852. Server &set_keep_alive_max_count(size_t count);
  1853. Server &set_keep_alive_timeout(time_t sec);
  1854. template <class Rep, class Period>
  1855. Server &
  1856. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1857. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1858. template <class Rep, class Period>
  1859. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1860. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1861. template <class Rep, class Period>
  1862. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1863. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1864. template <class Rep, class Period>
  1865. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1866. Server &set_payload_max_length(size_t length);
  1867. Server &set_static_file_compression(bool on);
  1868. Server &set_static_file_compression_min_length(size_t length);
  1869. Server &set_static_file_compression_max_length(size_t length);
  1870. Server &set_websocket_ping_interval(time_t sec);
  1871. template <class Rep, class Period>
  1872. Server &set_websocket_ping_interval(
  1873. const std::chrono::duration<Rep, Period> &duration);
  1874. Server &set_websocket_max_missed_pongs(int count);
  1875. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1876. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1877. bool listen_after_bind();
  1878. bool listen(const std::string &host, int port, int socket_flags = 0);
  1879. bool is_running() const;
  1880. void wait_until_ready() const;
  1881. void stop() noexcept;
  1882. void decommission();
  1883. std::function<TaskQueue *(void)> new_task_queue;
  1884. protected:
  1885. bool process_request(Stream &strm, const std::string &remote_addr,
  1886. int remote_port, const std::string &local_addr,
  1887. int local_port, bool close_connection,
  1888. bool &connection_closed,
  1889. const std::function<void(Request &)> &setup_request,
  1890. bool *websocket_upgraded = nullptr);
  1891. // Runs the per-connection serving loop and stops an exception thrown by a
  1892. // user callback from escaping the worker thread.
  1893. //
  1894. // process_request() wraps only routing() in a try/catch. Content providers,
  1895. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1896. // handlers all run outside it, and the task queue calls the job without a
  1897. // catch, so an exception from any of those would terminate the process.
  1898. //
  1899. // No 500 is possible here: by the time a content provider runs, the status
  1900. // line and headers are already on the wire. Report it through the error
  1901. // logger and drop the connection, which is what the peer observes either
  1902. // way. Other connections are unaffected.
  1903. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1904. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1905. return serve();
  1906. #else
  1907. try {
  1908. return serve();
  1909. } catch (...) {
  1910. // The error logger is a user callback too, so it must not be able to
  1911. // throw the guard back open.
  1912. try {
  1913. output_error_log(Error::UserCallbackException, nullptr);
  1914. } catch (...) {}
  1915. return false;
  1916. }
  1917. #endif
  1918. }
  1919. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1920. std::vector<std::string> trusted_proxies_;
  1921. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1922. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1923. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1924. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1925. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1926. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1927. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1928. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1929. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1930. bool static_file_compression_ = false;
  1931. size_t static_file_compression_min_length_ =
  1932. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1933. size_t static_file_compression_max_length_ =
  1934. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1935. time_t websocket_ping_interval_sec_ =
  1936. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1937. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1938. private:
  1939. using Handlers =
  1940. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1941. using HandlersForContentReader =
  1942. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1943. HandlerWithContentReader>>;
  1944. // Both handler tables for one custom method live in a single entry, so that
  1945. // routing() needs only one map lookup per request to reach either of them.
  1946. struct CustomHandlerEntry {
  1947. Handlers handlers;
  1948. HandlersForContentReader handlers_for_content_reader;
  1949. };
  1950. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1951. static std::unique_ptr<detail::MatcherBase>
  1952. make_matcher(const std::string &pattern);
  1953. static const std::set<std::string> &builtin_methods();
  1954. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1955. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1956. template <typename H>
  1957. Server &add_handler(
  1958. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1959. const std::string &pattern, H handler) {
  1960. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  1961. return *this;
  1962. }
  1963. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  1964. Server &set_error_handler_core(Handler handler, std::false_type);
  1965. socket_t create_server_socket(const std::string &host, int port,
  1966. int socket_flags,
  1967. SocketOptions socket_options) const;
  1968. int bind_internal(const std::string &host, int port, int socket_flags);
  1969. bool listen_internal();
  1970. bool routing(Request &req, Response &res, Stream &strm);
  1971. bool handle_file_request(Request &req, Response &res);
  1972. bool check_if_not_modified(const Request &req, Response &res,
  1973. const std::string &etag, time_t mtime) const;
  1974. bool check_if_range(Request &req, const std::string &etag,
  1975. time_t mtime) const;
  1976. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  1977. Stream &strm);
  1978. bool dispatch_request_for_content_reader(
  1979. Request &req, Response &res, ContentReader content_reader,
  1980. const HandlersForContentReader &handlers) const;
  1981. bool parse_request_line(const char *s, Request &req) const;
  1982. detail::EncodingType static_file_encoding(const Request &req,
  1983. const Response &res,
  1984. const std::string &content_type,
  1985. size_t length) const;
  1986. bool apply_static_file_compression(const Request &req, Response &res) const;
  1987. void apply_ranges(const Request &req, Response &res,
  1988. std::string &content_type, std::string &boundary) const;
  1989. bool write_response(Stream &strm, bool close_connection, Request &req,
  1990. Response &res);
  1991. bool write_response_with_content(Stream &strm, bool close_connection,
  1992. const Request &req, Response &res);
  1993. bool write_response_core(Stream &strm, bool close_connection,
  1994. const Request &req, Response &res,
  1995. bool need_apply_ranges);
  1996. bool write_content_with_provider(Stream &strm, const Request &req,
  1997. Response &res, const std::string &boundary,
  1998. const std::string &content_type);
  1999. bool read_content(Stream &strm, Request &req, Response &res);
  2000. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2001. Response &res,
  2002. ContentReceiver receiver,
  2003. FormDataHeader multipart_header,
  2004. ContentReceiver multipart_receiver);
  2005. bool read_content_core(Stream &strm, Request &req, Response &res,
  2006. ContentReceiver receiver,
  2007. FormDataHeader multipart_header,
  2008. ContentReceiver multipart_receiver) const;
  2009. virtual bool process_and_close_socket(socket_t sock);
  2010. void output_log(const Request &req, const Response &res) const;
  2011. void output_pre_compression_log(const Request &req,
  2012. const Response &res) const;
  2013. void output_error_log(const Error &err, const Request *req) const;
  2014. std::atomic<bool> is_running_{false};
  2015. std::atomic<bool> is_decommissioned{false};
  2016. // Set when CustomRoute() refuses a registration. Written before listen(),
  2017. // read by is_valid() on the same thread, so it needs no synchronization.
  2018. bool has_invalid_registration_ = false;
  2019. struct MountPointEntry {
  2020. std::string mount_point;
  2021. std::string base_dir;
  2022. std::string resolved_base_dir;
  2023. Headers headers;
  2024. };
  2025. std::vector<MountPointEntry> base_dirs_;
  2026. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2027. std::string default_file_mimetype_ = "application/octet-stream";
  2028. Handler file_request_handler_;
  2029. Handlers get_handlers_;
  2030. Handlers post_handlers_;
  2031. HandlersForContentReader post_handlers_for_content_reader_;
  2032. Handlers put_handlers_;
  2033. HandlersForContentReader put_handlers_for_content_reader_;
  2034. Handlers patch_handlers_;
  2035. HandlersForContentReader patch_handlers_for_content_reader_;
  2036. Handlers delete_handlers_;
  2037. HandlersForContentReader delete_handlers_for_content_reader_;
  2038. Handlers options_handlers_;
  2039. CustomHandlers custom_handlers_;
  2040. struct WebSocketHandlerEntry {
  2041. std::unique_ptr<detail::MatcherBase> matcher;
  2042. WebSocketHandler handler;
  2043. SubProtocolSelector sub_protocol_selector;
  2044. };
  2045. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2046. WebSocketHandlers websocket_handlers_;
  2047. HandlerWithResponse error_handler_;
  2048. ExceptionHandler exception_handler_;
  2049. HandlerWithResponse pre_routing_handler_;
  2050. Handler post_routing_handler_;
  2051. HandlerWithResponse pre_request_handler_;
  2052. Expect100ContinueHandler expect_100_continue_handler_;
  2053. StartHandler start_handler_;
  2054. mutable std::mutex logger_mutex_;
  2055. Logger logger_;
  2056. Logger pre_compression_logger_;
  2057. ErrorLogger error_logger_;
  2058. int address_family_ = AF_UNSPEC;
  2059. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2060. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2061. SocketOptions socket_options_ = default_socket_options;
  2062. Headers default_headers_;
  2063. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2064. detail::write_headers;
  2065. };
  2066. class Result {
  2067. public:
  2068. Result() = default;
  2069. Result(std::unique_ptr<Response> &&res, Error err,
  2070. Headers &&request_headers = Headers{})
  2071. : res_(std::move(res)), err_(err),
  2072. request_headers_(std::move(request_headers)) {}
  2073. // Response
  2074. operator bool() const { return res_ != nullptr; }
  2075. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2076. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2077. const Response &value() const { return *res_; }
  2078. Response &value() { return *res_; }
  2079. const Response &operator*() const { return *res_; }
  2080. Response &operator*() { return *res_; }
  2081. const Response *operator->() const { return res_.get(); }
  2082. Response *operator->() { return res_.get(); }
  2083. // Error
  2084. Error error() const { return err_; }
  2085. // Request Headers
  2086. bool has_request_header(const std::string &key) const;
  2087. std::string get_request_header_value(const std::string &key,
  2088. const char *def = "",
  2089. size_t id = 0) const;
  2090. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2091. size_t id = 0) const;
  2092. size_t get_request_header_value_count(const std::string &key) const;
  2093. private:
  2094. std::unique_ptr<Response> res_;
  2095. Error err_ = Error::Unknown;
  2096. Headers request_headers_;
  2097. #ifdef CPPHTTPLIB_SSL_ENABLED
  2098. public:
  2099. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2100. int ssl_error)
  2101. : res_(std::move(res)), err_(err),
  2102. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2103. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2104. int ssl_error, uint64_t ssl_backend_error)
  2105. : res_(std::move(res)), err_(err),
  2106. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2107. ssl_backend_error_(ssl_backend_error) {}
  2108. int ssl_error() const { return ssl_error_; }
  2109. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2110. private:
  2111. int ssl_error_ = 0;
  2112. uint64_t ssl_backend_error_ = 0;
  2113. #endif
  2114. };
  2115. struct ClientConnection {
  2116. socket_t sock = INVALID_SOCKET;
  2117. bool is_open() const { return sock != INVALID_SOCKET; }
  2118. ClientConnection() = default;
  2119. ~ClientConnection();
  2120. ClientConnection(const ClientConnection &) = delete;
  2121. ClientConnection &operator=(const ClientConnection &) = delete;
  2122. ClientConnection(ClientConnection &&other) noexcept
  2123. : sock(other.sock)
  2124. #ifdef CPPHTTPLIB_SSL_ENABLED
  2125. ,
  2126. session(other.session)
  2127. #endif
  2128. {
  2129. other.sock = INVALID_SOCKET;
  2130. #ifdef CPPHTTPLIB_SSL_ENABLED
  2131. other.session = nullptr;
  2132. #endif
  2133. }
  2134. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2135. if (this != &other) {
  2136. sock = other.sock;
  2137. other.sock = INVALID_SOCKET;
  2138. #ifdef CPPHTTPLIB_SSL_ENABLED
  2139. session = other.session;
  2140. other.session = nullptr;
  2141. #endif
  2142. }
  2143. return *this;
  2144. }
  2145. #ifdef CPPHTTPLIB_SSL_ENABLED
  2146. tls::session_t session = nullptr;
  2147. #endif
  2148. };
  2149. namespace detail {
  2150. struct ChunkedDecoder;
  2151. struct BodyReader {
  2152. Stream *stream = nullptr;
  2153. bool has_content_length = false;
  2154. size_t content_length = 0;
  2155. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2156. size_t bytes_read = 0;
  2157. bool chunked = false;
  2158. bool eof = false;
  2159. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2160. Error last_error = Error::Success;
  2161. ssize_t read(char *buf, size_t len);
  2162. bool has_error() const { return last_error != Error::Success; }
  2163. };
  2164. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2165. size_t len) {
  2166. (void)stream;
  2167. return br.read(buf, len);
  2168. }
  2169. class decompressor;
  2170. enum class NoProxyKind {
  2171. Wildcard, // "*"
  2172. HostnameSuffix, // "example.com" or ".example.com"
  2173. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2174. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2175. };
  2176. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2177. // Lets one CIDR matcher cover both families.
  2178. using IPBytes = std::array<uint8_t, 16>;
  2179. struct NoProxyEntry {
  2180. NoProxyKind kind = NoProxyKind::Wildcard;
  2181. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2182. IPBytes net{};
  2183. int prefix_bits = 0;
  2184. };
  2185. struct NormalizedTarget {
  2186. std::string hostname; // lowercase; brackets and trailing dot removed
  2187. bool is_ipv4 = false;
  2188. bool is_ipv6 = false;
  2189. IPBytes ip{};
  2190. };
  2191. } // namespace detail
  2192. class ClientImpl {
  2193. public:
  2194. explicit ClientImpl(const std::string &host);
  2195. explicit ClientImpl(const std::string &host, int port);
  2196. explicit ClientImpl(const std::string &host, int port,
  2197. const std::string &client_cert_path,
  2198. const std::string &client_key_path);
  2199. virtual ~ClientImpl();
  2200. virtual bool is_valid() const;
  2201. struct StreamHandle {
  2202. std::unique_ptr<Response> response;
  2203. Error error = Error::Success;
  2204. StreamHandle() = default;
  2205. StreamHandle(const StreamHandle &) = delete;
  2206. StreamHandle &operator=(const StreamHandle &) = delete;
  2207. StreamHandle(StreamHandle &&) = default;
  2208. StreamHandle &operator=(StreamHandle &&) = default;
  2209. ~StreamHandle() = default;
  2210. bool is_valid() const {
  2211. return response != nullptr && error == Error::Success;
  2212. }
  2213. ssize_t read(char *buf, size_t len);
  2214. void parse_trailers_if_needed();
  2215. Error get_read_error() const { return body_reader_.last_error; }
  2216. bool has_read_error() const { return body_reader_.has_error(); }
  2217. bool trailers_parsed_ = false;
  2218. private:
  2219. friend class ClientImpl;
  2220. ssize_t read_with_decompression(char *buf, size_t len);
  2221. std::unique_ptr<ClientConnection> connection_;
  2222. std::unique_ptr<Stream> socket_stream_;
  2223. Stream *stream_ = nullptr;
  2224. detail::BodyReader body_reader_;
  2225. std::unique_ptr<detail::decompressor> decompressor_;
  2226. std::string decompress_buffer_;
  2227. size_t decompress_offset_ = 0;
  2228. size_t decompressed_bytes_read_ = 0;
  2229. };
  2230. // clang-format off
  2231. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2232. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2233. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2234. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2235. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2236. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2237. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2238. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2239. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2240. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2241. Result Head(const std::string &path);
  2242. Result Head(const std::string &path, const Headers &headers);
  2243. Result Post(const std::string &path);
  2244. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2245. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2246. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2247. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2248. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2249. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2250. Result Post(const std::string &path, const Params &params);
  2251. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2252. Result Post(const std::string &path, const Headers &headers);
  2253. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2254. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2255. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2256. 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);
  2257. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2258. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2259. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2260. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2261. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2262. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2263. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2264. Result Put(const std::string &path);
  2265. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2266. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2267. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2268. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2269. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2270. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2271. Result Put(const std::string &path, const Params &params);
  2272. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2273. Result Put(const std::string &path, const Headers &headers);
  2274. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2275. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2276. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2277. 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);
  2278. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2279. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2280. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2281. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2282. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2283. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2284. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2285. Result Patch(const std::string &path);
  2286. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2287. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2288. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2289. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2290. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2292. Result Patch(const std::string &path, const Params &params);
  2293. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2294. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2295. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2296. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2297. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2298. 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);
  2299. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2301. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2302. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2303. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2304. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2305. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2306. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2307. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2308. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2309. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2310. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2311. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2312. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2313. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2314. Result Options(const std::string &path);
  2315. Result Options(const std::string &path, const Headers &headers);
  2316. // clang-format on
  2317. // Streaming API: Open a stream for reading response body incrementally
  2318. // Socket ownership is transferred to StreamHandle for true streaming
  2319. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2320. StreamHandle open_stream(const std::string &method, const std::string &path,
  2321. const Params &params = {},
  2322. const Headers &headers = {},
  2323. const std::string &body = {},
  2324. const std::string &content_type = {});
  2325. bool send(Request &req, Response &res, Error &error);
  2326. Result send(const Request &req);
  2327. void stop();
  2328. std::string host() const;
  2329. int port() const;
  2330. size_t is_socket_open() const;
  2331. socket_t socket() const;
  2332. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2333. void set_default_headers(Headers headers);
  2334. void
  2335. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2336. void set_address_family(int family);
  2337. void set_tcp_nodelay(bool on);
  2338. void set_ipv6_v6only(bool on);
  2339. void set_socket_options(SocketOptions socket_options);
  2340. void set_connection_timeout(time_t sec, time_t usec = 0);
  2341. template <class Rep, class Period>
  2342. void
  2343. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2344. void set_read_timeout(time_t sec, time_t usec = 0);
  2345. template <class Rep, class Period>
  2346. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2347. void set_write_timeout(time_t sec, time_t usec = 0);
  2348. template <class Rep, class Period>
  2349. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2350. void set_max_timeout(time_t msec);
  2351. template <class Rep, class Period>
  2352. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2353. void set_basic_auth(const std::string &username, const std::string &password);
  2354. void set_bearer_token_auth(const std::string &token);
  2355. void set_keep_alive(bool on);
  2356. void set_follow_location(bool on);
  2357. void set_path_encode(bool on);
  2358. void set_compress(bool on);
  2359. void set_decompress(bool on);
  2360. void set_payload_max_length(size_t length);
  2361. void set_interface(const std::string &intf);
  2362. void set_proxy(const std::string &host, int port);
  2363. void set_proxy_basic_auth(const std::string &username,
  2364. const std::string &password);
  2365. void set_proxy_bearer_token_auth(const std::string &token);
  2366. void set_no_proxy(const std::vector<std::string> &patterns);
  2367. void set_logger(Logger logger);
  2368. void set_error_logger(ErrorLogger error_logger);
  2369. protected:
  2370. struct Socket {
  2371. socket_t sock = INVALID_SOCKET;
  2372. // For Mbed TLS compatibility: start_time for request timeout tracking
  2373. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2374. bool is_open() const { return sock != INVALID_SOCKET; }
  2375. #ifdef CPPHTTPLIB_SSL_ENABLED
  2376. tls::session_t ssl = nullptr;
  2377. #endif
  2378. };
  2379. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2380. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2381. virtual bool setup_proxy_connection(
  2382. Socket &socket,
  2383. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2384. Response &res, bool &success, Error &error);
  2385. bool is_proxy_enabled_for_host(const std::string &host) const;
  2386. // All of:
  2387. // shutdown_ssl
  2388. // shutdown_socket
  2389. // close_socket
  2390. // disconnect
  2391. // should ONLY be called when socket_mutex_ is locked, and only when
  2392. // no other thread is using the socket.
  2393. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2394. void shutdown_socket(Socket &socket) const;
  2395. void close_socket(Socket &socket);
  2396. void disconnect(bool gracefully);
  2397. bool process_request(Stream &strm, Request &req, Response &res,
  2398. bool close_connection, Error &error);
  2399. bool write_content_with_provider(Stream &strm, const Request &req,
  2400. Error &error) const;
  2401. void copy_settings(const ClientImpl &rhs);
  2402. void output_log(const Request &req, const Response &res) const;
  2403. void output_error_log(const Error &err, const Request *req) const;
  2404. // Socket endpoint information
  2405. const std::string host_;
  2406. const int port_;
  2407. // Current open socket
  2408. Socket socket_;
  2409. mutable std::mutex socket_mutex_;
  2410. std::recursive_mutex request_mutex_;
  2411. // These are all protected under socket_mutex
  2412. size_t socket_requests_in_flight_ = 0;
  2413. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2414. bool socket_should_be_closed_when_request_is_done_ = false;
  2415. // Hostname to connection target map. The value is an IP literal or another
  2416. // hostname; only the connection target changes, never the identity.
  2417. std::map<std::string, std::string> addr_map_;
  2418. // Default headers
  2419. Headers default_headers_;
  2420. // Header writer
  2421. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2422. detail::write_headers;
  2423. // Settings
  2424. std::string client_cert_path_;
  2425. std::string client_key_path_;
  2426. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2427. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2428. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2429. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2430. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2431. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2432. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2433. std::string basic_auth_username_;
  2434. std::string basic_auth_password_;
  2435. std::string bearer_token_auth_token_;
  2436. bool keep_alive_ = false;
  2437. bool follow_location_ = false;
  2438. bool path_encode_ = true;
  2439. int address_family_ = AF_UNSPEC;
  2440. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2441. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2442. SocketOptions socket_options_ = nullptr;
  2443. bool compress_ = false;
  2444. bool decompress_ = true;
  2445. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2446. bool has_payload_max_length_ = false;
  2447. std::string interface_;
  2448. std::string proxy_host_;
  2449. int proxy_port_ = -1;
  2450. std::string proxy_basic_auth_username_;
  2451. std::string proxy_basic_auth_password_;
  2452. std::string proxy_bearer_token_auth_token_;
  2453. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2454. mutable detail::NormalizedTarget host_normalized_;
  2455. mutable bool host_normalized_valid_ = false;
  2456. mutable std::mutex logger_mutex_;
  2457. Logger logger_;
  2458. ErrorLogger error_logger_;
  2459. private:
  2460. bool send_(Request &req, Response &res, Error &error);
  2461. Result send_(Request &&req);
  2462. socket_t create_client_socket(Error &error) const;
  2463. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2464. bool skip_100_continue = true) const;
  2465. bool write_request(Stream &strm, Request &req, bool close_connection,
  2466. Error &error, bool skip_body = false);
  2467. bool write_request_body(Stream &strm, Request &req, Error &error);
  2468. void prepare_default_headers(Request &r, bool for_stream,
  2469. const std::string &ct);
  2470. bool redirect(Request &req, Response &res, Error &error);
  2471. bool create_redirect_client(const std::string &scheme,
  2472. const std::string &host, int port, Request &req,
  2473. Response &res, const std::string &path,
  2474. const std::string &location, Error &error);
  2475. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2476. bool handle_request(Stream &strm, Request &req, Response &res,
  2477. bool close_connection, Error &error);
  2478. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2479. Request &req, const char *body, size_t content_length,
  2480. ContentProvider content_provider,
  2481. ContentProviderWithoutLength content_provider_without_length,
  2482. const std::string &content_type, ContentReceiver content_receiver,
  2483. Error &error);
  2484. Result send_with_content_provider_and_receiver(
  2485. const std::string &method, const std::string &path,
  2486. const Headers &headers, const char *body, size_t content_length,
  2487. ContentProvider content_provider,
  2488. ContentProviderWithoutLength content_provider_without_length,
  2489. const std::string &content_type, ContentReceiver content_receiver,
  2490. UploadProgress progress);
  2491. ContentProviderWithoutLength get_multipart_content_provider(
  2492. const std::string &boundary, const UploadFormDataItems &items,
  2493. const FormDataProviderItems &provider_items) const;
  2494. virtual bool
  2495. process_socket(const Socket &socket,
  2496. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2497. std::function<bool(Stream &strm)> callback);
  2498. virtual bool is_ssl() const;
  2499. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2500. #ifdef CPPHTTPLIB_SSL_ENABLED
  2501. public:
  2502. void set_digest_auth(const std::string &username,
  2503. const std::string &password);
  2504. void set_proxy_digest_auth(const std::string &username,
  2505. const std::string &password);
  2506. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2507. const std::string &ca_cert_dir_path = std::string());
  2508. void enable_server_certificate_verification(bool enabled);
  2509. void enable_server_hostname_verification(bool enabled);
  2510. void enable_system_ca(bool enabled);
  2511. protected:
  2512. std::string digest_auth_username_;
  2513. std::string digest_auth_password_;
  2514. std::string proxy_digest_auth_username_;
  2515. std::string proxy_digest_auth_password_;
  2516. std::string ca_cert_file_path_;
  2517. std::string ca_cert_dir_path_;
  2518. bool server_certificate_verification_ = true;
  2519. bool server_hostname_verification_ = true;
  2520. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2521. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2522. int last_ssl_error_ = 0;
  2523. uint64_t last_backend_error_ = 0;
  2524. #endif
  2525. };
  2526. class Client {
  2527. public:
  2528. // Universal interface
  2529. explicit Client(const std::string &scheme_host_port);
  2530. explicit Client(const std::string &scheme_host_port,
  2531. const std::string &client_cert_path,
  2532. const std::string &client_key_path);
  2533. // HTTP only interface
  2534. explicit Client(const std::string &host, int port);
  2535. explicit Client(const std::string &host, int port,
  2536. const std::string &client_cert_path,
  2537. const std::string &client_key_path);
  2538. Client(Client &&) = default;
  2539. Client &operator=(Client &&) = default;
  2540. ~Client();
  2541. bool is_valid() const;
  2542. // clang-format off
  2543. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2544. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2545. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2546. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2547. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2548. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2549. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2550. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2551. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2552. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2553. Result Head(const std::string &path);
  2554. Result Head(const std::string &path, const Headers &headers);
  2555. Result Post(const std::string &path);
  2556. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2557. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2558. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2559. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2560. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2561. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2562. Result Post(const std::string &path, const Params &params);
  2563. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2564. Result Post(const std::string &path, const Headers &headers);
  2565. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2566. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2567. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2568. 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);
  2569. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2570. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2571. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2572. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2573. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2574. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2575. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2576. Result Put(const std::string &path);
  2577. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2578. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2579. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2580. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2581. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2582. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2583. Result Put(const std::string &path, const Params &params);
  2584. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2585. Result Put(const std::string &path, const Headers &headers);
  2586. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2587. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2588. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2589. 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);
  2590. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2591. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2592. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2593. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2594. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2595. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2596. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2597. Result Patch(const std::string &path);
  2598. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2599. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2600. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2601. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2602. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2604. Result Patch(const std::string &path, const Params &params);
  2605. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2606. Result Patch(const std::string &path, const Headers &headers);
  2607. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2608. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2609. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2610. 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);
  2611. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2613. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2614. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2615. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2616. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2617. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2618. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2619. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2620. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2621. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2622. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2623. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2624. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2625. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2626. Result Options(const std::string &path);
  2627. Result Options(const std::string &path, const Headers &headers);
  2628. // clang-format on
  2629. // Streaming API: Open a stream for reading response body incrementally
  2630. // Socket ownership is transferred to StreamHandle for true streaming
  2631. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2632. ClientImpl::StreamHandle open_stream(const std::string &method,
  2633. const std::string &path,
  2634. const Params &params = {},
  2635. const Headers &headers = {},
  2636. const std::string &body = {},
  2637. const std::string &content_type = {});
  2638. bool send(Request &req, Response &res, Error &error);
  2639. Result send(const Request &req);
  2640. void stop();
  2641. std::string host() const;
  2642. int port() const;
  2643. size_t is_socket_open() const;
  2644. socket_t socket() const;
  2645. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2646. void set_default_headers(Headers headers);
  2647. void
  2648. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2649. void set_address_family(int family);
  2650. void set_tcp_nodelay(bool on);
  2651. void set_socket_options(SocketOptions socket_options);
  2652. void set_connection_timeout(time_t sec, time_t usec = 0);
  2653. template <class Rep, class Period>
  2654. void
  2655. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2656. void set_read_timeout(time_t sec, time_t usec = 0);
  2657. template <class Rep, class Period>
  2658. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2659. void set_write_timeout(time_t sec, time_t usec = 0);
  2660. template <class Rep, class Period>
  2661. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2662. void set_max_timeout(time_t msec);
  2663. template <class Rep, class Period>
  2664. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2665. void set_basic_auth(const std::string &username, const std::string &password);
  2666. void set_bearer_token_auth(const std::string &token);
  2667. void set_keep_alive(bool on);
  2668. void set_follow_location(bool on);
  2669. void set_path_encode(bool on);
  2670. void set_compress(bool on);
  2671. void set_decompress(bool on);
  2672. void set_payload_max_length(size_t length);
  2673. void set_interface(const std::string &intf);
  2674. void set_proxy(const std::string &host, int port);
  2675. void set_proxy_basic_auth(const std::string &username,
  2676. const std::string &password);
  2677. void set_proxy_bearer_token_auth(const std::string &token);
  2678. void set_no_proxy(const std::vector<std::string> &patterns);
  2679. void set_logger(Logger logger);
  2680. void set_error_logger(ErrorLogger error_logger);
  2681. private:
  2682. std::unique_ptr<ClientImpl> cli_;
  2683. #ifdef CPPHTTPLIB_SSL_ENABLED
  2684. public:
  2685. void set_digest_auth(const std::string &username,
  2686. const std::string &password);
  2687. void set_proxy_digest_auth(const std::string &username,
  2688. const std::string &password);
  2689. void enable_server_certificate_verification(bool enabled);
  2690. void enable_server_hostname_verification(bool enabled);
  2691. void enable_system_ca(bool enabled);
  2692. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2693. const std::string &ca_cert_dir_path = std::string());
  2694. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2695. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2696. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2697. void set_session_verifier(
  2698. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2699. tls::ctx_t tls_context() const;
  2700. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2701. void enable_windows_certificate_verification(bool enabled);
  2702. #endif
  2703. private:
  2704. bool is_ssl_ = false;
  2705. #endif
  2706. };
  2707. #ifdef CPPHTTPLIB_SSL_ENABLED
  2708. class SSLServer : public Server {
  2709. public:
  2710. SSLServer(const char *cert_path, const char *private_key_path,
  2711. const char *client_ca_cert_file_path = nullptr,
  2712. const char *client_ca_cert_dir_path = nullptr,
  2713. const char *private_key_password = nullptr);
  2714. struct PemMemory {
  2715. const char *cert_pem;
  2716. size_t cert_pem_len;
  2717. const char *key_pem;
  2718. size_t key_pem_len;
  2719. const char *client_ca_pem;
  2720. size_t client_ca_pem_len;
  2721. const char *private_key_password;
  2722. };
  2723. explicit SSLServer(const PemMemory &pem);
  2724. // The callback receives the ctx_t handle which can be cast to the
  2725. // appropriate backend type (SSL_CTX* for OpenSSL,
  2726. // tls::impl::MbedTlsContext* for Mbed TLS)
  2727. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2728. ~SSLServer() override;
  2729. bool is_valid() const override;
  2730. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2731. const char *client_ca_pem = nullptr,
  2732. const char *password = nullptr);
  2733. tls::ctx_t tls_context() const { return ctx_; }
  2734. int ssl_last_error() const { return last_ssl_error_; }
  2735. private:
  2736. bool process_and_close_socket(socket_t sock) override;
  2737. tls::ctx_t ctx_ = nullptr;
  2738. std::mutex ctx_mutex_;
  2739. int last_ssl_error_ = 0;
  2740. };
  2741. class SSLClient final : public ClientImpl {
  2742. public:
  2743. explicit SSLClient(const std::string &host);
  2744. explicit SSLClient(const std::string &host, int port);
  2745. explicit SSLClient(const std::string &host, int port,
  2746. const std::string &client_cert_path,
  2747. const std::string &client_key_path,
  2748. const std::string &private_key_password = std::string());
  2749. struct PemMemory {
  2750. const char *cert_pem;
  2751. size_t cert_pem_len;
  2752. const char *key_pem;
  2753. size_t key_pem_len;
  2754. const char *private_key_password;
  2755. };
  2756. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2757. ~SSLClient() override;
  2758. bool is_valid() const override;
  2759. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2760. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2761. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2762. // Post-handshake session verifier (backend-independent)
  2763. void set_session_verifier(
  2764. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2765. tls::ctx_t tls_context() const { return ctx_; }
  2766. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2767. void enable_windows_certificate_verification(bool enabled);
  2768. #endif
  2769. private:
  2770. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2771. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2772. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2773. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2774. bool
  2775. process_socket(const Socket &socket,
  2776. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2777. std::function<bool(Stream &strm)> callback) override;
  2778. bool is_ssl() const override;
  2779. bool setup_proxy_connection(
  2780. Socket &socket,
  2781. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2782. Response &res, bool &success, Error &error) override;
  2783. bool connect_with_proxy(
  2784. Socket &sock,
  2785. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2786. Response &res, bool &success, Error &error);
  2787. bool initialize_ssl(Socket &socket, Error &error);
  2788. void init_ctx();
  2789. void reset_ctx_on_error();
  2790. bool load_certs();
  2791. tls::ctx_t ctx_ = nullptr;
  2792. std::mutex ctx_mutex_;
  2793. std::once_flag initialize_cert_;
  2794. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2795. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2796. // Used to keep custom CA configuration exclusive with system CA loading.
  2797. bool ca_cert_store_set_ = false;
  2798. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2799. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2800. bool enable_windows_cert_verification_ = true;
  2801. #endif
  2802. friend class ClientImpl;
  2803. };
  2804. #endif // CPPHTTPLIB_SSL_ENABLED
  2805. namespace detail {
  2806. template <typename T, typename U>
  2807. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2808. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2809. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2810. duration - std::chrono::seconds(sec))
  2811. .count();
  2812. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2813. }
  2814. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2815. return N - 1;
  2816. }
  2817. inline bool is_numeric(const std::string &str) {
  2818. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2819. }
  2820. inline size_t get_header_value_u64(const Headers &headers,
  2821. const std::string &key, size_t def,
  2822. size_t id, bool &is_invalid_value) {
  2823. is_invalid_value = false;
  2824. auto rng = headers.equal_range(key);
  2825. auto it = rng.first;
  2826. std::advance(it, static_cast<ssize_t>(id));
  2827. if (it != rng.second) {
  2828. if (is_numeric(it->second)) {
  2829. // Parse at size_t width so an out-of-range Content-Length is reported
  2830. // rather than silently saturated/truncated (a value above 2^32 would
  2831. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2832. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2833. size_t val = 0;
  2834. const auto &s = it->second;
  2835. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2836. if (r.ec == std::errc::result_out_of_range) {
  2837. is_invalid_value = true;
  2838. return (std::numeric_limits<size_t>::max)();
  2839. }
  2840. return val;
  2841. } else {
  2842. is_invalid_value = true;
  2843. }
  2844. }
  2845. return def;
  2846. }
  2847. inline size_t get_header_value_u64(const Headers &headers,
  2848. const std::string &key, size_t def,
  2849. size_t id) {
  2850. auto dummy = false;
  2851. return get_header_value_u64(headers, key, def, id, dummy);
  2852. }
  2853. } // namespace detail
  2854. template <class Rep, class Period>
  2855. inline Server &
  2856. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2857. detail::duration_to_sec_and_usec(
  2858. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2859. return *this;
  2860. }
  2861. template <class Rep, class Period>
  2862. inline Server &
  2863. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2864. detail::duration_to_sec_and_usec(
  2865. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2866. return *this;
  2867. }
  2868. template <class Rep, class Period>
  2869. inline Server &
  2870. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2871. detail::duration_to_sec_and_usec(
  2872. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2873. return *this;
  2874. }
  2875. template <class Rep, class Period>
  2876. inline void ClientImpl::set_connection_timeout(
  2877. const std::chrono::duration<Rep, Period> &duration) {
  2878. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2879. set_connection_timeout(sec, usec);
  2880. });
  2881. }
  2882. template <class Rep, class Period>
  2883. inline void ClientImpl::set_read_timeout(
  2884. const std::chrono::duration<Rep, Period> &duration) {
  2885. detail::duration_to_sec_and_usec(
  2886. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2887. }
  2888. template <class Rep, class Period>
  2889. inline void ClientImpl::set_write_timeout(
  2890. const std::chrono::duration<Rep, Period> &duration) {
  2891. detail::duration_to_sec_and_usec(
  2892. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2893. }
  2894. template <class Rep, class Period>
  2895. inline void ClientImpl::set_max_timeout(
  2896. const std::chrono::duration<Rep, Period> &duration) {
  2897. auto msec =
  2898. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2899. set_max_timeout(msec);
  2900. }
  2901. template <class Rep, class Period>
  2902. inline void Client::set_connection_timeout(
  2903. const std::chrono::duration<Rep, Period> &duration) {
  2904. cli_->set_connection_timeout(duration);
  2905. }
  2906. template <class Rep, class Period>
  2907. inline void
  2908. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2909. cli_->set_read_timeout(duration);
  2910. }
  2911. template <class Rep, class Period>
  2912. inline void
  2913. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2914. cli_->set_write_timeout(duration);
  2915. }
  2916. inline void Client::set_max_timeout(time_t msec) {
  2917. cli_->set_max_timeout(msec);
  2918. }
  2919. template <class Rep, class Period>
  2920. inline void
  2921. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2922. cli_->set_max_timeout(duration);
  2923. }
  2924. /*
  2925. * Forward declarations and types that will be part of the .h file if split into
  2926. * .h + .cc.
  2927. */
  2928. std::string hosted_at(const std::string &hostname);
  2929. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2930. // JavaScript-style URL encoding/decoding functions
  2931. std::string encode_uri_component(const std::string &value);
  2932. std::string encode_uri(const std::string &value);
  2933. std::string decode_uri_component(const std::string &value);
  2934. std::string decode_uri(const std::string &value);
  2935. // RFC 3986 compliant URL component encoding/decoding functions
  2936. std::string encode_path_component(const std::string &component);
  2937. std::string decode_path_component(const std::string &component);
  2938. std::string encode_query_component(const std::string &component,
  2939. bool space_as_plus = true);
  2940. std::string decode_query_component(const std::string &component,
  2941. bool plus_as_space = true);
  2942. std::string sanitize_filename(const std::string &filename);
  2943. std::string append_query_params(const std::string &path, const Params &params);
  2944. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2945. std::pair<std::string, std::string>
  2946. make_basic_authentication_header(const std::string &username,
  2947. const std::string &password,
  2948. bool is_proxy = false);
  2949. namespace detail {
  2950. #if defined(_WIN32)
  2951. inline std::wstring u8string_to_wstring(const char *s) {
  2952. if (!s) { return std::wstring(); }
  2953. auto len = static_cast<int>(strlen(s));
  2954. if (!len) { return std::wstring(); }
  2955. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2956. if (!wlen) { return std::wstring(); }
  2957. std::wstring ws;
  2958. ws.resize(wlen);
  2959. wlen = ::MultiByteToWideChar(
  2960. CP_UTF8, 0, s, len,
  2961. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  2962. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  2963. return ws;
  2964. }
  2965. #endif
  2966. struct FileStat {
  2967. FileStat(const std::string &path);
  2968. bool is_file() const;
  2969. bool is_dir() const;
  2970. time_t mtime() const;
  2971. size_t size() const;
  2972. private:
  2973. #if defined(_WIN32)
  2974. struct _stat st_;
  2975. #else
  2976. struct stat st_;
  2977. #endif
  2978. int ret_ = -1;
  2979. };
  2980. std::string make_host_and_port_string(const std::string &host, int port,
  2981. bool is_ssl);
  2982. template <typename T>
  2983. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  2984. Error &error);
  2985. std::string trim_copy(const std::string &s);
  2986. void divide(
  2987. const char *data, std::size_t size, char d,
  2988. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2989. fn);
  2990. void divide(
  2991. const std::string &str, char d,
  2992. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2993. fn);
  2994. void split(const char *b, const char *e, char d,
  2995. std::function<void(const char *, const char *)> fn);
  2996. void split(const char *b, const char *e, char d, size_t m,
  2997. std::function<void(const char *, const char *)> fn);
  2998. bool split_find(const char *b, const char *e, char d,
  2999. std::function<bool(const char *, const char *)> fn);
  3000. bool has_header_token(const Headers &headers, const std::string &key,
  3001. const std::string &token);
  3002. std::string websocket_accept_key(const std::string &client_key);
  3003. bool is_websocket_upgrade(const Request &req);
  3004. bool process_client_socket(
  3005. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3006. time_t write_timeout_sec, time_t write_timeout_usec,
  3007. time_t max_timeout_msec,
  3008. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3009. std::function<bool(Stream &)> callback);
  3010. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3011. int port, int address_family, bool tcp_nodelay,
  3012. bool ipv6_v6only, SocketOptions socket_options,
  3013. time_t connection_timeout_sec,
  3014. time_t connection_timeout_usec,
  3015. time_t read_timeout_sec, time_t read_timeout_usec,
  3016. time_t write_timeout_sec,
  3017. time_t write_timeout_usec,
  3018. const std::string &intf, Error &error);
  3019. const char *get_header_value(const Headers &headers, const std::string &key,
  3020. const char *def, size_t id);
  3021. std::string get_combined_header_value(const Headers &headers,
  3022. const std::string &key);
  3023. std::string params_to_query_str(const Params &params);
  3024. void parse_query_text(const char *data, std::size_t size, Params &params);
  3025. void parse_query_text(const std::string &s, Params &params);
  3026. bool parse_multipart_boundary(const std::string &content_type,
  3027. std::string &boundary);
  3028. bool parse_range_header(const std::string &s, Ranges &ranges);
  3029. bool parse_accept_header(const std::string &s,
  3030. std::vector<std::string> &content_types);
  3031. void parse_disposition_params(const std::string &s, Params &params);
  3032. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3033. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3034. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3035. EncodingType encoding_type(const Request &req, const Response &res,
  3036. const std::string &content_type);
  3037. EncodingType encoding_type(const Request &req, const Response &res);
  3038. class BufferStream final : public Stream {
  3039. public:
  3040. BufferStream() = default;
  3041. ~BufferStream() override = default;
  3042. bool is_readable() const override;
  3043. bool wait_readable() const override;
  3044. bool wait_writable() const override;
  3045. ssize_t read(char *ptr, size_t size) override;
  3046. ssize_t write(const char *ptr, size_t size) override;
  3047. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3048. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3049. socket_t socket() const override;
  3050. time_t duration() const override;
  3051. const std::string &get_buffer() const;
  3052. private:
  3053. std::string buffer;
  3054. size_t position = 0;
  3055. };
  3056. class compressor {
  3057. public:
  3058. virtual ~compressor() = default;
  3059. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3060. virtual bool compress(const char *data, size_t data_length, bool last,
  3061. Callback callback) = 0;
  3062. };
  3063. class decompressor {
  3064. public:
  3065. virtual ~decompressor() = default;
  3066. virtual bool is_valid() const = 0;
  3067. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3068. virtual bool decompress(const char *data, size_t data_length,
  3069. Callback callback) = 0;
  3070. };
  3071. class nocompressor final : public compressor {
  3072. public:
  3073. ~nocompressor() override = default;
  3074. bool compress(const char *data, size_t data_length, bool /*last*/,
  3075. Callback callback) override;
  3076. };
  3077. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3078. class gzip_compressor final : public compressor {
  3079. public:
  3080. gzip_compressor();
  3081. ~gzip_compressor() override;
  3082. bool compress(const char *data, size_t data_length, bool last,
  3083. Callback callback) override;
  3084. private:
  3085. bool is_valid_ = false;
  3086. z_stream strm_;
  3087. };
  3088. class gzip_decompressor final : public decompressor {
  3089. public:
  3090. gzip_decompressor();
  3091. ~gzip_decompressor() override;
  3092. bool is_valid() const override;
  3093. bool decompress(const char *data, size_t data_length,
  3094. Callback callback) override;
  3095. private:
  3096. bool is_valid_ = false;
  3097. z_stream strm_;
  3098. };
  3099. #endif
  3100. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3101. class brotli_compressor final : public compressor {
  3102. public:
  3103. brotli_compressor();
  3104. ~brotli_compressor();
  3105. bool compress(const char *data, size_t data_length, bool last,
  3106. Callback callback) override;
  3107. private:
  3108. BrotliEncoderState *state_ = nullptr;
  3109. };
  3110. class brotli_decompressor final : public decompressor {
  3111. public:
  3112. brotli_decompressor();
  3113. ~brotli_decompressor();
  3114. bool is_valid() const override;
  3115. bool decompress(const char *data, size_t data_length,
  3116. Callback callback) override;
  3117. private:
  3118. BrotliDecoderResult decoder_r;
  3119. BrotliDecoderState *decoder_s = nullptr;
  3120. };
  3121. #endif
  3122. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3123. class zstd_compressor : public compressor {
  3124. public:
  3125. zstd_compressor();
  3126. ~zstd_compressor();
  3127. bool compress(const char *data, size_t data_length, bool last,
  3128. Callback callback) override;
  3129. private:
  3130. ZSTD_CCtx *ctx_ = nullptr;
  3131. };
  3132. class zstd_decompressor : public decompressor {
  3133. public:
  3134. zstd_decompressor();
  3135. ~zstd_decompressor();
  3136. bool is_valid() const override;
  3137. bool decompress(const char *data, size_t data_length,
  3138. Callback callback) override;
  3139. private:
  3140. ZSTD_DCtx *ctx_ = nullptr;
  3141. };
  3142. #endif
  3143. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3144. // to store data. The call can set memory on stack for performance.
  3145. class stream_line_reader {
  3146. public:
  3147. stream_line_reader(Stream &strm, char *fixed_buffer,
  3148. size_t fixed_buffer_size);
  3149. const char *ptr() const;
  3150. size_t size() const;
  3151. bool end_with_crlf() const;
  3152. bool getline();
  3153. private:
  3154. void append(char c);
  3155. void append(const char *data, size_t size);
  3156. Stream &strm_;
  3157. char *fixed_buffer_;
  3158. const size_t fixed_buffer_size_;
  3159. size_t fixed_buffer_used_size_ = 0;
  3160. std::string growable_buffer_;
  3161. };
  3162. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3163. const Headers &src_headers);
  3164. struct ChunkedDecoder {
  3165. Stream &strm;
  3166. size_t chunk_remaining = 0;
  3167. bool finished = false;
  3168. char line_buf[64];
  3169. size_t last_chunk_total = 0;
  3170. size_t last_chunk_offset = 0;
  3171. explicit ChunkedDecoder(Stream &s);
  3172. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3173. size_t &out_chunk_total);
  3174. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3175. };
  3176. class mmap {
  3177. public:
  3178. mmap(const char *path);
  3179. ~mmap();
  3180. bool open(const char *path);
  3181. void close();
  3182. bool is_open() const;
  3183. size_t size() const;
  3184. const char *data() const;
  3185. private:
  3186. #if defined(_WIN32)
  3187. HANDLE hFile_ = NULL;
  3188. HANDLE hMapping_ = NULL;
  3189. #else
  3190. int fd_ = -1;
  3191. #endif
  3192. size_t size_ = 0;
  3193. void *addr_ = nullptr;
  3194. bool is_open_empty_file = false;
  3195. };
  3196. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3197. namespace fields {
  3198. bool is_token_char(char c);
  3199. bool is_token(const std::string &s);
  3200. bool is_field_name(const std::string &s);
  3201. bool is_vchar(char c);
  3202. bool is_obs_text(char c);
  3203. bool is_field_vchar(char c);
  3204. bool is_field_content(const std::string &s);
  3205. bool is_field_value(const std::string &s);
  3206. bool is_field_valid(const std::string &name, const std::string &value);
  3207. } // namespace fields
  3208. } // namespace detail
  3209. /*
  3210. * TLS Abstraction Layer Declarations
  3211. */
  3212. #ifdef CPPHTTPLIB_SSL_ENABLED
  3213. // TLS abstraction layer - backend-specific type declarations
  3214. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3215. namespace tls {
  3216. namespace impl {
  3217. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3218. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3219. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3220. struct MbedTlsContext {
  3221. mbedtls_ssl_config conf;
  3222. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3223. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3224. mbedtls_entropy_context entropy;
  3225. mbedtls_ctr_drbg_context ctr_drbg;
  3226. #endif
  3227. mbedtls_x509_crt ca_chain;
  3228. mbedtls_x509_crt own_cert;
  3229. mbedtls_pk_context own_key;
  3230. bool is_server = false;
  3231. bool verify_client = false;
  3232. bool has_verify_callback = false;
  3233. MbedTlsContext();
  3234. ~MbedTlsContext();
  3235. MbedTlsContext(const MbedTlsContext &) = delete;
  3236. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3237. };
  3238. } // namespace impl
  3239. } // namespace tls
  3240. #endif
  3241. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3242. namespace tls {
  3243. namespace impl {
  3244. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3245. // This struct is accessible via tls::impl for use in SSL context
  3246. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3247. struct WolfSSLContext {
  3248. WOLFSSL_CTX *ctx = nullptr;
  3249. bool is_server = false;
  3250. bool verify_client = false;
  3251. bool has_verify_callback = false;
  3252. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3253. WolfSSLContext();
  3254. ~WolfSSLContext();
  3255. WolfSSLContext(const WolfSSLContext &) = delete;
  3256. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3257. };
  3258. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3259. struct WolfSSLCAStore {
  3260. std::string pem_data;
  3261. };
  3262. } // namespace impl
  3263. } // namespace tls
  3264. #endif
  3265. #endif // CPPHTTPLIB_SSL_ENABLED
  3266. namespace stream {
  3267. class Result {
  3268. public:
  3269. Result();
  3270. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3271. Result(Result &&other) noexcept;
  3272. Result &operator=(Result &&other) noexcept;
  3273. Result(const Result &) = delete;
  3274. Result &operator=(const Result &) = delete;
  3275. // Response info
  3276. bool is_valid() const;
  3277. explicit operator bool() const;
  3278. int status() const;
  3279. const Headers &headers() const;
  3280. std::string get_header_value(const std::string &key,
  3281. const char *def = "") const;
  3282. bool has_header(const std::string &key) const;
  3283. Error error() const;
  3284. Error read_error() const;
  3285. bool has_read_error() const;
  3286. // Stream reading
  3287. bool next();
  3288. const char *data() const;
  3289. size_t size() const;
  3290. std::string read_all();
  3291. private:
  3292. ClientImpl::StreamHandle handle_;
  3293. std::string buffer_;
  3294. size_t current_size_ = 0;
  3295. size_t chunk_size_;
  3296. bool finished_ = false;
  3297. };
  3298. // GET
  3299. template <typename ClientType>
  3300. inline Result Get(ClientType &cli, const std::string &path,
  3301. size_t chunk_size = 8192) {
  3302. return Result{cli.open_stream("GET", path), chunk_size};
  3303. }
  3304. template <typename ClientType>
  3305. inline Result Get(ClientType &cli, const std::string &path,
  3306. const Headers &headers, size_t chunk_size = 8192) {
  3307. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3308. }
  3309. template <typename ClientType>
  3310. inline Result Get(ClientType &cli, const std::string &path,
  3311. const Params &params, size_t chunk_size = 8192) {
  3312. return Result{cli.open_stream("GET", path, params), chunk_size};
  3313. }
  3314. template <typename ClientType>
  3315. inline Result Get(ClientType &cli, const std::string &path,
  3316. const Params &params, const Headers &headers,
  3317. size_t chunk_size = 8192) {
  3318. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3319. }
  3320. // POST
  3321. template <typename ClientType>
  3322. inline Result Post(ClientType &cli, const std::string &path,
  3323. const std::string &body, const std::string &content_type,
  3324. size_t chunk_size = 8192) {
  3325. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3326. chunk_size};
  3327. }
  3328. template <typename ClientType>
  3329. inline Result Post(ClientType &cli, const std::string &path,
  3330. const Headers &headers, const std::string &body,
  3331. const std::string &content_type, size_t chunk_size = 8192) {
  3332. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3333. chunk_size};
  3334. }
  3335. template <typename ClientType>
  3336. inline Result Post(ClientType &cli, const std::string &path,
  3337. const Params &params, const std::string &body,
  3338. const std::string &content_type, size_t chunk_size = 8192) {
  3339. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3340. chunk_size};
  3341. }
  3342. template <typename ClientType>
  3343. inline Result Post(ClientType &cli, const std::string &path,
  3344. const Params &params, const Headers &headers,
  3345. const std::string &body, const std::string &content_type,
  3346. size_t chunk_size = 8192) {
  3347. return Result{
  3348. cli.open_stream("POST", path, params, headers, body, content_type),
  3349. chunk_size};
  3350. }
  3351. // PUT
  3352. template <typename ClientType>
  3353. inline Result Put(ClientType &cli, const std::string &path,
  3354. const std::string &body, const std::string &content_type,
  3355. size_t chunk_size = 8192) {
  3356. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3357. chunk_size};
  3358. }
  3359. template <typename ClientType>
  3360. inline Result Put(ClientType &cli, const std::string &path,
  3361. const Headers &headers, const std::string &body,
  3362. const std::string &content_type, size_t chunk_size = 8192) {
  3363. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3364. chunk_size};
  3365. }
  3366. template <typename ClientType>
  3367. inline Result Put(ClientType &cli, const std::string &path,
  3368. const Params &params, const std::string &body,
  3369. const std::string &content_type, size_t chunk_size = 8192) {
  3370. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3371. chunk_size};
  3372. }
  3373. template <typename ClientType>
  3374. inline Result Put(ClientType &cli, const std::string &path,
  3375. const Params &params, const Headers &headers,
  3376. const std::string &body, const std::string &content_type,
  3377. size_t chunk_size = 8192) {
  3378. return Result{
  3379. cli.open_stream("PUT", path, params, headers, body, content_type),
  3380. chunk_size};
  3381. }
  3382. // PATCH
  3383. template <typename ClientType>
  3384. inline Result Patch(ClientType &cli, const std::string &path,
  3385. const std::string &body, const std::string &content_type,
  3386. size_t chunk_size = 8192) {
  3387. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3388. chunk_size};
  3389. }
  3390. template <typename ClientType>
  3391. inline Result Patch(ClientType &cli, const std::string &path,
  3392. const Headers &headers, const std::string &body,
  3393. const std::string &content_type, size_t chunk_size = 8192) {
  3394. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3395. chunk_size};
  3396. }
  3397. template <typename ClientType>
  3398. inline Result Patch(ClientType &cli, const std::string &path,
  3399. const Params &params, const std::string &body,
  3400. const std::string &content_type, size_t chunk_size = 8192) {
  3401. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3402. chunk_size};
  3403. }
  3404. template <typename ClientType>
  3405. inline Result Patch(ClientType &cli, const std::string &path,
  3406. const Params &params, const Headers &headers,
  3407. const std::string &body, const std::string &content_type,
  3408. size_t chunk_size = 8192) {
  3409. return Result{
  3410. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3411. chunk_size};
  3412. }
  3413. // DELETE
  3414. template <typename ClientType>
  3415. inline Result Delete(ClientType &cli, const std::string &path,
  3416. size_t chunk_size = 8192) {
  3417. return Result{cli.open_stream("DELETE", path), chunk_size};
  3418. }
  3419. template <typename ClientType>
  3420. inline Result Delete(ClientType &cli, const std::string &path,
  3421. const Headers &headers, size_t chunk_size = 8192) {
  3422. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3423. }
  3424. template <typename ClientType>
  3425. inline Result Delete(ClientType &cli, const std::string &path,
  3426. const std::string &body, const std::string &content_type,
  3427. size_t chunk_size = 8192) {
  3428. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3429. chunk_size};
  3430. }
  3431. template <typename ClientType>
  3432. inline Result Delete(ClientType &cli, const std::string &path,
  3433. const Headers &headers, const std::string &body,
  3434. const std::string &content_type,
  3435. size_t chunk_size = 8192) {
  3436. return Result{
  3437. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3438. chunk_size};
  3439. }
  3440. template <typename ClientType>
  3441. inline Result Delete(ClientType &cli, const std::string &path,
  3442. const Params &params, size_t chunk_size = 8192) {
  3443. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3444. }
  3445. template <typename ClientType>
  3446. inline Result Delete(ClientType &cli, const std::string &path,
  3447. const Params &params, const Headers &headers,
  3448. size_t chunk_size = 8192) {
  3449. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3450. }
  3451. template <typename ClientType>
  3452. inline Result Delete(ClientType &cli, const std::string &path,
  3453. const Params &params, const std::string &body,
  3454. const std::string &content_type,
  3455. size_t chunk_size = 8192) {
  3456. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3457. chunk_size};
  3458. }
  3459. template <typename ClientType>
  3460. inline Result Delete(ClientType &cli, const std::string &path,
  3461. const Params &params, const Headers &headers,
  3462. const std::string &body, const std::string &content_type,
  3463. size_t chunk_size = 8192) {
  3464. return Result{
  3465. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3466. chunk_size};
  3467. }
  3468. // HEAD
  3469. template <typename ClientType>
  3470. inline Result Head(ClientType &cli, const std::string &path,
  3471. size_t chunk_size = 8192) {
  3472. return Result{cli.open_stream("HEAD", path), chunk_size};
  3473. }
  3474. template <typename ClientType>
  3475. inline Result Head(ClientType &cli, const std::string &path,
  3476. const Headers &headers, size_t chunk_size = 8192) {
  3477. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3478. }
  3479. template <typename ClientType>
  3480. inline Result Head(ClientType &cli, const std::string &path,
  3481. const Params &params, size_t chunk_size = 8192) {
  3482. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3483. }
  3484. template <typename ClientType>
  3485. inline Result Head(ClientType &cli, const std::string &path,
  3486. const Params &params, const Headers &headers,
  3487. size_t chunk_size = 8192) {
  3488. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3489. }
  3490. // OPTIONS
  3491. template <typename ClientType>
  3492. inline Result Options(ClientType &cli, const std::string &path,
  3493. size_t chunk_size = 8192) {
  3494. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3495. }
  3496. template <typename ClientType>
  3497. inline Result Options(ClientType &cli, const std::string &path,
  3498. const Headers &headers, size_t chunk_size = 8192) {
  3499. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3500. }
  3501. template <typename ClientType>
  3502. inline Result Options(ClientType &cli, const std::string &path,
  3503. const Params &params, size_t chunk_size = 8192) {
  3504. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3505. }
  3506. template <typename ClientType>
  3507. inline Result Options(ClientType &cli, const std::string &path,
  3508. const Params &params, const Headers &headers,
  3509. size_t chunk_size = 8192) {
  3510. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3511. }
  3512. } // namespace stream
  3513. namespace sse {
  3514. struct SSEMessage {
  3515. std::string event; // Event type (default: "message")
  3516. std::string data; // Event payload
  3517. std::string id; // Event ID for Last-Event-ID header
  3518. SSEMessage();
  3519. void clear();
  3520. };
  3521. class SSEClient {
  3522. public:
  3523. using MessageHandler = std::function<void(const SSEMessage &)>;
  3524. using ErrorHandler = std::function<void(Error)>;
  3525. using OpenHandler = std::function<void()>;
  3526. SSEClient(Client &client, const std::string &path);
  3527. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3528. ~SSEClient();
  3529. SSEClient(const SSEClient &) = delete;
  3530. SSEClient &operator=(const SSEClient &) = delete;
  3531. // Event handlers
  3532. SSEClient &on_message(MessageHandler handler);
  3533. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3534. SSEClient &on_open(OpenHandler handler);
  3535. SSEClient &on_error(ErrorHandler handler);
  3536. SSEClient &set_reconnect_interval(int ms);
  3537. SSEClient &set_max_reconnect_attempts(int n);
  3538. // Update headers (thread-safe)
  3539. SSEClient &set_headers(const Headers &headers);
  3540. // State accessors
  3541. bool is_connected() const;
  3542. const std::string &last_event_id() const;
  3543. // Blocking start - runs event loop with auto-reconnect
  3544. void start();
  3545. // Non-blocking start - runs in background thread
  3546. void start_async();
  3547. // Stop the client (thread-safe)
  3548. void stop();
  3549. private:
  3550. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3551. void run_event_loop();
  3552. void dispatch_event(const SSEMessage &msg);
  3553. bool should_reconnect(int count) const;
  3554. void wait_for_reconnect();
  3555. // Client and path
  3556. Client &client_;
  3557. std::string path_;
  3558. Headers headers_;
  3559. mutable std::mutex headers_mutex_;
  3560. // Callbacks
  3561. MessageHandler on_message_;
  3562. std::map<std::string, MessageHandler> event_handlers_;
  3563. OpenHandler on_open_;
  3564. ErrorHandler on_error_;
  3565. // Configuration
  3566. int reconnect_interval_ms_ = 3000;
  3567. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3568. // State
  3569. std::atomic<bool> running_{false};
  3570. std::atomic<bool> connected_{false};
  3571. std::string last_event_id_;
  3572. // Async support
  3573. std::thread async_thread_;
  3574. };
  3575. } // namespace sse
  3576. namespace ws {
  3577. enum class Opcode : uint8_t {
  3578. Continuation = 0x0,
  3579. Text = 0x1,
  3580. Binary = 0x2,
  3581. Close = 0x8,
  3582. Ping = 0x9,
  3583. Pong = 0xA,
  3584. };
  3585. enum class CloseStatus : uint16_t {
  3586. Normal = 1000,
  3587. GoingAway = 1001,
  3588. ProtocolError = 1002,
  3589. UnsupportedData = 1003,
  3590. NoStatus = 1005,
  3591. Abnormal = 1006,
  3592. InvalidPayload = 1007,
  3593. PolicyViolation = 1008,
  3594. MessageTooBig = 1009,
  3595. MandatoryExtension = 1010,
  3596. InternalError = 1011,
  3597. };
  3598. // Timeout is returned only when a read timeout was set and it elapsed before
  3599. // any byte of a frame arrived: nothing was consumed and the connection is
  3600. // still open, so the caller can send on it and read again. `msg` is left
  3601. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3602. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3603. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3604. // upgrade handshake fully succeeded. On failure error() identifies the
  3605. // failing layer; status()/headers() expose the server's upgrade response
  3606. // when one was received (status() is -1 otherwise).
  3607. class Result {
  3608. public:
  3609. Result() = default;
  3610. Result(Error err, int status, Headers &&headers)
  3611. : err_(err), status_(status), headers_(std::move(headers)) {}
  3612. explicit operator bool() const { return err_ == Error::Success; }
  3613. Error error() const { return err_; }
  3614. // Upgrade response info
  3615. int status() const { return status_; }
  3616. const Headers &headers() const { return headers_; }
  3617. std::string get_header_value(const std::string &key,
  3618. const char *def = "") const {
  3619. return detail::get_header_value(headers_, key, def, 0);
  3620. }
  3621. bool has_header(const std::string &key) const {
  3622. return headers_.find(key) != headers_.end();
  3623. }
  3624. #ifdef CPPHTTPLIB_SSL_ENABLED
  3625. Result(Error err, int status, Headers &&headers, int ssl_error,
  3626. uint64_t ssl_backend_error)
  3627. : err_(err), status_(status), headers_(std::move(headers)),
  3628. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3629. int ssl_error() const { return ssl_error_; }
  3630. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3631. #endif
  3632. private:
  3633. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3634. int status_ = -1;
  3635. Headers headers_;
  3636. #ifdef CPPHTTPLIB_SSL_ENABLED
  3637. int ssl_error_ = 0;
  3638. uint64_t ssl_backend_error_ = 0;
  3639. #endif
  3640. };
  3641. class WebSocket {
  3642. public:
  3643. WebSocket(const WebSocket &) = delete;
  3644. WebSocket &operator=(const WebSocket &) = delete;
  3645. ~WebSocket();
  3646. ReadResult read(std::string &msg);
  3647. bool send(const std::string &data);
  3648. bool send(const char *data, size_t len);
  3649. void close(CloseStatus status = CloseStatus::Normal,
  3650. const std::string &reason = "");
  3651. const Request &request() const;
  3652. bool is_open() const;
  3653. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3654. // A server handler owns its connection's timeout this way; a client sets it
  3655. // through WebSocketClient. Safe to call while another thread is in read().
  3656. void set_read_timeout(time_t sec, time_t usec = 0);
  3657. template <class Rep, class Period>
  3658. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3659. private:
  3660. friend class httplib::Server;
  3661. friend class WebSocketClient;
  3662. WebSocket(
  3663. Stream &strm, const Request &req, bool is_server,
  3664. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3665. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3666. : strm_(strm), req_(req), is_server_(is_server),
  3667. ping_interval_sec_(ping_interval_sec),
  3668. max_missed_pongs_(max_missed_pongs) {
  3669. start_heartbeat();
  3670. }
  3671. WebSocket(
  3672. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3673. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3674. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3675. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3676. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3677. max_missed_pongs_(max_missed_pongs) {
  3678. start_heartbeat();
  3679. }
  3680. void start_heartbeat();
  3681. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3682. Stream &strm_;
  3683. std::unique_ptr<Stream> owned_strm_;
  3684. Request req_;
  3685. bool is_server_;
  3686. time_t ping_interval_sec_;
  3687. int max_missed_pongs_;
  3688. int unacked_pings_ = 0;
  3689. std::atomic<bool> closed_{false};
  3690. std::mutex write_mutex_;
  3691. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3692. // may do so: read_websocket_frame() reads a payload until it has the whole
  3693. // declared length, so a second parser stealing bytes silently corrupts the
  3694. // message the first one is assembling.
  3695. std::mutex read_mutex_;
  3696. std::thread ping_thread_;
  3697. std::mutex ping_mutex_;
  3698. std::condition_variable ping_cv_;
  3699. };
  3700. class WebSocketClient {
  3701. public:
  3702. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3703. const Headers &headers = {});
  3704. ~WebSocketClient();
  3705. WebSocketClient(const WebSocketClient &) = delete;
  3706. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3707. bool is_valid() const;
  3708. Result connect();
  3709. ReadResult read(std::string &msg);
  3710. bool send(const std::string &data);
  3711. bool send(const char *data, size_t len);
  3712. void close(CloseStatus status = CloseStatus::Normal,
  3713. const std::string &reason = "");
  3714. bool is_open() const;
  3715. const std::string &subprotocol() const;
  3716. void set_read_timeout(time_t sec, time_t usec = 0);
  3717. template <class Rep, class Period>
  3718. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3719. void set_write_timeout(time_t sec, time_t usec = 0);
  3720. template <class Rep, class Period>
  3721. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3722. void set_websocket_ping_interval(time_t sec);
  3723. void set_websocket_max_missed_pongs(int count);
  3724. void set_tcp_nodelay(bool on);
  3725. void set_address_family(int family);
  3726. void set_ipv6_v6only(bool on);
  3727. void set_socket_options(SocketOptions socket_options);
  3728. void set_connection_timeout(time_t sec, time_t usec = 0);
  3729. template <class Rep, class Period>
  3730. void
  3731. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3732. void set_interface(const std::string &intf);
  3733. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3734. #ifdef CPPHTTPLIB_SSL_ENABLED
  3735. struct PemMemory {
  3736. const char *cert_pem;
  3737. size_t cert_pem_len;
  3738. const char *key_pem;
  3739. size_t key_pem_len;
  3740. const char *private_key_password;
  3741. };
  3742. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3743. const PemMemory &pem, const Headers &headers = {});
  3744. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3745. const std::string &ca_cert_dir_path = std::string());
  3746. void set_ca_cert_store(tls::ca_store_t store);
  3747. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3748. void enable_server_certificate_verification(bool enabled);
  3749. void enable_server_hostname_verification(bool enabled);
  3750. void enable_system_ca(bool enabled);
  3751. #endif
  3752. private:
  3753. void shutdown_and_close();
  3754. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3755. int &ssl_error, uint64_t &ssl_backend_error);
  3756. void prepare_default_headers(Request &req);
  3757. std::string host_;
  3758. int port_;
  3759. std::string path_;
  3760. Headers headers_;
  3761. std::string subprotocol_;
  3762. bool is_valid_ = false;
  3763. socket_t sock_ = INVALID_SOCKET;
  3764. std::unique_ptr<WebSocket> ws_;
  3765. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3766. time_t read_timeout_usec_ = 0;
  3767. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3768. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3769. time_t websocket_ping_interval_sec_ =
  3770. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3771. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3772. int address_family_ = AF_UNSPEC;
  3773. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3774. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3775. SocketOptions socket_options_ = nullptr;
  3776. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3777. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3778. std::string interface_;
  3779. // Hostname to connection target map. The value is an IP literal or another
  3780. // hostname; only the connection target changes, never the identity.
  3781. std::map<std::string, std::string> addr_map_;
  3782. #ifdef CPPHTTPLIB_SSL_ENABLED
  3783. bool is_ssl_ = false;
  3784. tls::ctx_t tls_ctx_ = nullptr;
  3785. tls::session_t tls_session_ = nullptr;
  3786. std::string ca_cert_file_path_;
  3787. std::string ca_cert_dir_path_;
  3788. bool custom_ca_loaded_ = false;
  3789. bool certs_loaded_ = false;
  3790. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3791. bool server_certificate_verification_ = true;
  3792. bool server_hostname_verification_ = true;
  3793. #endif
  3794. };
  3795. template <class Rep, class Period>
  3796. inline void WebSocket::set_read_timeout(
  3797. const std::chrono::duration<Rep, Period> &duration) {
  3798. detail::duration_to_sec_and_usec(
  3799. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3800. }
  3801. template <class Rep, class Period>
  3802. inline void WebSocketClient::set_read_timeout(
  3803. const std::chrono::duration<Rep, Period> &duration) {
  3804. detail::duration_to_sec_and_usec(
  3805. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3806. }
  3807. template <class Rep, class Period>
  3808. inline void WebSocketClient::set_write_timeout(
  3809. const std::chrono::duration<Rep, Period> &duration) {
  3810. detail::duration_to_sec_and_usec(
  3811. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3812. }
  3813. template <class Rep, class Period>
  3814. inline void WebSocketClient::set_connection_timeout(
  3815. const std::chrono::duration<Rep, Period> &duration) {
  3816. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3817. set_connection_timeout(sec, usec);
  3818. });
  3819. }
  3820. namespace impl {
  3821. bool is_valid_utf8(const std::string &s);
  3822. // Three states, because a failure that consumed bytes and one that consumed
  3823. // none are not the same thing: the first has left the stream in the middle of
  3824. // a frame and the connection cannot be reused, the second can just be retried.
  3825. enum class FrameRead { Ok, Fail, Timeout };
  3826. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3827. std::string &payload, bool &fin,
  3828. bool expect_masked, size_t max_len);
  3829. } // namespace impl
  3830. } // namespace ws
  3831. // ----------------------------------------------------------------------------
  3832. /*
  3833. * Implementation that will be part of the .cc file if split into .h + .cc.
  3834. */
  3835. namespace stream {
  3836. // stream::Result implementations
  3837. inline Result::Result() : chunk_size_(8192) {}
  3838. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3839. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3840. inline Result::Result(Result &&other) noexcept
  3841. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3842. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3843. finished_(other.finished_) {
  3844. other.current_size_ = 0;
  3845. other.finished_ = true;
  3846. }
  3847. inline Result &Result::operator=(Result &&other) noexcept {
  3848. if (this != &other) {
  3849. handle_ = std::move(other.handle_);
  3850. buffer_ = std::move(other.buffer_);
  3851. current_size_ = other.current_size_;
  3852. chunk_size_ = other.chunk_size_;
  3853. finished_ = other.finished_;
  3854. other.current_size_ = 0;
  3855. other.finished_ = true;
  3856. }
  3857. return *this;
  3858. }
  3859. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3860. inline Result::operator bool() const { return is_valid(); }
  3861. inline int Result::status() const {
  3862. return handle_.response ? handle_.response->status : -1;
  3863. }
  3864. inline const Headers &Result::headers() const {
  3865. static const Headers empty_headers;
  3866. return handle_.response ? handle_.response->headers : empty_headers;
  3867. }
  3868. inline std::string Result::get_header_value(const std::string &key,
  3869. const char *def) const {
  3870. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3871. }
  3872. inline bool Result::has_header(const std::string &key) const {
  3873. return handle_.response ? handle_.response->has_header(key) : false;
  3874. }
  3875. inline Error Result::error() const { return handle_.error; }
  3876. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3877. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3878. inline bool Result::next() {
  3879. if (!handle_.is_valid() || finished_) { return false; }
  3880. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3881. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3882. if (n > 0) {
  3883. current_size_ = static_cast<size_t>(n);
  3884. return true;
  3885. }
  3886. current_size_ = 0;
  3887. finished_ = true;
  3888. return false;
  3889. }
  3890. inline const char *Result::data() const { return buffer_.data(); }
  3891. inline size_t Result::size() const { return current_size_; }
  3892. inline std::string Result::read_all() {
  3893. std::string result;
  3894. while (next()) {
  3895. result.append(data(), size());
  3896. }
  3897. return result;
  3898. }
  3899. } // namespace stream
  3900. namespace sse {
  3901. // SSEMessage implementations
  3902. inline SSEMessage::SSEMessage() : event("message") {}
  3903. inline void SSEMessage::clear() {
  3904. event = "message";
  3905. data.clear();
  3906. id.clear();
  3907. }
  3908. // SSEClient implementations
  3909. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3910. : client_(client), path_(path) {}
  3911. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3912. const Headers &headers)
  3913. : client_(client), path_(path), headers_(headers) {}
  3914. inline SSEClient::~SSEClient() { stop(); }
  3915. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3916. on_message_ = std::move(handler);
  3917. return *this;
  3918. }
  3919. inline SSEClient &SSEClient::on_event(const std::string &type,
  3920. MessageHandler handler) {
  3921. event_handlers_[type] = std::move(handler);
  3922. return *this;
  3923. }
  3924. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3925. on_open_ = std::move(handler);
  3926. return *this;
  3927. }
  3928. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3929. on_error_ = std::move(handler);
  3930. return *this;
  3931. }
  3932. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3933. reconnect_interval_ms_ = ms;
  3934. return *this;
  3935. }
  3936. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3937. max_reconnect_attempts_ = n;
  3938. return *this;
  3939. }
  3940. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3941. std::lock_guard<std::mutex> lock(headers_mutex_);
  3942. headers_ = headers;
  3943. return *this;
  3944. }
  3945. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3946. inline const std::string &SSEClient::last_event_id() const {
  3947. return last_event_id_;
  3948. }
  3949. inline void SSEClient::start() {
  3950. running_.store(true);
  3951. run_event_loop();
  3952. }
  3953. inline void SSEClient::start_async() {
  3954. running_.store(true);
  3955. async_thread_ = std::thread([this]() { run_event_loop(); });
  3956. }
  3957. inline void SSEClient::stop() {
  3958. running_.store(false);
  3959. client_.stop(); // Cancel any pending operations
  3960. if (async_thread_.joinable()) { async_thread_.join(); }
  3961. }
  3962. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  3963. int &retry_ms) {
  3964. // Blank line signals end of event
  3965. if (line.empty() || line == "\r") { return true; }
  3966. // Lines starting with ':' are comments (ignored)
  3967. if (!line.empty() && line[0] == ':') { return false; }
  3968. // Find the colon separator
  3969. auto colon_pos = line.find(':');
  3970. if (colon_pos == std::string::npos) {
  3971. // Line with no colon is treated as field name with empty value
  3972. return false;
  3973. }
  3974. auto field = line.substr(0, colon_pos);
  3975. std::string value;
  3976. // Value starts after colon, skip optional single space
  3977. if (colon_pos + 1 < line.size()) {
  3978. auto value_start = colon_pos + 1;
  3979. if (line[value_start] == ' ') { value_start++; }
  3980. value = line.substr(value_start);
  3981. // Remove trailing \r if present
  3982. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  3983. }
  3984. // Handle known fields
  3985. if (field == "event") {
  3986. msg.event = value;
  3987. } else if (field == "data") {
  3988. // Multiple data lines are concatenated with newlines
  3989. if (!msg.data.empty()) { msg.data += "\n"; }
  3990. msg.data += value;
  3991. } else if (field == "id") {
  3992. // Empty id is valid (clears the last event ID)
  3993. msg.id = value;
  3994. } else if (field == "retry") {
  3995. // Parse retry interval in milliseconds
  3996. {
  3997. int v = 0;
  3998. auto res =
  3999. detail::from_chars(value.data(), value.data() + value.size(), v);
  4000. if (res.ec == std::errc{}) { retry_ms = v; }
  4001. }
  4002. }
  4003. // Unknown fields are ignored per SSE spec
  4004. return false;
  4005. }
  4006. inline void SSEClient::run_event_loop() {
  4007. auto reconnect_count = 0;
  4008. while (running_.load()) {
  4009. // Build headers, including Last-Event-ID if we have one
  4010. Headers request_headers;
  4011. {
  4012. std::lock_guard<std::mutex> lock(headers_mutex_);
  4013. request_headers = headers_;
  4014. }
  4015. if (!last_event_id_.empty()) {
  4016. request_headers.emplace("Last-Event-ID", last_event_id_);
  4017. }
  4018. // Open streaming connection
  4019. auto result = stream::Get(client_, path_, request_headers);
  4020. // Connection error handling
  4021. if (!result) {
  4022. connected_.store(false);
  4023. if (on_error_) { on_error_(result.error()); }
  4024. if (!should_reconnect(reconnect_count)) { break; }
  4025. wait_for_reconnect();
  4026. reconnect_count++;
  4027. continue;
  4028. }
  4029. if (result.status() != StatusCode::OK_200) {
  4030. connected_.store(false);
  4031. if (on_error_) { on_error_(Error::Connection); }
  4032. // For certain errors, don't reconnect.
  4033. // Note: 401 is intentionally absent so that handlers can refresh
  4034. // credentials via set_headers() and let the client reconnect.
  4035. if (result.status() == StatusCode::NoContent_204 ||
  4036. result.status() == StatusCode::NotFound_404 ||
  4037. result.status() == StatusCode::Forbidden_403) {
  4038. break;
  4039. }
  4040. if (!should_reconnect(reconnect_count)) { break; }
  4041. wait_for_reconnect();
  4042. reconnect_count++;
  4043. continue;
  4044. }
  4045. // Connection successful
  4046. connected_.store(true);
  4047. reconnect_count = 0;
  4048. if (on_open_) { on_open_(); }
  4049. // Event receiving loop
  4050. std::string buffer;
  4051. SSEMessage current_msg;
  4052. while (running_.load() && result.next()) {
  4053. buffer.append(result.data(), result.size());
  4054. // Process complete lines in the buffer
  4055. size_t line_start = 0;
  4056. size_t newline_pos;
  4057. while ((newline_pos = buffer.find('\n', line_start)) !=
  4058. std::string::npos) {
  4059. auto line = buffer.substr(line_start, newline_pos - line_start);
  4060. line_start = newline_pos + 1;
  4061. // Parse the line and check if event is complete
  4062. auto event_complete =
  4063. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4064. if (event_complete && !current_msg.data.empty()) {
  4065. // Update last_event_id for reconnection
  4066. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4067. // Dispatch event to appropriate handler
  4068. dispatch_event(current_msg);
  4069. current_msg.clear();
  4070. }
  4071. }
  4072. // Keep unprocessed data in buffer
  4073. buffer.erase(0, line_start);
  4074. }
  4075. // Connection ended
  4076. connected_.store(false);
  4077. if (!running_.load()) { break; }
  4078. // Check for read errors
  4079. if (result.has_read_error()) {
  4080. if (on_error_) { on_error_(result.read_error()); }
  4081. }
  4082. if (!should_reconnect(reconnect_count)) { break; }
  4083. wait_for_reconnect();
  4084. reconnect_count++;
  4085. }
  4086. connected_.store(false);
  4087. }
  4088. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4089. // Check for specific event type handler first
  4090. auto it = event_handlers_.find(msg.event);
  4091. if (it != event_handlers_.end()) {
  4092. it->second(msg);
  4093. return;
  4094. }
  4095. // Fall back to generic message handler
  4096. if (on_message_) { on_message_(msg); }
  4097. }
  4098. inline bool SSEClient::should_reconnect(int count) const {
  4099. if (!running_.load()) { return false; }
  4100. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4101. return count < max_reconnect_attempts_;
  4102. }
  4103. inline void SSEClient::wait_for_reconnect() {
  4104. // Use small increments to check running_ flag frequently
  4105. auto waited = 0;
  4106. while (running_.load() && waited < reconnect_interval_ms_) {
  4107. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4108. waited += 100;
  4109. }
  4110. }
  4111. } // namespace sse
  4112. #ifdef CPPHTTPLIB_SSL_ENABLED
  4113. /*
  4114. * TLS abstraction layer - internal function declarations
  4115. * These are implementation details and not part of the public API.
  4116. */
  4117. namespace tls {
  4118. // Client context
  4119. ctx_t create_client_context();
  4120. void free_context(ctx_t ctx);
  4121. bool set_min_version(ctx_t ctx, Version version);
  4122. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4123. bool load_ca_file(ctx_t ctx, const char *file_path);
  4124. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4125. bool load_system_certs(ctx_t ctx);
  4126. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4127. const char *password);
  4128. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4129. const char *key_path, const char *password);
  4130. // Server context
  4131. ctx_t create_server_context();
  4132. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4133. const char *password);
  4134. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4135. const char *key_path, const char *password);
  4136. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4137. void set_verify_client(ctx_t ctx, bool require);
  4138. // Session management
  4139. session_t create_session(ctx_t ctx, socket_t sock);
  4140. void free_session(session_t session);
  4141. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4142. // Handshake (non-blocking capable)
  4143. TlsError connect(session_t session);
  4144. TlsError accept(session_t session);
  4145. // Handshake with timeout (blocking until timeout)
  4146. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4147. time_t timeout_usec, TlsError *err);
  4148. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4149. time_t timeout_usec, TlsError *err);
  4150. // I/O (non-blocking capable)
  4151. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4152. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4153. int pending(const_session_t session);
  4154. void shutdown(session_t session, bool graceful);
  4155. // Connection state
  4156. bool is_peer_closed(session_t session, socket_t sock);
  4157. // Certificate verification
  4158. cert_t get_peer_cert(const_session_t session);
  4159. void free_cert(cert_t cert);
  4160. bool verify_hostname(cert_t cert, const char *hostname);
  4161. uint64_t hostname_mismatch_code();
  4162. long get_verify_result(const_session_t session);
  4163. // Certificate introspection
  4164. std::string get_cert_subject_cn(cert_t cert);
  4165. std::string get_cert_issuer_name(cert_t cert);
  4166. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4167. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4168. std::string get_cert_serial(cert_t cert);
  4169. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4170. const char *get_sni(const_session_t session);
  4171. // CA store management
  4172. ca_store_t create_ca_store(const char *pem, size_t len);
  4173. void free_ca_store(ca_store_t store);
  4174. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4175. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4176. std::vector<std::string> get_ca_names(ctx_t ctx);
  4177. // Dynamic certificate update (for servers)
  4178. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4179. const char *password);
  4180. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4181. // Certificate verification callback
  4182. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4183. long get_verify_error(const_session_t session);
  4184. std::string verify_error_string(long error_code);
  4185. // TlsError information
  4186. uint64_t peek_error();
  4187. uint64_t get_error();
  4188. std::string error_string(uint64_t code);
  4189. } // namespace tls
  4190. #endif // CPPHTTPLIB_SSL_ENABLED
  4191. /*
  4192. * Group 1: detail namespace - Non-SSL utilities
  4193. */
  4194. namespace detail {
  4195. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4196. const void *optval, socklen_t optlen) {
  4197. return setsockopt(sock, level, optname,
  4198. #ifdef _WIN32
  4199. reinterpret_cast<const char *>(optval),
  4200. #else
  4201. optval,
  4202. #endif
  4203. optlen) == 0;
  4204. }
  4205. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4206. time_t sec, time_t usec) {
  4207. #ifdef _WIN32
  4208. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4209. #else
  4210. timeval timeout;
  4211. timeout.tv_sec = static_cast<long>(sec);
  4212. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4213. #endif
  4214. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4215. }
  4216. inline bool is_hex(char c, int &v) {
  4217. if (is_ascii_digit(c)) {
  4218. v = c - '0';
  4219. return true;
  4220. } else if ('A' <= c && c <= 'F') {
  4221. v = c - 'A' + 10;
  4222. return true;
  4223. } else if ('a' <= c && c <= 'f') {
  4224. v = c - 'a' + 10;
  4225. return true;
  4226. }
  4227. return false;
  4228. }
  4229. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4230. int &val) {
  4231. if (i >= s.size()) { return false; }
  4232. val = 0;
  4233. for (; cnt; i++, cnt--) {
  4234. if (!s[i]) { return false; }
  4235. auto v = 0;
  4236. if (is_hex(s[i], v)) {
  4237. val = val * 16 + v;
  4238. } else {
  4239. return false;
  4240. }
  4241. }
  4242. return true;
  4243. }
  4244. inline std::string from_i_to_hex(size_t n) {
  4245. static const auto charset = "0123456789abcdef";
  4246. std::string ret;
  4247. do {
  4248. ret = charset[n & 15] + ret;
  4249. n >>= 4;
  4250. } while (n > 0);
  4251. return ret;
  4252. }
  4253. inline std::string compute_etag(const FileStat &fs,
  4254. const std::string &suffix = std::string()) {
  4255. if (!fs.is_file()) { return std::string(); }
  4256. // If mtime cannot be determined (negative value indicates an error
  4257. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4258. // value like 0 could collide with a real file that legitimately has
  4259. // mtime == 0 (epoch) and lead to misleading validators.
  4260. auto mtime_raw = fs.mtime();
  4261. if (mtime_raw < 0) { return std::string(); }
  4262. auto mtime = static_cast<size_t>(mtime_raw);
  4263. auto size = fs.size();
  4264. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4265. from_i_to_hex(size) + suffix + "\"";
  4266. }
  4267. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4268. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4269. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4270. inline std::string file_mtime_to_http_date(time_t mtime) {
  4271. if (mtime < 0) { return std::string(); }
  4272. struct tm tm_buf;
  4273. #ifdef _WIN32
  4274. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4275. #else
  4276. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4277. #endif
  4278. char buf[64];
  4279. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4280. return std::string();
  4281. }
  4282. return std::string(buf);
  4283. }
  4284. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4285. inline time_t parse_http_date(const std::string &date_str) {
  4286. struct tm tm_buf;
  4287. // Create a classic locale object once for all parsing attempts
  4288. const std::locale classic_locale = std::locale::classic();
  4289. // Try to parse using std::get_time (C++11, cross-platform)
  4290. auto try_parse = [&](const char *fmt) -> bool {
  4291. std::istringstream ss(date_str);
  4292. ss.imbue(classic_locale);
  4293. memset(&tm_buf, 0, sizeof(tm_buf));
  4294. ss >> std::get_time(&tm_buf, fmt);
  4295. return !ss.fail();
  4296. };
  4297. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4298. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4299. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4300. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4301. // asctime format: "Sun Nov 6 08:49:37 1994"
  4302. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4303. return static_cast<time_t>(-1);
  4304. }
  4305. }
  4306. }
  4307. #ifdef _WIN32
  4308. return _mkgmtime(&tm_buf);
  4309. #elif defined _AIX
  4310. return mktime(&tm_buf);
  4311. #else
  4312. return timegm(&tm_buf);
  4313. #endif
  4314. }
  4315. inline bool is_weak_etag(const std::string &s) {
  4316. // Check if the string is a weak ETag (starts with 'W/"')
  4317. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4318. }
  4319. inline bool is_strong_etag(const std::string &s) {
  4320. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4321. // chars)
  4322. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4323. }
  4324. inline size_t to_utf8(int code, char *buff) {
  4325. if (code < 0x0080) {
  4326. buff[0] = static_cast<char>(code & 0x7F);
  4327. return 1;
  4328. } else if (code < 0x0800) {
  4329. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4330. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4331. return 2;
  4332. } else if (code < 0xD800) {
  4333. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4334. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4335. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4336. return 3;
  4337. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4338. return 0;
  4339. } else if (code < 0x10000) {
  4340. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4341. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4342. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4343. return 3;
  4344. } else if (code < 0x110000) {
  4345. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4346. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4347. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4348. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4349. return 4;
  4350. }
  4351. // NOTREACHED
  4352. return 0;
  4353. }
  4354. } // namespace detail
  4355. namespace ws {
  4356. namespace impl {
  4357. inline bool is_valid_utf8(const std::string &s) {
  4358. size_t i = 0;
  4359. auto n = s.size();
  4360. while (i < n) {
  4361. auto c = static_cast<unsigned char>(s[i]);
  4362. size_t len;
  4363. uint32_t cp;
  4364. if (c < 0x80) {
  4365. i++;
  4366. continue;
  4367. } else if ((c & 0xE0) == 0xC0) {
  4368. len = 2;
  4369. cp = c & 0x1F;
  4370. } else if ((c & 0xF0) == 0xE0) {
  4371. len = 3;
  4372. cp = c & 0x0F;
  4373. } else if ((c & 0xF8) == 0xF0) {
  4374. len = 4;
  4375. cp = c & 0x07;
  4376. } else {
  4377. return false;
  4378. }
  4379. if (i + len > n) { return false; }
  4380. for (size_t j = 1; j < len; j++) {
  4381. auto b = static_cast<unsigned char>(s[i + j]);
  4382. if ((b & 0xC0) != 0x80) { return false; }
  4383. cp = (cp << 6) | (b & 0x3F);
  4384. }
  4385. // Overlong encoding check
  4386. if (len == 2 && cp < 0x80) { return false; }
  4387. if (len == 3 && cp < 0x800) { return false; }
  4388. if (len == 4 && cp < 0x10000) { return false; }
  4389. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4390. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4391. if (cp > 0x10FFFF) { return false; }
  4392. i += len;
  4393. }
  4394. return true;
  4395. }
  4396. } // namespace impl
  4397. } // namespace ws
  4398. namespace detail {
  4399. // NOTE: This code came up with the following stackoverflow post:
  4400. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4401. inline std::string base64_encode(const std::string &in) {
  4402. static const auto lookup =
  4403. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4404. std::string out;
  4405. out.reserve(in.size());
  4406. // Unsigned: the accumulator is never masked, so with a signed int the
  4407. // `val << 8` below overflows once enough bytes are folded in (undefined
  4408. // behaviour before C++20). Only the low bits are ever emitted, so the
  4409. // wrap-around of an unsigned accumulator does not affect the output.
  4410. uint32_t val = 0;
  4411. auto valb = -6;
  4412. for (auto c : in) {
  4413. val = (val << 8) + static_cast<uint8_t>(c);
  4414. valb += 8;
  4415. while (valb >= 0) {
  4416. out.push_back(lookup[(val >> valb) & 0x3F]);
  4417. valb -= 6;
  4418. }
  4419. }
  4420. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4421. while (out.size() % 4) {
  4422. out.push_back('=');
  4423. }
  4424. return out;
  4425. }
  4426. inline std::string sha1(const std::string &input) {
  4427. // RFC 3174 SHA-1 implementation
  4428. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4429. return (x << n) | (x >> (32 - n));
  4430. };
  4431. uint32_t h0 = 0x67452301;
  4432. uint32_t h1 = 0xEFCDAB89;
  4433. uint32_t h2 = 0x98BADCFE;
  4434. uint32_t h3 = 0x10325476;
  4435. uint32_t h4 = 0xC3D2E1F0;
  4436. // Pre-processing: adding padding bits
  4437. std::string msg = input;
  4438. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4439. msg.push_back(static_cast<char>(0x80u));
  4440. while (msg.size() % 64 != 56) {
  4441. msg.push_back(0);
  4442. }
  4443. // Append original length in bits as 64-bit big-endian
  4444. for (int i = 56; i >= 0; i -= 8) {
  4445. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4446. }
  4447. // Process each 512-bit chunk
  4448. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4449. uint32_t w[80];
  4450. for (size_t i = 0; i < 16; i++) {
  4451. w[i] =
  4452. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4453. << 24) |
  4454. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4455. << 16) |
  4456. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4457. << 8) |
  4458. (static_cast<uint32_t>(
  4459. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4460. }
  4461. for (int i = 16; i < 80; i++) {
  4462. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4463. }
  4464. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4465. for (int i = 0; i < 80; i++) {
  4466. uint32_t f, k;
  4467. if (i < 20) {
  4468. f = (b & c) | ((~b) & d);
  4469. k = 0x5A827999;
  4470. } else if (i < 40) {
  4471. f = b ^ c ^ d;
  4472. k = 0x6ED9EBA1;
  4473. } else if (i < 60) {
  4474. f = (b & c) | (b & d) | (c & d);
  4475. k = 0x8F1BBCDC;
  4476. } else {
  4477. f = b ^ c ^ d;
  4478. k = 0xCA62C1D6;
  4479. }
  4480. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4481. e = d;
  4482. d = c;
  4483. c = left_rotate(b, 30);
  4484. b = a;
  4485. a = temp;
  4486. }
  4487. h0 += a;
  4488. h1 += b;
  4489. h2 += c;
  4490. h3 += d;
  4491. h4 += e;
  4492. }
  4493. // Produce the final hash as a 20-byte binary string
  4494. std::string hash(20, '\0');
  4495. for (size_t i = 0; i < 4; i++) {
  4496. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4497. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4498. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4499. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4500. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4501. }
  4502. return hash;
  4503. }
  4504. inline std::string websocket_accept_key(const std::string &client_key) {
  4505. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4506. return base64_encode(sha1(client_key + magic));
  4507. }
  4508. inline bool is_websocket_upgrade(const Request &req) {
  4509. if (req.method != "GET") { return false; }
  4510. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4511. // list of protocols and asks recipients to match each name
  4512. // case-insensitively, so look for the token rather than compare the whole
  4513. // field value.
  4514. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4515. // Check Connection: Upgrade
  4516. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4517. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4518. // RFC 6455 Section 4.2.1
  4519. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4520. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4521. return false;
  4522. }
  4523. static const std::string b64chars =
  4524. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4525. for (size_t i = 0; i < 22; i++) {
  4526. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4527. }
  4528. // Check Sec-WebSocket-Version: 13
  4529. auto version = req.get_header_value("Sec-WebSocket-Version");
  4530. if (version != "13") { return false; }
  4531. return true;
  4532. }
  4533. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4534. const char *data, size_t len, bool fin,
  4535. bool mask) {
  4536. // First byte: FIN + opcode
  4537. uint8_t header[2];
  4538. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4539. (static_cast<uint8_t>(opcode) & 0x0F));
  4540. // Second byte: MASK + payload length
  4541. if (len < 126) {
  4542. header[1] = static_cast<uint8_t>(len);
  4543. if (mask) { header[1] |= 0x80; }
  4544. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4545. } else if (len <= 0xFFFF) {
  4546. header[1] = 126;
  4547. if (mask) { header[1] |= 0x80; }
  4548. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4549. uint8_t ext[2];
  4550. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4551. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4552. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4553. } else {
  4554. header[1] = 127;
  4555. if (mask) { header[1] |= 0x80; }
  4556. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4557. uint8_t ext[8];
  4558. for (int i = 7; i >= 0; i--) {
  4559. ext[7 - i] =
  4560. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4561. }
  4562. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4563. }
  4564. if (mask) {
  4565. // Generate random mask key
  4566. thread_local std::mt19937 rng(std::random_device{}());
  4567. uint8_t mask_key[4];
  4568. auto r = rng();
  4569. std::memcpy(mask_key, &r, 4);
  4570. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4571. // Write masked payload in chunks
  4572. const size_t chunk_size = 4096;
  4573. std::vector<char> buf((std::min)(len, chunk_size));
  4574. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4575. size_t n = (std::min)(chunk_size, len - offset);
  4576. for (size_t i = 0; i < n; i++) {
  4577. buf[i] =
  4578. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4579. }
  4580. if (strm.write(buf.data(), n) < 0) { return false; }
  4581. }
  4582. } else {
  4583. if (len > 0) {
  4584. if (strm.write(data, len) < 0) { return false; }
  4585. }
  4586. }
  4587. return true;
  4588. }
  4589. } // namespace detail
  4590. namespace ws {
  4591. namespace impl {
  4592. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4593. // hands back whatever its buffer already holds -- so every multi-byte field has
  4594. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4595. // header straddles the read buffer's boundary.
  4596. //
  4597. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4598. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4599. // there is a failure like any other. (When read() fails it always records why,
  4600. // so the error belongs to this call and not to an earlier one.)
  4601. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4602. auto p = static_cast<char *>(buf);
  4603. size_t total = 0;
  4604. while (total < size) {
  4605. auto n = strm.read(p + total, size - total);
  4606. if (n <= 0) {
  4607. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4608. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4609. }
  4610. total += static_cast<size_t>(n);
  4611. }
  4612. return FrameRead::Ok;
  4613. }
  4614. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4615. std::string &payload, bool &fin,
  4616. bool expect_masked, size_t max_len) {
  4617. // Read first 2 bytes. This is the only read that may report a timeout: it
  4618. // sits on a frame boundary, where nothing has been consumed yet.
  4619. uint8_t header[2];
  4620. FrameRead first = read_exact(strm, header, 2);
  4621. if (first != FrameRead::Ok) { return first; }
  4622. fin = (header[0] & 0x80) != 0;
  4623. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4624. if (header[0] & 0x70) { return FrameRead::Fail; }
  4625. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4626. bool masked = (header[1] & 0x80) != 0;
  4627. uint64_t payload_len = header[1] & 0x7F;
  4628. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4629. // MUST have a payload length of 125 bytes or less
  4630. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4631. if (is_control) {
  4632. if (!fin) { return FrameRead::Fail; }
  4633. if (payload_len > 125) { return FrameRead::Fail; }
  4634. }
  4635. if (masked != expect_masked) { return FrameRead::Fail; }
  4636. // Extended payload length
  4637. if (payload_len == 126) {
  4638. uint8_t ext[2];
  4639. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4640. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4641. } else if (payload_len == 127) {
  4642. uint8_t ext[8];
  4643. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4644. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4645. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4646. payload_len = 0;
  4647. for (int i = 0; i < 8; i++) {
  4648. payload_len = (payload_len << 8) | ext[i];
  4649. }
  4650. }
  4651. if (payload_len > max_len) { return FrameRead::Fail; }
  4652. // Read mask key if present
  4653. uint8_t mask_key[4] = {0};
  4654. if (masked) {
  4655. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4656. return FrameRead::Fail;
  4657. }
  4658. }
  4659. // Read payload
  4660. payload.resize(static_cast<size_t>(payload_len));
  4661. if (payload_len > 0 &&
  4662. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4663. FrameRead::Ok) {
  4664. return FrameRead::Fail;
  4665. }
  4666. // Unmask if needed
  4667. if (masked) {
  4668. for (size_t i = 0; i < payload.size(); i++) {
  4669. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4670. }
  4671. }
  4672. return FrameRead::Ok;
  4673. }
  4674. } // namespace impl
  4675. } // namespace ws
  4676. namespace detail {
  4677. inline bool is_valid_path(const std::string &path) {
  4678. size_t level = 0;
  4679. size_t i = 0;
  4680. // Skip slash
  4681. while (i < path.size() && path[i] == '/') {
  4682. i++;
  4683. }
  4684. while (i < path.size()) {
  4685. // Read component
  4686. auto beg = i;
  4687. while (i < path.size() && path[i] != '/') {
  4688. if (path[i] == '\0') {
  4689. return false;
  4690. } else if (path[i] == '\\') {
  4691. return false;
  4692. }
  4693. i++;
  4694. }
  4695. auto len = i - beg;
  4696. assert(len > 0);
  4697. if (!path.compare(beg, len, ".")) {
  4698. ;
  4699. } else if (!path.compare(beg, len, "..")) {
  4700. if (level == 0) { return false; }
  4701. level--;
  4702. } else {
  4703. level++;
  4704. }
  4705. // Skip slash
  4706. while (i < path.size() && path[i] == '/') {
  4707. i++;
  4708. }
  4709. }
  4710. return true;
  4711. }
  4712. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4713. #if defined(_WIN32)
  4714. char buf[_MAX_PATH];
  4715. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4716. resolved = buf;
  4717. #elif defined(PATH_MAX)
  4718. char buf[PATH_MAX];
  4719. if (realpath(path, buf) == nullptr) { return false; }
  4720. resolved = buf;
  4721. #else
  4722. auto buf = realpath(path, nullptr);
  4723. auto guard = scope_exit([&]() { std::free(buf); });
  4724. if (buf == nullptr) { return false; }
  4725. resolved = buf;
  4726. #endif
  4727. return true;
  4728. }
  4729. inline bool is_path_within_base(const std::string &resolved_path,
  4730. const std::string &resolved_base) {
  4731. #if defined(_WIN32)
  4732. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4733. resolved_base.size()) == 0;
  4734. #else
  4735. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4736. resolved_base.size()) == 0;
  4737. #endif
  4738. }
  4739. inline FileStat::FileStat(const std::string &path) {
  4740. #if defined(_WIN32)
  4741. auto wpath = u8string_to_wstring(path.c_str());
  4742. ret_ = _wstat(wpath.c_str(), &st_);
  4743. #else
  4744. ret_ = stat(path.c_str(), &st_);
  4745. #endif
  4746. }
  4747. inline bool FileStat::is_file() const {
  4748. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4749. }
  4750. inline bool FileStat::is_dir() const {
  4751. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4752. }
  4753. inline time_t FileStat::mtime() const {
  4754. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4755. : static_cast<time_t>(-1);
  4756. }
  4757. inline size_t FileStat::size() const {
  4758. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4759. }
  4760. inline std::string encode_path(const std::string &s) {
  4761. std::string result;
  4762. result.reserve(s.size());
  4763. for (size_t i = 0; s[i]; i++) {
  4764. switch (s[i]) {
  4765. case ' ': result += "%20"; break;
  4766. case '+': result += "%2B"; break;
  4767. case '\r': result += "%0D"; break;
  4768. case '\n': result += "%0A"; break;
  4769. case '\'': result += "%27"; break;
  4770. case ',': result += "%2C"; break;
  4771. // case ':': result += "%3A"; break; // ok? probably...
  4772. case ';': result += "%3B"; break;
  4773. default:
  4774. auto c = static_cast<uint8_t>(s[i]);
  4775. if (c >= 0x80) {
  4776. result += '%';
  4777. char hex[4];
  4778. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4779. assert(len == 2);
  4780. result.append(hex, static_cast<size_t>(len));
  4781. } else {
  4782. result += s[i];
  4783. }
  4784. break;
  4785. }
  4786. }
  4787. return result;
  4788. }
  4789. inline std::string file_extension(const std::string &path) {
  4790. std::smatch m;
  4791. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4792. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4793. return std::string();
  4794. }
  4795. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4796. template <typename T>
  4797. inline bool parse_header(const char *beg, const char *end, T fn);
  4798. template <typename T>
  4799. inline bool parse_header(const char *beg, const char *end, T fn) {
  4800. // Skip trailing spaces and tabs.
  4801. while (beg < end && is_space_or_tab(end[-1])) {
  4802. end--;
  4803. }
  4804. auto p = beg;
  4805. while (p < end && *p != ':') {
  4806. p++;
  4807. }
  4808. auto name = std::string(beg, p);
  4809. if (!detail::fields::is_field_name(name)) { return false; }
  4810. if (p == end) { return false; }
  4811. auto key_end = p;
  4812. if (*p++ != ':') { return false; }
  4813. while (p < end && is_space_or_tab(*p)) {
  4814. p++;
  4815. }
  4816. if (p <= end) {
  4817. auto key_len = key_end - beg;
  4818. if (!key_len) { return false; }
  4819. auto key = std::string(beg, key_end);
  4820. auto val = std::string(p, end);
  4821. if (!detail::fields::is_field_value(val)) { return false; }
  4822. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4823. // percent-decoded by the recipient. Applications that need to interpret a
  4824. // value as a URI component should call httplib::decode_uri_component()
  4825. // (or decode_path_component()) explicitly.
  4826. fn(key, val);
  4827. return true;
  4828. }
  4829. return false;
  4830. }
  4831. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4832. const Headers &src_headers) {
  4833. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4834. // transfer coding is complete when a chunk with a chunk-size of zero is
  4835. // received, possibly followed by a trailer section, and finally terminated by
  4836. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4837. //
  4838. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4839. // doesn't care for the existence of the final CRLF. In other words, it seems
  4840. // to be ok whether the final CRLF exists or not in the chunked data.
  4841. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4842. //
  4843. // According to the reference code in RFC 9112, cpp-httplib now allows
  4844. // chunked transfer coding data without the final CRLF.
  4845. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4846. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4847. "transfer-encoding",
  4848. "content-length",
  4849. "host",
  4850. "authorization",
  4851. "www-authenticate",
  4852. "proxy-authenticate",
  4853. "proxy-authorization",
  4854. "cookie",
  4855. "set-cookie",
  4856. "cache-control",
  4857. "expect",
  4858. "max-forwards",
  4859. "pragma",
  4860. "range",
  4861. "te",
  4862. "age",
  4863. "expires",
  4864. "date",
  4865. "location",
  4866. "retry-after",
  4867. "vary",
  4868. "warning",
  4869. "content-encoding",
  4870. "content-type",
  4871. "content-range",
  4872. "trailer"};
  4873. case_ignore::unordered_set<std::string> declared_trailers;
  4874. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4875. if (!trailer_header.empty()) {
  4876. // split() trims each token and skips empty ones, so the name arrives ready
  4877. // to look up.
  4878. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4879. ',', [&](const char *b, const char *e) {
  4880. std::string key(b, e);
  4881. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4882. declared_trailers.insert(key);
  4883. }
  4884. });
  4885. }
  4886. size_t trailer_header_count = 0;
  4887. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4888. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4889. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4890. constexpr auto line_terminator_len = 2;
  4891. auto line_beg = line_reader.ptr();
  4892. auto line_end =
  4893. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4894. if (!parse_header(line_beg, line_end,
  4895. [&](const std::string &key, const std::string &val) {
  4896. if (declared_trailers.find(key) !=
  4897. declared_trailers.end()) {
  4898. dest.emplace(key, val);
  4899. trailer_header_count++;
  4900. }
  4901. })) {
  4902. return false;
  4903. }
  4904. if (!line_reader.getline()) { return false; }
  4905. }
  4906. return true;
  4907. }
  4908. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4909. size_t right) {
  4910. while (b + left < e && is_space_or_tab(b[left])) {
  4911. left++;
  4912. }
  4913. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4914. right--;
  4915. }
  4916. return std::make_pair(left, right);
  4917. }
  4918. inline std::string trim_copy(const std::string &s) {
  4919. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4920. return s.substr(r.first, r.second - r.first);
  4921. }
  4922. inline std::string trim_double_quotes_copy(const std::string &s) {
  4923. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4924. return s.substr(1, s.size() - 2);
  4925. }
  4926. return s;
  4927. }
  4928. inline void
  4929. divide(const char *data, std::size_t size, char d,
  4930. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4931. fn) {
  4932. const auto it = std::find(data, data + size, d);
  4933. const auto found = static_cast<std::size_t>(it != data + size);
  4934. const auto lhs_data = data;
  4935. const auto lhs_size = static_cast<std::size_t>(it - data);
  4936. const auto rhs_data = it + found;
  4937. const auto rhs_size = size - lhs_size - found;
  4938. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4939. }
  4940. inline void
  4941. divide(const std::string &str, char d,
  4942. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4943. fn) {
  4944. divide(str.data(), str.size(), d, std::move(fn));
  4945. }
  4946. inline void split(const char *b, const char *e, char d,
  4947. std::function<void(const char *, const char *)> fn) {
  4948. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  4949. }
  4950. inline void split(const char *b, const char *e, char d, size_t m,
  4951. std::function<void(const char *, const char *)> fn) {
  4952. size_t i = 0;
  4953. size_t beg = 0;
  4954. size_t count = 1;
  4955. while (e ? (b + i < e) : (b[i] != '\0')) {
  4956. if (b[i] == d && count < m) {
  4957. auto r = trim(b, e, beg, i);
  4958. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4959. beg = i + 1;
  4960. count++;
  4961. }
  4962. i++;
  4963. }
  4964. if (i) {
  4965. auto r = trim(b, e, beg, i);
  4966. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4967. }
  4968. }
  4969. // Same contract as split(), except that a delimiter inside a quoted-string is
  4970. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  4971. // quoted-string, and ';' and '=' are legal characters inside one.
  4972. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  4973. std::function<void(const char *, const char *)> fn) {
  4974. size_t i = 0;
  4975. size_t beg = 0;
  4976. size_t count = 1;
  4977. auto in_quotes = false;
  4978. while (e ? (b + i < e) : (b[i] != '\0')) {
  4979. if (b[i] == '"') {
  4980. in_quotes = !in_quotes;
  4981. } else if (b[i] == d && !in_quotes && count < m) {
  4982. auto r = trim(b, e, beg, i);
  4983. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4984. beg = i + 1;
  4985. count++;
  4986. }
  4987. i++;
  4988. }
  4989. if (i) {
  4990. auto r = trim(b, e, beg, i);
  4991. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4992. }
  4993. }
  4994. inline void split_unquoted(const char *b, const char *e, char d,
  4995. std::function<void(const char *, const char *)> fn) {
  4996. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  4997. std::move(fn));
  4998. }
  4999. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5000. // key a token, so the first '=' is the separator even when the value is a
  5001. // quoted-string carrying more of them.
  5002. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5003. std::string &val) {
  5004. divide(
  5005. b, static_cast<std::size_t>(e - b), '=',
  5006. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5007. const auto kr = trim(kb, kb + klen, 0, klen);
  5008. key.assign(kb + kr.first, kb + kr.second);
  5009. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5010. val.assign(vb + vr.first, vb + vr.second);
  5011. });
  5012. }
  5013. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5014. std::function<bool(const char *, const char *)> fn) {
  5015. size_t i = 0;
  5016. size_t beg = 0;
  5017. size_t count = 1;
  5018. while (e ? (b + i < e) : (b[i] != '\0')) {
  5019. if (b[i] == d && count < m) {
  5020. auto r = trim(b, e, beg, i);
  5021. if (r.first < r.second) {
  5022. auto found = fn(&b[r.first], &b[r.second]);
  5023. if (found) { return true; }
  5024. }
  5025. beg = i + 1;
  5026. count++;
  5027. }
  5028. i++;
  5029. }
  5030. if (i) {
  5031. auto r = trim(b, e, beg, i);
  5032. if (r.first < r.second) {
  5033. auto found = fn(&b[r.first], &b[r.second]);
  5034. if (found) { return true; }
  5035. }
  5036. }
  5037. return false;
  5038. }
  5039. inline bool split_find(const char *b, const char *e, char d,
  5040. std::function<bool(const char *, const char *)> fn) {
  5041. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5042. std::move(fn));
  5043. }
  5044. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5045. size_t fixed_buffer_size)
  5046. : strm_(strm), fixed_buffer_(fixed_buffer),
  5047. fixed_buffer_size_(fixed_buffer_size) {}
  5048. inline const char *stream_line_reader::ptr() const {
  5049. if (growable_buffer_.empty()) {
  5050. return fixed_buffer_;
  5051. } else {
  5052. return growable_buffer_.data();
  5053. }
  5054. }
  5055. inline size_t stream_line_reader::size() const {
  5056. if (growable_buffer_.empty()) {
  5057. return fixed_buffer_used_size_;
  5058. } else {
  5059. return growable_buffer_.size();
  5060. }
  5061. }
  5062. inline bool stream_line_reader::end_with_crlf() const {
  5063. auto end = ptr() + size();
  5064. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5065. }
  5066. inline bool stream_line_reader::getline() {
  5067. fixed_buffer_used_size_ = 0;
  5068. growable_buffer_.clear();
  5069. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5070. char prev_byte = 0;
  5071. #endif
  5072. for (size_t i = 0;; i++) {
  5073. // Fast path: whatever the stream has already buffered can be scanned for
  5074. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5075. // call, a bounds check and a one-byte copy per character of the request.
  5076. size_t buffered_size = 0;
  5077. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5078. auto take = buffered_size;
  5079. auto terminated = false;
  5080. for (size_t at = 0; at < buffered_size;) {
  5081. auto nl = static_cast<const char *>(
  5082. memchr(buffered + at, '\n', buffered_size - at));
  5083. if (!nl) { break; }
  5084. auto pos = static_cast<size_t>(nl - buffered);
  5085. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5086. take = pos + 1;
  5087. terminated = true;
  5088. break;
  5089. #else
  5090. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5091. // be the last byte of an earlier chunk, hence prev_byte.
  5092. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5093. take = pos + 1;
  5094. terminated = true;
  5095. break;
  5096. }
  5097. at = pos + 1;
  5098. #endif
  5099. }
  5100. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5101. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5102. prev_byte = buffered[take - 1];
  5103. #endif
  5104. append(buffered, take);
  5105. strm_.consume_buffered(take);
  5106. i += take;
  5107. if (terminated) { return true; }
  5108. continue;
  5109. }
  5110. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5111. // Treat exceptionally long lines as an error to
  5112. // prevent infinite loops/memory exhaustion
  5113. return false;
  5114. }
  5115. char byte;
  5116. auto n = strm_.read(&byte, 1);
  5117. if (n < 0) {
  5118. return false;
  5119. } else if (n == 0) {
  5120. if (i == 0) {
  5121. return false;
  5122. } else {
  5123. break;
  5124. }
  5125. }
  5126. append(byte);
  5127. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5128. if (byte == '\n') { break; }
  5129. #else
  5130. if (prev_byte == '\r' && byte == '\n') { break; }
  5131. prev_byte = byte;
  5132. #endif
  5133. }
  5134. return true;
  5135. }
  5136. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5137. inline void stream_line_reader::append(const char *data, size_t size) {
  5138. // Once the line has outgrown the fixed buffer everything must keep going to
  5139. // the growable one, even if a later chunk would have fit. Without the
  5140. // emptiness check a short append after a long one would land in the fixed
  5141. // buffer, which ptr() and size() no longer look at, and be lost.
  5142. if (growable_buffer_.empty() &&
  5143. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5144. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5145. fixed_buffer_used_size_ += size;
  5146. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5147. } else {
  5148. // Unlike the per-character overload, this can be the very first append of
  5149. // the line, so the fixed buffer may hold nothing and carry no terminator
  5150. // yet. assign() takes an explicit length and does not need one.
  5151. if (growable_buffer_.empty()) {
  5152. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5153. }
  5154. growable_buffer_.append(data, size);
  5155. }
  5156. }
  5157. inline mmap::mmap(const char *path) { open(path); }
  5158. inline mmap::~mmap() { close(); }
  5159. inline bool mmap::open(const char *path) {
  5160. close();
  5161. #if defined(_WIN32)
  5162. auto wpath = u8string_to_wstring(path);
  5163. if (wpath.empty()) { return false; }
  5164. hFile_ =
  5165. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5166. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5167. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5168. LARGE_INTEGER size{};
  5169. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5170. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5171. // See:
  5172. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5173. if (static_cast<ULONGLONG>(size.QuadPart) >
  5174. (std::numeric_limits<decltype(size_)>::max)()) {
  5175. // `size_t` might be 32-bits, on 32-bits Windows.
  5176. return false;
  5177. }
  5178. size_ = static_cast<size_t>(size.QuadPart);
  5179. hMapping_ =
  5180. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5181. // Special treatment for an empty file...
  5182. if (hMapping_ == NULL && size_ == 0) {
  5183. close();
  5184. is_open_empty_file = true;
  5185. return true;
  5186. }
  5187. if (hMapping_ == NULL) {
  5188. close();
  5189. return false;
  5190. }
  5191. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5192. if (addr_ == nullptr) {
  5193. close();
  5194. return false;
  5195. }
  5196. #else
  5197. fd_ = ::open(path, O_RDONLY);
  5198. if (fd_ == -1) { return false; }
  5199. struct stat sb;
  5200. if (fstat(fd_, &sb) == -1) {
  5201. close();
  5202. return false;
  5203. }
  5204. size_ = static_cast<size_t>(sb.st_size);
  5205. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5206. // Special treatment for an empty file...
  5207. if (addr_ == MAP_FAILED && size_ == 0) {
  5208. close();
  5209. is_open_empty_file = true;
  5210. return false;
  5211. }
  5212. if (addr_ == MAP_FAILED) {
  5213. // Clear the sentinel before `close()`, since `is_open()` only checks
  5214. // `addr_` against nullptr and `munmap()` must not be called with it.
  5215. addr_ = nullptr;
  5216. close();
  5217. return false;
  5218. }
  5219. #endif
  5220. return true;
  5221. }
  5222. inline bool mmap::is_open() const {
  5223. return is_open_empty_file ? true : addr_ != nullptr;
  5224. }
  5225. inline size_t mmap::size() const { return size_; }
  5226. inline const char *mmap::data() const {
  5227. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5228. }
  5229. inline void mmap::close() {
  5230. #if defined(_WIN32)
  5231. if (addr_) {
  5232. ::UnmapViewOfFile(addr_);
  5233. addr_ = nullptr;
  5234. }
  5235. if (hMapping_) {
  5236. ::CloseHandle(hMapping_);
  5237. hMapping_ = NULL;
  5238. }
  5239. if (hFile_ != INVALID_HANDLE_VALUE) {
  5240. ::CloseHandle(hFile_);
  5241. hFile_ = INVALID_HANDLE_VALUE;
  5242. }
  5243. is_open_empty_file = false;
  5244. #else
  5245. if (addr_ != nullptr) {
  5246. munmap(addr_, size_);
  5247. addr_ = nullptr;
  5248. }
  5249. if (fd_ != -1) {
  5250. ::close(fd_);
  5251. fd_ = -1;
  5252. }
  5253. #endif
  5254. size_ = 0;
  5255. }
  5256. inline int close_socket(socket_t sock) noexcept {
  5257. #ifdef _WIN32
  5258. return closesocket(sock);
  5259. #else
  5260. return close(sock);
  5261. #endif
  5262. }
  5263. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5264. ssize_t res = 0;
  5265. while (true) {
  5266. res = fn();
  5267. if (res < 0 && errno == EINTR) {
  5268. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5269. continue;
  5270. }
  5271. break;
  5272. }
  5273. return res;
  5274. }
  5275. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5276. return handle_EINTR([&]() {
  5277. return recv(sock,
  5278. #ifdef _WIN32
  5279. static_cast<char *>(ptr), static_cast<int>(size),
  5280. #else
  5281. ptr, size,
  5282. #endif
  5283. flags);
  5284. });
  5285. }
  5286. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5287. int flags) {
  5288. return handle_EINTR([&]() {
  5289. return send(sock,
  5290. #ifdef _WIN32
  5291. static_cast<const char *>(ptr), static_cast<int>(size),
  5292. #else
  5293. ptr, size,
  5294. #endif
  5295. flags);
  5296. });
  5297. }
  5298. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5299. #ifdef _WIN32
  5300. return ::WSAPoll(fds, nfds, timeout);
  5301. #else
  5302. return ::poll(fds, nfds, timeout);
  5303. #endif
  5304. }
  5305. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5306. time_t usec) {
  5307. struct pollfd pfd;
  5308. pfd.fd = sock;
  5309. pfd.events = events;
  5310. pfd.revents = 0;
  5311. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5312. // "return immediately", which callers here rely on to probe a socket.
  5313. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5314. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5315. }
  5316. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5317. return select_impl(sock, POLLIN, sec, usec);
  5318. }
  5319. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5320. return select_impl(sock, POLLOUT, sec, usec);
  5321. }
  5322. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5323. time_t usec) {
  5324. struct pollfd pfd_read;
  5325. pfd_read.fd = sock;
  5326. pfd_read.events = POLLIN | POLLOUT;
  5327. pfd_read.revents = 0;
  5328. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5329. auto poll_res =
  5330. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5331. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5332. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5333. auto error = 0;
  5334. socklen_t len = sizeof(error);
  5335. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5336. reinterpret_cast<char *>(&error), &len);
  5337. auto successful = res >= 0 && !error;
  5338. return successful ? Error::Success : Error::Connection;
  5339. }
  5340. return Error::Connection;
  5341. }
  5342. inline bool is_socket_alive(socket_t sock) {
  5343. const auto val = detail::select_read(sock, 0, 0);
  5344. if (val == 0) {
  5345. return true;
  5346. } else if (val < 0 && errno == EBADF) {
  5347. return false;
  5348. }
  5349. char buf[1];
  5350. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5351. }
  5352. class SocketStream final : public Stream {
  5353. public:
  5354. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5355. time_t write_timeout_sec, time_t write_timeout_usec,
  5356. time_t max_timeout_msec = 0,
  5357. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5358. (std::chrono::steady_clock::time_point::min)());
  5359. ~SocketStream() override;
  5360. bool is_readable() const override;
  5361. bool wait_readable() const override;
  5362. bool wait_writable() const override;
  5363. bool is_peer_alive() const override;
  5364. ssize_t read(char *ptr, size_t size) override;
  5365. ssize_t write(const char *ptr, size_t size) override;
  5366. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5367. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5368. socket_t socket() const override;
  5369. time_t duration() const override;
  5370. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5371. const char *buffered_data(size_t &size) const override;
  5372. void consume_buffered(size_t size) override;
  5373. // The caller has just seen this socket become readable. Lets the next read
  5374. // skip its own readiness wait, which would otherwise ask the kernel a
  5375. // question that was answered a moment ago. Consumed by that read.
  5376. void set_readable_hint() { readable_hint_ = true; }
  5377. private:
  5378. bool ensure_readable();
  5379. socket_t sock_;
  5380. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5381. // thread while a read is in flight -- that is the point of it, for a caller
  5382. // holding one connection and wanting control back to send on it.
  5383. std::atomic<time_t> read_timeout_sec_;
  5384. std::atomic<time_t> read_timeout_usec_;
  5385. time_t write_timeout_sec_;
  5386. time_t write_timeout_usec_;
  5387. time_t max_timeout_msec_;
  5388. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5389. std::vector<char> read_buff_;
  5390. size_t read_buff_off_ = 0;
  5391. size_t read_buff_content_size_ = 0;
  5392. bool readable_hint_ = false;
  5393. static const size_t read_buff_size_ = 1024l * 4;
  5394. };
  5395. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5396. time_t keep_alive_timeout_sec) {
  5397. using namespace std::chrono;
  5398. const auto interval_usec =
  5399. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5400. // Avoid expensive `steady_clock::now()` call for the first time
  5401. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5402. const auto start = steady_clock::now() - microseconds{interval_usec};
  5403. const auto timeout = seconds{keep_alive_timeout_sec};
  5404. while (true) {
  5405. if (svr_sock == INVALID_SOCKET) {
  5406. break; // Server socket is closed
  5407. }
  5408. auto val = select_read(sock, 0, interval_usec);
  5409. if (val < 0) {
  5410. break; // Ssocket error
  5411. } else if (val == 0) {
  5412. if (steady_clock::now() - start > timeout) {
  5413. break; // Timeout
  5414. }
  5415. } else {
  5416. return true; // Ready for read
  5417. }
  5418. }
  5419. return false;
  5420. }
  5421. template <typename T>
  5422. inline bool
  5423. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5424. size_t keep_alive_max_count,
  5425. time_t keep_alive_timeout_sec, T callback) {
  5426. assert(keep_alive_max_count > 0);
  5427. auto ret = false;
  5428. auto count = keep_alive_max_count;
  5429. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5430. auto close_connection = count == 1;
  5431. auto connection_closed = false;
  5432. ret = callback(close_connection, connection_closed);
  5433. if (!ret || connection_closed) { break; }
  5434. count--;
  5435. }
  5436. return ret;
  5437. }
  5438. template <typename T>
  5439. inline bool
  5440. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5441. size_t keep_alive_max_count,
  5442. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5443. time_t read_timeout_usec, time_t write_timeout_sec,
  5444. time_t write_timeout_usec, T callback) {
  5445. return process_server_socket_core(
  5446. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5447. [&](bool close_connection, bool &connection_closed) {
  5448. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5449. write_timeout_sec, write_timeout_usec);
  5450. // process_server_socket_core() only gets here once keep_alive() has
  5451. // seen the socket go readable.
  5452. strm.set_readable_hint();
  5453. return callback(strm, close_connection, connection_closed);
  5454. });
  5455. }
  5456. inline bool process_client_socket(
  5457. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5458. time_t write_timeout_sec, time_t write_timeout_usec,
  5459. time_t max_timeout_msec,
  5460. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5461. std::function<bool(Stream &)> callback) {
  5462. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5463. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5464. start_time);
  5465. return callback(strm);
  5466. }
  5467. inline int shutdown_socket(socket_t sock) noexcept {
  5468. #ifdef _WIN32
  5469. return shutdown(sock, SD_BOTH);
  5470. #else
  5471. return shutdown(sock, SHUT_RDWR);
  5472. #endif
  5473. }
  5474. // Half-closes the write side and drains any in-flight/queued bytes before
  5475. // the final shutdown+close. Closing with unread data in the receive queue
  5476. // (or bytes arriving after the receive side is closed) makes the stack send
  5477. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5478. // response as a failed read even though it was fully written.
  5479. inline void drain_and_close_socket(socket_t sock) noexcept {
  5480. #ifdef _WIN32
  5481. shutdown(sock, SD_SEND);
  5482. #else
  5483. shutdown(sock, SHUT_WR);
  5484. #endif
  5485. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5486. size_t total = 0;
  5487. const auto deadline = std::chrono::steady_clock::now() +
  5488. std::chrono::milliseconds(100); // bound #1
  5489. while (total < size_t(1024u * 1024u)) { // bound #2
  5490. const auto remaining =
  5491. std::chrono::duration_cast<std::chrono::microseconds>(
  5492. deadline - std::chrono::steady_clock::now())
  5493. .count();
  5494. if (remaining <= 0) { break; }
  5495. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5496. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5497. if (n <= 0) { break; }
  5498. total += static_cast<size_t>(n);
  5499. }
  5500. shutdown_socket(sock);
  5501. close_socket(sock);
  5502. }
  5503. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5504. if (s.size() > 1 && s[0] == '\0') {
  5505. auto ret = s;
  5506. ret[0] = '@';
  5507. return ret;
  5508. }
  5509. return s;
  5510. }
  5511. inline std::string
  5512. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5513. if (s.size() > 1 && s[0] == '@') {
  5514. auto ret = s;
  5515. ret[0] = '\0';
  5516. return ret;
  5517. }
  5518. return s;
  5519. }
  5520. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5521. const struct addrinfo *hints,
  5522. struct addrinfo **res, time_t timeout_sec) {
  5523. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5524. if (timeout_sec <= 0) {
  5525. // No timeout specified, use standard getaddrinfo
  5526. return getaddrinfo(node, service, hints, res);
  5527. }
  5528. #ifdef _WIN32
  5529. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5530. OVERLAPPED overlapped = {};
  5531. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5532. if (!event) { return EAI_FAIL; }
  5533. overlapped.hEvent = event;
  5534. PADDRINFOEXW result_addrinfo = nullptr;
  5535. HANDLE cancel_handle = nullptr;
  5536. ADDRINFOEXW hints_ex = {};
  5537. if (hints) {
  5538. hints_ex.ai_flags = hints->ai_flags;
  5539. hints_ex.ai_family = hints->ai_family;
  5540. hints_ex.ai_socktype = hints->ai_socktype;
  5541. hints_ex.ai_protocol = hints->ai_protocol;
  5542. }
  5543. auto wnode = u8string_to_wstring(node);
  5544. auto wservice = u8string_to_wstring(service);
  5545. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5546. hints ? &hints_ex : nullptr, &result_addrinfo,
  5547. nullptr, &overlapped, nullptr, &cancel_handle);
  5548. if (ret == WSA_IO_PENDING) {
  5549. auto wait_result =
  5550. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5551. if (wait_result == WAIT_TIMEOUT) {
  5552. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5553. ::CloseHandle(event);
  5554. return EAI_AGAIN;
  5555. }
  5556. DWORD bytes_returned;
  5557. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5558. &bytes_returned, FALSE)) {
  5559. ::CloseHandle(event);
  5560. return ::WSAGetLastError();
  5561. }
  5562. }
  5563. ::CloseHandle(event);
  5564. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5565. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5566. return 0;
  5567. }
  5568. return ret;
  5569. #elif TARGET_OS_MAC && defined(__clang__)
  5570. if (!node) { return EAI_NONAME; }
  5571. // macOS implementation using CFHost API for asynchronous DNS resolution
  5572. CFStringRef hostname_ref = CFStringCreateWithCString(
  5573. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5574. if (!hostname_ref) { return EAI_MEMORY; }
  5575. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5576. CFRelease(hostname_ref);
  5577. if (!host_ref) { return EAI_MEMORY; }
  5578. // Set up context for callback
  5579. struct CFHostContext {
  5580. bool completed = false;
  5581. bool success = false;
  5582. CFArrayRef addresses = nullptr;
  5583. std::mutex mutex;
  5584. std::condition_variable cv;
  5585. } context;
  5586. CFHostClientContext client_context;
  5587. memset(&client_context, 0, sizeof(client_context));
  5588. client_context.info = &context;
  5589. // Set callback
  5590. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5591. const CFStreamError *error, void *info) {
  5592. auto ctx = static_cast<CFHostContext *>(info);
  5593. std::lock_guard<std::mutex> lock(ctx->mutex);
  5594. if (error && error->error != 0) {
  5595. ctx->success = false;
  5596. } else {
  5597. Boolean hasBeenResolved;
  5598. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5599. if (ctx->addresses && hasBeenResolved) {
  5600. CFRetain(ctx->addresses);
  5601. ctx->success = true;
  5602. } else {
  5603. ctx->success = false;
  5604. }
  5605. }
  5606. ctx->completed = true;
  5607. ctx->cv.notify_one();
  5608. };
  5609. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5610. CFRelease(host_ref);
  5611. return EAI_SYSTEM;
  5612. }
  5613. // Schedule on run loop
  5614. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5615. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5616. // Start resolution
  5617. CFStreamError stream_error;
  5618. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5619. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5620. CFRelease(host_ref);
  5621. return EAI_FAIL;
  5622. }
  5623. // Wait for completion with timeout
  5624. auto timeout_time =
  5625. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5626. bool timed_out = false;
  5627. {
  5628. std::unique_lock<std::mutex> lock(context.mutex);
  5629. while (!context.completed) {
  5630. auto now = std::chrono::steady_clock::now();
  5631. if (now >= timeout_time) {
  5632. timed_out = true;
  5633. break;
  5634. }
  5635. // Run the runloop for a short time
  5636. lock.unlock();
  5637. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5638. lock.lock();
  5639. }
  5640. }
  5641. // Clean up
  5642. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5643. CFHostSetClient(host_ref, nullptr, nullptr);
  5644. if (timed_out || !context.completed) {
  5645. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5646. CFRelease(host_ref);
  5647. return EAI_AGAIN;
  5648. }
  5649. if (!context.success || !context.addresses) {
  5650. CFRelease(host_ref);
  5651. return EAI_NODATA;
  5652. }
  5653. // Convert CFArray to addrinfo
  5654. CFIndex count = CFArrayGetCount(context.addresses);
  5655. if (count == 0) {
  5656. CFRelease(context.addresses);
  5657. CFRelease(host_ref);
  5658. return EAI_NODATA;
  5659. }
  5660. struct addrinfo *result_addrinfo = nullptr;
  5661. struct addrinfo **current = &result_addrinfo;
  5662. for (CFIndex i = 0; i < count; i++) {
  5663. CFDataRef addr_data =
  5664. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5665. if (!addr_data) continue;
  5666. const struct sockaddr *sockaddr_ptr =
  5667. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5668. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5669. // Allocate addrinfo structure
  5670. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5671. if (!*current) {
  5672. freeaddrinfo(result_addrinfo);
  5673. CFRelease(context.addresses);
  5674. CFRelease(host_ref);
  5675. return EAI_MEMORY;
  5676. }
  5677. memset(*current, 0, sizeof(struct addrinfo));
  5678. // Set up addrinfo fields
  5679. (*current)->ai_family = sockaddr_ptr->sa_family;
  5680. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5681. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5682. (*current)->ai_addrlen = sockaddr_len;
  5683. // Copy sockaddr
  5684. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5685. if (!(*current)->ai_addr) {
  5686. freeaddrinfo(result_addrinfo);
  5687. CFRelease(context.addresses);
  5688. CFRelease(host_ref);
  5689. return EAI_MEMORY;
  5690. }
  5691. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5692. // Set port if service is specified
  5693. if (service && *service) {
  5694. int port = 0;
  5695. if (parse_port(service, strlen(service), port)) {
  5696. if (sockaddr_ptr->sa_family == AF_INET) {
  5697. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5698. ->sin_port = htons(static_cast<uint16_t>(port));
  5699. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5700. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5701. ->sin6_port = htons(static_cast<uint16_t>(port));
  5702. }
  5703. }
  5704. }
  5705. current = &((*current)->ai_next);
  5706. }
  5707. CFRelease(context.addresses);
  5708. CFRelease(host_ref);
  5709. *res = result_addrinfo;
  5710. return 0;
  5711. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5712. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5713. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5714. // the resolver worker still references the stack-local gaicb. The cancel
  5715. // path therefore waits (gai_suspend with no timeout) for the worker to
  5716. // actually finish before letting the stack frame go. The trade-off is that
  5717. // a wedged DNS server can hold this thread for the system resolver timeout
  5718. // (~30s by default) past the caller's connection timeout.
  5719. struct gaicb request {};
  5720. struct gaicb *requests[1] = {&request};
  5721. struct sigevent sevp {};
  5722. struct timespec timeout {
  5723. timeout_sec, 0
  5724. };
  5725. request.ar_name = node;
  5726. request.ar_service = service;
  5727. request.ar_request = hints;
  5728. sevp.sigev_notify = SIGEV_NONE;
  5729. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5730. if (rc != 0) { return rc; }
  5731. auto cleanup = scope_exit([&] {
  5732. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5733. });
  5734. int wait_result = gai_suspend(requests, 1, &timeout);
  5735. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5736. int gai_result = gai_error(&request);
  5737. if (gai_result == 0) {
  5738. *res = request.ar_result;
  5739. request.ar_result = nullptr;
  5740. return 0;
  5741. }
  5742. return gai_result;
  5743. }
  5744. gai_cancel(&request);
  5745. while (gai_error(&request) == EAI_INPROGRESS) {
  5746. gai_suspend(requests, 1, nullptr);
  5747. }
  5748. return wait_result;
  5749. #else
  5750. // Fallback implementation using thread-based timeout for other Unix systems.
  5751. struct GetAddrInfoState {
  5752. ~GetAddrInfoState() {
  5753. if (info) { freeaddrinfo(info); }
  5754. }
  5755. std::mutex mutex;
  5756. std::condition_variable result_cv;
  5757. bool completed = false;
  5758. int result = EAI_SYSTEM;
  5759. std::string node;
  5760. std::string service;
  5761. struct addrinfo hints;
  5762. struct addrinfo *info = nullptr;
  5763. };
  5764. // Allocate on the heap, so the resolver thread can keep using the data.
  5765. auto state = std::make_shared<GetAddrInfoState>();
  5766. if (node) { state->node = node; }
  5767. state->service = service;
  5768. state->hints = *hints;
  5769. std::thread resolve_thread([state]() {
  5770. auto thread_result =
  5771. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5772. &state->info);
  5773. std::lock_guard<std::mutex> lock(state->mutex);
  5774. state->result = thread_result;
  5775. state->completed = true;
  5776. state->result_cv.notify_one();
  5777. });
  5778. // Wait for completion or timeout
  5779. std::unique_lock<std::mutex> lock(state->mutex);
  5780. auto finished =
  5781. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5782. [&] { return state->completed; });
  5783. if (finished) {
  5784. // Operation completed within timeout
  5785. resolve_thread.join();
  5786. *res = state->info;
  5787. state->info = nullptr; // Pass ownership to caller
  5788. return state->result;
  5789. } else {
  5790. // Timeout occurred
  5791. resolve_thread.detach(); // Let the thread finish in background
  5792. return EAI_AGAIN; // Return timeout error
  5793. }
  5794. #endif
  5795. #else
  5796. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5797. return getaddrinfo(node, service, hints, res);
  5798. #endif
  5799. }
  5800. template <typename BindOrConnect>
  5801. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5802. int address_family, int socket_flags, bool tcp_nodelay,
  5803. bool ipv6_v6only, SocketOptions socket_options,
  5804. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5805. // Get address info
  5806. const char *node = nullptr;
  5807. struct addrinfo hints;
  5808. struct addrinfo *result;
  5809. memset(&hints, 0, sizeof(struct addrinfo));
  5810. hints.ai_socktype = SOCK_STREAM;
  5811. hints.ai_protocol = IPPROTO_IP;
  5812. if (!ip.empty()) {
  5813. node = ip.c_str();
  5814. // Ask getaddrinfo to convert IP in c-string to address
  5815. hints.ai_family = AF_UNSPEC;
  5816. hints.ai_flags = AI_NUMERICHOST;
  5817. } else {
  5818. if (!host.empty()) { node = host.c_str(); }
  5819. hints.ai_family = address_family;
  5820. hints.ai_flags = socket_flags;
  5821. }
  5822. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5823. if (hints.ai_family == AF_UNIX) {
  5824. const auto addrlen = host.length();
  5825. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5826. #ifdef SOCK_CLOEXEC
  5827. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5828. hints.ai_protocol);
  5829. #else
  5830. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5831. #endif
  5832. if (sock != INVALID_SOCKET) {
  5833. sockaddr_un addr{};
  5834. addr.sun_family = AF_UNIX;
  5835. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5836. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5837. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5838. hints.ai_addrlen = static_cast<socklen_t>(
  5839. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5840. #ifndef SOCK_CLOEXEC
  5841. #ifndef _WIN32
  5842. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5843. #endif
  5844. #endif
  5845. if (socket_options) { socket_options(sock); }
  5846. #ifdef _WIN32
  5847. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5848. // remove the option.
  5849. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5850. #endif
  5851. bool dummy;
  5852. if (!bind_or_connect(sock, hints, dummy)) {
  5853. close_socket(sock);
  5854. sock = INVALID_SOCKET;
  5855. }
  5856. }
  5857. return sock;
  5858. }
  5859. #endif
  5860. auto service = std::to_string(port);
  5861. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5862. timeout_sec)) {
  5863. #if defined __linux__ && !defined __ANDROID__
  5864. res_init();
  5865. #endif
  5866. return INVALID_SOCKET;
  5867. }
  5868. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5869. for (auto rp = result; rp; rp = rp->ai_next) {
  5870. // Create a socket
  5871. #ifdef _WIN32
  5872. auto sock =
  5873. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5874. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5875. /**
  5876. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5877. * and above the socket creation fails on older Windows Systems.
  5878. *
  5879. * Let's try to create a socket the old way in this case.
  5880. *
  5881. * Reference:
  5882. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5883. *
  5884. * WSA_FLAG_NO_HANDLE_INHERIT:
  5885. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5886. * SP1, and later
  5887. *
  5888. */
  5889. if (sock == INVALID_SOCKET) {
  5890. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5891. }
  5892. #else
  5893. #ifdef SOCK_CLOEXEC
  5894. auto sock =
  5895. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5896. #else
  5897. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5898. #endif
  5899. #endif
  5900. if (sock == INVALID_SOCKET) { continue; }
  5901. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5902. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5903. close_socket(sock);
  5904. continue;
  5905. }
  5906. #endif
  5907. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5908. if (rp->ai_family == AF_INET6) {
  5909. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5910. }
  5911. if (socket_options) { socket_options(sock); }
  5912. // bind or connect
  5913. auto quit = false;
  5914. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5915. close_socket(sock);
  5916. if (quit) { break; }
  5917. }
  5918. return INVALID_SOCKET;
  5919. }
  5920. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5921. #ifdef _WIN32
  5922. auto flags = nonblocking ? 1UL : 0UL;
  5923. ioctlsocket(sock, FIONBIO, &flags);
  5924. #else
  5925. auto flags = fcntl(sock, F_GETFL, 0);
  5926. fcntl(sock, F_SETFL,
  5927. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5928. #endif
  5929. }
  5930. inline bool is_connection_error() {
  5931. #ifdef _WIN32
  5932. return WSAGetLastError() != WSAEWOULDBLOCK;
  5933. #else
  5934. return errno != EINPROGRESS;
  5935. #endif
  5936. }
  5937. // accept() failed because the process or the network stack is temporarily out
  5938. // of resources. The listening socket is still usable, so back off briefly and
  5939. // try again.
  5940. inline bool is_accept_resource_error() {
  5941. #ifdef _WIN32
  5942. auto err = WSAGetLastError();
  5943. return err == WSAEMFILE || err == WSAENOBUFS;
  5944. #else
  5945. auto err = errno;
  5946. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  5947. #endif
  5948. }
  5949. // accept() failed for a reason that says nothing about the listening socket:
  5950. // the pending connection went away before it could be accepted, or the call
  5951. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  5952. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  5953. // connection that way.
  5954. inline bool is_accept_transient_error() {
  5955. #ifdef _WIN32
  5956. auto err = WSAGetLastError();
  5957. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  5958. err == WSAECONNABORTED;
  5959. #else
  5960. auto err = errno;
  5961. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  5962. err == ECONNABORTED;
  5963. #endif
  5964. }
  5965. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  5966. struct addrinfo hints;
  5967. struct addrinfo *result;
  5968. memset(&hints, 0, sizeof(struct addrinfo));
  5969. hints.ai_family = AF_UNSPEC;
  5970. hints.ai_socktype = SOCK_STREAM;
  5971. hints.ai_protocol = 0;
  5972. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  5973. return false;
  5974. }
  5975. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5976. auto ret = false;
  5977. for (auto rp = result; rp; rp = rp->ai_next) {
  5978. const auto &ai = *rp;
  5979. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  5980. ret = true;
  5981. break;
  5982. }
  5983. }
  5984. return ret;
  5985. }
  5986. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  5987. #define USE_IF2IP
  5988. #endif
  5989. #ifdef USE_IF2IP
  5990. inline std::string if2ip(int address_family, const std::string &ifn) {
  5991. struct ifaddrs *ifap;
  5992. getifaddrs(&ifap);
  5993. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  5994. std::string addr_candidate;
  5995. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  5996. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  5997. (AF_UNSPEC == address_family ||
  5998. ifa->ifa_addr->sa_family == address_family)) {
  5999. if (ifa->ifa_addr->sa_family == AF_INET) {
  6000. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6001. char buf[INET_ADDRSTRLEN];
  6002. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6003. return std::string(buf, INET_ADDRSTRLEN);
  6004. }
  6005. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6006. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6007. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6008. char buf[INET6_ADDRSTRLEN] = {};
  6009. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6010. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6011. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6012. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6013. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6014. } else {
  6015. return std::string(buf, INET6_ADDRSTRLEN);
  6016. }
  6017. }
  6018. }
  6019. }
  6020. }
  6021. }
  6022. return addr_candidate;
  6023. }
  6024. #endif
  6025. inline socket_t create_client_socket(
  6026. const std::string &host, const std::string &ip, int port,
  6027. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6028. SocketOptions socket_options, time_t connection_timeout_sec,
  6029. time_t connection_timeout_usec, time_t read_timeout_sec,
  6030. time_t read_timeout_usec, time_t write_timeout_sec,
  6031. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6032. auto sock = create_socket(
  6033. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6034. std::move(socket_options),
  6035. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6036. if (!intf.empty()) {
  6037. #ifdef USE_IF2IP
  6038. auto ip_from_if = if2ip(address_family, intf);
  6039. if (ip_from_if.empty()) { ip_from_if = intf; }
  6040. if (!bind_ip_address(sock2, ip_from_if)) {
  6041. error = Error::BindIPAddress;
  6042. return false;
  6043. }
  6044. #endif
  6045. }
  6046. set_nonblocking(sock2, true);
  6047. auto ret =
  6048. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6049. if (ret < 0) {
  6050. if (is_connection_error()) {
  6051. error = Error::Connection;
  6052. return false;
  6053. }
  6054. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6055. connection_timeout_usec);
  6056. if (error != Error::Success) {
  6057. if (error == Error::ConnectionTimeout) { quit = true; }
  6058. return false;
  6059. }
  6060. }
  6061. set_nonblocking(sock2, false);
  6062. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6063. read_timeout_usec);
  6064. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6065. write_timeout_usec);
  6066. error = Error::Success;
  6067. return true;
  6068. },
  6069. connection_timeout_sec); // Pass DNS timeout
  6070. if (sock != INVALID_SOCKET) {
  6071. error = Error::Success;
  6072. } else {
  6073. if (error == Error::Success) { error = Error::Connection; }
  6074. }
  6075. return sock;
  6076. }
  6077. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6078. socklen_t addr_len, std::string &ip, int &port) {
  6079. if (addr.ss_family == AF_INET) {
  6080. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6081. } else if (addr.ss_family == AF_INET6) {
  6082. port =
  6083. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6084. } else {
  6085. return false;
  6086. }
  6087. std::array<char, NI_MAXHOST> ipstr{};
  6088. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6089. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6090. 0, NI_NUMERICHOST)) {
  6091. return false;
  6092. }
  6093. ip = ipstr.data();
  6094. return true;
  6095. }
  6096. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6097. struct sockaddr_storage addr;
  6098. socklen_t addr_len = sizeof(addr);
  6099. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6100. &addr_len)) {
  6101. get_ip_and_port(addr, addr_len, ip, port);
  6102. }
  6103. }
  6104. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6105. struct sockaddr_storage addr;
  6106. socklen_t addr_len = sizeof(addr);
  6107. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6108. &addr_len)) {
  6109. #ifndef _WIN32
  6110. if (addr.ss_family == AF_UNIX) {
  6111. #if defined(__linux__)
  6112. struct ucred ucred;
  6113. socklen_t len = sizeof(ucred);
  6114. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6115. port = ucred.pid;
  6116. }
  6117. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6118. pid_t pid;
  6119. socklen_t len = sizeof(pid);
  6120. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6121. port = pid;
  6122. }
  6123. #endif
  6124. return;
  6125. }
  6126. #endif
  6127. get_ip_and_port(addr, addr_len, ip, port);
  6128. }
  6129. }
  6130. // Recursive form retained so operator""_t below can compute hashes for
  6131. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6132. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6133. // instead, which is iterative and stack-safe.
  6134. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6135. unsigned int h) {
  6136. return (l == 0)
  6137. ? h
  6138. : str2tag_core(
  6139. s + 1, l - 1,
  6140. // Unsets the 6 high bits of h, therefore no overflow happens
  6141. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6142. h * 33) ^
  6143. static_cast<unsigned char>(*s));
  6144. }
  6145. inline unsigned int str2tag(const std::string &s) {
  6146. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6147. // for compile-time UDL evaluation of short string literals, but at runtime
  6148. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6149. // would blow the stack with one frame per character.
  6150. unsigned int h = 0;
  6151. for (auto c : s) {
  6152. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6153. static_cast<unsigned char>(c);
  6154. }
  6155. return h;
  6156. }
  6157. namespace udl {
  6158. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6159. return str2tag_core(s, l, 0);
  6160. }
  6161. } // namespace udl
  6162. inline std::string
  6163. find_content_type(const std::string &path,
  6164. const std::map<std::string, std::string> &user_data,
  6165. const std::string &default_content_type) {
  6166. auto ext = file_extension(path);
  6167. auto it = user_data.find(ext);
  6168. if (it != user_data.end()) { return it->second; }
  6169. using udl::operator""_t;
  6170. switch (str2tag(ext)) {
  6171. default: return default_content_type;
  6172. case "css"_t: return "text/css";
  6173. case "csv"_t: return "text/csv";
  6174. case "htm"_t:
  6175. case "html"_t: return "text/html";
  6176. case "js"_t:
  6177. case "mjs"_t: return "text/javascript";
  6178. case "txt"_t: return "text/plain";
  6179. case "vtt"_t: return "text/vtt";
  6180. case "apng"_t: return "image/apng";
  6181. case "avif"_t: return "image/avif";
  6182. case "bmp"_t: return "image/bmp";
  6183. case "gif"_t: return "image/gif";
  6184. case "png"_t: return "image/png";
  6185. case "svg"_t: return "image/svg+xml";
  6186. case "webp"_t: return "image/webp";
  6187. case "ico"_t: return "image/x-icon";
  6188. case "tif"_t: return "image/tiff";
  6189. case "tiff"_t: return "image/tiff";
  6190. case "jpg"_t:
  6191. case "jpeg"_t: return "image/jpeg";
  6192. case "mp4"_t: return "video/mp4";
  6193. case "mpeg"_t: return "video/mpeg";
  6194. case "webm"_t: return "video/webm";
  6195. case "mp3"_t: return "audio/mp3";
  6196. case "mpga"_t: return "audio/mpeg";
  6197. case "weba"_t: return "audio/webm";
  6198. case "wav"_t: return "audio/wave";
  6199. case "otf"_t: return "font/otf";
  6200. case "ttf"_t: return "font/ttf";
  6201. case "woff"_t: return "font/woff";
  6202. case "woff2"_t: return "font/woff2";
  6203. case "7z"_t: return "application/x-7z-compressed";
  6204. case "atom"_t: return "application/atom+xml";
  6205. case "pdf"_t: return "application/pdf";
  6206. case "json"_t: return "application/json";
  6207. case "rss"_t: return "application/rss+xml";
  6208. case "tar"_t: return "application/x-tar";
  6209. case "xht"_t:
  6210. case "xhtml"_t: return "application/xhtml+xml";
  6211. case "xslt"_t: return "application/xslt+xml";
  6212. case "xml"_t: return "application/xml";
  6213. case "gz"_t: return "application/gzip";
  6214. case "zip"_t: return "application/zip";
  6215. case "wasm"_t: return "application/wasm";
  6216. }
  6217. }
  6218. inline std::string
  6219. extract_media_type(const std::string &content_type,
  6220. std::map<std::string, std::string> *params = nullptr) {
  6221. // Extract type/subtype from Content-Type value (RFC 2045)
  6222. // e.g. "application/json; charset=utf-8" -> "application/json"
  6223. auto media_type = content_type;
  6224. auto semicolon_pos = media_type.find(';');
  6225. if (semicolon_pos != std::string::npos) {
  6226. auto param_str = media_type.substr(semicolon_pos + 1);
  6227. media_type = media_type.substr(0, semicolon_pos);
  6228. if (params) {
  6229. // Parse parameters: key=value pairs separated by ';'
  6230. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6231. [&](const char *b, const char *e) {
  6232. std::string key;
  6233. std::string val;
  6234. divide_param_pair(b, e, key, val);
  6235. if (!key.empty()) {
  6236. params->emplace(trim_copy(key),
  6237. trim_double_quotes_copy(val));
  6238. }
  6239. });
  6240. }
  6241. }
  6242. // Trim whitespace from media type
  6243. return trim_copy(media_type);
  6244. }
  6245. inline bool can_compress_content_type(const std::string &content_type) {
  6246. using udl::operator""_t;
  6247. auto mime_type = extract_media_type(content_type);
  6248. auto tag = str2tag(mime_type);
  6249. switch (tag) {
  6250. case "image/svg+xml"_t:
  6251. case "application/javascript"_t:
  6252. case "application/x-javascript"_t:
  6253. case "application/json"_t:
  6254. case "application/ld+json"_t:
  6255. case "application/xml"_t:
  6256. case "application/xhtml+xml"_t:
  6257. case "application/rss+xml"_t:
  6258. case "application/atom+xml"_t:
  6259. case "application/xslt+xml"_t:
  6260. case "application/protobuf"_t: return true;
  6261. case "text/event-stream"_t: return false;
  6262. default: return !mime_type.rfind("text/", 0);
  6263. }
  6264. }
  6265. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6266. double &quality) {
  6267. quality = 1.0;
  6268. token.clear();
  6269. // Split on first ';': left = token name, right = parameters
  6270. const char *params_b = nullptr;
  6271. std::size_t params_len = 0;
  6272. divide(
  6273. b, static_cast<std::size_t>(e - b), ';',
  6274. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6275. auto r = trim(lb, lb + llen, 0, llen);
  6276. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6277. params_b = rb;
  6278. params_len = rlen;
  6279. });
  6280. if (token.empty()) { return false; }
  6281. if (params_len == 0) { return true; }
  6282. // Scan parameters for q= (stops on first match)
  6283. bool invalid = false;
  6284. split_find(params_b, params_b + params_len, ';',
  6285. (std::numeric_limits<size_t>::max)(),
  6286. [&](const char *pb, const char *pe) -> bool {
  6287. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6288. auto len = static_cast<size_t>(pe - pb);
  6289. if (len < 2) { return false; }
  6290. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6291. return false;
  6292. }
  6293. // Trim the value portion
  6294. auto r = trim(pb, pe, 2, len);
  6295. if (r.first >= r.second) {
  6296. invalid = true;
  6297. return true;
  6298. }
  6299. double v = 0.0;
  6300. auto res = from_chars(pb + r.first, pb + r.second, v);
  6301. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6302. invalid = true;
  6303. return true;
  6304. }
  6305. quality = v;
  6306. return true;
  6307. });
  6308. return !invalid;
  6309. }
  6310. inline EncodingType encoding_type(const Request &req,
  6311. const std::string &content_type) {
  6312. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6313. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6314. if (s.empty()) { return EncodingType::None; }
  6315. // Single-pass: iterate tokens and track the best supported encoding.
  6316. // Server preference breaks ties (br > gzip > zstd).
  6317. EncodingType best = EncodingType::None;
  6318. double best_q = 0.0; // q=0 means "not acceptable"
  6319. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6320. auto priority = [](EncodingType t) -> int {
  6321. switch (t) {
  6322. case EncodingType::Brotli: return 0;
  6323. case EncodingType::Gzip: return 1;
  6324. case EncodingType::Zstd: return 2;
  6325. default: return 3;
  6326. }
  6327. };
  6328. std::string name;
  6329. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6330. double quality = 1.0;
  6331. if (!parse_quality(b, e, name, quality)) { return; }
  6332. if (quality <= 0.0) { return; }
  6333. EncodingType type = EncodingType::None;
  6334. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6335. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6336. #endif
  6337. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6338. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6339. type = EncodingType::Gzip;
  6340. }
  6341. #endif
  6342. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6343. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6344. type = EncodingType::Zstd;
  6345. }
  6346. #endif
  6347. if (type == EncodingType::None) { return; }
  6348. // Higher q-value wins; for equal q, server preference breaks ties
  6349. if (quality > best_q ||
  6350. (quality == best_q && priority(type) < priority(best))) {
  6351. best_q = quality;
  6352. best = type;
  6353. }
  6354. });
  6355. return best;
  6356. }
  6357. // `content_type` is taken separately because a file-backed response has not
  6358. // been given one yet when its coding has to be decided.
  6359. inline EncodingType encoding_type(const Request &req, const Response &res,
  6360. const std::string &content_type) {
  6361. // The response already names a content coding of its own: a handler serving
  6362. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6363. // point whose headers name the coding its files are stored in. Applying one
  6364. // on top of that would double-encode the body and append a second
  6365. // `Content-Encoding` field line.
  6366. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6367. return encoding_type(req, content_type);
  6368. }
  6369. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6370. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6371. }
  6372. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6373. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6374. if (type == EncodingType::Gzip) {
  6375. return detail::make_unique<gzip_compressor>();
  6376. }
  6377. #endif
  6378. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6379. if (type == EncodingType::Brotli) {
  6380. return detail::make_unique<brotli_compressor>();
  6381. }
  6382. #endif
  6383. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6384. if (type == EncodingType::Zstd) {
  6385. return detail::make_unique<zstd_compressor>();
  6386. }
  6387. #endif
  6388. (void)type;
  6389. return nullptr;
  6390. }
  6391. inline const char *encoding_name(EncodingType type) {
  6392. switch (type) {
  6393. case EncodingType::Gzip: return "gzip";
  6394. case EncodingType::Brotli: return "br";
  6395. case EncodingType::Zstd: return "zstd";
  6396. default: return "";
  6397. }
  6398. }
  6399. inline bool nocompressor::compress(const char *data, size_t data_length,
  6400. bool /*last*/, Callback callback) {
  6401. if (!data_length) { return true; }
  6402. return callback(data, data_length);
  6403. }
  6404. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6405. inline gzip_compressor::gzip_compressor() {
  6406. std::memset(&strm_, 0, sizeof(strm_));
  6407. strm_.zalloc = Z_NULL;
  6408. strm_.zfree = Z_NULL;
  6409. strm_.opaque = Z_NULL;
  6410. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6411. Z_DEFAULT_STRATEGY) == Z_OK;
  6412. }
  6413. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6414. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6415. bool last, Callback callback) {
  6416. assert(is_valid_);
  6417. do {
  6418. constexpr size_t max_avail_in =
  6419. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6420. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6421. (std::min)(data_length, max_avail_in));
  6422. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6423. data_length -= strm_.avail_in;
  6424. data += strm_.avail_in;
  6425. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6426. auto ret = Z_OK;
  6427. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6428. do {
  6429. strm_.avail_out = static_cast<uInt>(buff.size());
  6430. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6431. ret = deflate(&strm_, flush);
  6432. if (ret == Z_STREAM_ERROR) { return false; }
  6433. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6434. return false;
  6435. }
  6436. } while (strm_.avail_out == 0);
  6437. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6438. (flush == Z_NO_FLUSH && ret == Z_OK));
  6439. assert(strm_.avail_in == 0);
  6440. } while (data_length > 0);
  6441. return true;
  6442. }
  6443. inline gzip_decompressor::gzip_decompressor() {
  6444. std::memset(&strm_, 0, sizeof(strm_));
  6445. strm_.zalloc = Z_NULL;
  6446. strm_.zfree = Z_NULL;
  6447. strm_.opaque = Z_NULL;
  6448. // 15 is the value of wbits, which should be at the maximum possible value
  6449. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6450. // that the stream type should be automatically detected either gzip or
  6451. // deflate.
  6452. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6453. }
  6454. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6455. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6456. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6457. Callback callback) {
  6458. assert(is_valid_);
  6459. auto ret = Z_OK;
  6460. do {
  6461. constexpr size_t max_avail_in =
  6462. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6463. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6464. (std::min)(data_length, max_avail_in));
  6465. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6466. data_length -= strm_.avail_in;
  6467. data += strm_.avail_in;
  6468. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6469. while (strm_.avail_in > 0 && ret == Z_OK) {
  6470. strm_.avail_out = static_cast<uInt>(buff.size());
  6471. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6472. ret = inflate(&strm_, Z_NO_FLUSH);
  6473. assert(ret != Z_STREAM_ERROR);
  6474. switch (ret) {
  6475. case Z_NEED_DICT:
  6476. case Z_DATA_ERROR:
  6477. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6478. }
  6479. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6480. return false;
  6481. }
  6482. }
  6483. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6484. } while (data_length > 0);
  6485. return true;
  6486. }
  6487. #endif
  6488. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6489. inline brotli_compressor::brotli_compressor() {
  6490. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6491. }
  6492. inline brotli_compressor::~brotli_compressor() {
  6493. BrotliEncoderDestroyInstance(state_);
  6494. }
  6495. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6496. bool last, Callback callback) {
  6497. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6498. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6499. auto available_in = data_length;
  6500. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6501. for (;;) {
  6502. if (last) {
  6503. if (BrotliEncoderIsFinished(state_)) { break; }
  6504. } else {
  6505. if (!available_in) { break; }
  6506. }
  6507. auto available_out = buff.size();
  6508. auto next_out = buff.data();
  6509. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6510. &available_out, &next_out, nullptr)) {
  6511. return false;
  6512. }
  6513. auto output_bytes = buff.size() - available_out;
  6514. if (output_bytes) {
  6515. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6516. }
  6517. }
  6518. return true;
  6519. }
  6520. inline brotli_decompressor::brotli_decompressor() {
  6521. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6522. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6523. : BROTLI_DECODER_RESULT_ERROR;
  6524. }
  6525. inline brotli_decompressor::~brotli_decompressor() {
  6526. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6527. }
  6528. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6529. inline bool brotli_decompressor::decompress(const char *data,
  6530. size_t data_length,
  6531. Callback callback) {
  6532. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6533. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6534. return 0;
  6535. }
  6536. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6537. size_t avail_in = data_length;
  6538. size_t total_out;
  6539. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6540. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6541. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6542. char *next_out = buff.data();
  6543. size_t avail_out = buff.size();
  6544. decoder_r = BrotliDecoderDecompressStream(
  6545. decoder_s, &avail_in, &next_in, &avail_out,
  6546. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6547. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6548. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6549. }
  6550. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6551. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6552. }
  6553. #endif
  6554. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6555. inline zstd_compressor::zstd_compressor() {
  6556. ctx_ = ZSTD_createCCtx();
  6557. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6558. }
  6559. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6560. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6561. bool last, Callback callback) {
  6562. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6563. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6564. ZSTD_inBuffer input = {data, data_length, 0};
  6565. bool finished;
  6566. do {
  6567. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6568. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6569. if (ZSTD_isError(remaining)) { return false; }
  6570. if (!callback(buff.data(), output.pos)) { return false; }
  6571. finished = last ? (remaining == 0) : (input.pos == input.size);
  6572. } while (!finished);
  6573. return true;
  6574. }
  6575. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6576. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6577. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6578. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6579. Callback callback) {
  6580. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6581. ZSTD_inBuffer input = {data, data_length, 0};
  6582. while (input.pos < input.size) {
  6583. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6584. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6585. if (ZSTD_isError(remaining)) { return false; }
  6586. if (!callback(buff.data(), output.pos)) { return false; }
  6587. }
  6588. return true;
  6589. }
  6590. #endif
  6591. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6592. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6593. // unknown coding, and its payload would be handed back still compressed.
  6594. inline bool is_zlib_encoding(const std::string &encoding) {
  6595. return case_ignore::equal(encoding, "gzip") ||
  6596. case_ignore::equal(encoding, "deflate");
  6597. }
  6598. inline bool is_brotli_encoding(const std::string &encoding) {
  6599. return case_ignore::equal(encoding, "br");
  6600. }
  6601. inline bool is_zstd_encoding(const std::string &encoding) {
  6602. return case_ignore::equal(encoding, "zstd");
  6603. }
  6604. // Returns true if the content coding is one cpp-httplib is able to decompress
  6605. // when the corresponding support is compiled in.
  6606. inline bool is_known_content_encoding(const std::string &encoding) {
  6607. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6608. is_zstd_encoding(encoding);
  6609. }
  6610. inline std::unique_ptr<decompressor>
  6611. create_decompressor(const std::string &encoding) {
  6612. std::unique_ptr<decompressor> decompressor;
  6613. if (is_zlib_encoding(encoding)) {
  6614. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6615. decompressor = detail::make_unique<gzip_decompressor>();
  6616. #endif
  6617. } else if (is_brotli_encoding(encoding)) {
  6618. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6619. decompressor = detail::make_unique<brotli_decompressor>();
  6620. #endif
  6621. } else if (is_zstd_encoding(encoding)) {
  6622. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6623. decompressor = detail::make_unique<zstd_decompressor>();
  6624. #endif
  6625. }
  6626. return decompressor;
  6627. }
  6628. // Returns the best available compressor and its Content-Encoding name.
  6629. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6630. inline std::pair<std::unique_ptr<compressor>, const char *>
  6631. create_compressor() {
  6632. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6633. return {detail::make_unique<brotli_compressor>(), "br"};
  6634. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6635. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6636. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6637. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6638. #else
  6639. return {nullptr, nullptr};
  6640. #endif
  6641. }
  6642. inline bool is_prohibited_header_name(const std::string &name) {
  6643. using udl::operator""_t;
  6644. switch (str2tag(name)) {
  6645. case "REMOTE_ADDR"_t:
  6646. case "REMOTE_PORT"_t:
  6647. case "LOCAL_ADDR"_t:
  6648. case "LOCAL_PORT"_t: return true;
  6649. default: return false;
  6650. }
  6651. }
  6652. inline bool has_header(const Headers &headers, const std::string &key) {
  6653. if (is_prohibited_header_name(key)) { return false; }
  6654. return headers.find(key) != headers.end();
  6655. }
  6656. inline const char *get_header_value(const Headers &headers,
  6657. const std::string &key, const char *def,
  6658. size_t id) {
  6659. if (is_prohibited_header_name(key)) {
  6660. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6661. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6662. throw std::invalid_argument(msg);
  6663. #else
  6664. return "";
  6665. #endif
  6666. }
  6667. auto rng = headers.equal_range(key);
  6668. auto it = rng.first;
  6669. std::advance(it, static_cast<ssize_t>(id));
  6670. if (it != rng.second) { return it->second.c_str(); }
  6671. return def;
  6672. }
  6673. inline size_t get_header_value_count(const Headers &headers,
  6674. const std::string &key) {
  6675. return headers.count(key);
  6676. }
  6677. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6678. // list may be sent as several field lines, and the combined field value is
  6679. // those values joined by commas in the order they were received. Callers that
  6680. // parse such a list must work on the combined value; reading only the first
  6681. // occurrence silently drops whatever the later field lines carry.
  6682. inline std::string get_combined_header_value(const Headers &headers,
  6683. const std::string &key) {
  6684. std::string combined;
  6685. auto rng = headers.equal_range(key);
  6686. for (auto it = rng.first; it != rng.second; ++it) {
  6687. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6688. // elements, so an empty field line must not contribute a bare comma to the
  6689. // combined value.
  6690. if (it->second.empty()) { continue; }
  6691. if (!combined.empty()) { combined += ", "; }
  6692. combined += it->second;
  6693. }
  6694. return combined;
  6695. }
  6696. inline bool has_header_token(const Headers &headers, const std::string &key,
  6697. const std::string &token) {
  6698. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6699. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6700. // several lines. Match complete tokens rather than searching the raw value,
  6701. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6702. auto rng = headers.equal_range(key);
  6703. for (auto it = rng.first; it != rng.second; ++it) {
  6704. const auto &value = it->second;
  6705. if (split_find(value.data(), value.data() + value.size(), ',',
  6706. [&](const char *b, const char *e) {
  6707. return case_ignore::equal(std::string(b, e), token);
  6708. })) {
  6709. return true;
  6710. }
  6711. }
  6712. return false;
  6713. }
  6714. template <typename Map>
  6715. inline typename Map::mapped_type
  6716. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6717. auto rng = m.equal_range(key);
  6718. auto it = rng.first;
  6719. std::advance(it, static_cast<ssize_t>(id));
  6720. if (it != rng.second) { return it->second; }
  6721. return typename Map::mapped_type();
  6722. }
  6723. inline void set_header(Headers &headers, const std::string &key,
  6724. const std::string &val) {
  6725. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6726. }
  6727. inline bool read_headers(Stream &strm, Headers &headers) {
  6728. const auto bufsiz = 2048;
  6729. char buf[bufsiz];
  6730. stream_line_reader line_reader(strm, buf, bufsiz);
  6731. size_t header_count = 0;
  6732. for (;;) {
  6733. if (!line_reader.getline()) { return false; }
  6734. // Check if the line ends with CRLF.
  6735. auto line_terminator_len = 2;
  6736. if (line_reader.end_with_crlf()) {
  6737. // Blank line indicates end of headers.
  6738. if (line_reader.size() == 2) { break; }
  6739. } else {
  6740. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6741. // Blank line indicates end of headers.
  6742. if (line_reader.size() == 1) { break; }
  6743. line_terminator_len = 1;
  6744. #else
  6745. continue; // Skip invalid line.
  6746. #endif
  6747. }
  6748. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6749. // Check header count limit
  6750. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6751. // Exclude line terminator
  6752. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6753. if (!parse_header(line_reader.ptr(), end,
  6754. [&](const std::string &key, const std::string &val) {
  6755. headers.emplace(key, val);
  6756. })) {
  6757. return false;
  6758. }
  6759. header_count++;
  6760. }
  6761. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6762. // headers that have different values to prevent request smuggling.
  6763. auto cl_range = headers.equal_range("Content-Length");
  6764. if (cl_range.first != cl_range.second) {
  6765. const auto &first_val = cl_range.first->second;
  6766. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6767. if (it->second != first_val) { return false; }
  6768. }
  6769. }
  6770. return true;
  6771. }
  6772. inline bool parse_status_line(const char *line, std::string &version,
  6773. int &status, std::string &reason) {
  6774. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6775. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6776. #else
  6777. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6778. #endif
  6779. std::cmatch m;
  6780. if (!std::regex_match(line, m, re)) { return false; }
  6781. version = std::string(m[1]);
  6782. status = std::stoi(std::string(m[2]));
  6783. reason = std::string(m[3]);
  6784. return true;
  6785. }
  6786. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6787. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6788. struct WebSocketUpgradeResponse {
  6789. Error error = Error::Success;
  6790. int status = -1;
  6791. Headers headers;
  6792. std::string selected_subprotocol;
  6793. };
  6794. inline bool read_websocket_upgrade_response(Stream &strm,
  6795. const std::string &expected_accept,
  6796. WebSocketUpgradeResponse &upgrade) {
  6797. // Read status line
  6798. const auto bufsiz = 2048;
  6799. char buf[bufsiz];
  6800. stream_line_reader line_reader(strm, buf, bufsiz);
  6801. if (!line_reader.getline()) {
  6802. upgrade.error = Error::Read;
  6803. return false;
  6804. }
  6805. std::string version;
  6806. std::string reason;
  6807. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6808. upgrade.error = Error::WebSocketHandshake;
  6809. return false;
  6810. }
  6811. // Read the headers even for a rejection so the caller can see why the
  6812. // server refused the upgrade. A non-101 response may carry a body; it is
  6813. // deliberately left unread since the caller closes the socket right away.
  6814. if (!read_headers(strm, upgrade.headers)) {
  6815. upgrade.error = Error::Read;
  6816. return false;
  6817. }
  6818. const auto &headers = upgrade.headers;
  6819. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6820. upgrade.error = Error::WebSocketHandshake;
  6821. return false;
  6822. }
  6823. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6824. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6825. upgrade.error = Error::WebSocketHandshake;
  6826. return false;
  6827. }
  6828. // Verify Connection: Upgrade
  6829. if (!has_header_token(headers, "Connection", "upgrade")) {
  6830. upgrade.error = Error::WebSocketHandshake;
  6831. return false;
  6832. }
  6833. // Verify Sec-WebSocket-Accept header value
  6834. auto it = headers.find("Sec-WebSocket-Accept");
  6835. if (it == headers.end() || it->second != expected_accept) {
  6836. upgrade.error = Error::WebSocketHandshake;
  6837. return false;
  6838. }
  6839. // Extract negotiated subprotocol
  6840. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6841. if (proto_it != headers.end()) {
  6842. upgrade.selected_subprotocol = proto_it->second;
  6843. }
  6844. return true;
  6845. }
  6846. enum class ReadContentResult {
  6847. Success, // Successfully read the content
  6848. PayloadTooLarge, // The content exceeds the specified payload limit
  6849. Error // An error occurred while reading the content
  6850. };
  6851. inline ReadContentResult read_content_with_length(
  6852. Stream &strm, size_t len, DownloadProgress progress,
  6853. ContentReceiverWithProgress out,
  6854. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6855. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6856. detail::BodyReader br;
  6857. br.stream = &strm;
  6858. br.has_content_length = true;
  6859. br.content_length = len;
  6860. br.payload_max_length = payload_max_length;
  6861. br.chunked = false;
  6862. br.bytes_read = 0;
  6863. br.last_error = Error::Success;
  6864. size_t r = 0;
  6865. while (r < len) {
  6866. auto read_len = static_cast<size_t>(len - r);
  6867. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6868. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6869. if (n <= 0) {
  6870. // Check if it was a payload size error
  6871. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6872. return ReadContentResult::PayloadTooLarge;
  6873. }
  6874. return ReadContentResult::Error;
  6875. }
  6876. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6877. return ReadContentResult::Error;
  6878. }
  6879. r += static_cast<size_t>(n);
  6880. if (progress) {
  6881. if (!progress(r, len)) { return ReadContentResult::Error; }
  6882. }
  6883. }
  6884. return ReadContentResult::Success;
  6885. }
  6886. inline ReadContentResult
  6887. read_content_without_length(Stream &strm, size_t payload_max_length,
  6888. ContentReceiverWithProgress out) {
  6889. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6890. size_t r = 0;
  6891. for (;;) {
  6892. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6893. if (n == 0) { return ReadContentResult::Success; }
  6894. if (n < 0) { return ReadContentResult::Error; }
  6895. // Check if adding this data would exceed the payload limit
  6896. if (r > payload_max_length ||
  6897. payload_max_length - r < static_cast<size_t>(n)) {
  6898. return ReadContentResult::PayloadTooLarge;
  6899. }
  6900. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6901. return ReadContentResult::Error;
  6902. }
  6903. r += static_cast<size_t>(n);
  6904. }
  6905. return ReadContentResult::Success;
  6906. }
  6907. template <typename T>
  6908. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6909. size_t payload_max_length,
  6910. ContentReceiverWithProgress out) {
  6911. detail::ChunkedDecoder dec(strm);
  6912. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6913. size_t total_len = 0;
  6914. for (;;) {
  6915. size_t chunk_offset = 0;
  6916. size_t chunk_total = 0;
  6917. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6918. if (n < 0) { return ReadContentResult::Error; }
  6919. if (n == 0) {
  6920. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6921. return ReadContentResult::Error;
  6922. }
  6923. return ReadContentResult::Success;
  6924. }
  6925. if (total_len > payload_max_length ||
  6926. payload_max_length - total_len < static_cast<size_t>(n)) {
  6927. return ReadContentResult::PayloadTooLarge;
  6928. }
  6929. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6930. return ReadContentResult::Error;
  6931. }
  6932. total_len += static_cast<size_t>(n);
  6933. }
  6934. }
  6935. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6936. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6937. // is the final transfer coding. A single field value may list several
  6938. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6939. // several Transfer-Encoding lines, which combine into one comma-separated
  6940. // list in the order the lines were received. Headers preserves that order,
  6941. // so the final coding is the last token of the last line. Match it
  6942. // case-insensitively rather than comparing the whole value against
  6943. // "chunked".
  6944. //
  6945. // Security: reading a chunked message as unframed leaves its body in the
  6946. // socket, where a keep-alive connection parses it as a smuggled request.
  6947. // Server::process_request() answers 400 and closes when the final coding is
  6948. // not chunked, so a request whose framing cannot be determined never
  6949. // reaches the "no body" path.
  6950. auto rng = headers.equal_range("Transfer-Encoding");
  6951. if (rng.first == rng.second) { return false; }
  6952. // Cleared per line, so a trailing line carrying no coding at all leaves the
  6953. // combined list ending in nothing rather than inheriting the line before it.
  6954. std::string last_coding;
  6955. for (auto it = rng.first; it != rng.second; ++it) {
  6956. const auto &value = it->second;
  6957. last_coding.clear();
  6958. split(value.data(), value.data() + value.size(), ',',
  6959. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  6960. }
  6961. return case_ignore::equal(last_coding, "chunked");
  6962. }
  6963. template <typename T, typename U>
  6964. bool prepare_content_receiver(T &x, int &status,
  6965. ContentReceiverWithProgress receiver,
  6966. bool decompress, size_t payload_max_length,
  6967. bool &exceed_payload_max_length, U callback) {
  6968. if (decompress) {
  6969. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  6970. std::unique_ptr<decompressor> decompressor;
  6971. if (!encoding.empty()) {
  6972. // A coding we know about but were not built with is an error. An
  6973. // unrecognized coding (including "identity") is left alone and the
  6974. // payload is passed through as-is, since some servers misuse the header,
  6975. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  6976. decompressor = detail::create_decompressor(encoding);
  6977. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  6978. status = StatusCode::UnsupportedMediaType_415;
  6979. return false;
  6980. }
  6981. }
  6982. if (decompressor) {
  6983. if (decompressor->is_valid()) {
  6984. size_t decompressed_size = 0;
  6985. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  6986. size_t off, size_t len) {
  6987. return decompressor->decompress(
  6988. buf, n, [&](const char *buf2, size_t n2) {
  6989. // Guard against zip-bomb: check
  6990. // decompressed size against limit.
  6991. if (payload_max_length > 0 &&
  6992. (decompressed_size >= payload_max_length ||
  6993. n2 > payload_max_length - decompressed_size)) {
  6994. exceed_payload_max_length = true;
  6995. return false;
  6996. }
  6997. decompressed_size += n2;
  6998. return receiver(buf2, n2, off, len);
  6999. });
  7000. };
  7001. return callback(std::move(out));
  7002. } else {
  7003. status = StatusCode::InternalServerError_500;
  7004. return false;
  7005. }
  7006. }
  7007. }
  7008. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7009. size_t len) {
  7010. return receiver(buf, n, off, len);
  7011. };
  7012. return callback(std::move(out));
  7013. }
  7014. template <typename T>
  7015. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7016. DownloadProgress progress,
  7017. ContentReceiverWithProgress receiver, bool decompress) {
  7018. bool exceed_payload_max_length = false;
  7019. return prepare_content_receiver(
  7020. x, status, std::move(receiver), decompress, payload_max_length,
  7021. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7022. auto ret = true;
  7023. // Note: exceed_payload_max_length may also be set by the decompressor
  7024. // wrapper in prepare_content_receiver when the decompressed payload
  7025. // size exceeds the limit.
  7026. if (is_chunked_transfer_encoding(x.headers)) {
  7027. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7028. if (result == ReadContentResult::Success) {
  7029. ret = true;
  7030. } else if (result == ReadContentResult::PayloadTooLarge) {
  7031. exceed_payload_max_length = true;
  7032. ret = false;
  7033. } else {
  7034. ret = false;
  7035. }
  7036. } else if (!has_header(x.headers, "Content-Length")) {
  7037. auto result =
  7038. read_content_without_length(strm, payload_max_length, out);
  7039. if (result == ReadContentResult::Success) {
  7040. ret = true;
  7041. } else if (result == ReadContentResult::PayloadTooLarge) {
  7042. exceed_payload_max_length = true;
  7043. ret = false;
  7044. } else {
  7045. ret = false;
  7046. }
  7047. } else {
  7048. auto is_invalid_value = false;
  7049. auto len = get_header_value_u64(x.headers, "Content-Length",
  7050. (std::numeric_limits<size_t>::max)(),
  7051. 0, is_invalid_value);
  7052. if (is_invalid_value) {
  7053. ret = false;
  7054. } else if (len > 0) {
  7055. auto result = read_content_with_length(
  7056. strm, len, std::move(progress), out, payload_max_length);
  7057. ret = (result == ReadContentResult::Success);
  7058. if (result == ReadContentResult::PayloadTooLarge) {
  7059. exceed_payload_max_length = true;
  7060. }
  7061. }
  7062. }
  7063. if (!ret) {
  7064. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7065. : StatusCode::BadRequest_400;
  7066. }
  7067. return ret;
  7068. });
  7069. }
  7070. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7071. const std::string &path) {
  7072. // A request target must not carry CR/LF (or other control octets); otherwise
  7073. // a value smuggled into it splits the request line and injects headers or a
  7074. // whole request. The same field-value check already guards header values in
  7075. // check_and_write_headers and the request target in
  7076. // perform_websocket_handshake; apply it here too.
  7077. if (!fields::is_field_value(path)) { return -1; }
  7078. std::string s = method;
  7079. s += ' ';
  7080. s += path;
  7081. s += " HTTP/1.1\r\n";
  7082. return strm.write(s.data(), s.size());
  7083. }
  7084. inline ssize_t write_response_line(Stream &strm, int status) {
  7085. std::string s = "HTTP/1.1 ";
  7086. s += std::to_string(status);
  7087. s += ' ';
  7088. s += httplib::status_message(status);
  7089. s += "\r\n";
  7090. return strm.write(s.data(), s.size());
  7091. }
  7092. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7093. ssize_t write_len = 0;
  7094. for (const auto &x : headers) {
  7095. // Skip fields with invalid names or values to prevent response splitting
  7096. // via CR/LF injection, matching set_header(). The client validates request
  7097. // headers up front in check_and_write_headers, but the server passes
  7098. // res.headers straight to this writer, and res.headers is a public field
  7099. // an application can populate directly with request-derived values.
  7100. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7101. std::string s;
  7102. s = x.first;
  7103. s += ": ";
  7104. s += x.second;
  7105. s += "\r\n";
  7106. auto len = strm.write(s.data(), s.size());
  7107. if (len < 0) { return len; }
  7108. write_len += len;
  7109. }
  7110. auto len = strm.write("\r\n");
  7111. if (len < 0) { return len; }
  7112. write_len += len;
  7113. return write_len;
  7114. }
  7115. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7116. size_t offset = 0;
  7117. while (offset < l) {
  7118. auto length = strm.write(d + offset, l - offset);
  7119. if (length < 0) { return false; }
  7120. offset += static_cast<size_t>(length);
  7121. }
  7122. return true;
  7123. }
  7124. template <typename T>
  7125. inline bool write_content_with_progress(Stream &strm,
  7126. const ContentProvider &content_provider,
  7127. size_t offset, size_t length,
  7128. T is_shutting_down,
  7129. const UploadProgress &upload_progress,
  7130. Error &error) {
  7131. size_t end_offset = offset + length;
  7132. size_t start_offset = offset;
  7133. auto ok = true;
  7134. auto finished = false;
  7135. DataSink data_sink;
  7136. data_sink.write = [&](const char *d, size_t l) -> bool {
  7137. if (ok) {
  7138. if (write_data(strm, d, l)) {
  7139. offset += l;
  7140. if (upload_progress && length > 0) {
  7141. size_t current_written = offset - start_offset;
  7142. if (!upload_progress(current_written, length)) {
  7143. ok = false;
  7144. return false;
  7145. }
  7146. }
  7147. } else {
  7148. ok = false;
  7149. }
  7150. }
  7151. return ok;
  7152. };
  7153. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7154. // The body is framed by `length`, so a provider that reports itself done
  7155. // early has truncated it. Record that and let the short-body check below
  7156. // fail the write, rather than calling the provider again forever.
  7157. data_sink.done = [&]() { finished = true; };
  7158. while (offset < end_offset && !finished && !is_shutting_down()) {
  7159. auto last_offset = offset;
  7160. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7161. error = Error::Write;
  7162. return false;
  7163. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7164. error = Error::Canceled;
  7165. return false;
  7166. } else if (!ok) {
  7167. error = Error::Write;
  7168. return false;
  7169. }
  7170. // A provider that reports success without writing anything and without
  7171. // reporting itself done gets handed the same offset and length again on
  7172. // the next pass, so it would spin here for as long as the peer stays
  7173. // connected. Treat making no progress as a short body, like done() early.
  7174. if (!finished && offset == last_offset) {
  7175. error = Error::Write;
  7176. return false;
  7177. }
  7178. }
  7179. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7180. error = Error::Write;
  7181. return false;
  7182. }
  7183. error = Error::Success;
  7184. return true;
  7185. }
  7186. template <typename T>
  7187. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7188. size_t offset, size_t length, T is_shutting_down,
  7189. Error &error) {
  7190. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7191. is_shutting_down, nullptr, error);
  7192. }
  7193. template <typename T>
  7194. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7195. size_t offset, size_t length,
  7196. const T &is_shutting_down) {
  7197. auto error = Error::Success;
  7198. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7199. error);
  7200. }
  7201. template <typename T>
  7202. inline bool
  7203. write_content_without_length(Stream &strm,
  7204. const ContentProvider &content_provider,
  7205. const T &is_shutting_down) {
  7206. size_t offset = 0;
  7207. auto data_available = true;
  7208. auto ok = true;
  7209. DataSink data_sink;
  7210. data_sink.write = [&](const char *d, size_t l) -> bool {
  7211. if (ok) {
  7212. offset += l;
  7213. if (!write_data(strm, d, l)) { ok = false; }
  7214. }
  7215. return ok;
  7216. };
  7217. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7218. data_sink.done = [&](void) { data_available = false; };
  7219. while (data_available && !is_shutting_down()) {
  7220. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7221. return false;
  7222. } else if (!content_provider(offset, 0, data_sink)) {
  7223. return false;
  7224. } else if (!ok) {
  7225. return false;
  7226. }
  7227. }
  7228. return !data_available; // true only if done() was called, false if shutting
  7229. // down
  7230. }
  7231. // Runs a known-length content provider to completion and compresses what it
  7232. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7233. // by an mmap hands the compressor a pointer straight into the mapping.
  7234. inline bool compress_content_provider(const ContentProvider &content_provider,
  7235. size_t length, compressor &cmp,
  7236. std::string &out) {
  7237. size_t offset = 0;
  7238. auto ok = true;
  7239. auto finished = false;
  7240. DataSink data_sink;
  7241. auto append = [&](const char *data, size_t data_len) {
  7242. out.append(data, data_len);
  7243. return true;
  7244. };
  7245. data_sink.write = [&](const char *d, size_t l) -> bool {
  7246. if (!ok) { return false; }
  7247. offset += l;
  7248. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7249. return ok;
  7250. };
  7251. // The body is framed by `length`, so a provider that reports itself done
  7252. // early has truncated it; the short-body check below turns that into a
  7253. // failure rather than calling the provider again forever.
  7254. data_sink.done = [&]() { finished = true; };
  7255. while (offset < length && !finished) {
  7256. auto prev_offset = offset;
  7257. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7258. return false;
  7259. }
  7260. // No Stream to block on here, so a provider that keeps returning true
  7261. // without writing would spin. Treat a pass that made no progress as a
  7262. // failure.
  7263. if (offset == prev_offset) { return false; }
  7264. }
  7265. if (offset != length) { return false; }
  7266. return cmp.compress(nullptr, 0, true, append);
  7267. }
  7268. // Serves `m` as the response body. `set_content_provider()` clears the coding,
  7269. // so recording it has to come after; keeping both here means a third
  7270. // file-serving path cannot get that order wrong.
  7271. inline void set_file_content_provider(Response &res,
  7272. const std::shared_ptr<mmap> &m,
  7273. const std::string &content_type,
  7274. EncodingType encoding) {
  7275. res.set_content_provider(
  7276. m->size(), content_type,
  7277. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7278. sink.write(m->data() + offset, length);
  7279. return true;
  7280. });
  7281. res.content_coding_ = encoding;
  7282. }
  7283. template <typename T, typename U>
  7284. inline bool
  7285. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7286. const T &is_shutting_down, U &compressor, Error &error) {
  7287. size_t offset = 0;
  7288. auto data_available = true;
  7289. auto ok = true;
  7290. DataSink data_sink;
  7291. data_sink.write = [&](const char *d, size_t l) -> bool {
  7292. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7293. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7294. // zero-length chunk is the terminator, so it must not be emitted here.
  7295. if (ok && l > 0) {
  7296. offset += l;
  7297. std::string payload;
  7298. if (compressor.compress(d, l, false,
  7299. [&](const char *data, size_t data_len) {
  7300. payload.append(data, data_len);
  7301. return true;
  7302. })) {
  7303. if (!payload.empty()) {
  7304. // Emit chunked response header and footer for each chunk
  7305. auto chunk =
  7306. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7307. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7308. }
  7309. } else {
  7310. ok = false;
  7311. }
  7312. }
  7313. return ok;
  7314. };
  7315. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7316. auto done_with_trailer = [&](const Headers *trailer) {
  7317. if (!ok) { return; }
  7318. data_available = false;
  7319. std::string payload;
  7320. if (!compressor.compress(nullptr, 0, true,
  7321. [&](const char *data, size_t data_len) {
  7322. payload.append(data, data_len);
  7323. return true;
  7324. })) {
  7325. ok = false;
  7326. return;
  7327. }
  7328. if (!payload.empty()) {
  7329. // Emit chunked response header and footer for each chunk
  7330. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7331. if (!write_data(strm, chunk.data(), chunk.size())) {
  7332. ok = false;
  7333. return;
  7334. }
  7335. }
  7336. constexpr const char done_marker[] = "0\r\n";
  7337. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7338. // Trailer
  7339. if (trailer) {
  7340. for (const auto &kv : *trailer) {
  7341. // Skip fields with invalid names or values to prevent response
  7342. // splitting via CR/LF injection, matching set_header().
  7343. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7344. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7345. if (!write_data(strm, field_line.data(), field_line.size())) {
  7346. ok = false;
  7347. }
  7348. }
  7349. }
  7350. constexpr const char crlf[] = "\r\n";
  7351. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7352. };
  7353. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7354. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7355. done_with_trailer(&trailer);
  7356. };
  7357. while (data_available && !is_shutting_down()) {
  7358. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7359. error = Error::Write;
  7360. return false;
  7361. } else if (!content_provider(offset, 0, data_sink)) {
  7362. error = Error::Canceled;
  7363. return false;
  7364. } else if (!ok) {
  7365. error = Error::Write;
  7366. return false;
  7367. }
  7368. }
  7369. if (data_available) { // exited due to is_shutting_down(), not done()
  7370. error = Error::Write;
  7371. return false;
  7372. }
  7373. error = Error::Success;
  7374. return true;
  7375. }
  7376. template <typename T, typename U>
  7377. inline bool write_content_chunked(Stream &strm,
  7378. const ContentProvider &content_provider,
  7379. const T &is_shutting_down, U &compressor) {
  7380. auto error = Error::Success;
  7381. return write_content_chunked(strm, content_provider, is_shutting_down,
  7382. compressor, error);
  7383. }
  7384. template <typename T>
  7385. inline bool redirect(T &cli, Request &req, Response &res,
  7386. const std::string &path, const std::string &location,
  7387. Error &error) {
  7388. Request new_req = req;
  7389. new_req.path = path;
  7390. new_req.redirect_count_ -= 1;
  7391. if (res.status == StatusCode::SeeOther_303 &&
  7392. (req.method != "GET" && req.method != "HEAD")) {
  7393. new_req.method = "GET";
  7394. new_req.body.clear();
  7395. new_req.headers.clear();
  7396. }
  7397. Response new_res;
  7398. auto ret = cli.send(new_req, new_res, error);
  7399. if (ret) {
  7400. req = std::move(new_req);
  7401. res = std::move(new_res);
  7402. if (res.location.empty()) { res.location = location; }
  7403. }
  7404. return ret;
  7405. }
  7406. inline std::string params_to_query_str(const Params &params) {
  7407. std::string query;
  7408. for (auto it = params.begin(); it != params.end(); ++it) {
  7409. if (it != params.begin()) { query += '&'; }
  7410. query += encode_query_component(it->first);
  7411. query += '=';
  7412. query += encode_query_component(it->second);
  7413. }
  7414. return query;
  7415. }
  7416. // Splits one "key=value" span of a query string at its first '='. A span with
  7417. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7418. // "?flag" keeps its name.
  7419. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7420. std::string &val) {
  7421. divide(b, static_cast<std::size_t>(e - b), '=',
  7422. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7423. std::size_t rhs_size) {
  7424. key.assign(lhs_data, lhs_size);
  7425. val.assign(rhs_data, rhs_size);
  7426. });
  7427. }
  7428. inline void parse_query_text(const char *data, std::size_t size,
  7429. Params &params) {
  7430. std::set<std::string> cache;
  7431. split(data, data + size, '&', [&](const char *b, const char *e) {
  7432. std::string kv(b, e);
  7433. if (cache.find(kv) != cache.end()) { return; }
  7434. cache.insert(std::move(kv));
  7435. std::string key;
  7436. std::string val;
  7437. divide_query_pair(b, e, key, val);
  7438. if (!key.empty()) {
  7439. params.emplace(decode_query_component(key), decode_query_component(val));
  7440. }
  7441. });
  7442. }
  7443. inline void parse_query_text(const std::string &s, Params &params) {
  7444. parse_query_text(s.data(), s.size(), params);
  7445. }
  7446. // Normalize a query string by decoding and re-encoding each key/value pair
  7447. // while preserving the original parameter order. This avoids double-encoding
  7448. // and ensures consistent encoding. It works on the raw string rather than
  7449. // parsing into Params and re-serializing, because that round trip cannot
  7450. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7451. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7452. // duplicated pairs.
  7453. inline std::string normalize_query_string(const std::string &query) {
  7454. std::string result;
  7455. split(query.data(), query.data() + query.size(), '&',
  7456. [&](const char *b, const char *e) {
  7457. std::string key;
  7458. std::string val;
  7459. divide_query_pair(b, e, key, val);
  7460. if (!key.empty()) {
  7461. auto dec_key = decode_query_component(key);
  7462. auto dec_val = decode_query_component(val);
  7463. if (!result.empty()) { result += '&'; }
  7464. result += encode_query_component(dec_key);
  7465. if (!val.empty() || std::find(b, e, '=') != e) {
  7466. result += '=';
  7467. result += encode_query_component(dec_val);
  7468. }
  7469. }
  7470. });
  7471. return result;
  7472. }
  7473. // Build the request target that goes on the wire from a caller-supplied path.
  7474. // Shared by the buffered send path and the streaming API so that both put the
  7475. // same bytes in the request line for the same input.
  7476. inline std::string encode_request_target(const std::string &target,
  7477. bool path_encode) {
  7478. // `substr(0, npos)` yields the whole string, which is what the no-query
  7479. // case needs.
  7480. auto query_pos = target.find('?');
  7481. auto path_part = target.substr(0, query_pos);
  7482. std::string query_part;
  7483. if (query_pos != std::string::npos) {
  7484. query_part = target.substr(query_pos + 1);
  7485. }
  7486. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7487. if (!query_part.empty()) {
  7488. // When path encoding is disabled the caller has supplied an already-encoded
  7489. // target and expects the exact bytes to be sent on the wire, so skip
  7490. // normalization for the query too. Normalizing would decode-then-re-encode
  7491. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7492. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7493. if (path_encode) {
  7494. auto normalized = normalize_query_string(query_part);
  7495. if (!normalized.empty()) {
  7496. result += '?';
  7497. result += normalized;
  7498. }
  7499. } else {
  7500. result += '?';
  7501. result += query_part;
  7502. }
  7503. }
  7504. return result;
  7505. }
  7506. inline bool parse_multipart_boundary(const std::string &content_type,
  7507. std::string &boundary) {
  7508. std::map<std::string, std::string> params;
  7509. extract_media_type(content_type, &params);
  7510. auto it = params.find("boundary");
  7511. if (it == params.end()) { return false; }
  7512. boundary = it->second;
  7513. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7514. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7515. // bytes costs a nearly full comparison at nearly every position: the
  7516. // boundary's length multiplies the worst-case cost of scanning a body.
  7517. return !boundary.empty() && boundary.size() <= 70;
  7518. }
  7519. inline void parse_disposition_params(const std::string &s, Params &params) {
  7520. std::set<std::string> cache;
  7521. split_unquoted(s.data(), s.data() + s.size(), ';',
  7522. [&](const char *b, const char *e) {
  7523. std::string kv(b, e);
  7524. if (cache.find(kv) != cache.end()) { return; }
  7525. cache.insert(kv);
  7526. std::string key;
  7527. std::string val;
  7528. divide_param_pair(b, e, key, val);
  7529. if (!key.empty()) {
  7530. params.emplace(trim_double_quotes_copy(key),
  7531. trim_double_quotes_copy(val));
  7532. }
  7533. });
  7534. }
  7535. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7536. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7537. #else
  7538. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7539. #endif
  7540. auto is_valid = [](const std::string &str) {
  7541. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7542. };
  7543. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7544. const auto pos = static_cast<size_t>(6);
  7545. const auto len = static_cast<size_t>(s.size() - 6);
  7546. auto all_valid_ranges = true;
  7547. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7548. if (!all_valid_ranges) { return; }
  7549. const auto it = std::find(b, e, '-');
  7550. if (it == e) {
  7551. all_valid_ranges = false;
  7552. return;
  7553. }
  7554. const auto lhs = std::string(b, it);
  7555. const auto rhs = std::string(it + 1, e);
  7556. if (!is_valid(lhs) || !is_valid(rhs)) {
  7557. all_valid_ranges = false;
  7558. return;
  7559. }
  7560. ssize_t first = -1;
  7561. if (!lhs.empty()) {
  7562. ssize_t v;
  7563. auto res = detail::from_chars(lhs.data(), lhs.data() + lhs.size(), v);
  7564. if (res.ec == std::errc{}) { first = v; }
  7565. }
  7566. ssize_t last = -1;
  7567. if (!rhs.empty()) {
  7568. ssize_t v;
  7569. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7570. if (res.ec == std::errc{}) { last = v; }
  7571. }
  7572. if ((first == -1 && last == -1) ||
  7573. (first != -1 && last != -1 && first > last)) {
  7574. all_valid_ranges = false;
  7575. return;
  7576. }
  7577. ranges.emplace_back(first, last);
  7578. });
  7579. return all_valid_ranges && !ranges.empty();
  7580. }
  7581. return false;
  7582. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7583. }
  7584. #else
  7585. } catch (...) { return false; }
  7586. #endif
  7587. inline bool parse_accept_header(const std::string &s,
  7588. std::vector<std::string> &content_types) {
  7589. content_types.clear();
  7590. // Empty string is considered valid (no preference)
  7591. if (s.empty()) { return true; }
  7592. struct AcceptEntry {
  7593. std::string media_type;
  7594. double quality;
  7595. int order;
  7596. };
  7597. std::vector<AcceptEntry> entries;
  7598. int order = 0;
  7599. bool has_invalid_entry = false;
  7600. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7601. // has to parse and ignore empty list elements, so a leading, trailing or
  7602. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7603. // split() skips them, and the header length limit bounds how many a sender
  7604. // can send, so ignoring all of them cannot be used as a denial-of-service
  7605. // vector.
  7606. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7607. std::string entry(b, e);
  7608. entry = trim_copy(entry);
  7609. AcceptEntry accept_entry;
  7610. accept_entry.order = order++;
  7611. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7612. accept_entry.media_type, accept_entry.quality)) {
  7613. has_invalid_entry = true;
  7614. return;
  7615. }
  7616. // Remove additional parameters from media type
  7617. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7618. // Basic validation of media type format
  7619. if (accept_entry.media_type.empty()) {
  7620. has_invalid_entry = true;
  7621. return;
  7622. }
  7623. // Check for basic media type format (should contain '/' or be '*')
  7624. if (accept_entry.media_type != "*" &&
  7625. accept_entry.media_type.find('/') == std::string::npos) {
  7626. has_invalid_entry = true;
  7627. return;
  7628. }
  7629. entries.push_back(std::move(accept_entry));
  7630. });
  7631. // Return false if any invalid entry was found
  7632. if (has_invalid_entry) { return false; }
  7633. // Sort by quality (descending), then by original order (ascending)
  7634. std::sort(entries.begin(), entries.end(),
  7635. [](const AcceptEntry &a, const AcceptEntry &b) {
  7636. if (a.quality != b.quality) {
  7637. return a.quality > b.quality; // Higher quality first
  7638. }
  7639. return a.order < b.order; // Earlier order first for same quality
  7640. });
  7641. // Extract sorted media types
  7642. content_types.reserve(entries.size());
  7643. for (auto &entry : entries) {
  7644. content_types.push_back(std::move(entry.media_type));
  7645. }
  7646. return true;
  7647. }
  7648. class FormDataParser {
  7649. public:
  7650. FormDataParser() = default;
  7651. void set_boundary(std::string &&boundary) {
  7652. boundary_ = std::move(boundary);
  7653. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7654. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7655. }
  7656. bool is_valid() const { return is_valid_; }
  7657. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7658. const ContentReceiver &content_callback) {
  7659. // Once the close delimiter has been seen the rest of the body is epilogue
  7660. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7661. // spread across reads is not copied in only to be erased right away.
  7662. if (state_ == 5) { return true; }
  7663. buf_append(buf, n);
  7664. while (buf_size() > 0) {
  7665. switch (state_) {
  7666. case 0: { // Initial boundary
  7667. auto pos = buf_find(dash_boundary_crlf_);
  7668. if (pos == buf_size()) {
  7669. // Not found yet: keep only a possible partial boundary at the tail so
  7670. // that a body which never contains the boundary cannot grow the
  7671. // buffer (and get rescanned from the start) without bound.
  7672. auto keep = dash_boundary_crlf_.size() - 1;
  7673. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7674. return true;
  7675. }
  7676. buf_erase(pos + dash_boundary_crlf_.size());
  7677. state_ = 1;
  7678. break;
  7679. }
  7680. case 1: { // New entry
  7681. clear_file_info();
  7682. state_ = 2;
  7683. break;
  7684. }
  7685. case 2: { // Headers
  7686. auto pos = buf_find(crlf_);
  7687. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7688. while (pos < buf_size()) {
  7689. // Empty line
  7690. if (pos == 0) {
  7691. if (!header_callback(file_)) {
  7692. is_valid_ = false;
  7693. return false;
  7694. }
  7695. buf_erase(crlf_.size());
  7696. state_ = 3;
  7697. break;
  7698. }
  7699. // Check header count limit
  7700. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7701. is_valid_ = false;
  7702. return false;
  7703. }
  7704. header_count_++;
  7705. const auto header = buf_head(pos);
  7706. if (!parse_header(header.data(), header.data() + header.size(),
  7707. [&](const std::string &, const std::string &) {})) {
  7708. is_valid_ = false;
  7709. return false;
  7710. }
  7711. // Parse and emplace space trimmed headers into a map
  7712. if (!parse_header(
  7713. header.data(), header.data() + header.size(),
  7714. [&](const std::string &key, const std::string &val) {
  7715. file_.headers.emplace(key, val);
  7716. })) {
  7717. is_valid_ = false;
  7718. return false;
  7719. }
  7720. constexpr const char header_content_type[] = "Content-Type:";
  7721. if (start_with_case_ignore(header, header_content_type)) {
  7722. file_.content_type =
  7723. trim_copy(header.substr(str_len(header_content_type)));
  7724. } else {
  7725. std::string disposition_params;
  7726. if (parse_content_disposition(header, disposition_params)) {
  7727. Params params;
  7728. parse_disposition_params(disposition_params, params);
  7729. auto it = params.find("name");
  7730. if (it != params.end()) {
  7731. file_.name = it->second;
  7732. } else {
  7733. is_valid_ = false;
  7734. return false;
  7735. }
  7736. it = params.find("filename");
  7737. if (it != params.end()) { file_.filename = it->second; }
  7738. it = params.find("filename*");
  7739. if (it != params.end()) {
  7740. // RFC 5987: only UTF-8 encoding is allowed
  7741. const auto &val = it->second;
  7742. constexpr const char utf8_prefix[] = "UTF-8''";
  7743. constexpr size_t prefix_len = str_len(utf8_prefix);
  7744. if (val.size() > prefix_len &&
  7745. start_with_case_ignore(val, utf8_prefix)) {
  7746. file_.filename = decode_path_component(
  7747. val.substr(prefix_len)); // override...
  7748. } else {
  7749. is_valid_ = false;
  7750. return false;
  7751. }
  7752. }
  7753. }
  7754. }
  7755. buf_erase(pos + crlf_.size());
  7756. pos = buf_find(crlf_);
  7757. }
  7758. if (state_ != 3) { return true; }
  7759. break;
  7760. }
  7761. case 3: { // Body
  7762. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7763. auto pos = buf_find(crlf_dash_boundary_);
  7764. if (pos < buf_size()) {
  7765. if (!content_callback(buf_data(), pos)) {
  7766. is_valid_ = false;
  7767. return false;
  7768. }
  7769. buf_erase(pos + crlf_dash_boundary_.size());
  7770. state_ = 4;
  7771. } else {
  7772. auto len = buf_size() - crlf_dash_boundary_.size();
  7773. if (len > 0) {
  7774. if (!content_callback(buf_data(), len)) {
  7775. is_valid_ = false;
  7776. return false;
  7777. }
  7778. buf_erase(len);
  7779. }
  7780. return true;
  7781. }
  7782. break;
  7783. }
  7784. case 4: { // Boundary
  7785. if (crlf_.size() > buf_size()) { return true; }
  7786. if (buf_start_with(crlf_)) {
  7787. buf_erase(crlf_.size());
  7788. state_ = 1;
  7789. } else if (buf_start_with(dash_)) {
  7790. buf_erase(dash_.size());
  7791. is_valid_ = true;
  7792. state_ = 5;
  7793. } else {
  7794. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7795. // accepted after a boundary; RFC 2046 allows transport-padding in
  7796. // between, but this parser has never supported it. Either way the
  7797. // body is already destined to be rejected, so fail now instead of
  7798. // buffering the rest of it. Both are two bytes, so the check above
  7799. // already guarantees enough buffered data to decide.
  7800. is_valid_ = false;
  7801. return false;
  7802. }
  7803. break;
  7804. }
  7805. case 5: { // Epilogue
  7806. buf_erase(buf_size());
  7807. break;
  7808. }
  7809. }
  7810. }
  7811. return true;
  7812. }
  7813. private:
  7814. void clear_file_info() {
  7815. file_.name.clear();
  7816. file_.filename.clear();
  7817. file_.content_type.clear();
  7818. file_.headers.clear();
  7819. header_count_ = 0;
  7820. }
  7821. bool start_with_case_ignore(const std::string &a, const char *b,
  7822. size_t offset = 0) const {
  7823. const auto b_len = strlen(b);
  7824. if (a.size() < offset + b_len) { return false; }
  7825. for (size_t i = 0; i < b_len; i++) {
  7826. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7827. return false;
  7828. }
  7829. }
  7830. return true;
  7831. }
  7832. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7833. // Returns true if header matches, with the params portion in `params_out`.
  7834. bool parse_content_disposition(const std::string &header,
  7835. std::string &params_out) const {
  7836. constexpr const char prefix[] = "Content-Disposition:";
  7837. constexpr size_t prefix_len = str_len(prefix);
  7838. if (!start_with_case_ignore(header, prefix)) { return false; }
  7839. // Skip whitespace after "Content-Disposition:"
  7840. auto pos = prefix_len;
  7841. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7842. pos++;
  7843. }
  7844. // Match "form-data;" (case-insensitive)
  7845. constexpr const char form_data[] = "form-data;";
  7846. constexpr size_t form_data_len = str_len(form_data);
  7847. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7848. pos += form_data_len;
  7849. // Skip whitespace after "form-data;"
  7850. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7851. pos++;
  7852. }
  7853. params_out = header.substr(pos);
  7854. return true;
  7855. }
  7856. const std::string dash_ = "--";
  7857. const std::string crlf_ = "\r\n";
  7858. std::string boundary_;
  7859. std::string dash_boundary_crlf_;
  7860. std::string crlf_dash_boundary_;
  7861. size_t state_ = 0;
  7862. bool is_valid_ = false;
  7863. FormData file_;
  7864. size_t header_count_ = 0;
  7865. // Buffer
  7866. bool start_with(const std::string &a, size_t spos, size_t epos,
  7867. const std::string &b) const {
  7868. if (epos - spos < b.size()) { return false; }
  7869. for (size_t i = 0; i < b.size(); i++) {
  7870. if (a[i + spos] != b[i]) { return false; }
  7871. }
  7872. return true;
  7873. }
  7874. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7875. const char *buf_data() const { return &buf_[buf_spos_]; }
  7876. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7877. bool buf_start_with(const std::string &s) const {
  7878. return start_with(buf_, buf_spos_, buf_epos_, s);
  7879. }
  7880. size_t buf_find(const std::string &s) const {
  7881. auto c = s.front();
  7882. size_t off = buf_spos_;
  7883. while (off < buf_epos_) {
  7884. auto pos = off;
  7885. while (true) {
  7886. if (pos == buf_epos_) { return buf_size(); }
  7887. if (buf_[pos] == c) { break; }
  7888. pos++;
  7889. }
  7890. auto remaining_size = buf_epos_ - pos;
  7891. if (s.size() > remaining_size) { return buf_size(); }
  7892. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7893. off = pos + 1;
  7894. }
  7895. return buf_size();
  7896. }
  7897. void buf_append(const char *data, size_t n) {
  7898. auto remaining_size = buf_size();
  7899. if (remaining_size > 0 && buf_spos_ > 0) {
  7900. for (size_t i = 0; i < remaining_size; i++) {
  7901. buf_[i] = buf_[buf_spos_ + i];
  7902. }
  7903. }
  7904. buf_spos_ = 0;
  7905. buf_epos_ = remaining_size;
  7906. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7907. for (size_t i = 0; i < n; i++) {
  7908. buf_[buf_epos_ + i] = data[i];
  7909. }
  7910. buf_epos_ += n;
  7911. }
  7912. void buf_erase(size_t size) { buf_spos_ += size; }
  7913. std::string buf_;
  7914. size_t buf_spos_ = 0;
  7915. size_t buf_epos_ = 0;
  7916. };
  7917. inline std::string random_string(size_t length) {
  7918. constexpr const char data[] =
  7919. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7920. thread_local auto engine([]() {
  7921. // std::random_device might actually be deterministic on some
  7922. // platforms, but due to lack of support in the c++ standard library,
  7923. // doing better requires either some ugly hacks or breaking portability.
  7924. std::random_device seed_gen;
  7925. // Request 128 bits of entropy for initialization
  7926. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  7927. return std::mt19937(seed_sequence);
  7928. }());
  7929. std::string result;
  7930. for (size_t i = 0; i < length; i++) {
  7931. result += data[engine() % (sizeof(data) - 1)];
  7932. }
  7933. return result;
  7934. }
  7935. inline std::string make_multipart_data_boundary() {
  7936. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  7937. }
  7938. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  7939. auto valid = true;
  7940. for (size_t i = 0; i < boundary.size(); i++) {
  7941. auto c = boundary[i];
  7942. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  7943. valid = false;
  7944. break;
  7945. }
  7946. }
  7947. return valid;
  7948. }
  7949. // Escape a multipart field name/filename following the WHATWG HTML standard
  7950. // ("escape a multipart form-data name"), which is what browsers send:
  7951. // '"' -> %22, CR -> %0D, LF -> %0A
  7952. // With escape_quote = false, only CR and LF are escaped; this is for header
  7953. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  7954. inline std::string escape_multipart_field(const std::string &s,
  7955. bool escape_quote = true) {
  7956. std::string result;
  7957. result.reserve(s.size());
  7958. for (auto c : s) {
  7959. switch (c) {
  7960. case '"':
  7961. if (escape_quote) {
  7962. result += "%22";
  7963. } else {
  7964. result += c;
  7965. }
  7966. break;
  7967. case '\r': result += "%0D"; break;
  7968. case '\n': result += "%0A"; break;
  7969. default: result += c; break;
  7970. }
  7971. }
  7972. return result;
  7973. }
  7974. template <typename T>
  7975. inline std::string
  7976. serialize_multipart_formdata_item_begin(const T &item,
  7977. const std::string &boundary) {
  7978. std::string body = "--" + boundary + "\r\n";
  7979. body += "Content-Disposition: form-data; name=\"" +
  7980. escape_multipart_field(item.name) + "\"";
  7981. if (!item.filename.empty()) {
  7982. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  7983. }
  7984. body += "\r\n";
  7985. if (!item.content_type.empty()) {
  7986. body +=
  7987. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  7988. "\r\n";
  7989. }
  7990. body += "\r\n";
  7991. return body;
  7992. }
  7993. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  7994. inline std::string
  7995. serialize_multipart_formdata_finish(const std::string &boundary) {
  7996. return "--" + boundary + "--\r\n";
  7997. }
  7998. inline std::string
  7999. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8000. return "multipart/form-data; boundary=" + boundary;
  8001. }
  8002. inline std::string
  8003. serialize_multipart_formdata(const UploadFormDataItems &items,
  8004. const std::string &boundary, bool finish = true) {
  8005. std::string body;
  8006. for (const auto &item : items) {
  8007. body += serialize_multipart_formdata_item_begin(item, boundary);
  8008. body += item.content + serialize_multipart_formdata_item_end();
  8009. }
  8010. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8011. return body;
  8012. }
  8013. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8014. const std::string &boundary) {
  8015. size_t total = 0;
  8016. for (const auto &item : items) {
  8017. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8018. total += item.content.size();
  8019. total += serialize_multipart_formdata_item_end().size();
  8020. }
  8021. total += serialize_multipart_formdata_finish(boundary).size();
  8022. return total;
  8023. }
  8024. struct MultipartSegment {
  8025. const char *data;
  8026. size_t size;
  8027. };
  8028. // NOTE: items must outlive the returned ContentProvider
  8029. // (safe for synchronous use inside Post/Put/Patch)
  8030. inline ContentProvider
  8031. make_multipart_content_provider(const UploadFormDataItems &items,
  8032. const std::string &boundary) {
  8033. // Own the per-item header strings and the finish string
  8034. std::vector<std::string> owned;
  8035. owned.reserve(items.size() + 1);
  8036. for (const auto &item : items)
  8037. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8038. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8039. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8040. std::vector<MultipartSegment> segs;
  8041. segs.reserve(items.size() * 3 + 1);
  8042. static const char crlf[] = "\r\n";
  8043. for (size_t i = 0; i < items.size(); i++) {
  8044. segs.push_back({owned[i].data(), owned[i].size()});
  8045. segs.push_back({items[i].content.data(), items[i].content.size()});
  8046. segs.push_back({crlf, 2});
  8047. }
  8048. segs.push_back({owned.back().data(), owned.back().size()});
  8049. struct MultipartState {
  8050. std::vector<std::string> owned;
  8051. std::vector<MultipartSegment> segs;
  8052. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8053. };
  8054. auto state = std::make_shared<MultipartState>();
  8055. state->owned = std::move(owned);
  8056. // `segs` holds raw pointers into owned strings; std::string move preserves
  8057. // the data pointer, so these pointers remain valid after the move above.
  8058. state->segs = std::move(segs);
  8059. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8060. // Buffer multiple small segments into fewer, larger writes to avoid
  8061. // excessive TCP packets when there are many form data items (#2410)
  8062. auto &buf = state->buf;
  8063. auto buf_size = buf.size();
  8064. size_t buf_len = 0;
  8065. size_t remaining = length;
  8066. // Find the first segment containing 'offset'
  8067. size_t pos = 0;
  8068. size_t seg_idx = 0;
  8069. for (; seg_idx < state->segs.size(); seg_idx++) {
  8070. const auto &seg = state->segs[seg_idx];
  8071. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8072. pos += seg.size;
  8073. }
  8074. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8075. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8076. const auto &seg = state->segs[seg_idx];
  8077. size_t available = seg.size - seg_offset;
  8078. size_t to_copy = (std::min)(available, remaining);
  8079. const char *src = seg.data + seg_offset;
  8080. seg_offset = 0; // only the first segment has a non-zero offset
  8081. while (to_copy > 0) {
  8082. size_t space = buf_size - buf_len;
  8083. size_t chunk = (std::min)(to_copy, space);
  8084. std::memcpy(buf.data() + buf_len, src, chunk);
  8085. buf_len += chunk;
  8086. src += chunk;
  8087. to_copy -= chunk;
  8088. remaining -= chunk;
  8089. if (buf_len == buf_size) {
  8090. if (!sink.write(buf.data(), buf_len)) { return false; }
  8091. buf_len = 0;
  8092. }
  8093. }
  8094. }
  8095. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8096. return true;
  8097. };
  8098. }
  8099. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8100. if (ranges.size() <= 1) return;
  8101. // Sort ranges by start position
  8102. std::sort(ranges.begin(), ranges.end(),
  8103. [](const Range &a, const Range &b) { return a.first < b.first; });
  8104. Ranges coalesced;
  8105. coalesced.reserve(ranges.size());
  8106. for (auto &r : ranges) {
  8107. auto first_pos = r.first;
  8108. auto last_pos = r.second;
  8109. // Handle special cases like in range_error
  8110. if (first_pos == -1 && last_pos == -1) {
  8111. first_pos = 0;
  8112. last_pos = static_cast<ssize_t>(content_length);
  8113. }
  8114. if (first_pos == -1) {
  8115. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8116. last_pos = static_cast<ssize_t>(content_length) - 1;
  8117. }
  8118. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8119. last_pos = static_cast<ssize_t>(content_length) - 1;
  8120. }
  8121. // Skip invalid ranges
  8122. if (!(0 <= first_pos && first_pos <= last_pos &&
  8123. last_pos < static_cast<ssize_t>(content_length))) {
  8124. continue;
  8125. }
  8126. // Coalesce with previous range if overlapping or adjacent (but not
  8127. // identical)
  8128. if (!coalesced.empty()) {
  8129. auto &prev = coalesced.back();
  8130. // Check if current range overlaps or is adjacent to previous range
  8131. // but don't coalesce identical ranges (allow duplicates)
  8132. if (first_pos <= prev.second + 1 &&
  8133. !(first_pos == prev.first && last_pos == prev.second)) {
  8134. // Extend the previous range
  8135. prev.second = (std::max)(prev.second, last_pos);
  8136. continue;
  8137. }
  8138. }
  8139. // Add new range
  8140. coalesced.emplace_back(first_pos, last_pos);
  8141. }
  8142. ranges = std::move(coalesced);
  8143. }
  8144. inline bool range_error(Request &req, Response &res) {
  8145. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8146. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8147. req.ranges.clear();
  8148. if (res.status == StatusCode::PartialContent_206) {
  8149. res.status = StatusCode::OK_200;
  8150. }
  8151. return false;
  8152. }
  8153. ssize_t content_len = static_cast<ssize_t>(
  8154. res.content_length_ ? res.content_length_ : res.body.size());
  8155. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8156. size_t overwrapping_count = 0;
  8157. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8158. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8159. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8160. // Too many ranges
  8161. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8162. for (auto &r : req.ranges) {
  8163. auto &first_pos = r.first;
  8164. auto &last_pos = r.second;
  8165. if (first_pos == -1 && last_pos == -1) {
  8166. first_pos = 0;
  8167. last_pos = content_len;
  8168. }
  8169. if (first_pos == -1) {
  8170. first_pos = content_len - last_pos;
  8171. last_pos = content_len - 1;
  8172. }
  8173. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8174. // A client can limit the number of bytes requested without knowing the
  8175. // size of the selected representation. If the last-pos value is absent,
  8176. // or if the value is greater than or equal to the current length of the
  8177. // representation data, the byte range is interpreted as the remainder of
  8178. // the representation (i.e., the server replaces the value of last-pos
  8179. // with a value that is one less than the current length of the selected
  8180. // representation).
  8181. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8182. if (last_pos == -1 || last_pos >= content_len) {
  8183. last_pos = content_len - 1;
  8184. }
  8185. // Range must be within content length
  8186. if (!(0 <= first_pos && first_pos <= last_pos &&
  8187. last_pos <= content_len - 1)) {
  8188. return true;
  8189. }
  8190. // Request must not have more than two overlapping ranges
  8191. for (const auto &processed_range : processed_ranges) {
  8192. if (!(last_pos < processed_range.first ||
  8193. first_pos > processed_range.second)) {
  8194. overwrapping_count++;
  8195. if (overwrapping_count > 2) { return true; }
  8196. break; // Only count once per range
  8197. }
  8198. }
  8199. processed_ranges.emplace_back(first_pos, last_pos);
  8200. }
  8201. // After validation, coalesce overlapping ranges as per RFC 9110
  8202. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8203. }
  8204. return false;
  8205. }
  8206. inline std::pair<size_t, size_t>
  8207. get_range_offset_and_length(Range r, size_t content_length) {
  8208. assert(r.first != -1 && r.second != -1);
  8209. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8210. assert(r.first <= r.second &&
  8211. r.second < static_cast<ssize_t>(content_length));
  8212. (void)(content_length);
  8213. return std::make_pair(static_cast<size_t>(r.first),
  8214. static_cast<size_t>(r.second - r.first) + 1);
  8215. }
  8216. inline std::string make_content_range_header_field(
  8217. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8218. auto st = offset_and_length.first;
  8219. auto ed = st + offset_and_length.second - 1;
  8220. std::string field = "bytes ";
  8221. field += std::to_string(st);
  8222. field += '-';
  8223. field += std::to_string(ed);
  8224. field += '/';
  8225. field += std::to_string(content_length);
  8226. return field;
  8227. }
  8228. template <typename SToken, typename CToken, typename Content>
  8229. bool process_multipart_ranges_data(const Request &req,
  8230. const std::string &boundary,
  8231. const std::string &content_type,
  8232. size_t content_length, SToken stoken,
  8233. CToken ctoken, Content content) {
  8234. for (size_t i = 0; i < req.ranges.size(); i++) {
  8235. ctoken("--");
  8236. stoken(boundary);
  8237. ctoken("\r\n");
  8238. if (!content_type.empty()) {
  8239. ctoken("Content-Type: ");
  8240. stoken(content_type);
  8241. ctoken("\r\n");
  8242. }
  8243. auto offset_and_length =
  8244. get_range_offset_and_length(req.ranges[i], content_length);
  8245. ctoken("Content-Range: ");
  8246. stoken(make_content_range_header_field(offset_and_length, content_length));
  8247. ctoken("\r\n");
  8248. ctoken("\r\n");
  8249. if (!content(offset_and_length.first, offset_and_length.second)) {
  8250. return false;
  8251. }
  8252. ctoken("\r\n");
  8253. }
  8254. ctoken("--");
  8255. stoken(boundary);
  8256. ctoken("--");
  8257. return true;
  8258. }
  8259. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8260. const std::string &boundary,
  8261. const std::string &content_type,
  8262. size_t content_length,
  8263. std::string &data) {
  8264. process_multipart_ranges_data(
  8265. req, boundary, content_type, content_length,
  8266. [&](const std::string &token) { data += token; },
  8267. [&](const std::string &token) { data += token; },
  8268. [&](size_t offset, size_t length) {
  8269. assert(offset + length <= content_length);
  8270. data += res.body.substr(offset, length);
  8271. return true;
  8272. });
  8273. }
  8274. inline size_t get_multipart_ranges_data_length(const Request &req,
  8275. const std::string &boundary,
  8276. const std::string &content_type,
  8277. size_t content_length) {
  8278. size_t data_length = 0;
  8279. process_multipart_ranges_data(
  8280. req, boundary, content_type, content_length,
  8281. [&](const std::string &token) { data_length += token.size(); },
  8282. [&](const std::string &token) { data_length += token.size(); },
  8283. [&](size_t /*offset*/, size_t length) {
  8284. data_length += length;
  8285. return true;
  8286. });
  8287. return data_length;
  8288. }
  8289. template <typename T>
  8290. inline bool
  8291. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8292. const std::string &boundary,
  8293. const std::string &content_type,
  8294. size_t content_length, const T &is_shutting_down) {
  8295. return process_multipart_ranges_data(
  8296. req, boundary, content_type, content_length,
  8297. [&](const std::string &token) { strm.write(token); },
  8298. [&](const std::string &token) { strm.write(token); },
  8299. [&](size_t offset, size_t length) {
  8300. return write_content(strm, res.content_provider_, offset, length,
  8301. is_shutting_down);
  8302. });
  8303. }
  8304. inline bool has_framed_body(const Request &req) {
  8305. return is_chunked_transfer_encoding(req.headers) ||
  8306. req.get_header_value_u64("Content-Length") > 0;
  8307. }
  8308. inline bool is_connection_persistent(const Request &req) {
  8309. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8310. if (req.version == "HTTP/1.0" &&
  8311. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8312. return false;
  8313. }
  8314. return true;
  8315. }
  8316. inline bool expect_content(const Request &req) {
  8317. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8318. req.method == "DELETE") {
  8319. return true;
  8320. }
  8321. return has_framed_body(req);
  8322. }
  8323. #ifdef _WIN32
  8324. class WSInit {
  8325. public:
  8326. WSInit() {
  8327. WSADATA wsaData;
  8328. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8329. }
  8330. ~WSInit() {
  8331. if (is_valid_) WSACleanup();
  8332. }
  8333. bool is_valid_ = false;
  8334. };
  8335. static WSInit wsinit_;
  8336. #endif
  8337. // RFC 9110 Section 11.6.1 defines a challenge list as
  8338. // WWW-Authenticate = #challenge
  8339. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8340. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8341. // so a server may offer several schemes, each with its own comma-separated
  8342. // auth-param list, in either order and either as separate field lines or
  8343. // packed into one. Splitting on every comma would break apart a challenge's
  8344. // own param list; splitting only on the first space would miss a Digest
  8345. // challenge that isn't first. Split on commas that aren't inside a
  8346. // quoted-string instead, then track which scheme each resulting segment
  8347. // belongs to: a segment whose text before "=" contains whitespace (or that
  8348. // has no "=" at all) starts a new challenge named by its leading token.
  8349. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8350. std::vector<std::string> segments;
  8351. size_t start = 0;
  8352. auto in_quotes = false;
  8353. for (size_t i = 0; i < s.size(); i++) {
  8354. auto c = s[i];
  8355. if (in_quotes) {
  8356. if (c == '\\' && i + 1 < s.size()) {
  8357. i++;
  8358. } else if (c == '"') {
  8359. in_quotes = false;
  8360. }
  8361. } else if (c == '"') {
  8362. in_quotes = true;
  8363. } else if (c == ',') {
  8364. segments.push_back(s.substr(start, i - start));
  8365. start = i + 1;
  8366. }
  8367. }
  8368. segments.push_back(s.substr(start));
  8369. return segments;
  8370. }
  8371. inline std::string unescape_quoted_pairs(const std::string &s) {
  8372. std::string out;
  8373. out.reserve(s.size());
  8374. for (size_t i = 0; i < s.size(); i++) {
  8375. if (s[i] == '\\' && i + 1 < s.size()) {
  8376. out += s[++i];
  8377. } else {
  8378. out += s[i];
  8379. }
  8380. }
  8381. return out;
  8382. }
  8383. inline bool parse_www_authenticate(const Response &res,
  8384. std::map<std::string, std::string> &auth,
  8385. bool is_proxy) {
  8386. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8387. auto combined = get_combined_header_value(res.headers, auth_key);
  8388. if (combined.empty()) { return false; }
  8389. auto found_digest = false;
  8390. auto in_digest_challenge = false;
  8391. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8392. auto segment = trim_copy(raw_segment);
  8393. if (segment.empty()) { continue; }
  8394. auto eq_pos = segment.find('=');
  8395. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8396. // for the first segment of a challenge, "<scheme> <key>") must be
  8397. // trimmed before its boundaries are inspected.
  8398. auto key_part = trim_copy(
  8399. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8400. auto space_pos = key_part.find_last_of(" \t");
  8401. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8402. // "<scheme>[ <key>]" starts a new challenge.
  8403. auto scheme_end =
  8404. space_pos == std::string::npos ? key_part.size() : space_pos;
  8405. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8406. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8407. // from one challenge is never paired with another's algorithm.
  8408. in_digest_challenge =
  8409. !found_digest &&
  8410. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8411. if (in_digest_challenge) { found_digest = true; }
  8412. if (space_pos == std::string::npos) {
  8413. // Bare scheme (or a token68), no auth-param on this segment.
  8414. continue;
  8415. }
  8416. key_part = key_part.substr(space_pos + 1);
  8417. }
  8418. if (!in_digest_challenge) { continue; }
  8419. auto val = trim_copy(segment.substr(eq_pos + 1));
  8420. auto unquoted = trim_double_quotes_copy(val);
  8421. if (unquoted.size() != val.size()) {
  8422. unquoted = unescape_quoted_pairs(unquoted);
  8423. }
  8424. auth[std::move(key_part)] = std::move(unquoted);
  8425. }
  8426. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8427. // make_digest_authentication_header() dereferences both unconditionally, so
  8428. // a challenge missing either can't produce a usable Authorization header.
  8429. // Treat it the same as no Digest challenge at all.
  8430. return found_digest && auth.find("realm") != auth.end() &&
  8431. auth.find("nonce") != auth.end();
  8432. }
  8433. class ContentProviderAdapter {
  8434. public:
  8435. explicit ContentProviderAdapter(
  8436. ContentProviderWithoutLength &&content_provider)
  8437. : content_provider_(std::move(content_provider)) {}
  8438. bool operator()(size_t offset, size_t, DataSink &sink) {
  8439. return content_provider_(offset, sink);
  8440. }
  8441. private:
  8442. ContentProviderWithoutLength content_provider_;
  8443. };
  8444. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8445. namespace fields {
  8446. inline bool is_token_char(char c) {
  8447. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8448. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8449. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8450. }
  8451. inline bool is_token(const std::string &s) {
  8452. if (s.empty()) { return false; }
  8453. for (auto c : s) {
  8454. if (!is_token_char(c)) { return false; }
  8455. }
  8456. return true;
  8457. }
  8458. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8459. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8460. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8461. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8462. inline bool is_field_content(const std::string &s) {
  8463. if (s.empty()) { return true; }
  8464. if (s.size() == 1) {
  8465. return is_field_vchar(s[0]);
  8466. } else if (s.size() == 2) {
  8467. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8468. } else {
  8469. size_t i = 0;
  8470. if (!is_field_vchar(s[i])) { return false; }
  8471. i++;
  8472. while (i < s.size() - 1) {
  8473. auto c = s[i++];
  8474. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8475. } else {
  8476. return false;
  8477. }
  8478. }
  8479. return is_field_vchar(s[i]);
  8480. }
  8481. }
  8482. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8483. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8484. return is_field_name(name) && is_field_value(value);
  8485. }
  8486. } // namespace fields
  8487. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8488. WebSocketUpgradeResponse &upgrade) {
  8489. // Generate random Sec-WebSocket-Key
  8490. thread_local std::mt19937 rng(std::random_device{}());
  8491. std::string key_bytes(16, '\0');
  8492. for (size_t i = 0; i < 16; i += 4) {
  8493. auto r = rng();
  8494. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8495. }
  8496. auto client_key = base64_encode(key_bytes);
  8497. req.headers.erase("Upgrade");
  8498. req.headers.erase("Connection");
  8499. req.headers.erase("Sec-WebSocket-Key");
  8500. req.headers.erase("Sec-WebSocket-Version");
  8501. req.headers.emplace("Upgrade", "websocket");
  8502. req.headers.emplace("Connection", "Upgrade");
  8503. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8504. req.headers.emplace("Sec-WebSocket-Version", "13");
  8505. // Build the request in memory first, like ClientImpl::write_request does.
  8506. // Writing straight to the socket would leak a request line onto the wire
  8507. // before check_and_write_headers gets a chance to reject an invalid header,
  8508. // and would emit one small write per header.
  8509. BufferStream bstrm;
  8510. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8511. upgrade.error = Error::Write;
  8512. return false;
  8513. }
  8514. auto error = Error::Success;
  8515. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8516. upgrade.error = error;
  8517. return false;
  8518. }
  8519. const auto &data = bstrm.get_buffer();
  8520. if (!write_data(strm, data.data(), data.size())) {
  8521. upgrade.error = Error::Write;
  8522. return false;
  8523. }
  8524. // Verify 101 response and Sec-WebSocket-Accept header
  8525. auto expected_accept = websocket_accept_key(client_key);
  8526. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8527. }
  8528. inline bool is_ip_address(const std::string &host) {
  8529. struct in_addr addr4;
  8530. struct in6_addr addr6;
  8531. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8532. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8533. }
  8534. // Resolve where a client should connect for `host`, honoring a user-supplied
  8535. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8536. // supplying the Host header and SNI; only the connection target changes.
  8537. //
  8538. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8539. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8540. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8541. // absent or empty mapping leaves `host` as the connection target; without the
  8542. // empty check the value would reach getaddrinfo as a null node and silently
  8543. // resolve to loopback.
  8544. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8545. const std::string &host, std::string &connect_host,
  8546. std::string &ip) {
  8547. connect_host = host;
  8548. ip.clear();
  8549. auto it = addr_map.find(host);
  8550. if (it == addr_map.end() || it->second.empty()) { return; }
  8551. if (is_ip_address(it->second)) {
  8552. ip = it->second;
  8553. } else {
  8554. connect_host = it->second;
  8555. }
  8556. }
  8557. } // namespace detail
  8558. /*
  8559. * Group 2: detail namespace - SSL common utilities
  8560. */
  8561. #ifdef CPPHTTPLIB_SSL_ENABLED
  8562. namespace detail {
  8563. class SSLSocketStream final : public Stream {
  8564. public:
  8565. SSLSocketStream(
  8566. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8567. time_t read_timeout_usec, time_t write_timeout_sec,
  8568. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8569. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8570. (std::chrono::steady_clock::time_point::min)());
  8571. ~SSLSocketStream() override;
  8572. bool is_readable() const override;
  8573. bool wait_readable() const override;
  8574. bool wait_writable() const override;
  8575. bool is_peer_alive() const override;
  8576. ssize_t read(char *ptr, size_t size) override;
  8577. ssize_t write(const char *ptr, size_t size) override;
  8578. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8579. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8580. socket_t socket() const override;
  8581. time_t duration() const override;
  8582. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8583. // See SocketStream::set_readable_hint().
  8584. void set_readable_hint() { readable_hint_ = true; }
  8585. private:
  8586. bool ensure_readable();
  8587. socket_t sock_;
  8588. tls::session_t session_;
  8589. time_t read_timeout_sec_;
  8590. time_t read_timeout_usec_;
  8591. time_t write_timeout_sec_;
  8592. time_t write_timeout_usec_;
  8593. time_t max_timeout_msec_;
  8594. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8595. bool readable_hint_ = false;
  8596. };
  8597. // A TLS stream for WebSocket connections, where the receive path and the
  8598. // send path (application send() plus the heartbeat ping thread) run on
  8599. // different threads. A single TLS session must never be entered
  8600. // concurrently, so every call into the session is serialized by one mutex.
  8601. //
  8602. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8603. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8604. // call under the lock, then waits for readiness with select() outside the
  8605. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8606. // blocked waiting for data never stalls a concurrent sender.
  8607. //
  8608. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8609. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8610. class WebSocketSSLStream final : public Stream {
  8611. public:
  8612. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8613. time_t read_timeout_sec, time_t read_timeout_usec,
  8614. time_t write_timeout_sec, time_t write_timeout_usec);
  8615. ~WebSocketSSLStream() override;
  8616. bool is_readable() const override;
  8617. bool wait_readable() const override;
  8618. bool wait_writable() const override;
  8619. ssize_t read(char *ptr, size_t size) override;
  8620. ssize_t write(const char *ptr, size_t size) override;
  8621. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8622. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8623. socket_t socket() const override;
  8624. time_t duration() const override;
  8625. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8626. private:
  8627. mutable std::mutex session_mutex_;
  8628. socket_t sock_;
  8629. tls::session_t session_;
  8630. // WebSocket::close() shortens the read timeout from the closing thread
  8631. // while the receive thread is inside wait_readable(), so these two are read
  8632. // and written concurrently. The write timeouts are never mutated.
  8633. std::atomic<time_t> read_timeout_sec_;
  8634. std::atomic<time_t> read_timeout_usec_;
  8635. time_t write_timeout_sec_;
  8636. time_t write_timeout_usec_;
  8637. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8638. };
  8639. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8640. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8641. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8642. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8643. unsigned int hash_length = 0;
  8644. unsigned char hash[EVP_MAX_MD_SIZE];
  8645. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8646. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8647. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8648. std::stringstream ss;
  8649. for (auto i = 0u; i < hash_length; ++i) {
  8650. ss << std::hex << std::setw(2) << std::setfill('0')
  8651. << static_cast<unsigned int>(hash[i]);
  8652. }
  8653. return ss.str();
  8654. }
  8655. inline std::string MD5(const std::string &s) {
  8656. return message_digest(s, EVP_md5());
  8657. }
  8658. inline std::string SHA_256(const std::string &s) {
  8659. return message_digest(s, EVP_sha256());
  8660. }
  8661. inline std::string SHA_512(const std::string &s) {
  8662. return message_digest(s, EVP_sha512());
  8663. }
  8664. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8665. namespace {
  8666. template <size_t N>
  8667. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8668. std::stringstream ss;
  8669. for (size_t i = 0; i < N; ++i) {
  8670. ss << std::hex << std::setw(2) << std::setfill('0')
  8671. << static_cast<unsigned int>(hash[i]);
  8672. }
  8673. return ss.str();
  8674. }
  8675. } // namespace
  8676. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8677. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8678. // initialized once. PSA state is process-global; do not free it.
  8679. inline bool ensure_mbedtls_psa_crypto() {
  8680. static std::once_flag once;
  8681. static bool ok = false;
  8682. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8683. return ok;
  8684. }
  8685. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8686. unsigned char *out, size_t out_size) {
  8687. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8688. size_t olen = 0;
  8689. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8690. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8691. olen == out_size;
  8692. }
  8693. #endif
  8694. inline std::string MD5(const std::string &s) {
  8695. unsigned char hash[16];
  8696. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8697. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8698. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8699. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8700. hash);
  8701. #else
  8702. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8703. hash);
  8704. #endif
  8705. return hash_to_hex(hash);
  8706. }
  8707. inline std::string SHA_256(const std::string &s) {
  8708. unsigned char hash[32];
  8709. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8710. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8711. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8712. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8713. hash, 0);
  8714. #else
  8715. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8716. s.size(), hash, 0);
  8717. #endif
  8718. return hash_to_hex(hash);
  8719. }
  8720. inline std::string SHA_512(const std::string &s) {
  8721. unsigned char hash[64];
  8722. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8723. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8724. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8725. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8726. hash, 0);
  8727. #else
  8728. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8729. s.size(), hash, 0);
  8730. #endif
  8731. return hash_to_hex(hash);
  8732. }
  8733. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8734. namespace {
  8735. template <size_t N>
  8736. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8737. std::stringstream ss;
  8738. for (size_t i = 0; i < N; ++i) {
  8739. ss << std::hex << std::setw(2) << std::setfill('0')
  8740. << static_cast<unsigned int>(hash[i]);
  8741. }
  8742. return ss.str();
  8743. }
  8744. } // namespace
  8745. inline std::string MD5(const std::string &s) {
  8746. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8747. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8748. static_cast<word32>(s.size()), hash);
  8749. return hash_to_hex(hash);
  8750. }
  8751. inline std::string SHA_256(const std::string &s) {
  8752. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8753. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8754. static_cast<word32>(s.size()), hash);
  8755. return hash_to_hex(hash);
  8756. }
  8757. inline std::string SHA_512(const std::string &s) {
  8758. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8759. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8760. static_cast<word32>(s.size()), hash);
  8761. return hash_to_hex(hash);
  8762. }
  8763. #endif
  8764. template <typename T>
  8765. inline bool process_server_socket_ssl(
  8766. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8767. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8768. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8769. time_t write_timeout_usec, T callback) {
  8770. return process_server_socket_core(
  8771. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8772. [&](bool close_connection, bool &connection_closed) {
  8773. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8774. write_timeout_sec, write_timeout_usec);
  8775. // See the non-TLS path in process_server_socket().
  8776. strm.set_readable_hint();
  8777. return callback(strm, close_connection, connection_closed);
  8778. });
  8779. }
  8780. template <typename T>
  8781. inline bool process_client_socket_ssl(
  8782. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8783. time_t read_timeout_usec, time_t write_timeout_sec,
  8784. time_t write_timeout_usec, time_t max_timeout_msec,
  8785. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8786. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8787. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8788. start_time);
  8789. return callback(strm);
  8790. }
  8791. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8792. const Request &req, const std::map<std::string, std::string> &auth,
  8793. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8794. const std::string &password, bool is_proxy = false) {
  8795. std::string nc;
  8796. {
  8797. std::stringstream ss;
  8798. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8799. nc = ss.str();
  8800. }
  8801. std::string qop;
  8802. if (auth.find("qop") != auth.end()) {
  8803. qop = auth.at("qop");
  8804. if (qop.find("auth-int") != std::string::npos) {
  8805. qop = "auth-int";
  8806. } else if (qop.find("auth") != std::string::npos) {
  8807. qop = "auth";
  8808. } else {
  8809. qop.clear();
  8810. }
  8811. }
  8812. std::string algo = "MD5";
  8813. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8814. std::string response;
  8815. {
  8816. auto H = algo == "SHA-256" ? detail::SHA_256
  8817. : algo == "SHA-512" ? detail::SHA_512
  8818. : detail::MD5;
  8819. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8820. auto A2 = req.method + ":" + req.path;
  8821. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8822. if (qop.empty()) {
  8823. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8824. } else {
  8825. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8826. ":" + qop + ":" + H(A2));
  8827. }
  8828. }
  8829. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8830. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8831. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8832. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8833. (qop.empty() ? ", response=\""
  8834. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8835. cnonce + "\", response=\"") +
  8836. response + "\"" +
  8837. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8838. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8839. return std::make_pair(key, field);
  8840. }
  8841. inline bool match_hostname(const std::string &pattern,
  8842. const std::string &hostname) {
  8843. // Exact match (case-insensitive)
  8844. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8845. // Split both pattern and hostname into components by '.'
  8846. std::vector<std::string> pattern_components;
  8847. if (!pattern.empty()) {
  8848. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8849. [&](const char *b, const char *e) {
  8850. pattern_components.emplace_back(b, e);
  8851. });
  8852. }
  8853. std::vector<std::string> host_components;
  8854. if (!hostname.empty()) {
  8855. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8856. [&](const char *b, const char *e) {
  8857. host_components.emplace_back(b, e);
  8858. });
  8859. }
  8860. // Component count must match
  8861. if (host_components.size() != pattern_components.size()) { return false; }
  8862. // Compare each component with wildcard support
  8863. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8864. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8865. auto itr = pattern_components.begin();
  8866. for (const auto &h : host_components) {
  8867. auto &p = *itr;
  8868. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8869. bool partial_match = false;
  8870. if (!p.empty() && p[p.size() - 1] == '*') {
  8871. const auto prefix_length = p.size() - 1;
  8872. if (prefix_length == 0) {
  8873. partial_match = true;
  8874. } else if (h.size() >= prefix_length) {
  8875. partial_match =
  8876. std::equal(p.begin(),
  8877. p.begin() + static_cast<std::string::difference_type>(
  8878. prefix_length),
  8879. h.begin(), [](const char ca, const char cb) {
  8880. return detail::case_ignore::to_lower(ca) ==
  8881. detail::case_ignore::to_lower(cb);
  8882. });
  8883. }
  8884. }
  8885. if (!partial_match) { return false; }
  8886. }
  8887. ++itr;
  8888. }
  8889. return true;
  8890. }
  8891. #ifdef _WIN32
  8892. // Verify certificate using Windows CertGetCertificateChain API.
  8893. // This provides real-time certificate validation with Windows Update
  8894. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8895. inline bool
  8896. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8897. const std::string &hostname,
  8898. bool verify_hostname, uint64_t &out_error) {
  8899. if (der_cert.empty()) { return false; }
  8900. out_error = 0;
  8901. // Create Windows certificate context from DER data
  8902. auto cert_context = CertCreateCertificateContext(
  8903. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8904. static_cast<DWORD>(der_cert.size()));
  8905. if (!cert_context) {
  8906. out_error = GetLastError();
  8907. return false;
  8908. }
  8909. auto cert_guard =
  8910. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8911. // Setup chain parameters
  8912. CERT_CHAIN_PARA chain_para = {};
  8913. chain_para.cbSize = sizeof(chain_para);
  8914. // Build certificate chain with revocation checking
  8915. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8916. auto chain_result = CertGetCertificateChain(
  8917. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8918. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8919. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8920. nullptr, &chain_context);
  8921. if (!chain_result || !chain_context) {
  8922. out_error = GetLastError();
  8923. return false;
  8924. }
  8925. auto chain_guard =
  8926. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  8927. // Check if chain has errors
  8928. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  8929. out_error = chain_context->TrustStatus.dwErrorStatus;
  8930. return false;
  8931. }
  8932. // Verify SSL policy
  8933. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  8934. extra_policy_para.cbSize = sizeof(extra_policy_para);
  8935. #ifdef AUTHTYPE_SERVER
  8936. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  8937. #endif
  8938. std::wstring whost;
  8939. if (verify_hostname) {
  8940. whost = u8string_to_wstring(hostname.c_str());
  8941. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  8942. }
  8943. CERT_CHAIN_POLICY_PARA policy_para = {};
  8944. policy_para.cbSize = sizeof(policy_para);
  8945. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  8946. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  8947. #else
  8948. policy_para.dwFlags = 0;
  8949. #endif
  8950. policy_para.pvExtraPolicyPara = &extra_policy_para;
  8951. CERT_CHAIN_POLICY_STATUS policy_status = {};
  8952. policy_status.cbSize = sizeof(policy_status);
  8953. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  8954. &policy_para, &policy_status)) {
  8955. out_error = GetLastError();
  8956. return false;
  8957. }
  8958. if (policy_status.dwError != 0) {
  8959. out_error = policy_status.dwError;
  8960. return false;
  8961. }
  8962. return true;
  8963. }
  8964. #endif // _WIN32
  8965. // Loads CA file/dir configuration and applies the system CA policy to a
  8966. // client TLS context. PEM data and native stores are applied to the context
  8967. // directly at set time; has_custom_store reflects them for the Auto policy
  8968. // decision.
  8969. inline bool load_client_ca_config(tls::ctx_t ctx,
  8970. const std::string &ca_cert_file_path,
  8971. const std::string &ca_cert_dir_path,
  8972. bool has_custom_store, SystemCAMode mode,
  8973. uint64_t &backend_error) {
  8974. auto ret = true;
  8975. if (!ca_cert_file_path.empty()) {
  8976. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  8977. backend_error = tls::get_error();
  8978. ret = false;
  8979. }
  8980. } else if (!ca_cert_dir_path.empty()) {
  8981. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  8982. backend_error = tls::get_error();
  8983. ret = false;
  8984. }
  8985. }
  8986. auto has_custom_ca = !ca_cert_file_path.empty() ||
  8987. !ca_cert_dir_path.empty() || has_custom_store;
  8988. if (mode == SystemCAMode::Enabled ||
  8989. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  8990. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  8991. }
  8992. return ret;
  8993. }
  8994. // The parts of session setup that only SSLClient needs, plus the handful
  8995. // WebSocketClient also exposes; everything else takes the defaults, which is
  8996. // what keeps the two clients on one implementation.
  8997. struct ClientTlsSessionOptions {
  8998. // Both SSLClient and WebSocketClient expose this independently of
  8999. // certificate verification.
  9000. bool server_hostname_verification = true;
  9001. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9002. // When non-null, guards session creation against concurrent use of the
  9003. // context. A WebSocketClient is not safe to use from several threads to
  9004. // begin with, so it passes nothing.
  9005. std::mutex *ctx_mutex = nullptr;
  9006. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9007. // The caller decides whether Schannel has anything to say about this
  9008. // connection; see SSLClient::initialize_ssl().
  9009. bool windows_cert_verification = false;
  9010. #endif
  9011. };
  9012. // Filled in on failure for callers that report error details.
  9013. struct ClientTlsSessionError {
  9014. Error error = Error::Success;
  9015. int ssl_error = 0;
  9016. uint64_t backend_error = 0;
  9017. };
  9018. // Establishes a client TLS session on an already connected socket. On failure
  9019. // the session is left for the caller to free: SSLClient frees it right away,
  9020. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9021. inline bool setup_client_tls_session(
  9022. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9023. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9024. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9025. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9026. using namespace tls;
  9027. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9028. if (out_error) {
  9029. out_error->error = error;
  9030. out_error->ssl_error = ssl_error;
  9031. out_error->backend_error = backend_error;
  9032. }
  9033. return false;
  9034. };
  9035. if (!ctx) {
  9036. session = nullptr;
  9037. return fail(Error::SSLConnection, 0, 0);
  9038. }
  9039. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9040. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9041. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9042. // verification happens during the handshake even for IP hosts; the
  9043. // certificate identity is verified post-handshake via verify_hostname().
  9044. set_verify_client(ctx, server_certificate_verification);
  9045. #endif
  9046. {
  9047. std::unique_lock<std::mutex> guard;
  9048. if (options.ctx_mutex) {
  9049. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9050. }
  9051. session = create_session(ctx, sock);
  9052. }
  9053. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9054. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9055. // their identity is checked post-handshake below instead. On Mbed TLS and
  9056. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9057. // options.server_hostname_verification is threaded through here.
  9058. if (!is_ip_address(host)) {
  9059. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9060. return fail(Error::SSLConnection, 0, get_error());
  9061. }
  9062. }
  9063. TlsError tls_err;
  9064. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9065. &tls_err)) {
  9066. auto error = Error::SSLConnection;
  9067. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9068. error = Error::SSLServerVerification;
  9069. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9070. error = Error::SSLServerHostnameVerification;
  9071. }
  9072. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9073. }
  9074. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9075. if (options.session_verifier) {
  9076. verification_status = options.session_verifier(session);
  9077. }
  9078. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9079. return fail(Error::SSLServerVerification, 0, get_error());
  9080. }
  9081. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9082. server_certificate_verification) {
  9083. auto verify_result = get_verify_result(session);
  9084. if (verify_result != 0) {
  9085. return fail(Error::SSLServerVerification, 0,
  9086. static_cast<uint64_t>(verify_result));
  9087. }
  9088. auto server_cert = get_peer_cert(session);
  9089. if (!server_cert) {
  9090. return fail(Error::SSLServerVerification, 0, get_error());
  9091. }
  9092. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9093. // Identity check against the peer certificate, post-handshake for all
  9094. // backends. For IP hosts this is the only identity verification, since no
  9095. // hostname is bound during the handshake.
  9096. if (options.server_hostname_verification) {
  9097. if (!verify_hostname(server_cert, host.c_str())) {
  9098. return fail(Error::SSLServerHostnameVerification, 0,
  9099. hostname_mismatch_code());
  9100. }
  9101. }
  9102. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9103. // Additional Windows Schannel verification.
  9104. // This provides real-time certificate validation with Windows Update
  9105. // integration, working with both OpenSSL and MbedTLS backends.
  9106. if (options.windows_cert_verification) {
  9107. std::vector<unsigned char> der;
  9108. if (get_cert_der(server_cert, der)) {
  9109. uint64_t wincrypt_error = 0;
  9110. if (!verify_cert_with_windows_schannel(
  9111. der, host, options.server_hostname_verification,
  9112. wincrypt_error)) {
  9113. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9114. }
  9115. }
  9116. }
  9117. #endif
  9118. }
  9119. return true;
  9120. }
  9121. } // namespace detail
  9122. #endif // CPPHTTPLIB_SSL_ENABLED
  9123. /*
  9124. * Group 3: httplib namespace - Non-SSL public API implementations
  9125. */
  9126. inline void default_socket_options(socket_t sock) {
  9127. set_socket_opt(sock, SOL_SOCKET,
  9128. #ifdef SO_REUSEPORT
  9129. SO_REUSEPORT,
  9130. #else
  9131. SO_REUSEADDR,
  9132. #endif
  9133. 1);
  9134. }
  9135. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9136. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9137. sizeof(optval));
  9138. }
  9139. inline std::string get_bearer_token_auth(const Request &req) {
  9140. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9141. // than the prefix carries no token.
  9142. constexpr const char bearer_prefix[] = "Bearer ";
  9143. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9144. auto value = req.get_header_value("Authorization");
  9145. if (value.size() >= bearer_prefix_len &&
  9146. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9147. bearer_prefix)) {
  9148. return value.substr(bearer_prefix_len);
  9149. }
  9150. return "";
  9151. }
  9152. inline const char *status_message(int status) {
  9153. switch (status) {
  9154. case StatusCode::Continue_100: return "Continue";
  9155. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9156. case StatusCode::Processing_102: return "Processing";
  9157. case StatusCode::EarlyHints_103: return "Early Hints";
  9158. case StatusCode::OK_200: return "OK";
  9159. case StatusCode::Created_201: return "Created";
  9160. case StatusCode::Accepted_202: return "Accepted";
  9161. case StatusCode::NonAuthoritativeInformation_203:
  9162. return "Non-Authoritative Information";
  9163. case StatusCode::NoContent_204: return "No Content";
  9164. case StatusCode::ResetContent_205: return "Reset Content";
  9165. case StatusCode::PartialContent_206: return "Partial Content";
  9166. case StatusCode::MultiStatus_207: return "Multi-Status";
  9167. case StatusCode::AlreadyReported_208: return "Already Reported";
  9168. case StatusCode::IMUsed_226: return "IM Used";
  9169. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9170. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9171. case StatusCode::Found_302: return "Found";
  9172. case StatusCode::SeeOther_303: return "See Other";
  9173. case StatusCode::NotModified_304: return "Not Modified";
  9174. case StatusCode::UseProxy_305: return "Use Proxy";
  9175. case StatusCode::unused_306: return "unused";
  9176. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9177. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9178. case StatusCode::BadRequest_400: return "Bad Request";
  9179. case StatusCode::Unauthorized_401: return "Unauthorized";
  9180. case StatusCode::PaymentRequired_402: return "Payment Required";
  9181. case StatusCode::Forbidden_403: return "Forbidden";
  9182. case StatusCode::NotFound_404: return "Not Found";
  9183. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9184. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9185. case StatusCode::ProxyAuthenticationRequired_407:
  9186. return "Proxy Authentication Required";
  9187. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9188. case StatusCode::Conflict_409: return "Conflict";
  9189. case StatusCode::Gone_410: return "Gone";
  9190. case StatusCode::LengthRequired_411: return "Length Required";
  9191. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9192. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9193. case StatusCode::UriTooLong_414: return "URI Too Long";
  9194. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9195. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9196. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9197. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9198. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9199. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9200. case StatusCode::Locked_423: return "Locked";
  9201. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9202. case StatusCode::TooEarly_425: return "Too Early";
  9203. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9204. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9205. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9206. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9207. return "Request Header Fields Too Large";
  9208. case StatusCode::UnavailableForLegalReasons_451:
  9209. return "Unavailable For Legal Reasons";
  9210. case StatusCode::NotImplemented_501: return "Not Implemented";
  9211. case StatusCode::BadGateway_502: return "Bad Gateway";
  9212. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9213. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9214. case StatusCode::HttpVersionNotSupported_505:
  9215. return "HTTP Version Not Supported";
  9216. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9217. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9218. case StatusCode::LoopDetected_508: return "Loop Detected";
  9219. case StatusCode::NotExtended_510: return "Not Extended";
  9220. case StatusCode::NetworkAuthenticationRequired_511:
  9221. return "Network Authentication Required";
  9222. default:
  9223. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9224. }
  9225. }
  9226. inline std::string to_string(const Error error) {
  9227. switch (error) {
  9228. case Error::Success: return "Success (no error)";
  9229. case Error::Unknown: return "Unknown";
  9230. case Error::Connection: return "Could not establish connection";
  9231. case Error::BindIPAddress: return "Failed to bind IP address";
  9232. case Error::Read: return "Failed to read connection";
  9233. case Error::Write: return "Failed to write connection";
  9234. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9235. case Error::Canceled: return "Connection handling canceled";
  9236. case Error::SSLConnection: return "SSL connection failed";
  9237. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9238. case Error::SSLServerVerification: return "SSL server verification failed";
  9239. case Error::SSLServerHostnameVerification:
  9240. return "SSL server hostname verification failed";
  9241. case Error::UnsupportedMultipartBoundaryChars:
  9242. return "Unsupported HTTP multipart boundary characters";
  9243. case Error::Compression: return "Compression failed";
  9244. case Error::ConnectionTimeout: return "Connection timed out";
  9245. case Error::ProxyConnection: return "Proxy connection failed";
  9246. case Error::ConnectionClosed: return "Connection closed by server";
  9247. case Error::Timeout: return "Read timeout";
  9248. case Error::ResourceExhaustion: return "Resource exhaustion";
  9249. case Error::TooManyFormDataFiles: return "Too many form data files";
  9250. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9251. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9252. case Error::ExceedMaxSocketDescriptorCount:
  9253. return "Exceeded maximum socket descriptor count";
  9254. case Error::InvalidRequestLine: return "Invalid request line";
  9255. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9256. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9257. case Error::InvalidHeaders: return "Invalid headers";
  9258. case Error::MultipartParsing: return "Multipart parsing failed";
  9259. case Error::OpenFile: return "Failed to open file";
  9260. case Error::Listen: return "Failed to listen on socket";
  9261. case Error::GetSockName: return "Failed to get socket name";
  9262. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9263. case Error::HTTPParsing: return "HTTP parsing failed";
  9264. case Error::InvalidRangeHeader: return "Invalid Range header";
  9265. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9266. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9267. case Error::UserCallbackException: return "User callback threw an exception";
  9268. default: break;
  9269. }
  9270. return "Invalid";
  9271. }
  9272. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9273. os << to_string(obj);
  9274. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9275. return os;
  9276. }
  9277. inline std::string hosted_at(const std::string &hostname) {
  9278. std::vector<std::string> addrs;
  9279. hosted_at(hostname, addrs);
  9280. if (addrs.empty()) { return std::string(); }
  9281. return addrs[0];
  9282. }
  9283. inline void hosted_at(const std::string &hostname,
  9284. std::vector<std::string> &addrs) {
  9285. struct addrinfo hints;
  9286. struct addrinfo *result;
  9287. memset(&hints, 0, sizeof(struct addrinfo));
  9288. hints.ai_family = AF_UNSPEC;
  9289. hints.ai_socktype = SOCK_STREAM;
  9290. hints.ai_protocol = 0;
  9291. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9292. &result, 0)) {
  9293. #if defined __linux__ && !defined __ANDROID__
  9294. res_init();
  9295. #endif
  9296. return;
  9297. }
  9298. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9299. for (auto rp = result; rp; rp = rp->ai_next) {
  9300. const auto &addr =
  9301. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9302. std::string ip;
  9303. auto dummy = -1;
  9304. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9305. dummy)) {
  9306. addrs.emplace_back(std::move(ip));
  9307. }
  9308. }
  9309. }
  9310. inline std::string encode_uri_component(const std::string &value) {
  9311. std::ostringstream escaped;
  9312. escaped.fill('0');
  9313. escaped << std::hex;
  9314. for (auto c : value) {
  9315. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9316. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9317. escaped << c;
  9318. } else {
  9319. escaped << std::uppercase;
  9320. escaped << '%' << std::setw(2)
  9321. << static_cast<int>(static_cast<unsigned char>(c));
  9322. escaped << std::nouppercase;
  9323. }
  9324. }
  9325. return escaped.str();
  9326. }
  9327. inline std::string encode_uri(const std::string &value) {
  9328. std::ostringstream escaped;
  9329. escaped.fill('0');
  9330. escaped << std::hex;
  9331. for (auto c : value) {
  9332. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9333. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9334. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9335. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9336. escaped << c;
  9337. } else {
  9338. escaped << std::uppercase;
  9339. escaped << '%' << std::setw(2)
  9340. << static_cast<int>(static_cast<unsigned char>(c));
  9341. escaped << std::nouppercase;
  9342. }
  9343. }
  9344. return escaped.str();
  9345. }
  9346. inline std::string decode_uri_component(const std::string &value) {
  9347. std::string result;
  9348. for (size_t i = 0; i < value.size(); i++) {
  9349. if (value[i] == '%' && i + 2 < value.size()) {
  9350. auto val = 0;
  9351. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9352. result += static_cast<char>(val);
  9353. i += 2;
  9354. } else {
  9355. result += value[i];
  9356. }
  9357. } else {
  9358. result += value[i];
  9359. }
  9360. }
  9361. return result;
  9362. }
  9363. inline std::string decode_uri(const std::string &value) {
  9364. std::string result;
  9365. for (size_t i = 0; i < value.size(); i++) {
  9366. if (value[i] == '%' && i + 2 < value.size()) {
  9367. auto val = 0;
  9368. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9369. auto c = static_cast<char>(val);
  9370. // Keep escapes of the reserved characters that encode_uri leaves
  9371. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9372. // delimiter is not promoted into a real one (as with JS decodeURI).
  9373. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9374. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9375. c == '#') {
  9376. result += value[i];
  9377. result += value[i + 1];
  9378. result += value[i + 2];
  9379. } else {
  9380. result += c;
  9381. }
  9382. i += 2;
  9383. } else {
  9384. result += value[i];
  9385. }
  9386. } else {
  9387. result += value[i];
  9388. }
  9389. }
  9390. return result;
  9391. }
  9392. inline std::string encode_path_component(const std::string &component) {
  9393. std::string result;
  9394. result.reserve(component.size() * 3);
  9395. for (size_t i = 0; i < component.size(); i++) {
  9396. auto c = static_cast<unsigned char>(component[i]);
  9397. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9398. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9399. c == '_' || c == '~') {
  9400. result += static_cast<char>(c);
  9401. }
  9402. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9403. // "," / ";" / "="
  9404. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9405. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9406. c == '=') {
  9407. result += static_cast<char>(c);
  9408. }
  9409. // Colon is allowed in path segments except first segment
  9410. else if (c == ':') {
  9411. result += static_cast<char>(c);
  9412. }
  9413. // @ is allowed in path
  9414. else if (c == '@') {
  9415. result += static_cast<char>(c);
  9416. } else {
  9417. result += '%';
  9418. char hex[3];
  9419. snprintf(hex, sizeof(hex), "%02X", c);
  9420. result.append(hex, 2);
  9421. }
  9422. }
  9423. return result;
  9424. }
  9425. inline std::string decode_path_component(const std::string &component) {
  9426. std::string result;
  9427. result.reserve(component.size());
  9428. for (size_t i = 0; i < component.size(); i++) {
  9429. if (component[i] == '%' && i + 1 < component.size()) {
  9430. if (component[i + 1] == 'u') {
  9431. // Unicode %uXXXX encoding
  9432. auto val = 0;
  9433. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9434. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9435. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9436. char buff[4];
  9437. size_t len = detail::to_utf8(val, buff);
  9438. if (len > 0) { result.append(buff, len); }
  9439. i += 5; // 'u0000'
  9440. } else {
  9441. result += component[i];
  9442. }
  9443. } else {
  9444. // Standard %XX encoding
  9445. auto val = 0;
  9446. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9447. // 2 digits hex codes
  9448. result += static_cast<char>(val);
  9449. i += 2; // 'XX'
  9450. } else {
  9451. result += component[i];
  9452. }
  9453. }
  9454. } else {
  9455. result += component[i];
  9456. }
  9457. }
  9458. return result;
  9459. }
  9460. inline std::string encode_query_component(const std::string &component,
  9461. bool space_as_plus) {
  9462. std::string result;
  9463. result.reserve(component.size() * 3);
  9464. for (size_t i = 0; i < component.size(); i++) {
  9465. auto c = static_cast<unsigned char>(component[i]);
  9466. // Unreserved characters per RFC 3986
  9467. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9468. c == '_' || c == '~') {
  9469. result += static_cast<char>(c);
  9470. }
  9471. // Space handling
  9472. else if (c == ' ') {
  9473. if (space_as_plus) {
  9474. result += '+';
  9475. } else {
  9476. result += "%20";
  9477. }
  9478. }
  9479. // Plus sign handling
  9480. else if (c == '+') {
  9481. if (space_as_plus) {
  9482. result += "%2B";
  9483. } else {
  9484. result += static_cast<char>(c);
  9485. }
  9486. }
  9487. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9488. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9489. c == '*' || c == ',' || c == ';') {
  9490. result += static_cast<char>(c);
  9491. }
  9492. // Colon and @ are allowed in query
  9493. else if (c == ':' || c == '@') {
  9494. result += static_cast<char>(c);
  9495. }
  9496. // Forward slash is allowed in query values
  9497. else if (c == '/') {
  9498. result += static_cast<char>(c);
  9499. }
  9500. // Question mark is allowed in query values (after first ?)
  9501. else if (c == '?') {
  9502. result += static_cast<char>(c);
  9503. } else {
  9504. result += '%';
  9505. char hex[3];
  9506. snprintf(hex, sizeof(hex), "%02X", c);
  9507. result.append(hex, 2);
  9508. }
  9509. }
  9510. return result;
  9511. }
  9512. inline std::string decode_query_component(const std::string &component,
  9513. bool plus_as_space) {
  9514. std::string result;
  9515. result.reserve(component.size());
  9516. for (size_t i = 0; i < component.size(); i++) {
  9517. if (component[i] == '%' && i + 2 < component.size()) {
  9518. auto val = 0;
  9519. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9520. result += static_cast<char>(val);
  9521. i += 2;
  9522. } else {
  9523. result += component[i];
  9524. }
  9525. } else if (component[i] == '+' && plus_as_space) {
  9526. result += ' '; // + becomes space in form-urlencoded
  9527. } else {
  9528. result += component[i];
  9529. }
  9530. }
  9531. return result;
  9532. }
  9533. inline std::string sanitize_filename(const std::string &filename) {
  9534. // Extract basename: find the last path separator (/ or \)
  9535. auto pos = filename.find_last_of("/\\");
  9536. auto result =
  9537. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9538. // Strip null bytes
  9539. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9540. // Trim whitespace
  9541. {
  9542. auto start = result.find_first_not_of(" \t");
  9543. auto end = result.find_last_not_of(" \t");
  9544. result = (start == std::string::npos)
  9545. ? ""
  9546. : result.substr(start, end - start + 1);
  9547. }
  9548. // Reject . and ..
  9549. if (result == "." || result == "..") { return ""; }
  9550. return result;
  9551. }
  9552. inline std::string append_query_params(const std::string &path,
  9553. const Params &params) {
  9554. std::string path_with_query = path;
  9555. thread_local const std::regex re("[^?]+\\?.*");
  9556. auto delm = std::regex_match(path, re) ? '&' : '?';
  9557. path_with_query += delm + detail::params_to_query_str(params);
  9558. return path_with_query;
  9559. }
  9560. // Header utilities
  9561. inline std::pair<std::string, std::string>
  9562. make_range_header(const Ranges &ranges) {
  9563. std::string field = "bytes=";
  9564. auto i = 0;
  9565. for (const auto &r : ranges) {
  9566. if (i != 0) { field += ", "; }
  9567. if (r.first != -1) { field += std::to_string(r.first); }
  9568. field += '-';
  9569. if (r.second != -1) { field += std::to_string(r.second); }
  9570. i++;
  9571. }
  9572. return std::make_pair("Range", std::move(field));
  9573. }
  9574. inline std::pair<std::string, std::string>
  9575. make_basic_authentication_header(const std::string &username,
  9576. const std::string &password, bool is_proxy) {
  9577. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9578. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9579. return std::make_pair(key, std::move(field));
  9580. }
  9581. inline std::pair<std::string, std::string>
  9582. make_bearer_token_authentication_header(const std::string &token,
  9583. bool is_proxy = false) {
  9584. auto field = "Bearer " + token;
  9585. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9586. return std::make_pair(key, std::move(field));
  9587. }
  9588. // Request implementation
  9589. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9590. size_t id) const {
  9591. return detail::get_header_value_u64(headers, key, def, id);
  9592. }
  9593. inline bool Request::has_header(const std::string &key) const {
  9594. return detail::has_header(headers, key);
  9595. }
  9596. inline std::string Request::get_header_value(const std::string &key,
  9597. const char *def, size_t id) const {
  9598. return detail::get_header_value(headers, key, def, id);
  9599. }
  9600. inline size_t Request::get_header_value_count(const std::string &key) const {
  9601. return detail::get_header_value_count(headers, key);
  9602. }
  9603. inline void Request::set_header(const std::string &key,
  9604. const std::string &val) {
  9605. detail::set_header(headers, key, val);
  9606. }
  9607. inline bool Request::has_trailer(const std::string &key) const {
  9608. return trailers.find(key) != trailers.end();
  9609. }
  9610. inline std::string Request::get_trailer_value(const std::string &key,
  9611. size_t id) const {
  9612. return detail::get_multimap_value(trailers, key, id);
  9613. }
  9614. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9615. return trailers.count(key);
  9616. }
  9617. inline bool Request::has_param(const std::string &key) const {
  9618. return params.find(key) != params.end();
  9619. }
  9620. inline std::string Request::get_param_value(const std::string &key,
  9621. size_t id) const {
  9622. return detail::get_multimap_value(params, key, id);
  9623. }
  9624. inline std::vector<std::string>
  9625. Request::get_param_values(const std::string &key) const {
  9626. auto rng = params.equal_range(key);
  9627. std::vector<std::string> values;
  9628. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9629. for (auto it = rng.first; it != rng.second; ++it) {
  9630. values.push_back(it->second);
  9631. }
  9632. return values;
  9633. }
  9634. inline size_t Request::get_param_value_count(const std::string &key) const {
  9635. return params.count(key);
  9636. }
  9637. inline bool Request::is_multipart_form_data() const {
  9638. const auto &content_type = get_header_value("Content-Type");
  9639. return detail::extract_media_type(content_type) == "multipart/form-data";
  9640. }
  9641. // Multipart FormData implementation
  9642. inline std::string MultipartFormData::get_field(const std::string &key,
  9643. size_t id) const {
  9644. auto rng = fields.equal_range(key);
  9645. auto it = rng.first;
  9646. std::advance(it, static_cast<ssize_t>(id));
  9647. if (it != rng.second) { return it->second.content; }
  9648. return std::string();
  9649. }
  9650. inline std::vector<std::string>
  9651. MultipartFormData::get_fields(const std::string &key) const {
  9652. std::vector<std::string> values;
  9653. auto rng = fields.equal_range(key);
  9654. for (auto it = rng.first; it != rng.second; it++) {
  9655. values.push_back(it->second.content);
  9656. }
  9657. return values;
  9658. }
  9659. inline bool MultipartFormData::has_field(const std::string &key) const {
  9660. return fields.find(key) != fields.end();
  9661. }
  9662. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9663. return fields.count(key);
  9664. }
  9665. inline FormData MultipartFormData::get_file(const std::string &key,
  9666. size_t id) const {
  9667. return detail::get_multimap_value(files, key, id);
  9668. }
  9669. inline std::vector<FormData>
  9670. MultipartFormData::get_files(const std::string &key) const {
  9671. std::vector<FormData> values;
  9672. auto rng = files.equal_range(key);
  9673. for (auto it = rng.first; it != rng.second; it++) {
  9674. values.push_back(it->second);
  9675. }
  9676. return values;
  9677. }
  9678. inline bool MultipartFormData::has_file(const std::string &key) const {
  9679. return files.find(key) != files.end();
  9680. }
  9681. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9682. return files.count(key);
  9683. }
  9684. // Multipart FormData writer implementation
  9685. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9686. return detail::is_multipart_boundary_chars_valid(boundary);
  9687. }
  9688. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9689. : boundary_(detail::make_multipart_data_boundary()) {}
  9690. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9691. : boundary_(std::move(boundary)) {}
  9692. inline const std::string &MultipartFormDataWriter::boundary() const {
  9693. return boundary_;
  9694. }
  9695. inline std::string MultipartFormDataWriter::content_type() const {
  9696. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9697. }
  9698. inline std::string
  9699. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9700. return detail::serialize_multipart_formdata(items, boundary_);
  9701. }
  9702. inline size_t MultipartFormDataWriter::content_length(
  9703. const UploadFormDataItems &items) const {
  9704. return detail::get_multipart_content_length(items, boundary_);
  9705. }
  9706. inline std::string
  9707. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9708. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9709. }
  9710. inline std::string MultipartFormDataWriter::item_end() {
  9711. return detail::serialize_multipart_formdata_item_end();
  9712. }
  9713. inline std::string MultipartFormDataWriter::finish() const {
  9714. return detail::serialize_multipart_formdata_finish(boundary_);
  9715. }
  9716. // Response implementation
  9717. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9718. size_t id) const {
  9719. return detail::get_header_value_u64(headers, key, def, id);
  9720. }
  9721. inline bool Response::has_header(const std::string &key) const {
  9722. return headers.find(key) != headers.end();
  9723. }
  9724. inline std::string Response::get_header_value(const std::string &key,
  9725. const char *def,
  9726. size_t id) const {
  9727. return detail::get_header_value(headers, key, def, id);
  9728. }
  9729. inline size_t Response::get_header_value_count(const std::string &key) const {
  9730. return detail::get_header_value_count(headers, key);
  9731. }
  9732. inline void Response::set_header(const std::string &key,
  9733. const std::string &val) {
  9734. detail::set_header(headers, key, val);
  9735. }
  9736. inline bool Response::has_trailer(const std::string &key) const {
  9737. return trailers.find(key) != trailers.end();
  9738. }
  9739. inline std::string Response::get_trailer_value(const std::string &key,
  9740. size_t id) const {
  9741. return detail::get_multimap_value(trailers, key, id);
  9742. }
  9743. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9744. return trailers.count(key);
  9745. }
  9746. inline void Response::set_redirect(const std::string &url, int stat) {
  9747. if (detail::fields::is_field_value(url)) {
  9748. set_header("Location", url);
  9749. if (300 <= stat && stat < 400) {
  9750. this->status = stat;
  9751. } else {
  9752. this->status = StatusCode::Found_302;
  9753. }
  9754. }
  9755. }
  9756. inline void Response::set_content(const char *s, size_t n,
  9757. const std::string &content_type) {
  9758. body.assign(s, n);
  9759. auto rng = headers.equal_range("Content-Type");
  9760. headers.erase(rng.first, rng.second);
  9761. set_header("Content-Type", content_type);
  9762. content_coding_ = detail::EncodingType::None;
  9763. }
  9764. inline void Response::set_content(const std::string &s,
  9765. const std::string &content_type) {
  9766. set_content(s.data(), s.size(), content_type);
  9767. }
  9768. inline void Response::set_content(std::string &&s,
  9769. const std::string &content_type) {
  9770. body = std::move(s);
  9771. auto rng = headers.equal_range("Content-Type");
  9772. headers.erase(rng.first, rng.second);
  9773. set_header("Content-Type", content_type);
  9774. content_coding_ = detail::EncodingType::None;
  9775. }
  9776. inline void Response::set_content_provider(
  9777. size_t in_length, const std::string &content_type, ContentProvider provider,
  9778. ContentProviderResourceReleaser resource_releaser) {
  9779. set_header("Content-Type", content_type);
  9780. content_length_ = in_length;
  9781. if (in_length > 0) { content_provider_ = std::move(provider); }
  9782. content_provider_resource_releaser_ = std::move(resource_releaser);
  9783. is_chunked_content_provider_ = false;
  9784. content_coding_ = detail::EncodingType::None;
  9785. }
  9786. inline void Response::set_content_provider(
  9787. const std::string &content_type, ContentProviderWithoutLength provider,
  9788. ContentProviderResourceReleaser resource_releaser) {
  9789. set_header("Content-Type", content_type);
  9790. content_length_ = 0;
  9791. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9792. content_provider_resource_releaser_ = std::move(resource_releaser);
  9793. is_chunked_content_provider_ = false;
  9794. content_coding_ = detail::EncodingType::None;
  9795. }
  9796. inline void Response::set_chunked_content_provider(
  9797. const std::string &content_type, ContentProviderWithoutLength provider,
  9798. ContentProviderResourceReleaser resource_releaser) {
  9799. set_header("Content-Type", content_type);
  9800. content_length_ = 0;
  9801. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9802. content_provider_resource_releaser_ = std::move(resource_releaser);
  9803. is_chunked_content_provider_ = true;
  9804. content_coding_ = detail::EncodingType::None;
  9805. }
  9806. inline void Response::set_file_content(const std::string &path,
  9807. const std::string &content_type) {
  9808. file_content_path_ = path;
  9809. file_content_content_type_ = content_type;
  9810. }
  9811. inline void Response::set_file_content(const std::string &path) {
  9812. file_content_path_ = path;
  9813. }
  9814. // Result implementation
  9815. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9816. size_t def,
  9817. size_t id) const {
  9818. return detail::get_header_value_u64(request_headers_, key, def, id);
  9819. }
  9820. inline bool Result::has_request_header(const std::string &key) const {
  9821. return request_headers_.find(key) != request_headers_.end();
  9822. }
  9823. inline std::string Result::get_request_header_value(const std::string &key,
  9824. const char *def,
  9825. size_t id) const {
  9826. return detail::get_header_value(request_headers_, key, def, id);
  9827. }
  9828. inline size_t
  9829. Result::get_request_header_value_count(const std::string &key) const {
  9830. return request_headers_.count(key);
  9831. }
  9832. // Stream implementation
  9833. inline ssize_t Stream::write(const char *ptr) {
  9834. return write(ptr, strlen(ptr));
  9835. }
  9836. inline ssize_t Stream::write(const std::string &s) {
  9837. return write(s.data(), s.size());
  9838. }
  9839. // BodyReader implementation
  9840. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9841. if (!stream) {
  9842. last_error = Error::Connection;
  9843. return -1;
  9844. }
  9845. if (eof) { return 0; }
  9846. if (!chunked) {
  9847. // Content-Length based reading
  9848. if (has_content_length && bytes_read >= content_length) {
  9849. eof = true;
  9850. return 0;
  9851. }
  9852. auto to_read = len;
  9853. if (has_content_length) {
  9854. auto remaining = content_length - bytes_read;
  9855. to_read = (std::min)(len, remaining);
  9856. }
  9857. auto n = stream->read(buf, to_read);
  9858. if (n < 0) {
  9859. last_error = stream->get_error();
  9860. if (last_error == Error::Success) { last_error = Error::Read; }
  9861. eof = true;
  9862. return n;
  9863. }
  9864. if (n == 0) {
  9865. // Unexpected EOF before content_length
  9866. last_error = stream->get_error();
  9867. if (last_error == Error::Success) { last_error = Error::Read; }
  9868. eof = true;
  9869. return 0;
  9870. }
  9871. bytes_read += static_cast<size_t>(n);
  9872. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9873. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9874. last_error = Error::ExceedMaxPayloadSize;
  9875. eof = true;
  9876. return -1;
  9877. }
  9878. return n;
  9879. }
  9880. // Chunked transfer encoding: delegate to shared decoder instance.
  9881. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9882. size_t chunk_offset = 0;
  9883. size_t chunk_total = 0;
  9884. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9885. if (n < 0) {
  9886. last_error = stream->get_error();
  9887. if (last_error == Error::Success) { last_error = Error::Read; }
  9888. eof = true;
  9889. return n;
  9890. }
  9891. if (n == 0) {
  9892. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9893. eof = true;
  9894. return 0;
  9895. }
  9896. bytes_read += static_cast<size_t>(n);
  9897. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9898. last_error = Error::ExceedMaxPayloadSize;
  9899. eof = true;
  9900. return -1;
  9901. }
  9902. return n;
  9903. }
  9904. // ThreadPool implementation
  9905. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9906. time_t idle_timeout_sec)
  9907. : base_thread_count_(n), max_queued_requests_(mqr),
  9908. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9909. shutdown_(false) {
  9910. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9911. if (max_n != 0 && max_n < n) {
  9912. std::string msg = "max_threads must be >= base_threads";
  9913. throw std::invalid_argument(msg);
  9914. }
  9915. #endif
  9916. max_thread_count_ = max_n == 0 ? n : max_n;
  9917. threads_.reserve(base_thread_count_);
  9918. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9919. try {
  9920. #endif
  9921. for (size_t i = 0; i < base_thread_count_; i++) {
  9922. threads_.emplace_back(std::thread([this]() { worker(false); }));
  9923. }
  9924. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9925. } catch (...) {
  9926. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  9927. // signal the workers we already spawned to exit and join them so the
  9928. // vector destructor does not see joinable threads (which would call
  9929. // std::terminate). Then rethrow so the caller learns of the failure.
  9930. {
  9931. std::unique_lock<std::mutex> lock(mutex_);
  9932. shutdown_ = true;
  9933. }
  9934. cond_.notify_all();
  9935. for (auto &t : threads_) {
  9936. if (t.joinable()) { t.join(); }
  9937. }
  9938. throw;
  9939. }
  9940. #endif
  9941. }
  9942. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  9943. {
  9944. std::unique_lock<std::mutex> lock(mutex_);
  9945. if (shutdown_) { return false; }
  9946. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  9947. return false;
  9948. }
  9949. jobs_.push_back(std::move(fn));
  9950. // Spawn a dynamic thread if no idle threads and under max
  9951. if (idle_thread_count_ == 0 &&
  9952. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  9953. cleanup_finished_threads();
  9954. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  9955. }
  9956. }
  9957. cond_.notify_one();
  9958. return true;
  9959. }
  9960. inline void ThreadPool::shutdown() {
  9961. {
  9962. std::unique_lock<std::mutex> lock(mutex_);
  9963. shutdown_ = true;
  9964. }
  9965. cond_.notify_all();
  9966. for (auto &t : threads_) {
  9967. if (t.joinable()) { t.join(); }
  9968. }
  9969. // Move dynamic_threads_ to a local list under the lock to avoid racing
  9970. // with worker threads that call move_to_finished() concurrently.
  9971. std::list<std::thread> remaining_dynamic;
  9972. {
  9973. std::unique_lock<std::mutex> lock(mutex_);
  9974. remaining_dynamic = std::move(dynamic_threads_);
  9975. }
  9976. for (auto &t : remaining_dynamic) {
  9977. if (t.joinable()) { t.join(); }
  9978. }
  9979. std::unique_lock<std::mutex> lock(mutex_);
  9980. cleanup_finished_threads();
  9981. }
  9982. inline void ThreadPool::move_to_finished(std::thread::id id) {
  9983. // Must be called with mutex_ held
  9984. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  9985. if (it->get_id() == id) {
  9986. finished_threads_.push_back(std::move(*it));
  9987. dynamic_threads_.erase(it);
  9988. return;
  9989. }
  9990. }
  9991. }
  9992. inline void ThreadPool::cleanup_finished_threads() {
  9993. // Must be called with mutex_ held
  9994. for (auto &t : finished_threads_) {
  9995. if (t.joinable()) { t.join(); }
  9996. }
  9997. finished_threads_.clear();
  9998. }
  9999. inline void ThreadPool::worker(bool is_dynamic) {
  10000. for (;;) {
  10001. std::function<void()> fn;
  10002. {
  10003. std::unique_lock<std::mutex> lock(mutex_);
  10004. idle_thread_count_++;
  10005. if (is_dynamic) {
  10006. auto has_work =
  10007. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10008. [&] { return !jobs_.empty() || shutdown_; });
  10009. if (!has_work) {
  10010. // Timed out with no work - exit this dynamic thread
  10011. idle_thread_count_--;
  10012. move_to_finished(std::this_thread::get_id());
  10013. break;
  10014. }
  10015. } else {
  10016. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10017. }
  10018. idle_thread_count_--;
  10019. if (shutdown_ && jobs_.empty()) { break; }
  10020. fn = std::move(jobs_.front());
  10021. jobs_.pop_front();
  10022. }
  10023. assert(true == static_cast<bool>(fn));
  10024. fn();
  10025. }
  10026. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10027. !defined(LIBRESSL_VERSION_NUMBER)
  10028. OPENSSL_thread_stop();
  10029. #endif
  10030. }
  10031. /*
  10032. * Group 1 (continued): detail namespace - Stream implementations
  10033. */
  10034. namespace detail {
  10035. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10036. time_t timeout_sec, time_t timeout_usec,
  10037. time_t &actual_timeout_sec,
  10038. time_t &actual_timeout_usec) {
  10039. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10040. auto actual_timeout_msec =
  10041. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10042. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10043. actual_timeout_sec = actual_timeout_msec / 1000;
  10044. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10045. }
  10046. // Socket stream implementation
  10047. inline SocketStream::SocketStream(
  10048. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10049. time_t write_timeout_sec, time_t write_timeout_usec,
  10050. time_t max_timeout_msec,
  10051. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10052. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10053. read_timeout_usec_(read_timeout_usec),
  10054. write_timeout_sec_(write_timeout_sec),
  10055. write_timeout_usec_(write_timeout_usec),
  10056. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10057. read_buff_(read_buff_size_, 0) {}
  10058. inline SocketStream::~SocketStream() = default;
  10059. inline bool SocketStream::is_readable() const {
  10060. return read_buff_off_ < read_buff_content_size_;
  10061. }
  10062. inline bool SocketStream::wait_readable() const {
  10063. if (max_timeout_msec_ <= 0) {
  10064. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10065. }
  10066. time_t read_timeout_sec;
  10067. time_t read_timeout_usec;
  10068. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10069. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10070. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10071. }
  10072. inline bool SocketStream::wait_writable() const {
  10073. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10074. }
  10075. inline bool SocketStream::ensure_readable() {
  10076. if (readable_hint_) {
  10077. readable_hint_ = false;
  10078. return true;
  10079. }
  10080. return wait_readable();
  10081. }
  10082. inline const char *SocketStream::buffered_data(size_t &size) const {
  10083. size = read_buff_content_size_ - read_buff_off_;
  10084. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10085. }
  10086. inline void SocketStream::consume_buffered(size_t size) {
  10087. assert(size <= read_buff_content_size_ - read_buff_off_);
  10088. read_buff_off_ += size;
  10089. }
  10090. inline bool SocketStream::is_peer_alive() const {
  10091. return detail::is_socket_alive(sock_);
  10092. }
  10093. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10094. #ifdef _WIN32
  10095. size =
  10096. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10097. #else
  10098. size = (std::min)(size,
  10099. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10100. #endif
  10101. if (read_buff_off_ < read_buff_content_size_) {
  10102. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10103. if (size <= remaining_size) {
  10104. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10105. read_buff_off_ += size;
  10106. return static_cast<ssize_t>(size);
  10107. } else {
  10108. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10109. read_buff_off_ += remaining_size;
  10110. return static_cast<ssize_t>(remaining_size);
  10111. }
  10112. }
  10113. if (!ensure_readable()) {
  10114. error_ = Error::Timeout;
  10115. return -1;
  10116. }
  10117. read_buff_off_ = 0;
  10118. read_buff_content_size_ = 0;
  10119. if (size < read_buff_size_) {
  10120. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10121. CPPHTTPLIB_RECV_FLAGS);
  10122. if (n <= 0) {
  10123. if (n == 0) {
  10124. error_ = Error::ConnectionClosed;
  10125. } else {
  10126. error_ = Error::Read;
  10127. }
  10128. return n;
  10129. } else if (n <= static_cast<ssize_t>(size)) {
  10130. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10131. return n;
  10132. } else {
  10133. memcpy(ptr, read_buff_.data(), size);
  10134. read_buff_off_ = size;
  10135. read_buff_content_size_ = static_cast<size_t>(n);
  10136. return static_cast<ssize_t>(size);
  10137. }
  10138. } else {
  10139. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10140. if (n <= 0) {
  10141. if (n == 0) {
  10142. error_ = Error::ConnectionClosed;
  10143. } else {
  10144. error_ = Error::Read;
  10145. }
  10146. }
  10147. return n;
  10148. }
  10149. }
  10150. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10151. if (!wait_writable()) { return -1; }
  10152. #if defined(_WIN32) && !defined(_WIN64)
  10153. size =
  10154. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10155. #endif
  10156. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10157. }
  10158. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10159. int &port) const {
  10160. return detail::get_remote_ip_and_port(sock_, ip, port);
  10161. }
  10162. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10163. int &port) const {
  10164. return detail::get_local_ip_and_port(sock_, ip, port);
  10165. }
  10166. inline socket_t SocketStream::socket() const { return sock_; }
  10167. inline time_t SocketStream::duration() const {
  10168. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10169. std::chrono::steady_clock::now() - start_time_)
  10170. .count();
  10171. }
  10172. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10173. read_timeout_sec_ = sec;
  10174. read_timeout_usec_ = usec;
  10175. }
  10176. // Buffer stream implementation
  10177. inline bool BufferStream::is_readable() const { return true; }
  10178. inline bool BufferStream::wait_readable() const { return true; }
  10179. inline bool BufferStream::wait_writable() const { return true; }
  10180. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10181. #if defined(_MSC_VER) && _MSC_VER < 1910
  10182. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10183. #else
  10184. auto len_read = buffer.copy(ptr, size, position);
  10185. #endif
  10186. position += static_cast<size_t>(len_read);
  10187. return static_cast<ssize_t>(len_read);
  10188. }
  10189. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10190. buffer.append(ptr, size);
  10191. return static_cast<ssize_t>(size);
  10192. }
  10193. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10194. int & /*port*/) const {}
  10195. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10196. int & /*port*/) const {}
  10197. inline socket_t BufferStream::socket() const { return 0; }
  10198. inline time_t BufferStream::duration() const { return 0; }
  10199. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10200. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10201. : MatcherBase(pattern) {
  10202. constexpr const char marker[] = "/:";
  10203. // One past the last ending position of a path param substring
  10204. std::size_t last_param_end = 0;
  10205. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10206. // Needed to ensure that parameter names are unique during matcher
  10207. // construction
  10208. // If exceptions are disabled, only last duplicate path
  10209. // parameter will be set
  10210. std::unordered_set<std::string> param_name_set;
  10211. #endif
  10212. while (true) {
  10213. const auto marker_pos = pattern.find(
  10214. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10215. if (marker_pos == std::string::npos) { break; }
  10216. static_fragments_.push_back(
  10217. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10218. const auto param_name_start = marker_pos + str_len(marker);
  10219. auto sep_pos = pattern.find(separator, param_name_start);
  10220. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10221. auto param_name =
  10222. pattern.substr(param_name_start, sep_pos - param_name_start);
  10223. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10224. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10225. std::string msg = "Encountered path parameter '" + param_name +
  10226. "' multiple times in route pattern '" + pattern + "'.";
  10227. throw std::invalid_argument(msg);
  10228. }
  10229. #endif
  10230. param_names_.push_back(std::move(param_name));
  10231. last_param_end = sep_pos + 1;
  10232. }
  10233. if (last_param_end < pattern.length()) {
  10234. static_fragments_.push_back(pattern.substr(last_param_end));
  10235. }
  10236. }
  10237. inline bool PathParamsMatcher::match(Request &request) const {
  10238. request.matches = std::smatch();
  10239. request.path_params.clear();
  10240. // A pattern without parameters is just a literal path to compare against
  10241. if (param_names_.empty()) { return request.path == pattern(); }
  10242. request.path_params.reserve(param_names_.size());
  10243. // One past the position at which the path matched the pattern last time
  10244. std::size_t starting_pos = 0;
  10245. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10246. const auto &fragment = static_fragments_[i];
  10247. if (starting_pos + fragment.length() > request.path.length()) {
  10248. return false;
  10249. }
  10250. // Avoid unnecessary allocation by using strncmp instead of substr +
  10251. // comparison
  10252. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10253. fragment.length()) != 0) {
  10254. return false;
  10255. }
  10256. starting_pos += fragment.length();
  10257. // Should only happen when we have a static fragment after a param
  10258. // Example: '/users/:id/subscriptions'
  10259. // The 'subscriptions' fragment here does not have a corresponding param
  10260. if (i >= param_names_.size()) { continue; }
  10261. auto sep_pos = request.path.find(separator, starting_pos);
  10262. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10263. const auto &param_name = param_names_[i];
  10264. request.path_params.emplace(
  10265. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10266. // Mark everything up to '/' as matched
  10267. starting_pos = sep_pos + 1;
  10268. }
  10269. // Returns false if the path is longer than the pattern
  10270. return starting_pos >= request.path.length();
  10271. }
  10272. inline bool RegexMatcher::match(Request &request) const {
  10273. request.path_params.clear();
  10274. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10275. // a non-match rather than risking a stack overflow in std::regex_match.
  10276. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10277. return false;
  10278. }
  10279. return std::regex_match(request.path, request.matches, regex_);
  10280. }
  10281. // Enclose IPv6 address in brackets if needed
  10282. inline std::string prepare_host_string(const std::string &host) {
  10283. // Enclose IPv6 address in brackets (but not if already enclosed)
  10284. if (host.find(':') == std::string::npos ||
  10285. (!host.empty() && host[0] == '[')) {
  10286. // IPv4, hostname, or already bracketed IPv6
  10287. return host;
  10288. } else {
  10289. // IPv6 address without brackets
  10290. return "[" + host + "]";
  10291. }
  10292. }
  10293. inline std::string make_host_and_port_string(const std::string &host, int port,
  10294. bool is_ssl) {
  10295. auto result = prepare_host_string(host);
  10296. // Append port if not default
  10297. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10298. ; // do nothing
  10299. } else {
  10300. result += ":" + std::to_string(port);
  10301. }
  10302. return result;
  10303. }
  10304. // Create "host:port" string always including port number (for CONNECT method)
  10305. inline std::string
  10306. make_host_and_port_string_always_port(const std::string &host, int port) {
  10307. return prepare_host_string(host) + ":" + std::to_string(port);
  10308. }
  10309. // Value for the Host header a client sends when the caller supplied none.
  10310. // Only the value: callers decide where in their header list it goes.
  10311. inline std::string make_default_host_header_value(const std::string &host,
  10312. int port, bool is_ssl,
  10313. int address_family) {
  10314. if (address_family == AF_UNIX) { return "localhost"; }
  10315. return make_host_and_port_string(host, port, is_ssl);
  10316. }
  10317. inline void add_default_user_agent_header(Request &req) {
  10318. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10319. if (!req.has_header("User-Agent")) {
  10320. req.set_header("User-Agent",
  10321. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10322. }
  10323. #else
  10324. (void)req;
  10325. #endif
  10326. }
  10327. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10328. NormalizedTarget normalize_target(const std::string &host);
  10329. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10330. bool host_matches_no_proxy(const NormalizedTarget &target,
  10331. const std::vector<NoProxyEntry> &entries);
  10332. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10333. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10334. if (prefix_bits == 0) { return true; }
  10335. int full_bytes = prefix_bits / 8;
  10336. int rem_bits = prefix_bits % 8;
  10337. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10338. static_cast<size_t>(full_bytes)) != 0) {
  10339. return false;
  10340. }
  10341. if (rem_bits == 0) { return true; }
  10342. auto i = static_cast<size_t>(full_bytes);
  10343. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10344. return (ip[i] & mask) == (net[i] & mask);
  10345. }
  10346. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10347. if (token.empty()) { return false; }
  10348. if (token == "*") {
  10349. out.kind = NoProxyKind::Wildcard;
  10350. return true;
  10351. }
  10352. auto slash = token.find('/');
  10353. std::string addr_part =
  10354. (slash == std::string::npos) ? token : token.substr(0, slash);
  10355. std::string prefix_part =
  10356. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10357. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10358. // don't silently treat it as a /32 (or /128).
  10359. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10360. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10361. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10362. // when brackets are present.
  10363. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10364. addr_part.back() == ']';
  10365. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10366. if (!bracketed) {
  10367. struct in_addr v4;
  10368. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10369. int prefix = 32;
  10370. if (!prefix_part.empty()) {
  10371. auto r = from_chars(prefix_part.data(),
  10372. prefix_part.data() + prefix_part.size(), prefix);
  10373. if (r.ec != std::errc{} ||
  10374. r.ptr != prefix_part.data() + prefix_part.size()) {
  10375. return false;
  10376. }
  10377. if (prefix < 0 || prefix > 32) { return false; }
  10378. }
  10379. out.kind = NoProxyKind::IPv4Cidr;
  10380. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10381. out.prefix_bits = prefix;
  10382. return true;
  10383. }
  10384. }
  10385. struct in6_addr v6;
  10386. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10387. int prefix = 128;
  10388. if (!prefix_part.empty()) {
  10389. auto r = from_chars(prefix_part.data(),
  10390. prefix_part.data() + prefix_part.size(), prefix);
  10391. if (r.ec != std::errc{} ||
  10392. r.ptr != prefix_part.data() + prefix_part.size()) {
  10393. return false;
  10394. }
  10395. if (prefix < 0 || prefix > 128) { return false; }
  10396. }
  10397. out.kind = NoProxyKind::IPv6Cidr;
  10398. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10399. out.prefix_bits = prefix;
  10400. return true;
  10401. }
  10402. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10403. // the entry is malformed — don't fall through to the hostname branch.
  10404. if (bracketed) { return false; }
  10405. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10406. if (slash != std::string::npos) { return false; }
  10407. // Port-specific entries (host:port) are not supported.
  10408. if (token.find(':') != std::string::npos) { return false; }
  10409. std::string hostname = case_ignore::to_lower(token);
  10410. while (!hostname.empty() && hostname.front() == '.') {
  10411. hostname.erase(hostname.begin());
  10412. }
  10413. while (!hostname.empty() && hostname.back() == '.') {
  10414. hostname.pop_back();
  10415. }
  10416. if (hostname.empty()) { return false; }
  10417. out.kind = NoProxyKind::HostnameSuffix;
  10418. out.hostname_pattern = std::move(hostname);
  10419. return true;
  10420. }
  10421. inline NormalizedTarget normalize_target(const std::string &host) {
  10422. NormalizedTarget t;
  10423. std::string h = host;
  10424. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10425. h = h.substr(1, h.size() - 2);
  10426. }
  10427. // Strip a single trailing dot so "example.com." canonicalizes to
  10428. // "example.com".
  10429. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10430. t.hostname = case_ignore::to_lower(h);
  10431. if (!t.hostname.empty()) {
  10432. struct in_addr v4;
  10433. struct in6_addr v6;
  10434. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10435. t.is_ipv4 = true;
  10436. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10437. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10438. t.is_ipv6 = true;
  10439. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10440. }
  10441. }
  10442. return t;
  10443. }
  10444. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10445. const std::vector<NoProxyEntry> &entries) {
  10446. if (target.hostname.empty()) { return false; }
  10447. for (const auto &e : entries) {
  10448. switch (e.kind) {
  10449. case NoProxyKind::Wildcard: return true;
  10450. case NoProxyKind::IPv4Cidr:
  10451. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10452. return true;
  10453. }
  10454. break;
  10455. case NoProxyKind::IPv6Cidr:
  10456. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10457. return true;
  10458. }
  10459. break;
  10460. case NoProxyKind::HostnameSuffix:
  10461. if (target.is_ipv4 || target.is_ipv6) { break; }
  10462. if (target.hostname == e.hostname_pattern) { return true; }
  10463. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10464. // an entry of "example.com".
  10465. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10466. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10467. if (target.hostname[offset - 1] == '.' &&
  10468. target.hostname.compare(offset, e.hostname_pattern.size(),
  10469. e.hostname_pattern) == 0) {
  10470. return true;
  10471. }
  10472. }
  10473. break;
  10474. }
  10475. }
  10476. return false;
  10477. }
  10478. template <typename T>
  10479. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10480. T header_writer, Error &error) {
  10481. for (const auto &h : headers) {
  10482. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10483. error = Error::InvalidHeaders;
  10484. return false;
  10485. }
  10486. }
  10487. if (header_writer(strm, headers) <= 0) {
  10488. error = Error::Write;
  10489. return false;
  10490. }
  10491. return true;
  10492. }
  10493. } // namespace detail
  10494. /*
  10495. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10496. */
  10497. #ifdef CPPHTTPLIB_SSL_ENABLED
  10498. namespace detail {
  10499. // SSL socket stream implementation
  10500. inline SSLSocketStream::SSLSocketStream(
  10501. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10502. time_t read_timeout_usec, time_t write_timeout_sec,
  10503. time_t write_timeout_usec, time_t max_timeout_msec,
  10504. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10505. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10506. read_timeout_usec_(read_timeout_usec),
  10507. write_timeout_sec_(write_timeout_sec),
  10508. write_timeout_usec_(write_timeout_usec),
  10509. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10510. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10511. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10512. // Note: create_session() also clears this, but SSLClient currently
  10513. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10514. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10515. // SSL session was created.
  10516. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10517. #endif
  10518. }
  10519. inline SSLSocketStream::~SSLSocketStream() = default;
  10520. inline bool SSLSocketStream::is_readable() const {
  10521. return tls::pending(session_) > 0;
  10522. }
  10523. inline bool SSLSocketStream::wait_readable() const {
  10524. if (max_timeout_msec_ <= 0) {
  10525. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10526. }
  10527. time_t read_timeout_sec;
  10528. time_t read_timeout_usec;
  10529. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10530. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10531. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10532. }
  10533. inline bool SSLSocketStream::wait_writable() const {
  10534. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10535. !tls::is_peer_closed(session_, sock_);
  10536. }
  10537. inline bool SSLSocketStream::ensure_readable() {
  10538. if (readable_hint_) {
  10539. readable_hint_ = false;
  10540. return true;
  10541. }
  10542. return wait_readable();
  10543. }
  10544. inline bool SSLSocketStream::is_peer_alive() const {
  10545. return !tls::is_peer_closed(session_, sock_);
  10546. }
  10547. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10548. if (tls::pending(session_) > 0) {
  10549. tls::TlsError err;
  10550. auto ret = tls::read(session_, ptr, size, err);
  10551. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10552. error_ = Error::ConnectionClosed;
  10553. }
  10554. return ret;
  10555. } else if (ensure_readable()) {
  10556. tls::TlsError err;
  10557. auto ret = tls::read(session_, ptr, size, err);
  10558. if (ret < 0) {
  10559. auto n = 1000;
  10560. #ifdef _WIN32
  10561. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10562. (err.code == tls::ErrorCode::SyscallError &&
  10563. WSAGetLastError() == WSAETIMEDOUT))) {
  10564. #else
  10565. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10566. #endif
  10567. if (tls::pending(session_) > 0) {
  10568. return tls::read(session_, ptr, size, err);
  10569. } else if (wait_readable()) {
  10570. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10571. ret = tls::read(session_, ptr, size, err);
  10572. if (ret >= 0) { return ret; }
  10573. } else {
  10574. break;
  10575. }
  10576. }
  10577. assert(ret < 0);
  10578. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10579. error_ = Error::ConnectionClosed;
  10580. }
  10581. return ret;
  10582. } else {
  10583. error_ = Error::Timeout;
  10584. return -1;
  10585. }
  10586. }
  10587. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10588. if (wait_writable()) {
  10589. auto handle_size =
  10590. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10591. tls::TlsError err;
  10592. auto ret = tls::write(session_, ptr, handle_size, err);
  10593. if (ret < 0) {
  10594. auto n = 1000;
  10595. #ifdef _WIN32
  10596. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10597. (err.code == tls::ErrorCode::SyscallError &&
  10598. WSAGetLastError() == WSAETIMEDOUT))) {
  10599. #else
  10600. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10601. #endif
  10602. if (wait_writable()) {
  10603. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10604. ret = tls::write(session_, ptr, handle_size, err);
  10605. if (ret >= 0) { return ret; }
  10606. } else {
  10607. break;
  10608. }
  10609. }
  10610. assert(ret < 0);
  10611. }
  10612. return ret;
  10613. }
  10614. return -1;
  10615. }
  10616. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10617. int &port) const {
  10618. detail::get_remote_ip_and_port(sock_, ip, port);
  10619. }
  10620. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10621. int &port) const {
  10622. detail::get_local_ip_and_port(sock_, ip, port);
  10623. }
  10624. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10625. inline time_t SSLSocketStream::duration() const {
  10626. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10627. std::chrono::steady_clock::now() - start_time_)
  10628. .count();
  10629. }
  10630. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10631. read_timeout_sec_ = sec;
  10632. read_timeout_usec_ = usec;
  10633. }
  10634. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10635. tls::session_t session,
  10636. time_t read_timeout_sec,
  10637. time_t read_timeout_usec,
  10638. time_t write_timeout_sec,
  10639. time_t write_timeout_usec)
  10640. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10641. read_timeout_usec_(read_timeout_usec),
  10642. write_timeout_sec_(write_timeout_sec),
  10643. write_timeout_usec_(write_timeout_usec),
  10644. start_time_(std::chrono::steady_clock::now()) {
  10645. // The receive and send paths run on different threads, so each TLS call is
  10646. // driven in non-blocking mode and readiness is awaited with select()
  10647. // outside the session lock. Set the socket non-blocking once here; it is
  10648. // never flipped back, so no thread races on the flag.
  10649. detail::set_nonblocking(sock_, true);
  10650. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10651. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10652. #endif
  10653. }
  10654. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10655. inline bool WebSocketSSLStream::is_readable() const {
  10656. std::lock_guard<std::mutex> guard(session_mutex_);
  10657. return tls::pending(session_) > 0;
  10658. }
  10659. inline bool WebSocketSSLStream::wait_readable() const {
  10660. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10661. }
  10662. inline bool WebSocketSSLStream::wait_writable() const {
  10663. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10664. // that probe toggles the socket's blocking flag, which would race with the
  10665. // concurrent reader on a permanently non-blocking socket.
  10666. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10667. }
  10668. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10669. tls::TlsError err;
  10670. auto n = 1000;
  10671. while (--n >= 0) {
  10672. {
  10673. std::lock_guard<std::mutex> guard(session_mutex_);
  10674. auto ret = tls::read(session_, ptr, size, err);
  10675. if (ret > 0) { return ret; }
  10676. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10677. error_ = Error::ConnectionClosed;
  10678. return ret;
  10679. }
  10680. }
  10681. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10682. // direction: the send path shares this session, so output it left pending
  10683. // has to be flushed before more input can be decrypted. Anything else is
  10684. // a hard error.
  10685. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10686. #ifdef _WIN32
  10687. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10688. needs_readable =
  10689. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10690. WSAGetLastError() == WSAETIMEDOUT);
  10691. #endif
  10692. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10693. error_ = Error::Read;
  10694. return -1;
  10695. }
  10696. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10697. error_ = Error::Timeout;
  10698. return -1;
  10699. }
  10700. }
  10701. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10702. // to tell a timeout from a close would otherwise see whatever the previous
  10703. // failure left behind (error_ is never cleared on success).
  10704. error_ = Error::Read;
  10705. return -1;
  10706. }
  10707. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10708. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10709. tls::TlsError err;
  10710. auto n = 1000;
  10711. while (--n >= 0) {
  10712. {
  10713. std::lock_guard<std::mutex> guard(session_mutex_);
  10714. auto ret = tls::write(session_, ptr, handle_size, err);
  10715. if (ret >= 0) { return ret; }
  10716. }
  10717. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10718. // or a post-handshake message must be consumed before the record goes
  10719. // out. Anything else is a hard error.
  10720. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10721. #ifdef _WIN32
  10722. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10723. needs_writable =
  10724. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10725. WSAGetLastError() == WSAETIMEDOUT);
  10726. #endif
  10727. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10728. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10729. }
  10730. return -1;
  10731. }
  10732. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10733. int &port) const {
  10734. detail::get_remote_ip_and_port(sock_, ip, port);
  10735. }
  10736. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10737. int &port) const {
  10738. detail::get_local_ip_and_port(sock_, ip, port);
  10739. }
  10740. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10741. inline time_t WebSocketSSLStream::duration() const {
  10742. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10743. std::chrono::steady_clock::now() - start_time_)
  10744. .count();
  10745. }
  10746. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10747. read_timeout_sec_ = sec;
  10748. read_timeout_usec_ = usec;
  10749. }
  10750. } // namespace detail
  10751. #endif // CPPHTTPLIB_SSL_ENABLED
  10752. /*
  10753. * Group 4: Server implementation
  10754. */
  10755. // HTTP server implementation
  10756. inline Server::Server()
  10757. : new_task_queue([] {
  10758. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10759. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10760. }) {
  10761. #ifndef _WIN32
  10762. signal(SIGPIPE, SIG_IGN);
  10763. #endif
  10764. }
  10765. inline Server::~Server() = default;
  10766. inline std::unique_ptr<detail::MatcherBase>
  10767. Server::make_matcher(const std::string &pattern) {
  10768. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10769. // a path params pattern
  10770. if (pattern.find("/:") != std::string::npos) {
  10771. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10772. }
  10773. // A pattern with no regex metacharacter only has to be compared literally,
  10774. // which is what PathParamsMatcher already does when it captures no
  10775. // parameter, so std::regex is only worth building for the patterns that
  10776. // actually need it
  10777. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10778. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10779. }
  10780. return detail::make_unique<detail::RegexMatcher>(pattern);
  10781. }
  10782. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10783. return add_handler(get_handlers_, pattern, std::move(handler));
  10784. }
  10785. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10786. return add_handler(post_handlers_, pattern, std::move(handler));
  10787. }
  10788. inline Server &Server::Post(const std::string &pattern,
  10789. HandlerWithContentReader handler) {
  10790. return add_handler(post_handlers_for_content_reader_, pattern,
  10791. std::move(handler));
  10792. }
  10793. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10794. return add_handler(put_handlers_, pattern, std::move(handler));
  10795. }
  10796. inline Server &Server::Put(const std::string &pattern,
  10797. HandlerWithContentReader handler) {
  10798. return add_handler(put_handlers_for_content_reader_, pattern,
  10799. std::move(handler));
  10800. }
  10801. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10802. return add_handler(patch_handlers_, pattern, std::move(handler));
  10803. }
  10804. inline Server &Server::Patch(const std::string &pattern,
  10805. HandlerWithContentReader handler) {
  10806. return add_handler(patch_handlers_for_content_reader_, pattern,
  10807. std::move(handler));
  10808. }
  10809. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10810. return add_handler(delete_handlers_, pattern, std::move(handler));
  10811. }
  10812. inline Server &Server::Delete(const std::string &pattern,
  10813. HandlerWithContentReader handler) {
  10814. return add_handler(delete_handlers_for_content_reader_, pattern,
  10815. std::move(handler));
  10816. }
  10817. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10818. return add_handler(options_handlers_, pattern, std::move(handler));
  10819. }
  10820. inline const std::set<std::string> &Server::builtin_methods() {
  10821. thread_local const std::set<std::string> methods{
  10822. "GET", "HEAD", "POST", "PUT", "DELETE",
  10823. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10824. return methods;
  10825. }
  10826. inline Server::CustomHandlerEntry *
  10827. Server::custom_entry_for_registration(const std::string &method) {
  10828. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10829. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10830. // routing() before the custom tables are consulted, so a route registered
  10831. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10832. // there and would be reachable, but they carry protocol-level meaning
  10833. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10834. // library does not route.
  10835. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10836. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10837. has_invalid_registration_ = true;
  10838. return nullptr;
  10839. }
  10840. return &custom_handlers_[method];
  10841. }
  10842. inline Server &Server::CustomRoute(const std::string &method,
  10843. const std::string &pattern,
  10844. Handler handler) {
  10845. auto *entry = custom_entry_for_registration(method);
  10846. if (!entry) { return *this; }
  10847. return add_handler(entry->handlers, pattern, std::move(handler));
  10848. }
  10849. inline Server &Server::CustomRoute(const std::string &method,
  10850. const std::string &pattern,
  10851. HandlerWithContentReader handler) {
  10852. auto *entry = custom_entry_for_registration(method);
  10853. if (!entry) { return *this; }
  10854. return add_handler(entry->handlers_for_content_reader, pattern,
  10855. std::move(handler));
  10856. }
  10857. inline const Server::CustomHandlerEntry *
  10858. Server::find_custom_entry(const std::string &method) const {
  10859. // find() alone would be correct here. The empty() check is what keeps the
  10860. // per-request cost off servers that never call CustomRoute(), which is the
  10861. // overwhelmingly common case; keep it rather than walking into the tree.
  10862. if (custom_handlers_.empty()) { return nullptr; }
  10863. auto it = custom_handlers_.find(method);
  10864. return it == custom_handlers_.end() ? nullptr : &it->second;
  10865. }
  10866. inline Server &Server::WebSocket(const std::string &pattern,
  10867. WebSocketHandler handler) {
  10868. websocket_handlers_.push_back(
  10869. {make_matcher(pattern), std::move(handler), nullptr});
  10870. return *this;
  10871. }
  10872. inline Server &Server::WebSocket(const std::string &pattern,
  10873. WebSocketHandler handler,
  10874. SubProtocolSelector sub_protocol_selector) {
  10875. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10876. std::move(sub_protocol_selector)});
  10877. return *this;
  10878. }
  10879. inline bool Server::set_base_dir(const std::string &dir,
  10880. const std::string &mount_point) {
  10881. return set_mount_point(mount_point, dir);
  10882. }
  10883. inline bool Server::set_mount_point(const std::string &mount_point,
  10884. const std::string &dir, Headers headers) {
  10885. detail::FileStat stat(dir);
  10886. if (stat.is_dir()) {
  10887. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10888. if (!mnt.empty() && mnt[0] == '/') {
  10889. std::string resolved_base;
  10890. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10891. #if defined(_WIN32)
  10892. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10893. resolved_base += '\\';
  10894. }
  10895. #else
  10896. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10897. #endif
  10898. }
  10899. base_dirs_.push_back(
  10900. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10901. return true;
  10902. }
  10903. }
  10904. return false;
  10905. }
  10906. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10907. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10908. if (it->mount_point == mount_point) {
  10909. base_dirs_.erase(it);
  10910. return true;
  10911. }
  10912. }
  10913. return false;
  10914. }
  10915. inline Server &
  10916. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10917. const std::string &mime) {
  10918. file_extension_and_mimetype_map_[ext] = mime;
  10919. return *this;
  10920. }
  10921. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  10922. default_file_mimetype_ = mime;
  10923. return *this;
  10924. }
  10925. inline Server &Server::set_file_request_handler(Handler handler) {
  10926. file_request_handler_ = std::move(handler);
  10927. return *this;
  10928. }
  10929. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  10930. std::true_type) {
  10931. error_handler_ = std::move(handler);
  10932. return *this;
  10933. }
  10934. inline Server &Server::set_error_handler_core(Handler handler,
  10935. std::false_type) {
  10936. error_handler_ = [handler](const Request &req, Response &res) {
  10937. handler(req, res);
  10938. return HandlerResponse::Handled;
  10939. };
  10940. return *this;
  10941. }
  10942. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  10943. exception_handler_ = std::move(handler);
  10944. return *this;
  10945. }
  10946. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  10947. pre_routing_handler_ = std::move(handler);
  10948. return *this;
  10949. }
  10950. inline Server &Server::set_post_routing_handler(Handler handler) {
  10951. post_routing_handler_ = std::move(handler);
  10952. return *this;
  10953. }
  10954. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  10955. pre_request_handler_ = std::move(handler);
  10956. return *this;
  10957. }
  10958. inline Server &Server::set_logger(Logger logger) {
  10959. logger_ = std::move(logger);
  10960. return *this;
  10961. }
  10962. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  10963. error_logger_ = std::move(error_logger);
  10964. return *this;
  10965. }
  10966. inline Server &Server::set_pre_compression_logger(Logger logger) {
  10967. pre_compression_logger_ = std::move(logger);
  10968. return *this;
  10969. }
  10970. inline Server &
  10971. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  10972. expect_100_continue_handler_ = std::move(handler);
  10973. return *this;
  10974. }
  10975. inline Server &Server::set_start_handler(StartHandler handler) {
  10976. start_handler_ = std::move(handler);
  10977. return *this;
  10978. }
  10979. inline Server &Server::set_address_family(int family) {
  10980. address_family_ = family;
  10981. return *this;
  10982. }
  10983. inline Server &Server::set_tcp_nodelay(bool on) {
  10984. tcp_nodelay_ = on;
  10985. return *this;
  10986. }
  10987. inline Server &Server::set_ipv6_v6only(bool on) {
  10988. ipv6_v6only_ = on;
  10989. return *this;
  10990. }
  10991. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  10992. socket_options_ = std::move(socket_options);
  10993. return *this;
  10994. }
  10995. inline Server &Server::set_default_headers(Headers headers) {
  10996. default_headers_ = std::move(headers);
  10997. return *this;
  10998. }
  10999. inline Server &Server::set_header_writer(
  11000. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11001. header_writer_ = writer;
  11002. return *this;
  11003. }
  11004. inline Server &
  11005. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11006. trusted_proxies_ = proxies;
  11007. return *this;
  11008. }
  11009. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11010. keep_alive_max_count_ = count;
  11011. return *this;
  11012. }
  11013. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11014. keep_alive_timeout_sec_ = sec;
  11015. return *this;
  11016. }
  11017. template <class Rep, class Period>
  11018. inline Server &Server::set_keep_alive_timeout(
  11019. const std::chrono::duration<Rep, Period> &duration) {
  11020. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11021. set_keep_alive_timeout(sec);
  11022. });
  11023. return *this;
  11024. }
  11025. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11026. read_timeout_sec_ = sec;
  11027. read_timeout_usec_ = usec;
  11028. return *this;
  11029. }
  11030. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11031. write_timeout_sec_ = sec;
  11032. write_timeout_usec_ = usec;
  11033. return *this;
  11034. }
  11035. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11036. idle_interval_sec_ = sec;
  11037. idle_interval_usec_ = usec;
  11038. return *this;
  11039. }
  11040. inline Server &Server::set_payload_max_length(size_t length) {
  11041. payload_max_length_ = length;
  11042. return *this;
  11043. }
  11044. inline Server &Server::set_static_file_compression(bool on) {
  11045. static_file_compression_ = on;
  11046. return *this;
  11047. }
  11048. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11049. static_file_compression_min_length_ = length;
  11050. return *this;
  11051. }
  11052. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11053. static_file_compression_max_length_ = length;
  11054. return *this;
  11055. }
  11056. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11057. websocket_max_missed_pongs_ = count;
  11058. return *this;
  11059. }
  11060. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11061. websocket_ping_interval_sec_ = sec;
  11062. return *this;
  11063. }
  11064. template <class Rep, class Period>
  11065. inline Server &Server::set_websocket_ping_interval(
  11066. const std::chrono::duration<Rep, Period> &duration) {
  11067. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11068. set_websocket_ping_interval(sec);
  11069. });
  11070. return *this;
  11071. }
  11072. inline bool Server::bind_to_port(const std::string &host, int port,
  11073. int socket_flags) {
  11074. auto ret = bind_internal(host, port, socket_flags);
  11075. if (ret == -1) { is_decommissioned = true; }
  11076. return ret >= 0;
  11077. }
  11078. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11079. auto ret = bind_internal(host, 0, socket_flags);
  11080. if (ret == -1) { is_decommissioned = true; }
  11081. return ret;
  11082. }
  11083. inline bool Server::listen_after_bind() { return listen_internal(); }
  11084. inline bool Server::listen(const std::string &host, int port,
  11085. int socket_flags) {
  11086. return bind_to_port(host, port, socket_flags) && listen_internal();
  11087. }
  11088. inline bool Server::is_running() const { return is_running_; }
  11089. inline void Server::wait_until_ready() const {
  11090. while (!is_running_ && !is_decommissioned) {
  11091. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11092. }
  11093. }
  11094. inline void Server::stop() noexcept {
  11095. // Release the listening socket whether or not the accept loop is running:
  11096. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11097. // exchange is what makes this safe to call concurrently with the accept loop.
  11098. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11099. if (sock != INVALID_SOCKET) {
  11100. detail::shutdown_socket(sock);
  11101. detail::close_socket(sock);
  11102. }
  11103. is_decommissioned = false;
  11104. }
  11105. inline void Server::decommission() { is_decommissioned = true; }
  11106. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11107. auto len = strlen(s);
  11108. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11109. len -= 2;
  11110. {
  11111. size_t count = 0;
  11112. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11113. switch (count) {
  11114. case 0: req.method = std::string(b, e); break;
  11115. case 1: req.target = std::string(b, e); break;
  11116. case 2: req.version = std::string(b, e); break;
  11117. default: break;
  11118. }
  11119. count++;
  11120. });
  11121. if (count != 3) { return false; }
  11122. }
  11123. // A method outside the built-in set is accepted only when a handler has been
  11124. // registered for it with CustomRoute().
  11125. const auto &methods = builtin_methods();
  11126. if (methods.find(req.method) == methods.end() &&
  11127. !find_custom_entry(req.method)) {
  11128. output_error_log(Error::InvalidHTTPMethod, &req);
  11129. return false;
  11130. }
  11131. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11132. output_error_log(Error::InvalidHTTPVersion, &req);
  11133. return false;
  11134. }
  11135. {
  11136. // Skip URL fragment
  11137. for (size_t i = 0; i < req.target.size(); i++) {
  11138. if (req.target[i] == '#') {
  11139. req.target.erase(i);
  11140. break;
  11141. }
  11142. }
  11143. detail::divide(req.target, '?',
  11144. [&](const char *lhs_data, std::size_t lhs_size,
  11145. const char *rhs_data, std::size_t rhs_size) {
  11146. req.path =
  11147. decode_path_component(std::string(lhs_data, lhs_size));
  11148. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11149. });
  11150. }
  11151. return true;
  11152. }
  11153. inline bool Server::write_response(Stream &strm, bool close_connection,
  11154. Request &req, Response &res) {
  11155. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11156. // incorrectly to the error content.
  11157. req.ranges.clear();
  11158. return write_response_core(strm, close_connection, req, res, false);
  11159. }
  11160. inline bool Server::write_response_with_content(Stream &strm,
  11161. bool close_connection,
  11162. const Request &req,
  11163. Response &res) {
  11164. return write_response_core(strm, close_connection, req, res, true);
  11165. }
  11166. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11167. const Request &req, Response &res,
  11168. bool need_apply_ranges) {
  11169. assert(res.status != -1);
  11170. if (400 <= res.status && error_handler_ &&
  11171. error_handler_(req, res) == HandlerResponse::Handled) {
  11172. need_apply_ranges = true;
  11173. }
  11174. std::string content_type;
  11175. std::string boundary;
  11176. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11177. // Prepare additional headers
  11178. if (close_connection ||
  11179. detail::has_header_token(req.headers, "Connection", "close") ||
  11180. 400 <= res.status) { // Don't leave connections open after errors
  11181. res.set_header("Connection", "close");
  11182. } else {
  11183. std::string s = "timeout=";
  11184. s += std::to_string(keep_alive_timeout_sec_);
  11185. s += ", max=";
  11186. s += std::to_string(keep_alive_max_count_);
  11187. res.set_header("Keep-Alive", s);
  11188. }
  11189. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11190. !res.has_header("Content-Type")) {
  11191. res.set_header("Content-Type", "text/plain");
  11192. }
  11193. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11194. !res.has_header("Content-Length")) {
  11195. res.set_header("Content-Length", "0");
  11196. }
  11197. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11198. res.set_header("Accept-Ranges", "bytes");
  11199. }
  11200. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11201. // Response line and headers
  11202. detail::BufferStream bstrm;
  11203. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11204. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11205. // Combine small body with headers to reduce write syscalls
  11206. if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
  11207. bstrm.write(res.body.data(), res.body.size());
  11208. }
  11209. // Log before writing to avoid race condition with client-side code that
  11210. // accesses logger-captured data immediately after receiving the response.
  11211. output_log(req, res);
  11212. // Flush buffer
  11213. auto &data = bstrm.get_buffer();
  11214. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11215. // Streaming body
  11216. auto ret = true;
  11217. if (req.method != "HEAD" && res.content_provider_) {
  11218. if (write_content_with_provider(strm, req, res, boundary, content_type)) {
  11219. res.content_provider_success_ = true;
  11220. } else {
  11221. ret = false;
  11222. }
  11223. }
  11224. return ret;
  11225. }
  11226. inline bool
  11227. Server::write_content_with_provider(Stream &strm, const Request &req,
  11228. Response &res, const std::string &boundary,
  11229. const std::string &content_type) {
  11230. auto is_shutting_down = [this]() {
  11231. return this->svr_sock_ == INVALID_SOCKET;
  11232. };
  11233. if (res.content_length_ > 0) {
  11234. // Only a 206 response is served as a partial representation, matching the
  11235. // condition `apply_ranges()` used to decide the Content-Length and the
  11236. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11237. // only for a 2xx status, slicing under any other status would write a body
  11238. // that disagrees with the header already sent, from an unchecked offset.
  11239. auto is_partial =
  11240. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11241. if (!is_partial) {
  11242. return detail::write_content(strm, res.content_provider_, 0,
  11243. res.content_length_, is_shutting_down);
  11244. } else if (req.ranges.size() == 1) {
  11245. auto offset_and_length = detail::get_range_offset_and_length(
  11246. req.ranges[0], res.content_length_);
  11247. return detail::write_content(strm, res.content_provider_,
  11248. offset_and_length.first,
  11249. offset_and_length.second, is_shutting_down);
  11250. } else {
  11251. return detail::write_multipart_ranges_data(
  11252. strm, req, res, boundary, content_type, res.content_length_,
  11253. is_shutting_down);
  11254. }
  11255. } else {
  11256. if (res.is_chunked_content_provider_) {
  11257. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11258. // re-negotiating here would disagree with them, e.g. once a handler's
  11259. // own Content-Encoding header suppresses the negotiation.
  11260. auto compressor = detail::make_compressor(res.content_coding_);
  11261. if (!compressor) {
  11262. compressor = detail::make_unique<detail::nocompressor>();
  11263. }
  11264. return detail::write_content_chunked(strm, res.content_provider_,
  11265. is_shutting_down, *compressor);
  11266. } else {
  11267. return detail::write_content_without_length(strm, res.content_provider_,
  11268. is_shutting_down);
  11269. }
  11270. }
  11271. }
  11272. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11273. FormFields::iterator cur_field;
  11274. FormFiles::iterator cur_file;
  11275. auto is_text_field = false;
  11276. size_t count = 0;
  11277. if (read_content_core(
  11278. strm, req, res,
  11279. // Regular
  11280. [&](const char *buf, size_t n) {
  11281. // Prevent arithmetic overflow when checking sizes.
  11282. // Avoid computing (req.body.size() + n) directly because
  11283. // adding two unsigned `size_t` values can wrap around and
  11284. // produce a small result instead of indicating overflow.
  11285. // Instead, check using subtraction: ensure `n` does not
  11286. // exceed the remaining capacity `max_size() - size()`.
  11287. if (req.body.size() >= req.body.max_size() ||
  11288. n > req.body.max_size() - req.body.size()) {
  11289. return false;
  11290. }
  11291. // Limit decompressed body size to payload_max_length_ to protect
  11292. // against "zip bomb" attacks where a small compressed payload
  11293. // decompresses to a massive size.
  11294. if (payload_max_length_ > 0 &&
  11295. (req.body.size() >= payload_max_length_ ||
  11296. n > payload_max_length_ - req.body.size())) {
  11297. return false;
  11298. }
  11299. req.body.append(buf, n);
  11300. return true;
  11301. },
  11302. // Multipart FormData
  11303. [&](const FormData &file) {
  11304. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11305. output_error_log(Error::TooManyFormDataFiles, &req);
  11306. return false;
  11307. }
  11308. if (file.filename.empty()) {
  11309. cur_field = req.form.fields.emplace(
  11310. file.name, FormField{file.name, file.content, file.headers});
  11311. is_text_field = true;
  11312. } else {
  11313. cur_file = req.form.files.emplace(file.name, file);
  11314. is_text_field = false;
  11315. }
  11316. return true;
  11317. },
  11318. [&](const char *buf, size_t n) {
  11319. if (is_text_field) {
  11320. auto &content = cur_field->second.content;
  11321. if (content.size() + n > content.max_size()) { return false; }
  11322. content.append(buf, n);
  11323. } else {
  11324. auto &content = cur_file->second.content;
  11325. if (content.size() + n > content.max_size()) { return false; }
  11326. content.append(buf, n);
  11327. }
  11328. return true;
  11329. })) {
  11330. const auto &content_type = req.get_header_value("Content-Type");
  11331. if (detail::extract_media_type(content_type) ==
  11332. "application/x-www-form-urlencoded") {
  11333. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11334. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11335. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11336. return false;
  11337. }
  11338. detail::parse_query_text(req.body, req.params);
  11339. }
  11340. return true;
  11341. }
  11342. return false;
  11343. }
  11344. inline bool Server::read_content_with_content_receiver(
  11345. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11346. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11347. return read_content_core(strm, req, res, std::move(receiver),
  11348. std::move(multipart_header),
  11349. std::move(multipart_receiver));
  11350. }
  11351. inline bool Server::read_content_core(
  11352. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11353. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11354. detail::FormDataParser multipart_form_data_parser;
  11355. ContentReceiverWithProgress out;
  11356. if (req.is_multipart_form_data()) {
  11357. const auto &content_type = req.get_header_value("Content-Type");
  11358. std::string boundary;
  11359. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11360. res.status = StatusCode::BadRequest_400;
  11361. output_error_log(Error::MultipartParsing, &req);
  11362. return false;
  11363. }
  11364. multipart_form_data_parser.set_boundary(std::move(boundary));
  11365. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11366. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11367. multipart_receiver);
  11368. };
  11369. } else {
  11370. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11371. size_t /*len*/) { return receiver(buf, n); };
  11372. }
  11373. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11374. // For non-SSL builds we still scan non-persistent connections for stray
  11375. // body bytes so the payload limit is enforced (413). On keep-alive,
  11376. // pending bytes may be the next request (issue #2450), so skip.
  11377. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11378. if (!req.has_header("Content-Length") &&
  11379. !detail::is_chunked_transfer_encoding(req.headers)) {
  11380. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11381. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11382. auto has_data = strm.is_readable();
  11383. if (!has_data) {
  11384. auto s = strm.socket();
  11385. if (s != INVALID_SOCKET) {
  11386. has_data = detail::select_read(s, 0, 0) > 0;
  11387. }
  11388. }
  11389. if (has_data) {
  11390. // Route through the same decompressing reader used by the
  11391. // length-framed and chunked paths below, so payload_max_length_ is
  11392. // enforced on the decompressed size here too instead of only on the
  11393. // compressed wire bytes.
  11394. return detail::read_content(strm, req, payload_max_length_, res.status,
  11395. nullptr, out, true);
  11396. }
  11397. }
  11398. return true;
  11399. }
  11400. #else
  11401. if (!req.has_header("Content-Length") &&
  11402. !detail::is_chunked_transfer_encoding(req.headers)) {
  11403. return true;
  11404. }
  11405. #endif
  11406. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11407. out, true)) {
  11408. return false;
  11409. }
  11410. req.body_consumed_ = true;
  11411. if (req.is_multipart_form_data()) {
  11412. if (!multipart_form_data_parser.is_valid()) {
  11413. res.status = StatusCode::BadRequest_400;
  11414. output_error_log(Error::MultipartParsing, &req);
  11415. return false;
  11416. }
  11417. }
  11418. return true;
  11419. }
  11420. inline bool Server::handle_file_request(Request &req, Response &res) {
  11421. for (const auto &entry : base_dirs_) {
  11422. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11423. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11424. // One that already ends in '/' (the root mount among them) carries its own
  11425. // boundary; set_mount_point() guarantees the mount point is not empty.
  11426. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11427. (entry.mount_point.back() == '/' ||
  11428. req.path.size() == entry.mount_point.size() ||
  11429. req.path[entry.mount_point.size()] == '/')) {
  11430. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11431. if (detail::is_valid_path(sub_path)) {
  11432. auto path = entry.base_dir + sub_path;
  11433. if (path.back() == '/') { path += "index.html"; }
  11434. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11435. // but symlinks/junctions can still escape the base directory.
  11436. if (!entry.resolved_base_dir.empty()) {
  11437. std::string resolved_path;
  11438. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11439. !detail::is_path_within_base(resolved_path,
  11440. entry.resolved_base_dir)) {
  11441. res.status = StatusCode::Forbidden_403;
  11442. return true;
  11443. }
  11444. }
  11445. detail::FileStat stat(path);
  11446. if (stat.is_dir()) {
  11447. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11448. return true;
  11449. }
  11450. if (stat.is_file()) {
  11451. for (const auto &kv : entry.headers) {
  11452. res.set_header(kv.first, kv.second);
  11453. }
  11454. auto content_type_of = [&]() {
  11455. return detail::find_content_type(
  11456. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11457. };
  11458. // Only the ETag needs the content type this early, and only to name
  11459. // the coding. Deciding it here would otherwise put a regex in front
  11460. // of the 304 below, which serving a file never used to pay for.
  11461. std::string content_type;
  11462. auto encoding = detail::EncodingType::None;
  11463. if (static_file_compression_) {
  11464. content_type = content_type_of();
  11465. encoding =
  11466. static_file_encoding(req, res, content_type, stat.size());
  11467. }
  11468. // The ETag names the representation actually sent, so a client that
  11469. // cached the compressed form revalidates against the compressed ETag
  11470. // and still gets a 304, while one that took identity keeps the plain
  11471. // ETag.
  11472. auto etag = detail::compute_etag(
  11473. stat, encoding == detail::EncodingType::None
  11474. ? std::string()
  11475. : std::string("-") + detail::encoding_name(encoding));
  11476. if (!etag.empty()) { res.set_header("ETag", etag); }
  11477. auto mtime = stat.mtime();
  11478. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11479. if (!last_modified.empty()) {
  11480. res.set_header("Last-Modified", last_modified);
  11481. }
  11482. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11483. check_if_range(req, etag, mtime);
  11484. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11485. if (!mm->is_open()) {
  11486. output_error_log(Error::OpenFile, &req);
  11487. return false;
  11488. }
  11489. if (!static_file_compression_) { content_type = content_type_of(); }
  11490. detail::set_file_content_provider(res, mm, content_type, encoding);
  11491. if (req.method != "HEAD" && file_request_handler_) {
  11492. file_request_handler_(req, res);
  11493. }
  11494. return true;
  11495. } else {
  11496. output_error_log(Error::OpenFile, &req);
  11497. }
  11498. }
  11499. }
  11500. }
  11501. return false;
  11502. }
  11503. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11504. const std::string &etag,
  11505. time_t mtime) const {
  11506. // Handle conditional GET:
  11507. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11508. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11509. if (req.has_header("If-None-Match")) {
  11510. if (!etag.empty()) {
  11511. auto val =
  11512. detail::get_combined_header_value(req.headers, "If-None-Match");
  11513. // NOTE: We use exact string matching here. This works correctly
  11514. // because our server always generates weak ETags (W/"..."), and
  11515. // clients typically send back the same ETag they received.
  11516. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11517. // If-None-Match, where W/"x" and "x" would match, but this
  11518. // simplified implementation requires exact matches.
  11519. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11520. [&](const char *b, const char *e) {
  11521. auto seg_len = static_cast<size_t>(e - b);
  11522. return (seg_len == 1 && *b == '*') ||
  11523. (seg_len == etag.size() &&
  11524. std::equal(b, e, etag.begin()));
  11525. });
  11526. if (ret) {
  11527. res.status = StatusCode::NotModified_304;
  11528. return true;
  11529. }
  11530. }
  11531. } else if (req.has_header("If-Modified-Since")) {
  11532. auto val = req.get_header_value("If-Modified-Since");
  11533. auto t = detail::parse_http_date(val);
  11534. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11535. res.status = StatusCode::NotModified_304;
  11536. return true;
  11537. }
  11538. }
  11539. return false;
  11540. }
  11541. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11542. time_t mtime) const {
  11543. // Handle If-Range for partial content requests (RFC 9110
  11544. // Section 13.1.5). If-Range is only evaluated when Range header is
  11545. // present. If the validator matches, serve partial content; otherwise
  11546. // serve full content.
  11547. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11548. auto val = req.get_header_value("If-Range");
  11549. auto is_valid_range = [&]() {
  11550. if (detail::is_strong_etag(val)) {
  11551. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11552. // comparison.
  11553. return (!etag.empty() && val == etag);
  11554. } else if (detail::is_weak_etag(val)) {
  11555. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11556. return false;
  11557. } else {
  11558. // HTTP-date comparison
  11559. auto t = detail::parse_http_date(val);
  11560. return (t != static_cast<time_t>(-1) && mtime <= t);
  11561. }
  11562. };
  11563. if (!is_valid_range()) {
  11564. // Validator doesn't match: ignore Range and serve full content
  11565. req.ranges.clear();
  11566. return false;
  11567. }
  11568. }
  11569. return true;
  11570. }
  11571. inline socket_t
  11572. Server::create_server_socket(const std::string &host, int port,
  11573. int socket_flags,
  11574. SocketOptions socket_options) const {
  11575. return detail::create_socket(
  11576. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11577. ipv6_v6only_, std::move(socket_options),
  11578. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11579. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11580. output_error_log(Error::BindIPAddress, nullptr);
  11581. return false;
  11582. }
  11583. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11584. output_error_log(Error::Listen, nullptr);
  11585. return false;
  11586. }
  11587. return true;
  11588. });
  11589. }
  11590. inline int Server::bind_internal(const std::string &host, int port,
  11591. int socket_flags) {
  11592. if (is_decommissioned) { return -1; }
  11593. if (!is_valid()) { return -1; }
  11594. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11595. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11596. if (port == 0) {
  11597. struct sockaddr_storage addr;
  11598. socklen_t addr_len = sizeof(addr);
  11599. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11600. &addr_len) == -1) {
  11601. output_error_log(Error::GetSockName, nullptr);
  11602. return -1;
  11603. }
  11604. if (addr.ss_family == AF_INET) {
  11605. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11606. } else if (addr.ss_family == AF_INET6) {
  11607. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11608. } else {
  11609. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11610. return -1;
  11611. }
  11612. } else {
  11613. return port;
  11614. }
  11615. }
  11616. inline bool Server::listen_internal() {
  11617. // A stop() between bind and listen leaves nothing to accept on. Report
  11618. // failure instead of returning success without ever serving, and mark the
  11619. // server decommissioned the way any failed listen does so that a concurrent
  11620. // wait_until_ready() wakes up instead of spinning forever.
  11621. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11622. is_decommissioned = true;
  11623. return false;
  11624. }
  11625. auto ret = true;
  11626. is_running_ = true;
  11627. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11628. if (start_handler_) { start_handler_(); }
  11629. {
  11630. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11631. while (svr_sock_ != INVALID_SOCKET) {
  11632. #ifndef _WIN32
  11633. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11634. #endif
  11635. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11636. idle_interval_usec_);
  11637. if (val == 0) { // Timeout
  11638. task_queue->on_idle();
  11639. continue;
  11640. }
  11641. #ifndef _WIN32
  11642. }
  11643. #endif
  11644. #if defined _WIN32
  11645. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11646. // OVERLAPPED
  11647. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11648. #elif defined SOCK_CLOEXEC
  11649. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11650. #else
  11651. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11652. #endif
  11653. if (sock == INVALID_SOCKET) {
  11654. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11655. // touches the CRT errno, so the two have to be asked platform by
  11656. // platform rather than by testing errno here.
  11657. if (detail::is_accept_resource_error()) {
  11658. // The per-process descriptor limit or the network stack's buffer
  11659. // space has been reached. Try to accept new connections after a
  11660. // short sleep.
  11661. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11662. continue;
  11663. } else if (detail::is_accept_transient_error()) {
  11664. continue;
  11665. }
  11666. // Take the descriptor out of svr_sock_ before closing it: a later
  11667. // stop() would otherwise shutdown()/close() a value the OS may have
  11668. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11669. // gone. The exchange also settles the race with a concurrent stop(),
  11670. // since whichever side takes the descriptor closes it exactly once.
  11671. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11672. if (listen_sock != INVALID_SOCKET) {
  11673. detail::close_socket(listen_sock);
  11674. ret = false;
  11675. output_error_log(Error::Connection, nullptr);
  11676. } else {
  11677. ; // The server socket was closed by user.
  11678. }
  11679. break;
  11680. }
  11681. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11682. read_timeout_sec_, read_timeout_usec_);
  11683. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11684. write_timeout_sec_, write_timeout_usec_);
  11685. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11686. if (!task_queue->enqueue(
  11687. [this, sock]() { process_and_close_socket(sock); })) {
  11688. output_error_log(Error::ResourceExhaustion, nullptr);
  11689. detail::shutdown_socket(sock);
  11690. detail::close_socket(sock);
  11691. }
  11692. }
  11693. task_queue->shutdown();
  11694. }
  11695. is_decommissioned = !ret;
  11696. return ret;
  11697. }
  11698. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11699. if (pre_routing_handler_ &&
  11700. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11701. return true;
  11702. }
  11703. // File handler
  11704. if ((req.method == "GET" || req.method == "HEAD") &&
  11705. handle_file_request(req, res)) {
  11706. return true;
  11707. }
  11708. const auto *custom = find_custom_entry(req.method);
  11709. // The second clause mirrors what expect_content() does unconditionally for
  11710. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11711. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11712. // `allprop`) would skip its handler and fall through to 404.
  11713. if (detail::expect_content(req) ||
  11714. (custom && !custom->handlers_for_content_reader.empty())) {
  11715. // Content reader handler
  11716. {
  11717. // Track whether the ContentReader was aborted due to the decompressed
  11718. // payload exceeding `payload_max_length_`.
  11719. // The user handler runs after the lambda returns, so we must restore the
  11720. // 413 status if the handler overwrites it.
  11721. bool content_reader_payload_too_large = false;
  11722. ContentReader reader(
  11723. [&](ContentReceiver receiver) {
  11724. auto result = read_content_with_content_receiver(
  11725. strm, req, res, std::move(receiver), nullptr, nullptr);
  11726. if (!result) {
  11727. output_error_log(Error::Read, &req);
  11728. if (res.status == StatusCode::PayloadTooLarge_413) {
  11729. content_reader_payload_too_large = true;
  11730. }
  11731. }
  11732. return result;
  11733. },
  11734. [&](FormDataHeader header, ContentReceiver receiver) {
  11735. auto result = read_content_with_content_receiver(
  11736. strm, req, res, nullptr, std::move(header),
  11737. std::move(receiver));
  11738. if (!result) {
  11739. output_error_log(Error::Read, &req);
  11740. if (res.status == StatusCode::PayloadTooLarge_413) {
  11741. content_reader_payload_too_large = true;
  11742. }
  11743. }
  11744. return result;
  11745. });
  11746. bool dispatched = false;
  11747. if (req.method == "POST") {
  11748. dispatched = dispatch_request_for_content_reader(
  11749. req, res, std::move(reader), post_handlers_for_content_reader_);
  11750. } else if (req.method == "PUT") {
  11751. dispatched = dispatch_request_for_content_reader(
  11752. req, res, std::move(reader), put_handlers_for_content_reader_);
  11753. } else if (req.method == "PATCH") {
  11754. dispatched = dispatch_request_for_content_reader(
  11755. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11756. } else if (req.method == "DELETE") {
  11757. dispatched = dispatch_request_for_content_reader(
  11758. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11759. } else if (custom) {
  11760. dispatched = dispatch_request_for_content_reader(
  11761. req, res, std::move(reader), custom->handlers_for_content_reader);
  11762. }
  11763. if (dispatched) {
  11764. if (content_reader_payload_too_large) {
  11765. // Enforce the limit: override any status the handler may have set
  11766. // and return false so the error path sends a plain 413 response.
  11767. res.status = StatusCode::PayloadTooLarge_413;
  11768. res.body.clear();
  11769. res.content_length_ = 0;
  11770. res.content_provider_ = nullptr;
  11771. return false;
  11772. }
  11773. return true;
  11774. }
  11775. }
  11776. // NOTE: `req.body` is not read here. For a regular handler the body is
  11777. // read inside dispatch_request(), after the route has matched and the
  11778. // pre-request handler has approved the request, so that a rejected
  11779. // request (e.g. failed authentication) never forces us to buffer a
  11780. // potentially large body.
  11781. }
  11782. // Regular handler
  11783. if (req.method == "GET" || req.method == "HEAD") {
  11784. return dispatch_request(req, res, get_handlers_, strm);
  11785. } else if (req.method == "POST") {
  11786. return dispatch_request(req, res, post_handlers_, strm);
  11787. } else if (req.method == "PUT") {
  11788. return dispatch_request(req, res, put_handlers_, strm);
  11789. } else if (req.method == "DELETE") {
  11790. return dispatch_request(req, res, delete_handlers_, strm);
  11791. } else if (req.method == "OPTIONS") {
  11792. return dispatch_request(req, res, options_handlers_, strm);
  11793. } else if (req.method == "PATCH") {
  11794. return dispatch_request(req, res, patch_handlers_, strm);
  11795. } else if (custom) {
  11796. return dispatch_request(req, res, custom->handlers, strm);
  11797. }
  11798. res.status = StatusCode::BadRequest_400;
  11799. return false;
  11800. }
  11801. inline bool Server::dispatch_request(Request &req, Response &res,
  11802. const Handlers &handlers, Stream &strm) {
  11803. for (const auto &x : handlers) {
  11804. const auto &matcher = x.first;
  11805. const auto &handler = x.second;
  11806. if (matcher->match(req)) {
  11807. req.matched_route = matcher->pattern();
  11808. // Run the pre-request handler before reading the body so a rejected
  11809. // request (e.g. failed authentication) never forces us to buffer a
  11810. // potentially large body. `req.matched_route` is available here.
  11811. if (pre_request_handler_ &&
  11812. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11813. return true;
  11814. }
  11815. // The route matched and the request was approved; read the body now.
  11816. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11817. output_error_log(Error::Read, &req);
  11818. return false;
  11819. }
  11820. handler(req, res);
  11821. return true;
  11822. }
  11823. }
  11824. return false;
  11825. }
  11826. // Decides the content coding for a response served straight from a file. Both
  11827. // the ETag, which has to name the representation actually sent, and
  11828. // `apply_static_file_compression()` go through this, so the two cannot drift
  11829. // apart.
  11830. inline detail::EncodingType
  11831. Server::static_file_encoding(const Request &req, const Response &res,
  11832. const std::string &content_type,
  11833. size_t length) const {
  11834. if (!static_file_compression_) { return detail::EncodingType::None; }
  11835. // Nothing to compress, and an empty file already answers with
  11836. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11837. // turn an empty body into a 20-byte gzip stream.
  11838. if (length == 0) { return detail::EncodingType::None; }
  11839. // A file that already fits in a single packet gains nothing from being made
  11840. // smaller, since it still travels in that one segment, and a file of a few
  11841. // bytes comes out larger than it went in.
  11842. if (length < static_file_compression_min_length_) {
  11843. return detail::EncodingType::None;
  11844. }
  11845. // RFC 9110 applies Range to the representation after content coding, so a
  11846. // compressed 206 would mean compressing the whole file and then slicing it.
  11847. // Serve ranges from the identity representation instead.
  11848. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11849. if (static_file_compression_max_length_ > 0 &&
  11850. length > static_file_compression_max_length_) {
  11851. return detail::EncodingType::None;
  11852. }
  11853. return detail::encoding_type(req, res, content_type);
  11854. }
  11855. // Compresses a file-backed content provider into `res.body` and takes over the
  11856. // framing headers. Returns false when the response is left untouched.
  11857. inline bool Server::apply_static_file_compression(const Request &req,
  11858. Response &res) const {
  11859. auto type = res.content_coding_;
  11860. if (type == detail::EncodingType::None || !res.content_provider_) {
  11861. return false;
  11862. }
  11863. auto compressor = detail::make_compressor(type);
  11864. if (!compressor) { return false; }
  11865. output_pre_compression_log(req, res);
  11866. std::string compressed;
  11867. if (!detail::compress_content_provider(res.content_provider_,
  11868. res.content_length_, *compressor,
  11869. compressed)) {
  11870. return false;
  11871. }
  11872. res.body.swap(compressed);
  11873. // The provider was consumed in full, so a resource releaser registered with
  11874. // it should hear about a success when the response goes away.
  11875. res.content_provider_success_ = true;
  11876. res.content_provider_ = nullptr;
  11877. res.content_length_ = 0;
  11878. res.content_coding_ = detail::EncodingType::None;
  11879. res.set_header("Content-Encoding", detail::encoding_name(type));
  11880. res.set_header("Vary", "Accept-Encoding");
  11881. res.set_header("Content-Length", std::to_string(res.body.size()));
  11882. return true;
  11883. }
  11884. inline void Server::apply_ranges(const Request &req, Response &res,
  11885. std::string &content_type,
  11886. std::string &boundary) const {
  11887. // A known-length content provider leaves `res.body` empty, so the compressor
  11888. // at the end of this function never runs for one (issue #2545). A file-backed
  11889. // provider is fully readable right here, so compress it and answer with an
  11890. // ordinary body: `Content-Length` and HEAD keep working, and the response
  11891. // takes the same path as `set_content()` from here on. Range requests never
  11892. // get a content coding, so `Content-Range` still names identity bytes and
  11893. // none of the framing below applies.
  11894. if (apply_static_file_compression(req, res)) { return; }
  11895. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  11896. auto it = res.headers.find("Content-Type");
  11897. if (it != res.headers.end()) {
  11898. content_type = it->second;
  11899. res.headers.erase(it);
  11900. }
  11901. boundary = detail::make_multipart_data_boundary();
  11902. res.set_header("Content-Type",
  11903. "multipart/byteranges; boundary=" + boundary);
  11904. }
  11905. auto type = detail::encoding_type(req, res);
  11906. if (res.body.empty()) {
  11907. if (res.content_length_ > 0) {
  11908. size_t length = 0;
  11909. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11910. length = res.content_length_;
  11911. } else if (req.ranges.size() == 1) {
  11912. auto offset_and_length = detail::get_range_offset_and_length(
  11913. req.ranges[0], res.content_length_);
  11914. length = offset_and_length.second;
  11915. auto content_range = detail::make_content_range_header_field(
  11916. offset_and_length, res.content_length_);
  11917. res.set_header("Content-Range", content_range);
  11918. } else {
  11919. length = detail::get_multipart_ranges_data_length(
  11920. req, boundary, content_type, res.content_length_);
  11921. }
  11922. res.set_header("Content-Length", std::to_string(length));
  11923. } else {
  11924. if (res.content_provider_) {
  11925. if (res.is_chunked_content_provider_) {
  11926. res.set_header("Transfer-Encoding", "chunked");
  11927. res.content_coding_ = type;
  11928. if (type != detail::EncodingType::None) {
  11929. res.set_header("Content-Encoding", detail::encoding_name(type));
  11930. res.set_header("Vary", "Accept-Encoding");
  11931. }
  11932. }
  11933. }
  11934. }
  11935. } else {
  11936. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11937. ;
  11938. } else if (req.ranges.size() == 1) {
  11939. auto offset_and_length =
  11940. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  11941. auto offset = offset_and_length.first;
  11942. auto length = offset_and_length.second;
  11943. auto content_range = detail::make_content_range_header_field(
  11944. offset_and_length, res.body.size());
  11945. res.set_header("Content-Range", content_range);
  11946. assert(offset + length <= res.body.size());
  11947. res.body = res.body.substr(offset, length);
  11948. } else {
  11949. std::string data;
  11950. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  11951. res.body.size(), data);
  11952. res.body.swap(data);
  11953. }
  11954. if (type != detail::EncodingType::None) {
  11955. output_pre_compression_log(req, res);
  11956. if (auto compressor = detail::make_compressor(type)) {
  11957. std::string compressed;
  11958. if (compressor->compress(res.body.data(), res.body.size(), true,
  11959. [&](const char *data, size_t data_len) {
  11960. compressed.append(data, data_len);
  11961. return true;
  11962. })) {
  11963. res.body.swap(compressed);
  11964. res.set_header("Content-Encoding", detail::encoding_name(type));
  11965. res.set_header("Vary", "Accept-Encoding");
  11966. }
  11967. }
  11968. }
  11969. res.content_length_ = res.body.size();
  11970. res.set_header("Content-Length", std::to_string(res.content_length_));
  11971. }
  11972. }
  11973. inline bool Server::dispatch_request_for_content_reader(
  11974. Request &req, Response &res, ContentReader content_reader,
  11975. const HandlersForContentReader &handlers) const {
  11976. for (const auto &x : handlers) {
  11977. const auto &matcher = x.first;
  11978. const auto &handler = x.second;
  11979. if (matcher->match(req)) {
  11980. req.matched_route = matcher->pattern();
  11981. if (!pre_request_handler_ ||
  11982. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  11983. handler(req, res, content_reader);
  11984. }
  11985. return true;
  11986. }
  11987. }
  11988. return false;
  11989. }
  11990. inline std::string
  11991. get_client_ip(const std::string &x_forwarded_for,
  11992. const std::vector<std::string> &trusted_proxies) {
  11993. // X-Forwarded-For is a comma-separated list per RFC 7239
  11994. std::vector<std::string> ip_list;
  11995. detail::split(x_forwarded_for.data(),
  11996. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  11997. [&](const char *b, const char *e) {
  11998. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  11999. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12000. });
  12001. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12002. // no segments. Signal "no client IP derived" with an empty string so the
  12003. // caller can fall back to the connection-level remote address.
  12004. if (ip_list.empty()) { return std::string(); }
  12005. // Each hop appends the address it received the request from, so the rightmost
  12006. // entries are the ones written by our own infrastructure while the leftmost
  12007. // are whatever the original client chose to send. Walk from the right and
  12008. // skip trusted proxies; the first address that is not a trusted proxy is the
  12009. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12010. // from the left instead lets a client forge an arbitrary address by following
  12011. // it with a trusted proxy's address, which the left-to-right scan then
  12012. // returned as the client.
  12013. for (size_t i = ip_list.size(); i-- > 0;) {
  12014. const auto &ip = ip_list[i];
  12015. auto is_trusted_proxy =
  12016. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12017. [&](const std::string &proxy) { return ip == proxy; });
  12018. if (!is_trusted_proxy) { return ip; }
  12019. }
  12020. // Every hop was a trusted proxy; fall back to the first entry.
  12021. return ip_list.front();
  12022. }
  12023. inline bool
  12024. Server::process_request(Stream &strm, const std::string &remote_addr,
  12025. int remote_port, const std::string &local_addr,
  12026. int local_port, bool close_connection,
  12027. bool &connection_closed,
  12028. const std::function<void(Request &)> &setup_request,
  12029. bool *websocket_upgraded) {
  12030. std::array<char, 2048> buf{};
  12031. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12032. // Connection has been closed on client
  12033. if (!line_reader.getline()) { return false; }
  12034. Request req;
  12035. req.start_time_ = std::chrono::steady_clock::now();
  12036. req.remote_addr = remote_addr;
  12037. req.remote_port = remote_port;
  12038. req.local_addr = local_addr;
  12039. req.local_port = local_port;
  12040. Response res;
  12041. res.version = "HTTP/1.1";
  12042. res.headers = default_headers_;
  12043. // Request line and headers
  12044. if (!parse_request_line(line_reader.ptr(), req)) {
  12045. res.status = StatusCode::BadRequest_400;
  12046. output_error_log(Error::InvalidRequestLine, &req);
  12047. return write_response(strm, close_connection, req, res);
  12048. }
  12049. // Request headers
  12050. if (!detail::read_headers(strm, req.headers)) {
  12051. res.status = StatusCode::BadRequest_400;
  12052. output_error_log(Error::InvalidHeaders, &req);
  12053. return write_response(strm, close_connection, req, res);
  12054. }
  12055. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  12056. // otherwise let an intermediary and this parser disagree on where the body
  12057. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  12058. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  12059. // compatibility with existing clients), and a Transfer-Encoding whose final
  12060. // coding is not chunked, which leaves the body length undeterminable. The
  12061. // latter must not fall through to the "no body" path, or the body bytes are
  12062. // parsed as the next request on a persistent connection.
  12063. if (req.has_header("Transfer-Encoding") &&
  12064. (req.get_header_value_u64("Content-Length") > 0 ||
  12065. !detail::is_chunked_transfer_encoding(req.headers))) {
  12066. connection_closed = true;
  12067. res.status = StatusCode::BadRequest_400;
  12068. return write_response(strm, close_connection, req, res);
  12069. }
  12070. // Check if the request URI doesn't exceed the limit
  12071. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12072. connection_closed = true;
  12073. res.status = StatusCode::UriTooLong_414;
  12074. output_error_log(Error::ExceedUriMaxLength, &req);
  12075. return write_response(strm, close_connection, req, res);
  12076. }
  12077. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12078. connection_closed = true;
  12079. }
  12080. if (req.version == "HTTP/1.0" &&
  12081. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12082. connection_closed = true;
  12083. }
  12084. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12085. // itself a trusted proxy. Otherwise any direct client could spoof
  12086. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12087. auto is_trusted_peer = std::any_of(
  12088. trusted_proxies_.begin(), trusted_proxies_.end(),
  12089. [&](const std::string &proxy) { return proxy == remote_addr; });
  12090. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12091. // Some proxies append the address they observed as a separate
  12092. // X-Forwarded-For field line instead of extending the one the client sent
  12093. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12094. // be scanned. Reading only the first occurrence would hand back the
  12095. // client-supplied, and therefore forgeable, value.
  12096. auto x_forwarded_for =
  12097. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12098. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12099. req.remote_addr = derived.empty() ? remote_addr : derived;
  12100. } else {
  12101. req.remote_addr = remote_addr;
  12102. }
  12103. req.remote_port = remote_port;
  12104. req.local_addr = local_addr;
  12105. req.local_port = local_port;
  12106. if (req.has_header("Accept")) {
  12107. auto accept_header =
  12108. detail::get_combined_header_value(req.headers, "Accept");
  12109. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12110. connection_closed = true;
  12111. res.status = StatusCode::BadRequest_400;
  12112. output_error_log(Error::HTTPParsing, &req);
  12113. return write_response(strm, close_connection, req, res);
  12114. }
  12115. }
  12116. if (req.has_header("Range")) {
  12117. const auto &range_header_value = req.get_header_value("Range");
  12118. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12119. connection_closed = true;
  12120. res.status = StatusCode::RangeNotSatisfiable_416;
  12121. output_error_log(Error::InvalidRangeHeader, &req);
  12122. return write_response(strm, close_connection, req, res);
  12123. }
  12124. }
  12125. if (setup_request) { setup_request(req); }
  12126. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12127. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12128. // must be ignored. An expectation we do not recognize is left alone; the
  12129. // 417 the section allows for one is a MAY, not a requirement.
  12130. if (req.version != "HTTP/1.0" &&
  12131. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12132. int status = StatusCode::Continue_100;
  12133. if (expect_100_continue_handler_) {
  12134. status = expect_100_continue_handler_(req, res);
  12135. }
  12136. switch (status) {
  12137. case StatusCode::Continue_100:
  12138. case StatusCode::ExpectationFailed_417:
  12139. detail::write_response_line(strm, status);
  12140. strm.write("\r\n");
  12141. break;
  12142. default:
  12143. connection_closed = true;
  12144. return write_response(strm, true, req, res);
  12145. }
  12146. }
  12147. // Setup `is_connection_closed` method
  12148. auto sock = strm.socket();
  12149. req.is_connection_closed = [sock]() {
  12150. return !detail::is_socket_alive(sock);
  12151. };
  12152. // WebSocket upgrade
  12153. // Check pre_routing_handler_ before upgrading so that authentication
  12154. // and other middleware can reject the request with an HTTP response
  12155. // (e.g., 401) before the protocol switches.
  12156. if (detail::is_websocket_upgrade(req)) {
  12157. if (pre_routing_handler_ &&
  12158. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12159. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12160. return write_response(strm, close_connection, req, res);
  12161. }
  12162. // Find matching WebSocket handler
  12163. for (const auto &entry : websocket_handlers_) {
  12164. if (entry.matcher->match(req)) {
  12165. // Compute accept key
  12166. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12167. auto accept_key = detail::websocket_accept_key(client_key);
  12168. // Negotiate subprotocol
  12169. std::string selected_subprotocol;
  12170. if (entry.sub_protocol_selector) {
  12171. auto protocol_header = detail::get_combined_header_value(
  12172. req.headers, "Sec-WebSocket-Protocol");
  12173. if (!protocol_header.empty()) {
  12174. std::vector<std::string> protocols;
  12175. detail::split(protocol_header.data(),
  12176. protocol_header.data() + protocol_header.size(), ',',
  12177. [&](const char *b, const char *e) {
  12178. protocols.emplace_back(b, e);
  12179. });
  12180. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12181. }
  12182. }
  12183. // Send 101 Switching Protocols
  12184. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12185. "Upgrade: websocket\r\n"
  12186. "Connection: Upgrade\r\n"
  12187. "Sec-WebSocket-Accept: " +
  12188. accept_key + "\r\n";
  12189. if (!selected_subprotocol.empty()) {
  12190. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12191. return false;
  12192. }
  12193. handshake_response +=
  12194. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12195. }
  12196. handshake_response += "\r\n";
  12197. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12198. 0) {
  12199. return false;
  12200. }
  12201. connection_closed = true;
  12202. if (websocket_upgraded) { *websocket_upgraded = true; }
  12203. {
  12204. #ifdef CPPHTTPLIB_SSL_ENABLED
  12205. if (req.ssl) {
  12206. // wss: the heartbeat ping thread and the read path enter the same
  12207. // TLS session from different threads. Hand the WebSocket a stream
  12208. // that serializes every TLS call, so the shared SSLSocketStream on
  12209. // the plain HTTP/HTTPS paths stays untouched.
  12210. auto ws_strm =
  12211. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12212. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12213. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12214. write_timeout_sec_, write_timeout_usec_));
  12215. ws::WebSocket ws(std::move(ws_strm), req, true,
  12216. websocket_ping_interval_sec_,
  12217. websocket_max_missed_pongs_);
  12218. entry.handler(req, ws);
  12219. return true;
  12220. }
  12221. #endif
  12222. // Use WebSocket-specific read timeout instead of HTTP timeout
  12223. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12224. 0);
  12225. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12226. websocket_max_missed_pongs_);
  12227. entry.handler(req, ws);
  12228. }
  12229. return true;
  12230. }
  12231. }
  12232. // No matching handler - fall through to 404
  12233. }
  12234. // Routing
  12235. auto routed = false;
  12236. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12237. routed = routing(req, res, strm);
  12238. #else
  12239. try {
  12240. routed = routing(req, res, strm);
  12241. } catch (std::exception &) {
  12242. if (exception_handler_) {
  12243. auto ep = std::current_exception();
  12244. exception_handler_(req, res, ep);
  12245. routed = true;
  12246. } else {
  12247. res.status = StatusCode::InternalServerError_500;
  12248. }
  12249. } catch (...) {
  12250. if (exception_handler_) {
  12251. auto ep = std::current_exception();
  12252. exception_handler_(req, res, ep);
  12253. routed = true;
  12254. } else {
  12255. res.status = StatusCode::InternalServerError_500;
  12256. }
  12257. }
  12258. #endif
  12259. auto ret = false;
  12260. if (routed) {
  12261. if (res.status == -1) {
  12262. res.status = req.ranges.empty() ? StatusCode::OK_200
  12263. : StatusCode::PartialContent_206;
  12264. }
  12265. // Serve file content by using a content provider
  12266. auto file_open_error = false;
  12267. if (!res.file_content_path_.empty()) {
  12268. const auto &path = res.file_content_path_;
  12269. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12270. if (!mm->is_open()) {
  12271. res.body.clear();
  12272. res.content_length_ = 0;
  12273. res.content_provider_ = nullptr;
  12274. res.status = StatusCode::NotFound_404;
  12275. output_error_log(Error::OpenFile, &req);
  12276. file_open_error = true;
  12277. } else {
  12278. auto content_type = res.file_content_content_type_;
  12279. if (content_type.empty()) {
  12280. content_type = detail::find_content_type(
  12281. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12282. }
  12283. detail::set_file_content_provider(
  12284. res, mm, content_type,
  12285. static_file_encoding(req, res, content_type, mm->size()));
  12286. }
  12287. }
  12288. if (file_open_error) {
  12289. ret = write_response(strm, close_connection, req, res);
  12290. } else if (detail::range_error(req, res)) {
  12291. res.body.clear();
  12292. res.content_length_ = 0;
  12293. res.content_provider_ = nullptr;
  12294. res.status = StatusCode::RangeNotSatisfiable_416;
  12295. ret = write_response(strm, close_connection, req, res);
  12296. } else {
  12297. ret = write_response_with_content(strm, close_connection, req, res);
  12298. }
  12299. } else {
  12300. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12301. ret = write_response(strm, close_connection, req, res);
  12302. }
  12303. // Drain any unconsumed framed body to prevent request smuggling on
  12304. // keep-alive. Without framing there is no body to drain — reading would
  12305. // consume the next request (issue #2450). If the response has committed the
  12306. // connection to close, there is no next request to protect.
  12307. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12308. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12309. connection_closed = true;
  12310. } else {
  12311. int dummy_status;
  12312. if (!detail::read_content(
  12313. strm, req, payload_max_length_, dummy_status, nullptr,
  12314. [](const char *, size_t, size_t, size_t) { return true; },
  12315. false)) {
  12316. connection_closed = true;
  12317. }
  12318. }
  12319. }
  12320. return ret;
  12321. }
  12322. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12323. inline bool Server::process_and_close_socket(socket_t sock) {
  12324. std::string remote_addr;
  12325. int remote_port = 0;
  12326. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12327. std::string local_addr;
  12328. int local_port = 0;
  12329. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12330. bool websocket_upgraded = false;
  12331. auto ret = serve_guarded([&]() {
  12332. return detail::process_server_socket(
  12333. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12334. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12335. write_timeout_usec_,
  12336. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12337. return process_request(strm, remote_addr, remote_port, local_addr,
  12338. local_port, close_connection,
  12339. connection_closed, nullptr,
  12340. &websocket_upgraded);
  12341. });
  12342. });
  12343. detail::drain_and_close_socket(sock);
  12344. return ret;
  12345. }
  12346. inline void Server::output_log(const Request &req, const Response &res) const {
  12347. if (logger_) {
  12348. std::lock_guard<std::mutex> guard(logger_mutex_);
  12349. logger_(req, res);
  12350. }
  12351. }
  12352. inline void Server::output_pre_compression_log(const Request &req,
  12353. const Response &res) const {
  12354. if (pre_compression_logger_) {
  12355. std::lock_guard<std::mutex> guard(logger_mutex_);
  12356. pre_compression_logger_(req, res);
  12357. }
  12358. }
  12359. inline void Server::output_error_log(const Error &err,
  12360. const Request *req) const {
  12361. if (error_logger_) {
  12362. std::lock_guard<std::mutex> guard(logger_mutex_);
  12363. error_logger_(err, req);
  12364. }
  12365. }
  12366. /*
  12367. * Group 5: ClientImpl and Client (Universal) implementation
  12368. */
  12369. // HTTP client implementation
  12370. inline ClientImpl::ClientImpl(const std::string &host)
  12371. : ClientImpl(host, 80, std::string(), std::string()) {}
  12372. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12373. : ClientImpl(host, port, std::string(), std::string()) {}
  12374. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12375. const std::string &client_cert_path,
  12376. const std::string &client_key_path)
  12377. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12378. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12379. inline ClientImpl::~ClientImpl() {
  12380. // Wait until all the requests in flight are handled.
  12381. size_t retry_count = 10;
  12382. while (retry_count-- > 0) {
  12383. {
  12384. std::lock_guard<std::mutex> guard(socket_mutex_);
  12385. if (socket_requests_in_flight_ == 0) { break; }
  12386. }
  12387. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12388. }
  12389. std::lock_guard<std::mutex> guard(socket_mutex_);
  12390. shutdown_socket(socket_);
  12391. close_socket(socket_);
  12392. }
  12393. inline bool ClientImpl::is_valid() const { return true; }
  12394. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12395. client_cert_path_ = rhs.client_cert_path_;
  12396. client_key_path_ = rhs.client_key_path_;
  12397. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12398. read_timeout_sec_ = rhs.read_timeout_sec_;
  12399. read_timeout_usec_ = rhs.read_timeout_usec_;
  12400. write_timeout_sec_ = rhs.write_timeout_sec_;
  12401. write_timeout_usec_ = rhs.write_timeout_usec_;
  12402. max_timeout_msec_ = rhs.max_timeout_msec_;
  12403. basic_auth_username_ = rhs.basic_auth_username_;
  12404. basic_auth_password_ = rhs.basic_auth_password_;
  12405. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12406. keep_alive_ = rhs.keep_alive_;
  12407. follow_location_ = rhs.follow_location_;
  12408. path_encode_ = rhs.path_encode_;
  12409. address_family_ = rhs.address_family_;
  12410. tcp_nodelay_ = rhs.tcp_nodelay_;
  12411. ipv6_v6only_ = rhs.ipv6_v6only_;
  12412. socket_options_ = rhs.socket_options_;
  12413. compress_ = rhs.compress_;
  12414. decompress_ = rhs.decompress_;
  12415. payload_max_length_ = rhs.payload_max_length_;
  12416. has_payload_max_length_ = rhs.has_payload_max_length_;
  12417. interface_ = rhs.interface_;
  12418. proxy_host_ = rhs.proxy_host_;
  12419. proxy_port_ = rhs.proxy_port_;
  12420. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12421. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12422. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12423. no_proxy_entries_ = rhs.no_proxy_entries_;
  12424. logger_ = rhs.logger_;
  12425. error_logger_ = rhs.error_logger_;
  12426. #ifdef CPPHTTPLIB_SSL_ENABLED
  12427. digest_auth_username_ = rhs.digest_auth_username_;
  12428. digest_auth_password_ = rhs.digest_auth_password_;
  12429. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12430. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12431. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12432. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12433. server_certificate_verification_ = rhs.server_certificate_verification_;
  12434. server_hostname_verification_ = rhs.server_hostname_verification_;
  12435. system_ca_mode_ = rhs.system_ca_mode_;
  12436. #endif
  12437. }
  12438. inline bool
  12439. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12440. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12441. if (no_proxy_entries_.empty()) { return true; }
  12442. // host_ is const so its normalized form is invariant; cache it. The
  12443. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12444. if (host == host_) {
  12445. if (!host_normalized_valid_) {
  12446. host_normalized_ = detail::normalize_target(host_);
  12447. host_normalized_valid_ = true;
  12448. }
  12449. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12450. }
  12451. auto target = detail::normalize_target(host);
  12452. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12453. }
  12454. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12455. if (is_proxy_enabled_for_host(host_)) {
  12456. return detail::create_client_socket(
  12457. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12458. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12459. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12460. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12461. }
  12462. // Check is custom IP or hostname specified for host_
  12463. std::string connect_host;
  12464. std::string ip;
  12465. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12466. return detail::create_client_socket(
  12467. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12468. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12469. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12470. write_timeout_usec_, interface_, error);
  12471. }
  12472. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12473. Error &error) {
  12474. auto sock = create_client_socket(error);
  12475. if (sock == INVALID_SOCKET) { return false; }
  12476. socket.sock = sock;
  12477. return true;
  12478. }
  12479. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12480. return create_and_connect_socket(socket, error);
  12481. }
  12482. inline bool ClientImpl::setup_proxy_connection(
  12483. Socket & /*socket*/,
  12484. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12485. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12486. return true;
  12487. }
  12488. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12489. bool /*shutdown_gracefully*/) {
  12490. // If there are any requests in flight from threads other than us, then it's
  12491. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12492. assert(socket_requests_in_flight_ == 0 ||
  12493. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12494. }
  12495. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12496. if (socket.sock == INVALID_SOCKET) { return; }
  12497. detail::shutdown_socket(socket.sock);
  12498. }
  12499. inline void ClientImpl::close_socket(Socket &socket) {
  12500. // If there are requests in flight in another thread, usually closing
  12501. // the socket will be fine and they will simply receive an error when
  12502. // using the closed socket, but it is still a bug since rarely the OS
  12503. // may reassign the socket id to be used for a new socket, and then
  12504. // suddenly they will be operating on a live socket that is different
  12505. // than the one they intended!
  12506. assert(socket_requests_in_flight_ == 0 ||
  12507. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12508. // It is also a bug if this happens while SSL is still active
  12509. #ifdef CPPHTTPLIB_SSL_ENABLED
  12510. assert(socket.ssl == nullptr);
  12511. #endif
  12512. if (socket.sock == INVALID_SOCKET) { return; }
  12513. detail::close_socket(socket.sock);
  12514. socket.sock = INVALID_SOCKET;
  12515. }
  12516. inline void ClientImpl::disconnect(bool gracefully) {
  12517. shutdown_ssl(socket_, gracefully);
  12518. shutdown_socket(socket_);
  12519. close_socket(socket_);
  12520. }
  12521. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12522. Response &res,
  12523. bool skip_100_continue) const {
  12524. std::array<char, 2048> buf{};
  12525. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12526. if (!line_reader.getline()) { return false; }
  12527. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12528. res.reason)) {
  12529. return req.method == "CONNECT";
  12530. }
  12531. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12532. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12533. if (!line_reader.getline()) { return false; } // CRLF
  12534. if (!line_reader.getline()) { return false; } // next response line
  12535. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12536. res.reason)) {
  12537. return false;
  12538. }
  12539. }
  12540. return true;
  12541. }
  12542. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12543. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12544. auto ret = send_(req, res, error);
  12545. if (error == Error::SSLPeerCouldBeClosed_) {
  12546. assert(!ret);
  12547. ret = send_(req, res, error);
  12548. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12549. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12550. }
  12551. return ret;
  12552. }
  12553. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12554. {
  12555. std::lock_guard<std::mutex> guard(socket_mutex_);
  12556. // Set this to false immediately - if it ever gets set to true by the end
  12557. // of the request, we know another thread instructed us to close the
  12558. // socket.
  12559. socket_should_be_closed_when_request_is_done_ = false;
  12560. auto is_alive = false;
  12561. if (socket_.is_open()) {
  12562. is_alive = detail::is_socket_alive(socket_.sock);
  12563. #ifdef CPPHTTPLIB_SSL_ENABLED
  12564. if (is_alive && is_ssl()) {
  12565. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12566. is_alive = false;
  12567. }
  12568. }
  12569. #endif
  12570. if (!is_alive) {
  12571. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12572. disconnect(/*gracefully=*/false);
  12573. }
  12574. }
  12575. if (!is_alive) {
  12576. if (!ensure_socket_connection(socket_, error)) {
  12577. output_error_log(error, &req);
  12578. return false;
  12579. }
  12580. {
  12581. auto success = true;
  12582. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12583. error)) {
  12584. if (!success) { output_error_log(error, &req); }
  12585. return success;
  12586. }
  12587. }
  12588. }
  12589. // Mark the current socket as being in use so that it cannot be closed by
  12590. // anyone else while this request is ongoing, even though we will be
  12591. // releasing the mutex.
  12592. if (socket_requests_in_flight_ > 1) {
  12593. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12594. }
  12595. socket_requests_in_flight_ += 1;
  12596. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12597. }
  12598. for (const auto &header : default_headers_) {
  12599. if (req.headers.find(header.first) == req.headers.end()) {
  12600. req.headers.insert(header);
  12601. }
  12602. }
  12603. auto ret = false;
  12604. auto close_connection = !keep_alive_;
  12605. auto se = detail::scope_exit([&]() {
  12606. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12607. std::lock_guard<std::mutex> guard(socket_mutex_);
  12608. socket_requests_in_flight_ -= 1;
  12609. if (socket_requests_in_flight_ <= 0) {
  12610. assert(socket_requests_in_flight_ == 0);
  12611. socket_requests_are_from_thread_ = std::thread::id();
  12612. }
  12613. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12614. !ret) {
  12615. disconnect(/*gracefully=*/true);
  12616. }
  12617. });
  12618. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12619. return handle_request(strm, req, res, close_connection, error);
  12620. });
  12621. if (!ret) {
  12622. if (error == Error::Success) {
  12623. error = Error::Unknown;
  12624. output_error_log(error, &req);
  12625. }
  12626. }
  12627. return ret;
  12628. }
  12629. inline Result ClientImpl::send(const Request &req) {
  12630. auto req2 = req;
  12631. return send_(std::move(req2));
  12632. }
  12633. inline Result ClientImpl::send_(Request &&req) {
  12634. auto res = detail::make_unique<Response>();
  12635. auto error = Error::Success;
  12636. auto ret = send(req, *res, error);
  12637. #ifdef CPPHTTPLIB_SSL_ENABLED
  12638. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12639. last_ssl_error_, last_backend_error_};
  12640. #else
  12641. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12642. #endif
  12643. }
  12644. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12645. const std::string &ct) {
  12646. (void)for_stream;
  12647. for (const auto &header : default_headers_) {
  12648. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12649. }
  12650. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12651. // prepend it rather than appending it after the caller's own fields.
  12652. if (!r.has_header("Host")) {
  12653. r.headers.emplace_front(
  12654. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12655. address_family_));
  12656. }
  12657. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12658. if (!r.content_receiver) {
  12659. if (!r.has_header("Accept-Encoding")) {
  12660. std::string accept_encoding;
  12661. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12662. accept_encoding = "br";
  12663. #endif
  12664. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12665. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12666. accept_encoding += "gzip, deflate";
  12667. #endif
  12668. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12669. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12670. accept_encoding += "zstd";
  12671. #endif
  12672. r.set_header("Accept-Encoding", accept_encoding);
  12673. }
  12674. detail::add_default_user_agent_header(r);
  12675. }
  12676. if (!r.body.empty()) {
  12677. if (!ct.empty() && !r.has_header("Content-Type")) {
  12678. r.headers.emplace("Content-Type", ct);
  12679. }
  12680. if (!r.has_header("Content-Length")) {
  12681. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12682. }
  12683. }
  12684. }
  12685. inline ClientImpl::StreamHandle
  12686. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12687. const Params &params, const Headers &headers,
  12688. const std::string &body,
  12689. const std::string &content_type) {
  12690. StreamHandle handle;
  12691. handle.response = detail::make_unique<Response>();
  12692. handle.error = Error::Success;
  12693. // Encode the target exactly like the buffered send path does, so that the
  12694. // same `path` produces the same request line through either API.
  12695. auto raw_query_path =
  12696. params.empty() ? path : append_query_params(path, params);
  12697. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12698. handle.connection_ = detail::make_unique<ClientConnection>();
  12699. {
  12700. std::lock_guard<std::mutex> guard(socket_mutex_);
  12701. auto is_alive = false;
  12702. if (socket_.is_open()) {
  12703. is_alive = detail::is_socket_alive(socket_.sock);
  12704. #ifdef CPPHTTPLIB_SSL_ENABLED
  12705. if (is_alive && is_ssl()) {
  12706. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12707. is_alive = false;
  12708. }
  12709. }
  12710. #endif
  12711. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12712. }
  12713. if (!is_alive) {
  12714. if (!ensure_socket_connection(socket_, handle.error)) {
  12715. handle.response.reset();
  12716. return handle;
  12717. }
  12718. {
  12719. auto success = true;
  12720. auto start_time = std::chrono::steady_clock::now();
  12721. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12722. success, handle.error)) {
  12723. if (!success) { handle.response.reset(); }
  12724. return handle;
  12725. }
  12726. }
  12727. }
  12728. transfer_socket_ownership_to_handle(handle);
  12729. }
  12730. #ifdef CPPHTTPLIB_SSL_ENABLED
  12731. if (is_ssl() && handle.connection_->session) {
  12732. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12733. handle.connection_->sock, handle.connection_->session,
  12734. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12735. write_timeout_usec_);
  12736. } else {
  12737. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12738. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12739. write_timeout_sec_, write_timeout_usec_);
  12740. }
  12741. #else
  12742. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12743. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12744. write_timeout_sec_, write_timeout_usec_);
  12745. #endif
  12746. handle.stream_ = handle.socket_stream_.get();
  12747. Request req;
  12748. req.method = method;
  12749. req.path = query_path;
  12750. req.headers = headers;
  12751. req.body = body;
  12752. prepare_default_headers(req, true, content_type);
  12753. auto &strm = *handle.stream_;
  12754. if (detail::write_request_line(strm, req.method, req.path) < 0) {
  12755. handle.error = Error::Write;
  12756. handle.response.reset();
  12757. return handle;
  12758. }
  12759. if (!detail::check_and_write_headers(strm, req.headers, header_writer_,
  12760. handle.error)) {
  12761. handle.response.reset();
  12762. return handle;
  12763. }
  12764. if (!body.empty()) {
  12765. if (strm.write(body.data(), body.size()) < 0) {
  12766. handle.error = Error::Write;
  12767. handle.response.reset();
  12768. return handle;
  12769. }
  12770. }
  12771. if (!read_response_line(strm, req, *handle.response) ||
  12772. !detail::read_headers(strm, handle.response->headers)) {
  12773. handle.error = Error::Read;
  12774. handle.response.reset();
  12775. return handle;
  12776. }
  12777. handle.body_reader_.stream = handle.stream_;
  12778. handle.body_reader_.payload_max_length = payload_max_length_;
  12779. if (handle.response->has_header("Content-Length")) {
  12780. bool is_invalid = false;
  12781. auto content_length = detail::get_header_value_u64(
  12782. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12783. if (is_invalid) {
  12784. handle.error = Error::Read;
  12785. handle.response.reset();
  12786. return handle;
  12787. }
  12788. handle.body_reader_.has_content_length = true;
  12789. handle.body_reader_.content_length = content_length;
  12790. }
  12791. handle.body_reader_.chunked =
  12792. detail::is_chunked_transfer_encoding(handle.response->headers);
  12793. auto content_encoding = detail::get_combined_header_value(
  12794. handle.response->headers, "Content-Encoding");
  12795. if (!content_encoding.empty()) {
  12796. // Same policy as prepare_content_receiver(): reject a coding we know about
  12797. // but were not built with, pass an unrecognized one through as-is.
  12798. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12799. if (!handle.decompressor_) {
  12800. if (detail::is_known_content_encoding(content_encoding)) {
  12801. handle.error = Error::UnsupportedContentEncoding;
  12802. handle.response.reset();
  12803. return handle;
  12804. }
  12805. } else if (!handle.decompressor_->is_valid()) {
  12806. handle.error = Error::Compression;
  12807. handle.response.reset();
  12808. return handle;
  12809. }
  12810. }
  12811. return handle;
  12812. }
  12813. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12814. if (!is_valid() || !response) { return -1; }
  12815. if (decompressor_) { return read_with_decompression(buf, len); }
  12816. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12817. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12818. trailers_parsed_ = true;
  12819. if (body_reader_.chunked_decoder) {
  12820. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12821. response->trailers, response->headers)) {
  12822. return n;
  12823. }
  12824. } else {
  12825. detail::ChunkedDecoder dec(*stream_);
  12826. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12827. return n;
  12828. }
  12829. }
  12830. }
  12831. return n;
  12832. }
  12833. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12834. size_t len) {
  12835. if (decompress_offset_ < decompress_buffer_.size()) {
  12836. auto available = decompress_buffer_.size() - decompress_offset_;
  12837. auto to_copy = (std::min)(len, available);
  12838. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12839. decompress_offset_ += to_copy;
  12840. decompressed_bytes_read_ += to_copy;
  12841. return static_cast<ssize_t>(to_copy);
  12842. }
  12843. decompress_buffer_.clear();
  12844. decompress_offset_ = 0;
  12845. constexpr size_t kDecompressionBufferSize = 8192;
  12846. char compressed_buf[kDecompressionBufferSize];
  12847. while (true) {
  12848. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12849. sizeof(compressed_buf));
  12850. if (n <= 0) { return n; }
  12851. bool decompress_ok = decompressor_->decompress(
  12852. compressed_buf, static_cast<size_t>(n),
  12853. [this](const char *data, size_t data_len) {
  12854. decompress_buffer_.append(data, data_len);
  12855. auto limit = body_reader_.payload_max_length;
  12856. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12857. return false;
  12858. }
  12859. return true;
  12860. });
  12861. if (!decompress_ok) {
  12862. body_reader_.last_error = Error::Read;
  12863. return -1;
  12864. }
  12865. if (!decompress_buffer_.empty()) { break; }
  12866. }
  12867. auto to_copy = (std::min)(len, decompress_buffer_.size());
  12868. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  12869. decompress_offset_ = to_copy;
  12870. decompressed_bytes_read_ += to_copy;
  12871. return static_cast<ssize_t>(to_copy);
  12872. }
  12873. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  12874. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  12875. return;
  12876. }
  12877. trailers_parsed_ = true;
  12878. const auto bufsiz = 128;
  12879. char line_buf[bufsiz];
  12880. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  12881. if (!line_reader.getline()) { return; }
  12882. if (!detail::parse_trailers(line_reader, response->trailers,
  12883. response->headers)) {
  12884. return;
  12885. }
  12886. }
  12887. namespace detail {
  12888. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  12889. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  12890. size_t &out_chunk_offset,
  12891. size_t &out_chunk_total) {
  12892. if (finished) { return 0; }
  12893. if (chunk_remaining == 0) {
  12894. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12895. if (!lr.getline()) { return -1; }
  12896. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  12897. const char *p = lr.ptr();
  12898. int v = 0;
  12899. if (!is_hex(*p, v)) { return -1; }
  12900. size_t chunk_len = 0;
  12901. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  12902. for (; is_hex(*p, v); ++p) {
  12903. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  12904. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  12905. }
  12906. while (is_space_or_tab(*p)) {
  12907. ++p;
  12908. }
  12909. if (*p != '\0' && *p != ';' && *p != '\r' && *p != '\n') { return -1; }
  12910. if (chunk_len == 0) {
  12911. chunk_remaining = 0;
  12912. finished = true;
  12913. out_chunk_offset = 0;
  12914. out_chunk_total = 0;
  12915. return 0;
  12916. }
  12917. chunk_remaining = chunk_len;
  12918. last_chunk_total = chunk_remaining;
  12919. last_chunk_offset = 0;
  12920. }
  12921. auto to_read = (std::min)(chunk_remaining, len);
  12922. auto n = strm.read(buf, to_read);
  12923. if (n <= 0) { return -1; }
  12924. auto offset_before = last_chunk_offset;
  12925. last_chunk_offset += static_cast<size_t>(n);
  12926. chunk_remaining -= static_cast<size_t>(n);
  12927. out_chunk_offset = offset_before;
  12928. out_chunk_total = last_chunk_total;
  12929. if (chunk_remaining == 0) {
  12930. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12931. if (!lr.getline()) { return -1; }
  12932. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  12933. }
  12934. return n;
  12935. }
  12936. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  12937. const Headers &src_headers) {
  12938. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12939. if (!lr.getline()) { return false; }
  12940. return parse_trailers(lr, dest, src_headers);
  12941. }
  12942. } // namespace detail
  12943. inline void
  12944. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  12945. handle.connection_->sock = socket_.sock;
  12946. #ifdef CPPHTTPLIB_SSL_ENABLED
  12947. handle.connection_->session = socket_.ssl;
  12948. socket_.ssl = nullptr;
  12949. #endif
  12950. socket_.sock = INVALID_SOCKET;
  12951. }
  12952. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  12953. Response &res, bool close_connection,
  12954. Error &error) {
  12955. if (req.path.empty()) {
  12956. error = Error::Connection;
  12957. output_error_log(error, &req);
  12958. return false;
  12959. }
  12960. auto req_save = req;
  12961. bool ret;
  12962. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  12963. auto req2 = req;
  12964. req2.path = "http://" +
  12965. detail::make_host_and_port_string(host_, port_, false) +
  12966. req.path;
  12967. ret = process_request(strm, req2, res, close_connection, error);
  12968. req = std::move(req2);
  12969. req.path = req_save.path;
  12970. } else {
  12971. ret = process_request(strm, req, res, close_connection, error);
  12972. }
  12973. if (!ret) { return false; }
  12974. if (detail::has_header_token(res.headers, "Connection", "close") ||
  12975. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  12976. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  12977. // for this to be safe.
  12978. // This is safe to call because handle_request is only called by send_
  12979. // which locks the request mutex during the process. It would be a bug
  12980. // to call it from a different thread since it's a thread-safety issue
  12981. // to do these things to the socket if another thread is using the socket.
  12982. std::lock_guard<std::mutex> guard(socket_mutex_);
  12983. disconnect(/*gracefully=*/true);
  12984. }
  12985. if (300 < res.status && res.status < 400 && follow_location_) {
  12986. req = std::move(req_save);
  12987. ret = redirect(req, res, error);
  12988. }
  12989. #ifdef CPPHTTPLIB_SSL_ENABLED
  12990. if ((res.status == StatusCode::Unauthorized_401 ||
  12991. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  12992. req.authorization_count_ < 5) {
  12993. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  12994. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  12995. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  12996. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  12997. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  12998. return ret;
  12999. }
  13000. const auto &username =
  13001. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13002. const auto &password =
  13003. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13004. if (!username.empty() && !password.empty()) {
  13005. std::map<std::string, std::string> auth;
  13006. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13007. Request new_req = req;
  13008. new_req.authorization_count_ += 1;
  13009. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13010. : "Authorization");
  13011. new_req.headers.insert(detail::make_digest_authentication_header(
  13012. req, auth, new_req.authorization_count_, detail::random_string(10),
  13013. username, password, is_proxy));
  13014. Response new_res;
  13015. ret = send(new_req, new_res, error);
  13016. if (ret) { res = std::move(new_res); }
  13017. }
  13018. }
  13019. }
  13020. #endif
  13021. return ret;
  13022. }
  13023. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13024. if (req.redirect_count_ == 0) {
  13025. error = Error::ExceedRedirectCount;
  13026. output_error_log(error, &req);
  13027. return false;
  13028. }
  13029. auto location = res.get_header_value("location");
  13030. if (location.empty()) { return false; }
  13031. detail::UrlComponents uc;
  13032. if (!detail::parse_url(location, uc)) { return false; }
  13033. // Only follow http/https redirects
  13034. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13035. return false;
  13036. }
  13037. auto scheme = is_ssl() ? "https" : "http";
  13038. auto next_scheme = std::move(uc.scheme);
  13039. auto next_host = std::move(uc.host);
  13040. auto port_str = std::move(uc.port);
  13041. auto next_path = std::move(uc.path);
  13042. auto next_query = std::move(uc.query);
  13043. auto next_port = port_;
  13044. if (!port_str.empty()) {
  13045. if (!detail::parse_port(port_str, next_port)) { return false; }
  13046. } else if (!next_scheme.empty()) {
  13047. next_port = next_scheme == "https" ? 443 : 80;
  13048. }
  13049. if (next_scheme.empty()) { next_scheme = scheme; }
  13050. if (next_host.empty()) { next_host = host_; }
  13051. if (next_path.empty()) { next_path = "/"; }
  13052. auto path = decode_path_component(next_path) + next_query;
  13053. // Same host redirect - use current client
  13054. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13055. return detail::redirect(*this, req, res, path, location, error);
  13056. }
  13057. // Cross-host/scheme redirect - create new client with robust setup
  13058. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13059. path, location, error);
  13060. }
  13061. // New method for robust redirect client creation
  13062. inline bool ClientImpl::create_redirect_client(
  13063. const std::string &scheme, const std::string &host, int port, Request &req,
  13064. Response &res, const std::string &path, const std::string &location,
  13065. Error &error) {
  13066. // Determine if we need SSL
  13067. auto need_ssl = (scheme == "https");
  13068. // Clean up request headers that are host/client specific
  13069. // Remove headers that should not be carried over to new host
  13070. auto headers_to_remove = std::vector<std::string>{
  13071. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13072. for (const auto &header_name : headers_to_remove) {
  13073. auto it = req.headers.find(header_name);
  13074. while (it != req.headers.end()) {
  13075. it = req.headers.erase(it);
  13076. it = req.headers.find(header_name);
  13077. }
  13078. }
  13079. // Create appropriate client type and handle redirect
  13080. if (need_ssl) {
  13081. #ifdef CPPHTTPLIB_SSL_ENABLED
  13082. // Create SSL client for HTTPS redirect
  13083. SSLClient redirect_client(host, port);
  13084. // Setup basic client configuration first
  13085. setup_redirect_client(redirect_client);
  13086. redirect_client.enable_server_certificate_verification(
  13087. server_certificate_verification_);
  13088. redirect_client.enable_server_hostname_verification(
  13089. server_hostname_verification_);
  13090. redirect_client.system_ca_mode_ = system_ca_mode_;
  13091. // Transfer CA certificate to redirect client
  13092. if (!ca_cert_pem_.empty()) {
  13093. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13094. ca_cert_pem_.size());
  13095. }
  13096. if (!ca_cert_file_path_.empty()) {
  13097. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13098. }
  13099. // Client certificates are set through constructor for SSLClient
  13100. // NOTE: SSLClient constructor already takes client_cert_path and
  13101. // client_key_path so we need to create it properly if client certs are
  13102. // needed
  13103. // Execute the redirect
  13104. return detail::redirect(redirect_client, req, res, path, location, error);
  13105. #else
  13106. // SSL not supported - set appropriate error
  13107. error = Error::SSLConnection;
  13108. output_error_log(error, &req);
  13109. return false;
  13110. #endif
  13111. } else {
  13112. // HTTP redirect
  13113. ClientImpl redirect_client(host, port);
  13114. // Setup client with robust configuration
  13115. setup_redirect_client(redirect_client);
  13116. // Execute the redirect
  13117. return detail::redirect(redirect_client, req, res, path, location, error);
  13118. }
  13119. }
  13120. // New method for robust client setup (based on basic_manual_redirect.cpp
  13121. // logic)
  13122. template <typename ClientType>
  13123. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13124. // Copy basic settings first
  13125. client.set_connection_timeout(connection_timeout_sec_);
  13126. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13127. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13128. client.set_keep_alive(keep_alive_);
  13129. client.set_follow_location(
  13130. true); // Enable redirects to handle multi-step redirects
  13131. client.set_path_encode(path_encode_);
  13132. client.set_compress(compress_);
  13133. client.set_decompress(decompress_);
  13134. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13135. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13136. // 15.4, credentials must not be forwarded when redirecting to a different
  13137. // host. This function is only called for cross-host redirects; same-host
  13138. // redirects are handled directly in ClientImpl::redirect().
  13139. // Copy the proxy configuration unconditionally; the per-target bypass is
  13140. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13141. // still use the proxy.
  13142. client.no_proxy_entries_ = no_proxy_entries_;
  13143. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13144. client.set_proxy(proxy_host_, proxy_port_);
  13145. if (!proxy_basic_auth_username_.empty()) {
  13146. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13147. proxy_basic_auth_password_);
  13148. }
  13149. if (!proxy_bearer_token_auth_token_.empty()) {
  13150. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13151. }
  13152. #ifdef CPPHTTPLIB_SSL_ENABLED
  13153. if (!proxy_digest_auth_username_.empty()) {
  13154. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13155. proxy_digest_auth_password_);
  13156. }
  13157. #endif
  13158. }
  13159. // Copy network and socket settings
  13160. client.set_address_family(address_family_);
  13161. client.set_tcp_nodelay(tcp_nodelay_);
  13162. client.set_ipv6_v6only(ipv6_v6only_);
  13163. if (socket_options_) { client.set_socket_options(socket_options_); }
  13164. if (!interface_.empty()) { client.set_interface(interface_); }
  13165. // Copy logging and headers
  13166. if (logger_) { client.set_logger(logger_); }
  13167. if (error_logger_) { client.set_error_logger(error_logger_); }
  13168. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13169. // Each new client should generate its own headers based on its target host
  13170. }
  13171. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13172. const Request &req,
  13173. Error &error) const {
  13174. auto is_shutting_down = []() { return false; };
  13175. if (req.is_chunked_content_provider_) {
  13176. auto compressor = compress_ ? detail::create_compressor().first
  13177. : std::unique_ptr<detail::compressor>();
  13178. if (!compressor) {
  13179. compressor = detail::make_unique<detail::nocompressor>();
  13180. }
  13181. return detail::write_content_chunked(strm, req.content_provider_,
  13182. is_shutting_down, *compressor, error);
  13183. } else {
  13184. return detail::write_content_with_progress(
  13185. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13186. req.upload_progress, error);
  13187. }
  13188. }
  13189. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13190. bool close_connection, Error &error,
  13191. bool skip_body) {
  13192. // Prepare additional headers
  13193. if (close_connection) {
  13194. if (!req.has_header("Connection")) {
  13195. req.set_header("Connection", "close");
  13196. }
  13197. }
  13198. std::string ct_for_defaults;
  13199. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13200. ct_for_defaults = "text/plain";
  13201. }
  13202. prepare_default_headers(req, false, ct_for_defaults);
  13203. if (req.body.empty()) {
  13204. if (req.content_provider_) {
  13205. if (!req.is_chunked_content_provider_) {
  13206. if (!req.has_header("Content-Length")) {
  13207. auto length = std::to_string(req.content_length_);
  13208. req.set_header("Content-Length", length);
  13209. }
  13210. }
  13211. } else {
  13212. if (req.method == "POST" || req.method == "PUT" ||
  13213. req.method == "PATCH") {
  13214. req.set_header("Content-Length", "0");
  13215. }
  13216. }
  13217. }
  13218. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13219. if (!req.has_header("Authorization")) {
  13220. req.headers.insert(make_basic_authentication_header(
  13221. basic_auth_username_, basic_auth_password_, false));
  13222. }
  13223. }
  13224. if (!bearer_token_auth_token_.empty()) {
  13225. if (!req.has_header("Authorization")) {
  13226. req.headers.insert(make_bearer_token_authentication_header(
  13227. bearer_token_auth_token_, false));
  13228. }
  13229. }
  13230. // Proxy-Authorization is only sent when the proxy is actually used for
  13231. // this target — otherwise NO_PROXY-matched requests would leak proxy
  13232. // credentials directly to the destination server.
  13233. if (is_proxy_enabled_for_host(host_)) {
  13234. if (!proxy_basic_auth_username_.empty() &&
  13235. !proxy_basic_auth_password_.empty() &&
  13236. !req.has_header("Proxy-Authorization")) {
  13237. req.headers.insert(make_basic_authentication_header(
  13238. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13239. }
  13240. if (!proxy_bearer_token_auth_token_.empty() &&
  13241. !req.has_header("Proxy-Authorization")) {
  13242. req.headers.insert(make_bearer_token_authentication_header(
  13243. proxy_bearer_token_auth_token_, true));
  13244. }
  13245. }
  13246. // Request line and headers
  13247. {
  13248. detail::BufferStream bstrm;
  13249. // Extract the query from req.path. The encoding itself is delegated to
  13250. // `encode_request_target`; the raw query is still needed here to decide
  13251. // between populating `req.params` from it and falling back to building a
  13252. // query out of caller-supplied `req.params`.
  13253. auto query_pos = req.path.find('?');
  13254. auto query_part = query_pos == std::string::npos
  13255. ? std::string()
  13256. : req.path.substr(query_pos + 1);
  13257. auto path_with_query =
  13258. detail::encode_request_target(req.path, path_encode_);
  13259. if (!query_part.empty()) {
  13260. // The query already came in through `req.path`; still populate
  13261. // `req.params` for handlers/users who read them.
  13262. detail::parse_query_text(query_part, req.params);
  13263. } else if (!req.params.empty()) {
  13264. // No query in `req.path`; build one from `req.params` so existing
  13265. // callers that pass `Params` separately continue to work.
  13266. path_with_query = append_query_params(path_with_query, req.params);
  13267. }
  13268. // Write request line and headers
  13269. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13270. // A rejected target (e.g. CR/LF smuggled in via a decoded redirect
  13271. // Location under set_path_encode(false)) must fail the request cleanly
  13272. // instead of emitting a request-line-less, header-injecting request.
  13273. error = Error::Write;
  13274. output_error_log(error, &req);
  13275. return false;
  13276. }
  13277. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13278. error)) {
  13279. output_error_log(error, &req);
  13280. return false;
  13281. }
  13282. // Flush buffer
  13283. auto &data = bstrm.get_buffer();
  13284. if (!detail::write_data(strm, data.data(), data.size())) {
  13285. error = Error::Write;
  13286. output_error_log(error, &req);
  13287. return false;
  13288. }
  13289. }
  13290. // After sending request line and headers, wait briefly for an early server
  13291. // response (e.g. 4xx) and avoid sending a potentially large request body
  13292. // unnecessarily. This workaround is only enabled on Windows because Unix
  13293. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13294. // buffering can accept large writes even when the peer already responded.
  13295. // Check the stream first (which covers SSL via `is_readable()`), then
  13296. // fall back to select on the socket. Only perform the wait for very large
  13297. // request bodies to avoid interfering with normal small requests and
  13298. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13299. // response. Skip this check when using Expect: 100-continue, as the protocol
  13300. // handles early responses properly.
  13301. #if defined(_WIN32)
  13302. if (!skip_body &&
  13303. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13304. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13305. auto start = std::chrono::high_resolution_clock::now();
  13306. for (;;) {
  13307. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13308. // from SSL internals. If the underlying socket is readable, assume an
  13309. // early response may be present.
  13310. auto sock = strm.socket();
  13311. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13312. return false;
  13313. }
  13314. // Fallback to stream-level check for non-socket streams or when the
  13315. // socket isn't reporting readable. Avoid using `is_readable()` for
  13316. // SSL, since `SSL_pending()` may report buffered records that do not
  13317. // indicate a complete application-level response yet.
  13318. if (!is_ssl() && strm.is_readable()) { return false; }
  13319. auto now = std::chrono::high_resolution_clock::now();
  13320. auto elapsed =
  13321. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13322. .count();
  13323. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13324. break;
  13325. }
  13326. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13327. }
  13328. }
  13329. #endif
  13330. // Body
  13331. if (skip_body) { return true; }
  13332. return write_request_body(strm, req, error);
  13333. }
  13334. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13335. Error &error) {
  13336. if (req.body.empty()) {
  13337. return write_content_with_provider(strm, req, error);
  13338. }
  13339. if (req.upload_progress) {
  13340. auto body_size = req.body.size();
  13341. size_t written = 0;
  13342. auto data = req.body.data();
  13343. while (written < body_size) {
  13344. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13345. if (!detail::write_data(strm, data + written, to_write)) {
  13346. error = Error::Write;
  13347. output_error_log(error, &req);
  13348. return false;
  13349. }
  13350. written += to_write;
  13351. if (!req.upload_progress(written, body_size)) {
  13352. error = Error::Canceled;
  13353. output_error_log(error, &req);
  13354. return false;
  13355. }
  13356. }
  13357. } else {
  13358. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13359. error = Error::Write;
  13360. output_error_log(error, &req);
  13361. return false;
  13362. }
  13363. }
  13364. return true;
  13365. }
  13366. inline std::unique_ptr<Response>
  13367. ClientImpl::send_with_content_provider_and_receiver(
  13368. Request &req, const char *body, size_t content_length,
  13369. ContentProvider content_provider,
  13370. ContentProviderWithoutLength content_provider_without_length,
  13371. const std::string &content_type, ContentReceiver content_receiver,
  13372. Error &error) {
  13373. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13374. auto enc = compress_
  13375. ? detail::create_compressor()
  13376. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13377. nullptr, nullptr);
  13378. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13379. if (enc.first && !content_provider_without_length) {
  13380. auto &compressor = enc.first;
  13381. if (content_provider) {
  13382. auto ok = true;
  13383. auto finished = false;
  13384. size_t offset = 0;
  13385. DataSink data_sink;
  13386. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13387. if (ok) {
  13388. auto last = offset + data_len == content_length;
  13389. auto ret = compressor->compress(
  13390. data, data_len, last,
  13391. [&](const char *compressed_data, size_t compressed_data_len) {
  13392. req.body.append(compressed_data, compressed_data_len);
  13393. return true;
  13394. });
  13395. if (ret) {
  13396. offset += data_len;
  13397. } else {
  13398. ok = false;
  13399. }
  13400. }
  13401. return ok;
  13402. };
  13403. // As in detail::write_content_with_progress(): the body is framed by
  13404. // content_length, so a provider that finishes early has truncated it.
  13405. // Stop and report that instead of calling the provider forever.
  13406. data_sink.done = [&]() { finished = true; };
  13407. while (ok && !finished && offset < content_length) {
  13408. if (!content_provider(offset, content_length - offset, data_sink)) {
  13409. error = Error::Canceled;
  13410. output_error_log(error, &req);
  13411. return nullptr;
  13412. }
  13413. }
  13414. // A short body here means either the provider stopped early or the
  13415. // compressor gave up. The branch below reports a failing compressor as
  13416. // Error::Compression, so keep the two distinguishable.
  13417. if (offset < content_length) {
  13418. error = ok ? Error::Write : Error::Compression;
  13419. output_error_log(error, &req);
  13420. return nullptr;
  13421. }
  13422. } else {
  13423. if (!compressor->compress(body, content_length, true,
  13424. [&](const char *data, size_t data_len) {
  13425. req.body.append(data, data_len);
  13426. return true;
  13427. })) {
  13428. error = Error::Compression;
  13429. output_error_log(error, &req);
  13430. return nullptr;
  13431. }
  13432. }
  13433. } else {
  13434. if (content_provider) {
  13435. req.content_length_ = content_length;
  13436. req.content_provider_ = std::move(content_provider);
  13437. req.is_chunked_content_provider_ = false;
  13438. } else if (content_provider_without_length) {
  13439. req.content_length_ = 0;
  13440. req.content_provider_ = detail::ContentProviderAdapter(
  13441. std::move(content_provider_without_length));
  13442. req.is_chunked_content_provider_ = true;
  13443. req.set_header("Transfer-Encoding", "chunked");
  13444. } else {
  13445. req.body.assign(body, content_length);
  13446. }
  13447. }
  13448. if (content_receiver) {
  13449. req.content_receiver =
  13450. [content_receiver](const char *data, size_t data_length,
  13451. size_t /*offset*/, size_t /*total_length*/) {
  13452. return content_receiver(data, data_length);
  13453. };
  13454. }
  13455. auto res = detail::make_unique<Response>();
  13456. return send(req, *res, error) ? std::move(res) : nullptr;
  13457. }
  13458. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13459. const std::string &method, const std::string &path, const Headers &headers,
  13460. const char *body, size_t content_length, ContentProvider content_provider,
  13461. ContentProviderWithoutLength content_provider_without_length,
  13462. const std::string &content_type, ContentReceiver content_receiver,
  13463. UploadProgress progress) {
  13464. Request req;
  13465. req.method = method;
  13466. req.headers = headers;
  13467. req.path = path;
  13468. req.upload_progress = std::move(progress);
  13469. if (max_timeout_msec_ > 0) {
  13470. req.start_time_ = std::chrono::steady_clock::now();
  13471. }
  13472. auto error = Error::Success;
  13473. auto res = send_with_content_provider_and_receiver(
  13474. req, body, content_length, std::move(content_provider),
  13475. std::move(content_provider_without_length), content_type,
  13476. std::move(content_receiver), error);
  13477. #ifdef CPPHTTPLIB_SSL_ENABLED
  13478. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13479. last_backend_error_};
  13480. #else
  13481. return Result{std::move(res), error, std::move(req.headers)};
  13482. #endif
  13483. }
  13484. inline void ClientImpl::output_log(const Request &req,
  13485. const Response &res) const {
  13486. if (logger_) {
  13487. std::lock_guard<std::mutex> guard(logger_mutex_);
  13488. logger_(req, res);
  13489. }
  13490. }
  13491. inline void ClientImpl::output_error_log(const Error &err,
  13492. const Request *req) const {
  13493. if (error_logger_) {
  13494. std::lock_guard<std::mutex> guard(logger_mutex_);
  13495. error_logger_(err, req);
  13496. }
  13497. }
  13498. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13499. Response &res, bool close_connection,
  13500. Error &error) {
  13501. // Auto-add Expect: 100-continue for large bodies
  13502. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13503. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13504. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13505. req.set_header("Expect", "100-continue");
  13506. }
  13507. }
  13508. // Check for Expect: 100-continue
  13509. auto expect_100_continue =
  13510. detail::has_header_token(req.headers, "Expect", "100-continue");
  13511. // Send request (skip body if using Expect: 100-continue)
  13512. auto write_request_success =
  13513. write_request(strm, req, close_connection, error, expect_100_continue);
  13514. #ifdef CPPHTTPLIB_SSL_ENABLED
  13515. if (is_ssl() && !expect_100_continue) {
  13516. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13517. if (!is_proxy_enabled) {
  13518. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13519. error = Error::SSLPeerCouldBeClosed_;
  13520. output_error_log(error, &req);
  13521. return false;
  13522. }
  13523. }
  13524. }
  13525. #endif
  13526. // Handle Expect: 100-continue.
  13527. //
  13528. // Wait for an interim/early response by attempting to read the status line
  13529. // under a short timeout, instead of trusting raw socket readability. Over
  13530. // TLS, post-handshake records (e.g. session tickets) make the socket
  13531. // readable without any HTTP response being available; relying on
  13532. // `select_read` there caused the body to be withheld forever and the
  13533. // request to fail with `Read` (#2458). If no status line arrives within the
  13534. // timeout, send the body anyway (matching curl's behavior).
  13535. auto status_line_read = false;
  13536. if (expect_100_continue && write_request_success) {
  13537. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13538. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13539. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13540. strm.set_read_timeout(sec, usec);
  13541. status_line_read = read_response_line(strm, req, res, false);
  13542. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13543. }
  13544. if (!status_line_read) {
  13545. // No interim response within the timeout: send the body and handle the
  13546. // response as usual.
  13547. if (!write_request_body(strm, req, error)) { return false; }
  13548. expect_100_continue = false; // Switch to normal response handling
  13549. }
  13550. }
  13551. // Receive response and headers
  13552. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13553. if ((!status_line_read &&
  13554. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13555. !detail::read_headers(strm, res.headers)) {
  13556. if (write_request_success) { error = Error::Read; }
  13557. output_error_log(error, &req);
  13558. return false;
  13559. }
  13560. if (!write_request_success) { return false; }
  13561. // Handle Expect: 100-continue response
  13562. if (expect_100_continue) {
  13563. if (res.status == StatusCode::Continue_100) {
  13564. // Server accepted, send the body
  13565. if (!write_request_body(strm, req, error)) { return false; }
  13566. // Read the actual response
  13567. res.headers.clear();
  13568. res.body.clear();
  13569. if (!read_response_line(strm, req, res) ||
  13570. !detail::read_headers(strm, res.headers)) {
  13571. error = Error::Read;
  13572. output_error_log(error, &req);
  13573. return false;
  13574. }
  13575. }
  13576. // If not 100 Continue, server returned an error; proceed with that response
  13577. }
  13578. // Body
  13579. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13580. req.method != "CONNECT") {
  13581. auto redirect = 300 < res.status && res.status < 400 &&
  13582. res.status != StatusCode::NotModified_304 &&
  13583. follow_location_;
  13584. if (req.response_handler && !redirect) {
  13585. if (!req.response_handler(res)) {
  13586. error = Error::Canceled;
  13587. output_error_log(error, &req);
  13588. return false;
  13589. }
  13590. }
  13591. auto out =
  13592. req.content_receiver
  13593. ? static_cast<ContentReceiverWithProgress>(
  13594. [&](const char *buf, size_t n, size_t off, size_t len) {
  13595. if (redirect) { return true; }
  13596. auto ret = req.content_receiver(buf, n, off, len);
  13597. if (!ret) {
  13598. error = Error::Canceled;
  13599. output_error_log(error, &req);
  13600. }
  13601. return ret;
  13602. })
  13603. : static_cast<ContentReceiverWithProgress>(
  13604. [&](const char *buf, size_t n, size_t /*off*/,
  13605. size_t /*len*/) {
  13606. assert(res.body.size() + n <= res.body.max_size());
  13607. if (payload_max_length_ > 0 &&
  13608. (res.body.size() >= payload_max_length_ ||
  13609. n > payload_max_length_ - res.body.size())) {
  13610. return false;
  13611. }
  13612. res.body.append(buf, n);
  13613. return true;
  13614. });
  13615. auto progress = [&](size_t current, size_t total) {
  13616. if (!req.download_progress || redirect) { return true; }
  13617. auto ret = req.download_progress(current, total);
  13618. if (!ret) {
  13619. error = Error::Canceled;
  13620. output_error_log(error, &req);
  13621. }
  13622. return ret;
  13623. };
  13624. if (res.has_header("Content-Length")) {
  13625. if (!req.content_receiver) {
  13626. auto len = res.get_header_value_u64("Content-Length");
  13627. if (len > res.body.max_size()) {
  13628. error = Error::Read;
  13629. output_error_log(error, &req);
  13630. return false;
  13631. }
  13632. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13633. // hostile or malformed server sends an enormous Content-Length.
  13634. // The actual body read below is bounded by payload_max_length_,
  13635. // so reserving more than that is never useful.
  13636. auto reserve_len = static_cast<size_t>(len);
  13637. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13638. reserve_len = payload_max_length_;
  13639. }
  13640. res.body.reserve(reserve_len);
  13641. }
  13642. }
  13643. if (res.status != StatusCode::NotModified_304) {
  13644. auto content_status = 0;
  13645. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13646. ? (std::numeric_limits<size_t>::max)()
  13647. : payload_max_length_;
  13648. if (!detail::read_content(strm, res, max_length, content_status,
  13649. std::move(progress), std::move(out),
  13650. decompress_)) {
  13651. if (error != Error::Canceled) {
  13652. // Tell the caller apart from a plain read failure when the body could
  13653. // not be decoded because of its Content-Encoding.
  13654. switch (content_status) {
  13655. case StatusCode::UnsupportedMediaType_415:
  13656. error = Error::UnsupportedContentEncoding;
  13657. break;
  13658. case StatusCode::InternalServerError_500:
  13659. error = Error::Compression;
  13660. break;
  13661. default: error = Error::Read; break;
  13662. }
  13663. }
  13664. output_error_log(error, &req);
  13665. return false;
  13666. }
  13667. }
  13668. }
  13669. // Log
  13670. output_log(req, res);
  13671. return true;
  13672. }
  13673. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13674. const std::string &boundary, const UploadFormDataItems &items,
  13675. const FormDataProviderItems &provider_items) const {
  13676. size_t cur_item = 0;
  13677. size_t cur_start = 0;
  13678. // cur_item and cur_start are copied to within the std::function and
  13679. // maintain state between successive calls
  13680. return [&, cur_item, cur_start](size_t offset,
  13681. DataSink &sink) mutable -> bool {
  13682. if (!offset && !items.empty()) {
  13683. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13684. return true;
  13685. } else if (cur_item < provider_items.size()) {
  13686. if (!cur_start) {
  13687. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13688. provider_items[cur_item], boundary);
  13689. offset += begin.size();
  13690. cur_start = offset;
  13691. sink.os << begin;
  13692. }
  13693. DataSink cur_sink;
  13694. auto has_data = true;
  13695. cur_sink.write = sink.write;
  13696. // Forward is_writable so a provider item asking whether it may keep
  13697. // going gets the outer sink's answer rather than the default `true`.
  13698. cur_sink.is_writable = sink.is_writable;
  13699. cur_sink.done = [&]() { has_data = false; };
  13700. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13701. return false;
  13702. }
  13703. if (!has_data) {
  13704. sink.os << detail::serialize_multipart_formdata_item_end();
  13705. cur_item++;
  13706. cur_start = 0;
  13707. }
  13708. return true;
  13709. } else {
  13710. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13711. sink.done();
  13712. return true;
  13713. }
  13714. };
  13715. }
  13716. inline bool ClientImpl::process_socket(
  13717. const Socket &socket,
  13718. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13719. std::function<bool(Stream &strm)> callback) {
  13720. return detail::process_client_socket(
  13721. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13722. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13723. }
  13724. inline bool ClientImpl::is_ssl() const { return false; }
  13725. inline Result ClientImpl::Get(const std::string &path,
  13726. DownloadProgress progress) {
  13727. return Get(path, Headers(), std::move(progress));
  13728. }
  13729. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13730. DownloadProgress progress) {
  13731. return Get(path, params, Headers(), std::move(progress));
  13732. }
  13733. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13734. const Headers &headers,
  13735. DownloadProgress progress) {
  13736. if (params.empty()) { return Get(path, headers); }
  13737. std::string path_with_query = append_query_params(path, params);
  13738. return Get(path_with_query, headers, std::move(progress));
  13739. }
  13740. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13741. DownloadProgress progress) {
  13742. Request req;
  13743. req.method = "GET";
  13744. req.path = path;
  13745. req.headers = headers;
  13746. req.download_progress = std::move(progress);
  13747. if (max_timeout_msec_ > 0) {
  13748. req.start_time_ = std::chrono::steady_clock::now();
  13749. }
  13750. return send_(std::move(req));
  13751. }
  13752. inline Result ClientImpl::Get(const std::string &path,
  13753. ContentReceiver content_receiver,
  13754. DownloadProgress progress) {
  13755. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13756. std::move(progress));
  13757. }
  13758. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13759. ContentReceiver content_receiver,
  13760. DownloadProgress progress) {
  13761. return Get(path, headers, nullptr, std::move(content_receiver),
  13762. std::move(progress));
  13763. }
  13764. inline Result ClientImpl::Get(const std::string &path,
  13765. ResponseHandler response_handler,
  13766. ContentReceiver content_receiver,
  13767. DownloadProgress progress) {
  13768. return Get(path, Headers(), std::move(response_handler),
  13769. std::move(content_receiver), std::move(progress));
  13770. }
  13771. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13772. ResponseHandler response_handler,
  13773. ContentReceiver content_receiver,
  13774. DownloadProgress progress) {
  13775. Request req;
  13776. req.method = "GET";
  13777. req.path = path;
  13778. req.headers = headers;
  13779. req.response_handler = std::move(response_handler);
  13780. req.content_receiver =
  13781. [content_receiver](const char *data, size_t data_length,
  13782. size_t /*offset*/, size_t /*total_length*/) {
  13783. return content_receiver(data, data_length);
  13784. };
  13785. req.download_progress = std::move(progress);
  13786. if (max_timeout_msec_ > 0) {
  13787. req.start_time_ = std::chrono::steady_clock::now();
  13788. }
  13789. return send_(std::move(req));
  13790. }
  13791. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13792. const Headers &headers,
  13793. ContentReceiver content_receiver,
  13794. DownloadProgress progress) {
  13795. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13796. std::move(progress));
  13797. }
  13798. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13799. const Headers &headers,
  13800. ResponseHandler response_handler,
  13801. ContentReceiver content_receiver,
  13802. DownloadProgress progress) {
  13803. if (params.empty()) {
  13804. return Get(path, headers, std::move(response_handler),
  13805. std::move(content_receiver), std::move(progress));
  13806. }
  13807. std::string path_with_query = append_query_params(path, params);
  13808. return Get(path_with_query, headers, std::move(response_handler),
  13809. std::move(content_receiver), std::move(progress));
  13810. }
  13811. inline Result ClientImpl::Head(const std::string &path) {
  13812. return Head(path, Headers());
  13813. }
  13814. inline Result ClientImpl::Head(const std::string &path,
  13815. const Headers &headers) {
  13816. Request req;
  13817. req.method = "HEAD";
  13818. req.headers = headers;
  13819. req.path = path;
  13820. if (max_timeout_msec_ > 0) {
  13821. req.start_time_ = std::chrono::steady_clock::now();
  13822. }
  13823. return send_(std::move(req));
  13824. }
  13825. inline Result ClientImpl::Post(const std::string &path) {
  13826. return Post(path, std::string(), std::string());
  13827. }
  13828. inline Result ClientImpl::Post(const std::string &path,
  13829. const Headers &headers) {
  13830. return Post(path, headers, nullptr, 0, std::string());
  13831. }
  13832. inline Result ClientImpl::Post(const std::string &path, const char *body,
  13833. size_t content_length,
  13834. const std::string &content_type,
  13835. UploadProgress progress) {
  13836. return Post(path, Headers(), body, content_length, content_type, progress);
  13837. }
  13838. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  13839. const std::string &content_type,
  13840. UploadProgress progress) {
  13841. return Post(path, Headers(), body, content_type, progress);
  13842. }
  13843. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  13844. return Post(path, Headers(), params);
  13845. }
  13846. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13847. ContentProvider content_provider,
  13848. const std::string &content_type,
  13849. UploadProgress progress) {
  13850. return Post(path, Headers(), content_length, std::move(content_provider),
  13851. content_type, progress);
  13852. }
  13853. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13854. ContentProvider content_provider,
  13855. const std::string &content_type,
  13856. ContentReceiver content_receiver,
  13857. UploadProgress progress) {
  13858. return Post(path, Headers(), content_length, std::move(content_provider),
  13859. content_type, std::move(content_receiver), progress);
  13860. }
  13861. inline Result ClientImpl::Post(const std::string &path,
  13862. ContentProviderWithoutLength content_provider,
  13863. const std::string &content_type,
  13864. UploadProgress progress) {
  13865. return Post(path, Headers(), std::move(content_provider), content_type,
  13866. progress);
  13867. }
  13868. inline Result ClientImpl::Post(const std::string &path,
  13869. ContentProviderWithoutLength content_provider,
  13870. const std::string &content_type,
  13871. ContentReceiver content_receiver,
  13872. UploadProgress progress) {
  13873. return Post(path, Headers(), std::move(content_provider), content_type,
  13874. std::move(content_receiver), progress);
  13875. }
  13876. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13877. const Params &params) {
  13878. auto query = detail::params_to_query_str(params);
  13879. return Post(path, headers, query, "application/x-www-form-urlencoded");
  13880. }
  13881. inline Result ClientImpl::Post(const std::string &path,
  13882. const UploadFormDataItems &items,
  13883. UploadProgress progress) {
  13884. return Post(path, Headers(), items, progress);
  13885. }
  13886. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13887. const UploadFormDataItems &items,
  13888. UploadProgress progress) {
  13889. const auto &boundary = detail::make_multipart_data_boundary();
  13890. const auto &content_type =
  13891. detail::serialize_multipart_formdata_get_content_type(boundary);
  13892. auto content_length = detail::get_multipart_content_length(items, boundary);
  13893. return Post(path, headers, content_length,
  13894. detail::make_multipart_content_provider(items, boundary),
  13895. content_type, progress);
  13896. }
  13897. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13898. const UploadFormDataItems &items,
  13899. const std::string &boundary,
  13900. UploadProgress progress) {
  13901. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13902. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13903. }
  13904. const auto &content_type =
  13905. detail::serialize_multipart_formdata_get_content_type(boundary);
  13906. auto content_length = detail::get_multipart_content_length(items, boundary);
  13907. return Post(path, headers, content_length,
  13908. detail::make_multipart_content_provider(items, boundary),
  13909. content_type, progress);
  13910. }
  13911. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13912. const char *body, size_t content_length,
  13913. const std::string &content_type,
  13914. UploadProgress progress) {
  13915. return send_with_content_provider_and_receiver(
  13916. "POST", path, headers, body, content_length, nullptr, nullptr,
  13917. content_type, nullptr, progress);
  13918. }
  13919. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13920. const std::string &body,
  13921. const std::string &content_type,
  13922. UploadProgress progress) {
  13923. return send_with_content_provider_and_receiver(
  13924. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  13925. content_type, nullptr, progress);
  13926. }
  13927. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13928. size_t content_length,
  13929. ContentProvider content_provider,
  13930. const std::string &content_type,
  13931. UploadProgress progress) {
  13932. return send_with_content_provider_and_receiver(
  13933. "POST", path, headers, nullptr, content_length,
  13934. std::move(content_provider), nullptr, content_type, nullptr, progress);
  13935. }
  13936. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13937. size_t content_length,
  13938. ContentProvider content_provider,
  13939. const std::string &content_type,
  13940. ContentReceiver content_receiver,
  13941. DownloadProgress progress) {
  13942. return send_with_content_provider_and_receiver(
  13943. "POST", path, headers, nullptr, content_length,
  13944. std::move(content_provider), nullptr, content_type,
  13945. std::move(content_receiver), std::move(progress));
  13946. }
  13947. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13948. ContentProviderWithoutLength content_provider,
  13949. const std::string &content_type,
  13950. UploadProgress progress) {
  13951. return send_with_content_provider_and_receiver(
  13952. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13953. content_type, nullptr, progress);
  13954. }
  13955. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13956. ContentProviderWithoutLength content_provider,
  13957. const std::string &content_type,
  13958. ContentReceiver content_receiver,
  13959. DownloadProgress progress) {
  13960. return send_with_content_provider_and_receiver(
  13961. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13962. content_type, std::move(content_receiver), std::move(progress));
  13963. }
  13964. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13965. const UploadFormDataItems &items,
  13966. const FormDataProviderItems &provider_items,
  13967. UploadProgress progress) {
  13968. const auto &boundary = detail::make_multipart_data_boundary();
  13969. const auto &content_type =
  13970. detail::serialize_multipart_formdata_get_content_type(boundary);
  13971. return send_with_content_provider_and_receiver(
  13972. "POST", path, headers, nullptr, 0, nullptr,
  13973. get_multipart_content_provider(boundary, items, provider_items),
  13974. content_type, nullptr, progress);
  13975. }
  13976. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13977. const std::string &body,
  13978. const std::string &content_type,
  13979. ContentReceiver content_receiver,
  13980. DownloadProgress progress) {
  13981. Request req;
  13982. req.method = "POST";
  13983. req.path = path;
  13984. req.headers = headers;
  13985. req.body = body;
  13986. req.content_receiver =
  13987. [content_receiver](const char *data, size_t data_length,
  13988. size_t /*offset*/, size_t /*total_length*/) {
  13989. return content_receiver(data, data_length);
  13990. };
  13991. req.download_progress = std::move(progress);
  13992. if (max_timeout_msec_ > 0) {
  13993. req.start_time_ = std::chrono::steady_clock::now();
  13994. }
  13995. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13996. return send_(std::move(req));
  13997. }
  13998. inline Result ClientImpl::Put(const std::string &path) {
  13999. return Put(path, std::string(), std::string());
  14000. }
  14001. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14002. return Put(path, headers, nullptr, 0, std::string());
  14003. }
  14004. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14005. size_t content_length,
  14006. const std::string &content_type,
  14007. UploadProgress progress) {
  14008. return Put(path, Headers(), body, content_length, content_type, progress);
  14009. }
  14010. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14011. const std::string &content_type,
  14012. UploadProgress progress) {
  14013. return Put(path, Headers(), body, content_type, progress);
  14014. }
  14015. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14016. return Put(path, Headers(), params);
  14017. }
  14018. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14019. ContentProvider content_provider,
  14020. const std::string &content_type,
  14021. UploadProgress progress) {
  14022. return Put(path, Headers(), content_length, std::move(content_provider),
  14023. content_type, progress);
  14024. }
  14025. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14026. ContentProvider content_provider,
  14027. const std::string &content_type,
  14028. ContentReceiver content_receiver,
  14029. UploadProgress progress) {
  14030. return Put(path, Headers(), content_length, std::move(content_provider),
  14031. content_type, std::move(content_receiver), progress);
  14032. }
  14033. inline Result ClientImpl::Put(const std::string &path,
  14034. ContentProviderWithoutLength content_provider,
  14035. const std::string &content_type,
  14036. UploadProgress progress) {
  14037. return Put(path, Headers(), std::move(content_provider), content_type,
  14038. progress);
  14039. }
  14040. inline Result ClientImpl::Put(const std::string &path,
  14041. ContentProviderWithoutLength content_provider,
  14042. const std::string &content_type,
  14043. ContentReceiver content_receiver,
  14044. UploadProgress progress) {
  14045. return Put(path, Headers(), std::move(content_provider), content_type,
  14046. std::move(content_receiver), progress);
  14047. }
  14048. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14049. const Params &params) {
  14050. auto query = detail::params_to_query_str(params);
  14051. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14052. }
  14053. inline Result ClientImpl::Put(const std::string &path,
  14054. const UploadFormDataItems &items,
  14055. UploadProgress progress) {
  14056. return Put(path, Headers(), items, progress);
  14057. }
  14058. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14059. const UploadFormDataItems &items,
  14060. UploadProgress progress) {
  14061. const auto &boundary = detail::make_multipart_data_boundary();
  14062. const auto &content_type =
  14063. detail::serialize_multipart_formdata_get_content_type(boundary);
  14064. auto content_length = detail::get_multipart_content_length(items, boundary);
  14065. return Put(path, headers, content_length,
  14066. detail::make_multipart_content_provider(items, boundary),
  14067. content_type, progress);
  14068. }
  14069. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14070. const UploadFormDataItems &items,
  14071. const std::string &boundary,
  14072. UploadProgress progress) {
  14073. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14074. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14075. }
  14076. const auto &content_type =
  14077. detail::serialize_multipart_formdata_get_content_type(boundary);
  14078. auto content_length = detail::get_multipart_content_length(items, boundary);
  14079. return Put(path, headers, content_length,
  14080. detail::make_multipart_content_provider(items, boundary),
  14081. content_type, progress);
  14082. }
  14083. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14084. const char *body, size_t content_length,
  14085. const std::string &content_type,
  14086. UploadProgress progress) {
  14087. return send_with_content_provider_and_receiver(
  14088. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14089. content_type, nullptr, progress);
  14090. }
  14091. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14092. const std::string &body,
  14093. const std::string &content_type,
  14094. UploadProgress progress) {
  14095. return send_with_content_provider_and_receiver(
  14096. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14097. content_type, nullptr, progress);
  14098. }
  14099. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14100. size_t content_length,
  14101. ContentProvider content_provider,
  14102. const std::string &content_type,
  14103. UploadProgress progress) {
  14104. return send_with_content_provider_and_receiver(
  14105. "PUT", path, headers, nullptr, content_length,
  14106. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14107. }
  14108. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14109. size_t content_length,
  14110. ContentProvider content_provider,
  14111. const std::string &content_type,
  14112. ContentReceiver content_receiver,
  14113. UploadProgress progress) {
  14114. return send_with_content_provider_and_receiver(
  14115. "PUT", path, headers, nullptr, content_length,
  14116. std::move(content_provider), nullptr, content_type,
  14117. std::move(content_receiver), progress);
  14118. }
  14119. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14120. ContentProviderWithoutLength content_provider,
  14121. const std::string &content_type,
  14122. UploadProgress progress) {
  14123. return send_with_content_provider_and_receiver(
  14124. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14125. content_type, nullptr, progress);
  14126. }
  14127. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14128. ContentProviderWithoutLength content_provider,
  14129. const std::string &content_type,
  14130. ContentReceiver content_receiver,
  14131. UploadProgress progress) {
  14132. return send_with_content_provider_and_receiver(
  14133. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14134. content_type, std::move(content_receiver), progress);
  14135. }
  14136. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14137. const UploadFormDataItems &items,
  14138. const FormDataProviderItems &provider_items,
  14139. UploadProgress progress) {
  14140. const auto &boundary = detail::make_multipart_data_boundary();
  14141. const auto &content_type =
  14142. detail::serialize_multipart_formdata_get_content_type(boundary);
  14143. return send_with_content_provider_and_receiver(
  14144. "PUT", path, headers, nullptr, 0, nullptr,
  14145. get_multipart_content_provider(boundary, items, provider_items),
  14146. content_type, nullptr, progress);
  14147. }
  14148. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14149. const std::string &body,
  14150. const std::string &content_type,
  14151. ContentReceiver content_receiver,
  14152. DownloadProgress progress) {
  14153. Request req;
  14154. req.method = "PUT";
  14155. req.path = path;
  14156. req.headers = headers;
  14157. req.body = body;
  14158. req.content_receiver =
  14159. [content_receiver](const char *data, size_t data_length,
  14160. size_t /*offset*/, size_t /*total_length*/) {
  14161. return content_receiver(data, data_length);
  14162. };
  14163. req.download_progress = std::move(progress);
  14164. if (max_timeout_msec_ > 0) {
  14165. req.start_time_ = std::chrono::steady_clock::now();
  14166. }
  14167. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14168. return send_(std::move(req));
  14169. }
  14170. inline Result ClientImpl::Patch(const std::string &path) {
  14171. return Patch(path, std::string(), std::string());
  14172. }
  14173. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14174. UploadProgress progress) {
  14175. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14176. }
  14177. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14178. size_t content_length,
  14179. const std::string &content_type,
  14180. UploadProgress progress) {
  14181. return Patch(path, Headers(), body, content_length, content_type, progress);
  14182. }
  14183. inline Result ClientImpl::Patch(const std::string &path,
  14184. const std::string &body,
  14185. const std::string &content_type,
  14186. UploadProgress progress) {
  14187. return Patch(path, Headers(), body, content_type, progress);
  14188. }
  14189. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14190. return Patch(path, Headers(), params);
  14191. }
  14192. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14193. ContentProvider content_provider,
  14194. const std::string &content_type,
  14195. UploadProgress progress) {
  14196. return Patch(path, Headers(), content_length, std::move(content_provider),
  14197. content_type, progress);
  14198. }
  14199. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14200. ContentProvider content_provider,
  14201. const std::string &content_type,
  14202. ContentReceiver content_receiver,
  14203. UploadProgress progress) {
  14204. return Patch(path, Headers(), content_length, std::move(content_provider),
  14205. content_type, std::move(content_receiver), progress);
  14206. }
  14207. inline Result ClientImpl::Patch(const std::string &path,
  14208. ContentProviderWithoutLength content_provider,
  14209. const std::string &content_type,
  14210. UploadProgress progress) {
  14211. return Patch(path, Headers(), std::move(content_provider), content_type,
  14212. progress);
  14213. }
  14214. inline Result ClientImpl::Patch(const std::string &path,
  14215. ContentProviderWithoutLength content_provider,
  14216. const std::string &content_type,
  14217. ContentReceiver content_receiver,
  14218. UploadProgress progress) {
  14219. return Patch(path, Headers(), std::move(content_provider), content_type,
  14220. std::move(content_receiver), progress);
  14221. }
  14222. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14223. const Params &params) {
  14224. auto query = detail::params_to_query_str(params);
  14225. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14226. }
  14227. inline Result ClientImpl::Patch(const std::string &path,
  14228. const UploadFormDataItems &items,
  14229. UploadProgress progress) {
  14230. return Patch(path, Headers(), items, progress);
  14231. }
  14232. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14233. const UploadFormDataItems &items,
  14234. UploadProgress progress) {
  14235. const auto &boundary = detail::make_multipart_data_boundary();
  14236. const auto &content_type =
  14237. detail::serialize_multipart_formdata_get_content_type(boundary);
  14238. auto content_length = detail::get_multipart_content_length(items, boundary);
  14239. return Patch(path, headers, content_length,
  14240. detail::make_multipart_content_provider(items, boundary),
  14241. content_type, progress);
  14242. }
  14243. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14244. const UploadFormDataItems &items,
  14245. const std::string &boundary,
  14246. UploadProgress progress) {
  14247. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14248. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14249. }
  14250. const auto &content_type =
  14251. detail::serialize_multipart_formdata_get_content_type(boundary);
  14252. auto content_length = detail::get_multipart_content_length(items, boundary);
  14253. return Patch(path, headers, content_length,
  14254. detail::make_multipart_content_provider(items, boundary),
  14255. content_type, progress);
  14256. }
  14257. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14258. const char *body, size_t content_length,
  14259. const std::string &content_type,
  14260. UploadProgress progress) {
  14261. return send_with_content_provider_and_receiver(
  14262. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14263. content_type, nullptr, progress);
  14264. }
  14265. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14266. const std::string &body,
  14267. const std::string &content_type,
  14268. UploadProgress progress) {
  14269. return send_with_content_provider_and_receiver(
  14270. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14271. content_type, nullptr, progress);
  14272. }
  14273. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14274. size_t content_length,
  14275. ContentProvider content_provider,
  14276. const std::string &content_type,
  14277. UploadProgress progress) {
  14278. return send_with_content_provider_and_receiver(
  14279. "PATCH", path, headers, nullptr, content_length,
  14280. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14281. }
  14282. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14283. size_t content_length,
  14284. ContentProvider content_provider,
  14285. const std::string &content_type,
  14286. ContentReceiver content_receiver,
  14287. UploadProgress progress) {
  14288. return send_with_content_provider_and_receiver(
  14289. "PATCH", path, headers, nullptr, content_length,
  14290. std::move(content_provider), nullptr, content_type,
  14291. std::move(content_receiver), progress);
  14292. }
  14293. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14294. ContentProviderWithoutLength content_provider,
  14295. const std::string &content_type,
  14296. UploadProgress progress) {
  14297. return send_with_content_provider_and_receiver(
  14298. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14299. content_type, nullptr, progress);
  14300. }
  14301. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14302. ContentProviderWithoutLength content_provider,
  14303. const std::string &content_type,
  14304. ContentReceiver content_receiver,
  14305. UploadProgress progress) {
  14306. return send_with_content_provider_and_receiver(
  14307. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14308. content_type, std::move(content_receiver), progress);
  14309. }
  14310. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14311. const UploadFormDataItems &items,
  14312. const FormDataProviderItems &provider_items,
  14313. UploadProgress progress) {
  14314. const auto &boundary = detail::make_multipart_data_boundary();
  14315. const auto &content_type =
  14316. detail::serialize_multipart_formdata_get_content_type(boundary);
  14317. return send_with_content_provider_and_receiver(
  14318. "PATCH", path, headers, nullptr, 0, nullptr,
  14319. get_multipart_content_provider(boundary, items, provider_items),
  14320. content_type, nullptr, progress);
  14321. }
  14322. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14323. const std::string &body,
  14324. const std::string &content_type,
  14325. ContentReceiver content_receiver,
  14326. DownloadProgress progress) {
  14327. Request req;
  14328. req.method = "PATCH";
  14329. req.path = path;
  14330. req.headers = headers;
  14331. req.body = body;
  14332. req.content_receiver =
  14333. [content_receiver](const char *data, size_t data_length,
  14334. size_t /*offset*/, size_t /*total_length*/) {
  14335. return content_receiver(data, data_length);
  14336. };
  14337. req.download_progress = std::move(progress);
  14338. if (max_timeout_msec_ > 0) {
  14339. req.start_time_ = std::chrono::steady_clock::now();
  14340. }
  14341. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14342. return send_(std::move(req));
  14343. }
  14344. inline Result ClientImpl::Delete(const std::string &path,
  14345. DownloadProgress progress) {
  14346. return Delete(path, Headers(), std::string(), std::string(), progress);
  14347. }
  14348. inline Result ClientImpl::Delete(const std::string &path,
  14349. const Headers &headers,
  14350. DownloadProgress progress) {
  14351. return Delete(path, headers, std::string(), std::string(), progress);
  14352. }
  14353. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14354. size_t content_length,
  14355. const std::string &content_type,
  14356. DownloadProgress progress) {
  14357. return Delete(path, Headers(), body, content_length, content_type, progress);
  14358. }
  14359. inline Result ClientImpl::Delete(const std::string &path,
  14360. const std::string &body,
  14361. const std::string &content_type,
  14362. DownloadProgress progress) {
  14363. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14364. progress);
  14365. }
  14366. inline Result ClientImpl::Delete(const std::string &path,
  14367. const Headers &headers,
  14368. const std::string &body,
  14369. const std::string &content_type,
  14370. DownloadProgress progress) {
  14371. return Delete(path, headers, body.data(), body.size(), content_type,
  14372. progress);
  14373. }
  14374. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14375. DownloadProgress progress) {
  14376. return Delete(path, Headers(), params, progress);
  14377. }
  14378. inline Result ClientImpl::Delete(const std::string &path,
  14379. const Headers &headers, const Params &params,
  14380. DownloadProgress progress) {
  14381. auto query = detail::params_to_query_str(params);
  14382. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14383. progress);
  14384. }
  14385. inline Result ClientImpl::Delete(const std::string &path,
  14386. const Headers &headers, const char *body,
  14387. size_t content_length,
  14388. const std::string &content_type,
  14389. DownloadProgress progress) {
  14390. Request req;
  14391. req.method = "DELETE";
  14392. req.headers = headers;
  14393. req.path = path;
  14394. req.download_progress = std::move(progress);
  14395. if (max_timeout_msec_ > 0) {
  14396. req.start_time_ = std::chrono::steady_clock::now();
  14397. }
  14398. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14399. req.body.assign(body, content_length);
  14400. return send_(std::move(req));
  14401. }
  14402. inline Result ClientImpl::Options(const std::string &path) {
  14403. return Options(path, Headers());
  14404. }
  14405. inline Result ClientImpl::Options(const std::string &path,
  14406. const Headers &headers) {
  14407. Request req;
  14408. req.method = "OPTIONS";
  14409. req.headers = headers;
  14410. req.path = path;
  14411. if (max_timeout_msec_ > 0) {
  14412. req.start_time_ = std::chrono::steady_clock::now();
  14413. }
  14414. return send_(std::move(req));
  14415. }
  14416. inline void ClientImpl::stop() {
  14417. std::lock_guard<std::mutex> guard(socket_mutex_);
  14418. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14419. // do is to shutdown_socket, so that threads using this socket suddenly
  14420. // discover they can't read/write any more and error out. Everything else
  14421. // (closing the socket, shutting ssl down) is unsafe because these actions
  14422. // are not thread-safe.
  14423. if (socket_requests_in_flight_ > 0) {
  14424. shutdown_socket(socket_);
  14425. // Aside from that, we set a flag for the socket to be closed when we're
  14426. // done.
  14427. socket_should_be_closed_when_request_is_done_ = true;
  14428. return;
  14429. }
  14430. disconnect(/*gracefully=*/true);
  14431. }
  14432. inline std::string ClientImpl::host() const { return host_; }
  14433. inline int ClientImpl::port() const { return port_; }
  14434. inline size_t ClientImpl::is_socket_open() const {
  14435. std::lock_guard<std::mutex> guard(socket_mutex_);
  14436. return socket_.is_open();
  14437. }
  14438. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14439. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14440. connection_timeout_sec_ = sec;
  14441. connection_timeout_usec_ = usec;
  14442. }
  14443. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14444. read_timeout_sec_ = sec;
  14445. read_timeout_usec_ = usec;
  14446. }
  14447. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14448. write_timeout_sec_ = sec;
  14449. write_timeout_usec_ = usec;
  14450. }
  14451. inline void ClientImpl::set_max_timeout(time_t msec) {
  14452. max_timeout_msec_ = msec;
  14453. }
  14454. inline void ClientImpl::set_basic_auth(const std::string &username,
  14455. const std::string &password) {
  14456. basic_auth_username_ = username;
  14457. basic_auth_password_ = password;
  14458. }
  14459. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14460. bearer_token_auth_token_ = token;
  14461. }
  14462. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14463. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14464. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14465. inline void
  14466. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14467. addr_map_ = std::move(addr_map);
  14468. }
  14469. inline void ClientImpl::set_default_headers(Headers headers) {
  14470. default_headers_ = std::move(headers);
  14471. }
  14472. inline void ClientImpl::set_header_writer(
  14473. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14474. header_writer_ = writer;
  14475. }
  14476. inline void ClientImpl::set_address_family(int family) {
  14477. address_family_ = family;
  14478. }
  14479. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14480. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14481. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14482. socket_options_ = std::move(socket_options);
  14483. }
  14484. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14485. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14486. inline void ClientImpl::set_payload_max_length(size_t length) {
  14487. payload_max_length_ = length;
  14488. has_payload_max_length_ = true;
  14489. }
  14490. inline void ClientImpl::set_interface(const std::string &intf) {
  14491. interface_ = intf;
  14492. }
  14493. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14494. proxy_host_ = host;
  14495. proxy_port_ = port;
  14496. std::lock_guard<std::mutex> guard(socket_mutex_);
  14497. disconnect(/*gracefully=*/true);
  14498. }
  14499. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14500. const std::string &password) {
  14501. proxy_basic_auth_username_ = username;
  14502. proxy_basic_auth_password_ = password;
  14503. }
  14504. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14505. proxy_bearer_token_auth_token_ = token;
  14506. }
  14507. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14508. std::vector<detail::NoProxyEntry> parsed;
  14509. parsed.reserve(patterns.size());
  14510. for (const auto &p : patterns) {
  14511. auto trimmed = detail::trim_copy(p);
  14512. if (trimmed.empty()) { continue; }
  14513. detail::NoProxyEntry entry;
  14514. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14515. parsed.push_back(std::move(entry));
  14516. }
  14517. }
  14518. no_proxy_entries_ = std::move(parsed);
  14519. std::lock_guard<std::mutex> guard(socket_mutex_);
  14520. disconnect(/*gracefully=*/true);
  14521. }
  14522. #ifdef CPPHTTPLIB_SSL_ENABLED
  14523. inline void ClientImpl::set_digest_auth(const std::string &username,
  14524. const std::string &password) {
  14525. digest_auth_username_ = username;
  14526. digest_auth_password_ = password;
  14527. }
  14528. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14529. const std::string &ca_cert_dir_path) {
  14530. ca_cert_file_path_ = ca_cert_file_path;
  14531. ca_cert_dir_path_ = ca_cert_dir_path;
  14532. }
  14533. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14534. const std::string &password) {
  14535. proxy_digest_auth_username_ = username;
  14536. proxy_digest_auth_password_ = password;
  14537. }
  14538. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14539. server_certificate_verification_ = enabled;
  14540. }
  14541. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14542. server_hostname_verification_ = enabled;
  14543. }
  14544. inline void ClientImpl::enable_system_ca(bool enabled) {
  14545. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14546. }
  14547. #endif
  14548. inline void ClientImpl::set_logger(Logger logger) {
  14549. logger_ = std::move(logger);
  14550. }
  14551. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14552. error_logger_ = std::move(error_logger);
  14553. }
  14554. /*
  14555. * SSL/TLS Common Implementation
  14556. */
  14557. inline ClientConnection::~ClientConnection() {
  14558. #ifdef CPPHTTPLIB_SSL_ENABLED
  14559. if (session) {
  14560. tls::shutdown(session, true);
  14561. tls::free_session(session);
  14562. session = nullptr;
  14563. }
  14564. #endif
  14565. if (sock != INVALID_SOCKET) {
  14566. detail::close_socket(sock);
  14567. sock = INVALID_SOCKET;
  14568. }
  14569. }
  14570. // Universal client implementation
  14571. inline Client::Client(const std::string &scheme_host_port)
  14572. : Client(scheme_host_port, std::string(), std::string()) {}
  14573. inline Client::Client(const std::string &scheme_host_port,
  14574. const std::string &client_cert_path,
  14575. const std::string &client_key_path) {
  14576. detail::UrlComponents uc;
  14577. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14578. auto &scheme = uc.scheme;
  14579. #ifdef CPPHTTPLIB_SSL_ENABLED
  14580. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14581. #else
  14582. if (!scheme.empty() && scheme != "http") {
  14583. #endif
  14584. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14585. std::string msg = "'" + scheme + "' scheme is not supported.";
  14586. throw std::invalid_argument(msg);
  14587. #endif
  14588. return;
  14589. }
  14590. auto is_ssl = scheme == "https";
  14591. auto host = std::move(uc.host);
  14592. auto port = is_ssl ? 443 : 80;
  14593. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14594. if (is_ssl) {
  14595. #ifdef CPPHTTPLIB_SSL_ENABLED
  14596. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14597. client_key_path);
  14598. is_ssl_ = is_ssl;
  14599. #endif
  14600. } else {
  14601. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14602. client_key_path);
  14603. }
  14604. } else {
  14605. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14606. // if port param below changes.
  14607. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14608. client_cert_path, client_key_path);
  14609. }
  14610. }
  14611. inline Client::Client(const std::string &host, int port)
  14612. : Client(host, port, std::string(), std::string()) {}
  14613. inline Client::Client(const std::string &host, int port,
  14614. const std::string &client_cert_path,
  14615. const std::string &client_key_path)
  14616. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14617. client_key_path)) {}
  14618. inline Client::~Client() = default;
  14619. inline bool Client::is_valid() const {
  14620. return cli_ != nullptr && cli_->is_valid();
  14621. }
  14622. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14623. return cli_->Get(path, std::move(progress));
  14624. }
  14625. inline Result Client::Get(const std::string &path, const Headers &headers,
  14626. DownloadProgress progress) {
  14627. return cli_->Get(path, headers, std::move(progress));
  14628. }
  14629. inline Result Client::Get(const std::string &path,
  14630. ContentReceiver content_receiver,
  14631. DownloadProgress progress) {
  14632. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14633. }
  14634. inline Result Client::Get(const std::string &path, const Headers &headers,
  14635. ContentReceiver content_receiver,
  14636. DownloadProgress progress) {
  14637. return cli_->Get(path, headers, std::move(content_receiver),
  14638. std::move(progress));
  14639. }
  14640. inline Result Client::Get(const std::string &path,
  14641. ResponseHandler response_handler,
  14642. ContentReceiver content_receiver,
  14643. DownloadProgress progress) {
  14644. return cli_->Get(path, std::move(response_handler),
  14645. std::move(content_receiver), std::move(progress));
  14646. }
  14647. inline Result Client::Get(const std::string &path, const Headers &headers,
  14648. ResponseHandler response_handler,
  14649. ContentReceiver content_receiver,
  14650. DownloadProgress progress) {
  14651. return cli_->Get(path, headers, std::move(response_handler),
  14652. std::move(content_receiver), std::move(progress));
  14653. }
  14654. inline Result Client::Get(const std::string &path, const Params &params,
  14655. DownloadProgress progress) {
  14656. return cli_->Get(path, params, std::move(progress));
  14657. }
  14658. inline Result Client::Get(const std::string &path, const Params &params,
  14659. const Headers &headers, DownloadProgress progress) {
  14660. return cli_->Get(path, params, headers, std::move(progress));
  14661. }
  14662. inline Result Client::Get(const std::string &path, const Params &params,
  14663. const Headers &headers,
  14664. ContentReceiver content_receiver,
  14665. DownloadProgress progress) {
  14666. return cli_->Get(path, params, headers, std::move(content_receiver),
  14667. std::move(progress));
  14668. }
  14669. inline Result Client::Get(const std::string &path, const Params &params,
  14670. const Headers &headers,
  14671. ResponseHandler response_handler,
  14672. ContentReceiver content_receiver,
  14673. DownloadProgress progress) {
  14674. return cli_->Get(path, params, headers, std::move(response_handler),
  14675. std::move(content_receiver), std::move(progress));
  14676. }
  14677. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14678. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14679. return cli_->Head(path, headers);
  14680. }
  14681. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14682. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14683. return cli_->Post(path, headers);
  14684. }
  14685. inline Result Client::Post(const std::string &path, const char *body,
  14686. size_t content_length,
  14687. const std::string &content_type,
  14688. UploadProgress progress) {
  14689. return cli_->Post(path, body, content_length, content_type, progress);
  14690. }
  14691. inline Result Client::Post(const std::string &path, const Headers &headers,
  14692. const char *body, size_t content_length,
  14693. const std::string &content_type,
  14694. UploadProgress progress) {
  14695. return cli_->Post(path, headers, body, content_length, content_type,
  14696. progress);
  14697. }
  14698. inline Result Client::Post(const std::string &path, const std::string &body,
  14699. const std::string &content_type,
  14700. UploadProgress progress) {
  14701. return cli_->Post(path, body, content_type, progress);
  14702. }
  14703. inline Result Client::Post(const std::string &path, const Headers &headers,
  14704. const std::string &body,
  14705. const std::string &content_type,
  14706. UploadProgress progress) {
  14707. return cli_->Post(path, headers, body, content_type, progress);
  14708. }
  14709. inline Result Client::Post(const std::string &path, size_t content_length,
  14710. ContentProvider content_provider,
  14711. const std::string &content_type,
  14712. UploadProgress progress) {
  14713. return cli_->Post(path, content_length, std::move(content_provider),
  14714. content_type, progress);
  14715. }
  14716. inline Result Client::Post(const std::string &path, size_t content_length,
  14717. ContentProvider content_provider,
  14718. const std::string &content_type,
  14719. ContentReceiver content_receiver,
  14720. UploadProgress progress) {
  14721. return cli_->Post(path, content_length, std::move(content_provider),
  14722. content_type, std::move(content_receiver), progress);
  14723. }
  14724. inline Result Client::Post(const std::string &path,
  14725. ContentProviderWithoutLength content_provider,
  14726. const std::string &content_type,
  14727. UploadProgress progress) {
  14728. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14729. }
  14730. inline Result Client::Post(const std::string &path,
  14731. ContentProviderWithoutLength content_provider,
  14732. const std::string &content_type,
  14733. ContentReceiver content_receiver,
  14734. UploadProgress progress) {
  14735. return cli_->Post(path, std::move(content_provider), content_type,
  14736. std::move(content_receiver), progress);
  14737. }
  14738. inline Result Client::Post(const std::string &path, const Headers &headers,
  14739. size_t content_length,
  14740. ContentProvider content_provider,
  14741. const std::string &content_type,
  14742. UploadProgress progress) {
  14743. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14744. content_type, progress);
  14745. }
  14746. inline Result Client::Post(const std::string &path, const Headers &headers,
  14747. size_t content_length,
  14748. ContentProvider content_provider,
  14749. const std::string &content_type,
  14750. ContentReceiver content_receiver,
  14751. DownloadProgress progress) {
  14752. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14753. content_type, std::move(content_receiver), progress);
  14754. }
  14755. inline Result Client::Post(const std::string &path, const Headers &headers,
  14756. ContentProviderWithoutLength content_provider,
  14757. const std::string &content_type,
  14758. UploadProgress progress) {
  14759. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14760. progress);
  14761. }
  14762. inline Result Client::Post(const std::string &path, const Headers &headers,
  14763. ContentProviderWithoutLength content_provider,
  14764. const std::string &content_type,
  14765. ContentReceiver content_receiver,
  14766. DownloadProgress progress) {
  14767. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14768. std::move(content_receiver), progress);
  14769. }
  14770. inline Result Client::Post(const std::string &path, const Params &params) {
  14771. return cli_->Post(path, params);
  14772. }
  14773. inline Result Client::Post(const std::string &path, const Headers &headers,
  14774. const Params &params) {
  14775. return cli_->Post(path, headers, params);
  14776. }
  14777. inline Result Client::Post(const std::string &path,
  14778. const UploadFormDataItems &items,
  14779. UploadProgress progress) {
  14780. return cli_->Post(path, items, progress);
  14781. }
  14782. inline Result Client::Post(const std::string &path, const Headers &headers,
  14783. const UploadFormDataItems &items,
  14784. UploadProgress progress) {
  14785. return cli_->Post(path, headers, items, progress);
  14786. }
  14787. inline Result Client::Post(const std::string &path, const Headers &headers,
  14788. const UploadFormDataItems &items,
  14789. const std::string &boundary,
  14790. UploadProgress progress) {
  14791. return cli_->Post(path, headers, items, boundary, progress);
  14792. }
  14793. inline Result Client::Post(const std::string &path, const Headers &headers,
  14794. const UploadFormDataItems &items,
  14795. const FormDataProviderItems &provider_items,
  14796. UploadProgress progress) {
  14797. return cli_->Post(path, headers, items, provider_items, progress);
  14798. }
  14799. inline Result Client::Post(const std::string &path, const Headers &headers,
  14800. const std::string &body,
  14801. const std::string &content_type,
  14802. ContentReceiver content_receiver,
  14803. DownloadProgress progress) {
  14804. return cli_->Post(path, headers, body, content_type,
  14805. std::move(content_receiver), progress);
  14806. }
  14807. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14808. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14809. return cli_->Put(path, headers);
  14810. }
  14811. inline Result Client::Put(const std::string &path, const char *body,
  14812. size_t content_length,
  14813. const std::string &content_type,
  14814. UploadProgress progress) {
  14815. return cli_->Put(path, body, content_length, content_type, progress);
  14816. }
  14817. inline Result Client::Put(const std::string &path, const Headers &headers,
  14818. const char *body, size_t content_length,
  14819. const std::string &content_type,
  14820. UploadProgress progress) {
  14821. return cli_->Put(path, headers, body, content_length, content_type, progress);
  14822. }
  14823. inline Result Client::Put(const std::string &path, const std::string &body,
  14824. const std::string &content_type,
  14825. UploadProgress progress) {
  14826. return cli_->Put(path, body, content_type, progress);
  14827. }
  14828. inline Result Client::Put(const std::string &path, const Headers &headers,
  14829. const std::string &body,
  14830. const std::string &content_type,
  14831. UploadProgress progress) {
  14832. return cli_->Put(path, headers, body, content_type, progress);
  14833. }
  14834. inline Result Client::Put(const std::string &path, size_t content_length,
  14835. ContentProvider content_provider,
  14836. const std::string &content_type,
  14837. UploadProgress progress) {
  14838. return cli_->Put(path, content_length, std::move(content_provider),
  14839. content_type, progress);
  14840. }
  14841. inline Result Client::Put(const std::string &path, size_t content_length,
  14842. ContentProvider content_provider,
  14843. const std::string &content_type,
  14844. ContentReceiver content_receiver,
  14845. UploadProgress progress) {
  14846. return cli_->Put(path, content_length, std::move(content_provider),
  14847. content_type, std::move(content_receiver), progress);
  14848. }
  14849. inline Result Client::Put(const std::string &path,
  14850. ContentProviderWithoutLength content_provider,
  14851. const std::string &content_type,
  14852. UploadProgress progress) {
  14853. return cli_->Put(path, std::move(content_provider), content_type, progress);
  14854. }
  14855. inline Result Client::Put(const std::string &path,
  14856. ContentProviderWithoutLength content_provider,
  14857. const std::string &content_type,
  14858. ContentReceiver content_receiver,
  14859. UploadProgress progress) {
  14860. return cli_->Put(path, std::move(content_provider), content_type,
  14861. std::move(content_receiver), progress);
  14862. }
  14863. inline Result Client::Put(const std::string &path, const Headers &headers,
  14864. size_t content_length,
  14865. ContentProvider content_provider,
  14866. const std::string &content_type,
  14867. UploadProgress progress) {
  14868. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14869. content_type, progress);
  14870. }
  14871. inline Result Client::Put(const std::string &path, const Headers &headers,
  14872. size_t content_length,
  14873. ContentProvider content_provider,
  14874. const std::string &content_type,
  14875. ContentReceiver content_receiver,
  14876. UploadProgress progress) {
  14877. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14878. content_type, std::move(content_receiver), progress);
  14879. }
  14880. inline Result Client::Put(const std::string &path, const Headers &headers,
  14881. ContentProviderWithoutLength content_provider,
  14882. const std::string &content_type,
  14883. UploadProgress progress) {
  14884. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14885. progress);
  14886. }
  14887. inline Result Client::Put(const std::string &path, const Headers &headers,
  14888. ContentProviderWithoutLength content_provider,
  14889. const std::string &content_type,
  14890. ContentReceiver content_receiver,
  14891. UploadProgress progress) {
  14892. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14893. std::move(content_receiver), progress);
  14894. }
  14895. inline Result Client::Put(const std::string &path, const Params &params) {
  14896. return cli_->Put(path, params);
  14897. }
  14898. inline Result Client::Put(const std::string &path, const Headers &headers,
  14899. const Params &params) {
  14900. return cli_->Put(path, headers, params);
  14901. }
  14902. inline Result Client::Put(const std::string &path,
  14903. const UploadFormDataItems &items,
  14904. UploadProgress progress) {
  14905. return cli_->Put(path, items, progress);
  14906. }
  14907. inline Result Client::Put(const std::string &path, const Headers &headers,
  14908. const UploadFormDataItems &items,
  14909. UploadProgress progress) {
  14910. return cli_->Put(path, headers, items, progress);
  14911. }
  14912. inline Result Client::Put(const std::string &path, const Headers &headers,
  14913. const UploadFormDataItems &items,
  14914. const std::string &boundary,
  14915. UploadProgress progress) {
  14916. return cli_->Put(path, headers, items, boundary, progress);
  14917. }
  14918. inline Result Client::Put(const std::string &path, const Headers &headers,
  14919. const UploadFormDataItems &items,
  14920. const FormDataProviderItems &provider_items,
  14921. UploadProgress progress) {
  14922. return cli_->Put(path, headers, items, provider_items, progress);
  14923. }
  14924. inline Result Client::Put(const std::string &path, const Headers &headers,
  14925. const std::string &body,
  14926. const std::string &content_type,
  14927. ContentReceiver content_receiver,
  14928. DownloadProgress progress) {
  14929. return cli_->Put(path, headers, body, content_type, content_receiver,
  14930. progress);
  14931. }
  14932. inline Result Client::Patch(const std::string &path) {
  14933. return cli_->Patch(path);
  14934. }
  14935. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  14936. return cli_->Patch(path, headers);
  14937. }
  14938. inline Result Client::Patch(const std::string &path, const char *body,
  14939. size_t content_length,
  14940. const std::string &content_type,
  14941. UploadProgress progress) {
  14942. return cli_->Patch(path, body, content_length, content_type, progress);
  14943. }
  14944. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14945. const char *body, size_t content_length,
  14946. const std::string &content_type,
  14947. UploadProgress progress) {
  14948. return cli_->Patch(path, headers, body, content_length, content_type,
  14949. progress);
  14950. }
  14951. inline Result Client::Patch(const std::string &path, const std::string &body,
  14952. const std::string &content_type,
  14953. UploadProgress progress) {
  14954. return cli_->Patch(path, body, content_type, progress);
  14955. }
  14956. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14957. const std::string &body,
  14958. const std::string &content_type,
  14959. UploadProgress progress) {
  14960. return cli_->Patch(path, headers, body, content_type, progress);
  14961. }
  14962. inline Result Client::Patch(const std::string &path, size_t content_length,
  14963. ContentProvider content_provider,
  14964. const std::string &content_type,
  14965. UploadProgress progress) {
  14966. return cli_->Patch(path, content_length, std::move(content_provider),
  14967. content_type, progress);
  14968. }
  14969. inline Result Client::Patch(const std::string &path, size_t content_length,
  14970. ContentProvider content_provider,
  14971. const std::string &content_type,
  14972. ContentReceiver content_receiver,
  14973. UploadProgress progress) {
  14974. return cli_->Patch(path, content_length, std::move(content_provider),
  14975. content_type, std::move(content_receiver), progress);
  14976. }
  14977. inline Result Client::Patch(const std::string &path,
  14978. ContentProviderWithoutLength content_provider,
  14979. const std::string &content_type,
  14980. UploadProgress progress) {
  14981. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  14982. }
  14983. inline Result Client::Patch(const std::string &path,
  14984. ContentProviderWithoutLength content_provider,
  14985. const std::string &content_type,
  14986. ContentReceiver content_receiver,
  14987. UploadProgress progress) {
  14988. return cli_->Patch(path, std::move(content_provider), content_type,
  14989. std::move(content_receiver), progress);
  14990. }
  14991. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14992. size_t content_length,
  14993. ContentProvider content_provider,
  14994. const std::string &content_type,
  14995. UploadProgress progress) {
  14996. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14997. content_type, progress);
  14998. }
  14999. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15000. size_t content_length,
  15001. ContentProvider content_provider,
  15002. const std::string &content_type,
  15003. ContentReceiver content_receiver,
  15004. UploadProgress progress) {
  15005. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15006. content_type, std::move(content_receiver), progress);
  15007. }
  15008. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15009. ContentProviderWithoutLength content_provider,
  15010. const std::string &content_type,
  15011. UploadProgress progress) {
  15012. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15013. progress);
  15014. }
  15015. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15016. ContentProviderWithoutLength content_provider,
  15017. const std::string &content_type,
  15018. ContentReceiver content_receiver,
  15019. UploadProgress progress) {
  15020. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15021. std::move(content_receiver), progress);
  15022. }
  15023. inline Result Client::Patch(const std::string &path, const Params &params) {
  15024. return cli_->Patch(path, params);
  15025. }
  15026. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15027. const Params &params) {
  15028. return cli_->Patch(path, headers, params);
  15029. }
  15030. inline Result Client::Patch(const std::string &path,
  15031. const UploadFormDataItems &items,
  15032. UploadProgress progress) {
  15033. return cli_->Patch(path, items, progress);
  15034. }
  15035. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15036. const UploadFormDataItems &items,
  15037. UploadProgress progress) {
  15038. return cli_->Patch(path, headers, items, progress);
  15039. }
  15040. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15041. const UploadFormDataItems &items,
  15042. const std::string &boundary,
  15043. UploadProgress progress) {
  15044. return cli_->Patch(path, headers, items, boundary, progress);
  15045. }
  15046. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15047. const UploadFormDataItems &items,
  15048. const FormDataProviderItems &provider_items,
  15049. UploadProgress progress) {
  15050. return cli_->Patch(path, headers, items, provider_items, progress);
  15051. }
  15052. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15053. const std::string &body,
  15054. const std::string &content_type,
  15055. ContentReceiver content_receiver,
  15056. DownloadProgress progress) {
  15057. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15058. progress);
  15059. }
  15060. inline Result Client::Delete(const std::string &path,
  15061. DownloadProgress progress) {
  15062. return cli_->Delete(path, progress);
  15063. }
  15064. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15065. DownloadProgress progress) {
  15066. return cli_->Delete(path, headers, progress);
  15067. }
  15068. inline Result Client::Delete(const std::string &path, const char *body,
  15069. size_t content_length,
  15070. const std::string &content_type,
  15071. DownloadProgress progress) {
  15072. return cli_->Delete(path, body, content_length, content_type, progress);
  15073. }
  15074. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15075. const char *body, size_t content_length,
  15076. const std::string &content_type,
  15077. DownloadProgress progress) {
  15078. return cli_->Delete(path, headers, body, content_length, content_type,
  15079. progress);
  15080. }
  15081. inline Result Client::Delete(const std::string &path, const std::string &body,
  15082. const std::string &content_type,
  15083. DownloadProgress progress) {
  15084. return cli_->Delete(path, body, content_type, progress);
  15085. }
  15086. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15087. const std::string &body,
  15088. const std::string &content_type,
  15089. DownloadProgress progress) {
  15090. return cli_->Delete(path, headers, body, content_type, progress);
  15091. }
  15092. inline Result Client::Delete(const std::string &path, const Params &params,
  15093. DownloadProgress progress) {
  15094. return cli_->Delete(path, params, progress);
  15095. }
  15096. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15097. const Params &params, DownloadProgress progress) {
  15098. return cli_->Delete(path, headers, params, progress);
  15099. }
  15100. inline Result Client::Options(const std::string &path) {
  15101. return cli_->Options(path);
  15102. }
  15103. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15104. return cli_->Options(path, headers);
  15105. }
  15106. inline ClientImpl::StreamHandle
  15107. Client::open_stream(const std::string &method, const std::string &path,
  15108. const Params &params, const Headers &headers,
  15109. const std::string &body, const std::string &content_type) {
  15110. return cli_->open_stream(method, path, params, headers, body, content_type);
  15111. }
  15112. inline bool Client::send(Request &req, Response &res, Error &error) {
  15113. return cli_->send(req, res, error);
  15114. }
  15115. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15116. inline void Client::stop() { cli_->stop(); }
  15117. inline std::string Client::host() const { return cli_->host(); }
  15118. inline int Client::port() const { return cli_->port(); }
  15119. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15120. inline socket_t Client::socket() const { return cli_->socket(); }
  15121. inline void
  15122. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15123. cli_->set_hostname_addr_map(std::move(addr_map));
  15124. }
  15125. inline void Client::set_default_headers(Headers headers) {
  15126. cli_->set_default_headers(std::move(headers));
  15127. }
  15128. inline void Client::set_header_writer(
  15129. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15130. cli_->set_header_writer(writer);
  15131. }
  15132. inline void Client::set_address_family(int family) {
  15133. cli_->set_address_family(family);
  15134. }
  15135. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15136. inline void Client::set_socket_options(SocketOptions socket_options) {
  15137. cli_->set_socket_options(std::move(socket_options));
  15138. }
  15139. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15140. cli_->set_connection_timeout(sec, usec);
  15141. }
  15142. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15143. cli_->set_read_timeout(sec, usec);
  15144. }
  15145. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15146. cli_->set_write_timeout(sec, usec);
  15147. }
  15148. inline void Client::set_basic_auth(const std::string &username,
  15149. const std::string &password) {
  15150. cli_->set_basic_auth(username, password);
  15151. }
  15152. inline void Client::set_bearer_token_auth(const std::string &token) {
  15153. cli_->set_bearer_token_auth(token);
  15154. }
  15155. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15156. inline void Client::set_follow_location(bool on) {
  15157. cli_->set_follow_location(on);
  15158. }
  15159. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15160. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15161. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15162. inline void Client::set_payload_max_length(size_t length) {
  15163. cli_->set_payload_max_length(length);
  15164. }
  15165. inline void Client::set_interface(const std::string &intf) {
  15166. cli_->set_interface(intf);
  15167. }
  15168. inline void Client::set_proxy(const std::string &host, int port) {
  15169. cli_->set_proxy(host, port);
  15170. }
  15171. inline void Client::set_proxy_basic_auth(const std::string &username,
  15172. const std::string &password) {
  15173. cli_->set_proxy_basic_auth(username, password);
  15174. }
  15175. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15176. cli_->set_proxy_bearer_token_auth(token);
  15177. }
  15178. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15179. cli_->set_no_proxy(patterns);
  15180. }
  15181. inline void Client::set_logger(Logger logger) {
  15182. cli_->set_logger(std::move(logger));
  15183. }
  15184. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15185. cli_->set_error_logger(std::move(error_logger));
  15186. }
  15187. /*
  15188. * Group 6: SSL Server and Client implementation
  15189. */
  15190. #ifdef CPPHTTPLIB_SSL_ENABLED
  15191. // SSL HTTP server implementation
  15192. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15193. const char *client_ca_cert_file_path,
  15194. const char *client_ca_cert_dir_path,
  15195. const char *private_key_password) {
  15196. using namespace tls;
  15197. ctx_ = create_server_context();
  15198. if (!ctx_) { return; }
  15199. // Load server certificate and private key
  15200. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15201. private_key_password)) {
  15202. last_ssl_error_ = static_cast<int>(get_error());
  15203. free_context(ctx_);
  15204. ctx_ = nullptr;
  15205. return;
  15206. }
  15207. // Load client CA certificates for client authentication
  15208. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15209. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15210. client_ca_cert_dir_path)) {
  15211. last_ssl_error_ = static_cast<int>(get_error());
  15212. free_context(ctx_);
  15213. ctx_ = nullptr;
  15214. return;
  15215. }
  15216. // Enable client certificate verification
  15217. set_verify_client(ctx_, true);
  15218. }
  15219. }
  15220. inline SSLServer::SSLServer(const PemMemory &pem) {
  15221. using namespace tls;
  15222. ctx_ = create_server_context();
  15223. if (ctx_) {
  15224. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15225. pem.private_key_password)) {
  15226. last_ssl_error_ = static_cast<int>(get_error());
  15227. free_context(ctx_);
  15228. ctx_ = nullptr;
  15229. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15230. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15231. last_ssl_error_ = static_cast<int>(get_error());
  15232. free_context(ctx_);
  15233. ctx_ = nullptr;
  15234. } else {
  15235. set_verify_client(ctx_, true);
  15236. }
  15237. }
  15238. }
  15239. }
  15240. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15241. using namespace tls;
  15242. ctx_ = create_server_context();
  15243. if (ctx_) {
  15244. if (!setup_callback(ctx_)) {
  15245. free_context(ctx_);
  15246. ctx_ = nullptr;
  15247. }
  15248. }
  15249. }
  15250. inline SSLServer::~SSLServer() {
  15251. if (ctx_) { tls::free_context(ctx_); }
  15252. }
  15253. inline bool SSLServer::is_valid() const {
  15254. return ctx_ != nullptr && Server::is_valid();
  15255. }
  15256. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15257. using namespace tls;
  15258. // Create TLS session with mutex protection
  15259. session_t session = nullptr;
  15260. {
  15261. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15262. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15263. }
  15264. if (!session) {
  15265. last_ssl_error_ = static_cast<int>(get_error());
  15266. detail::shutdown_socket(sock);
  15267. detail::close_socket(sock);
  15268. return false;
  15269. }
  15270. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15271. bool handshake_done = false;
  15272. bool ret = false;
  15273. bool websocket_upgraded = false;
  15274. auto cleanup = detail::scope_exit([&] {
  15275. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15276. free_session(session);
  15277. detail::shutdown_socket(sock);
  15278. detail::close_socket(sock);
  15279. });
  15280. // Perform TLS accept handshake with timeout
  15281. TlsError tls_err;
  15282. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15283. &tls_err)) {
  15284. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15285. // Map TlsError to legacy ssl_error for backward compatibility
  15286. if (tls_err.code == ErrorCode::WantRead) {
  15287. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15288. } else if (tls_err.code == ErrorCode::WantWrite) {
  15289. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15290. } else {
  15291. last_ssl_error_ = SSL_ERROR_SSL;
  15292. }
  15293. #else
  15294. last_ssl_error_ = static_cast<int>(get_error());
  15295. #endif
  15296. return false;
  15297. }
  15298. handshake_done = true;
  15299. std::string remote_addr;
  15300. int remote_port = 0;
  15301. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15302. std::string local_addr;
  15303. int local_port = 0;
  15304. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15305. ret = serve_guarded([&]() {
  15306. return detail::process_server_socket_ssl(
  15307. svr_sock_, session, sock, keep_alive_max_count_,
  15308. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15309. write_timeout_sec_, write_timeout_usec_,
  15310. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15311. return process_request(
  15312. strm, remote_addr, remote_port, local_addr, local_port,
  15313. close_connection, connection_closed,
  15314. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15315. });
  15316. });
  15317. return ret;
  15318. }
  15319. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15320. const char *key_pem,
  15321. const char *client_ca_pem,
  15322. const char *password) {
  15323. if (!ctx_) { return false; }
  15324. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15325. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15326. return false;
  15327. }
  15328. if (client_ca_pem) {
  15329. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15330. }
  15331. return true;
  15332. }
  15333. // SSL HTTP client implementation
  15334. inline SSLClient::~SSLClient() {
  15335. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15336. // base function rather than the derived function once we get to the
  15337. // base class destructor, and won't free the SSL (causing a leak).
  15338. // This must happen before the context is freed below: some backends
  15339. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15340. // context, so freeing the context first leaves close_notify reading
  15341. // freed memory.
  15342. shutdown_ssl_impl(socket_, true);
  15343. if (ctx_) {
  15344. tls::free_context(ctx_);
  15345. ctx_ = nullptr;
  15346. }
  15347. }
  15348. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15349. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15350. shutdown_ssl_impl(socket, shutdown_gracefully);
  15351. }
  15352. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15353. bool shutdown_gracefully) {
  15354. if (socket.sock == INVALID_SOCKET) {
  15355. assert(socket.ssl == nullptr);
  15356. return;
  15357. }
  15358. if (socket.ssl) {
  15359. tls::shutdown(socket.ssl, shutdown_gracefully);
  15360. {
  15361. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15362. tls::free_session(socket.ssl);
  15363. }
  15364. socket.ssl = nullptr;
  15365. }
  15366. assert(socket.ssl == nullptr);
  15367. }
  15368. inline bool SSLClient::process_socket(
  15369. const Socket &socket,
  15370. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15371. std::function<bool(Stream &strm)> callback) {
  15372. assert(socket.ssl);
  15373. return detail::process_client_socket_ssl(
  15374. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15375. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15376. std::move(callback));
  15377. }
  15378. inline bool SSLClient::is_ssl() const { return true; }
  15379. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15380. if (!is_valid()) {
  15381. error = Error::SSLConnection;
  15382. return false;
  15383. }
  15384. return ClientImpl::create_and_connect_socket(socket, error);
  15385. }
  15386. inline bool SSLClient::setup_proxy_connection(
  15387. Socket &socket,
  15388. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15389. Response &res, bool &success, Error &error) {
  15390. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15391. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15392. return false;
  15393. }
  15394. if (!initialize_ssl(socket, error)) {
  15395. success = false;
  15396. return false;
  15397. }
  15398. return true;
  15399. }
  15400. // Assumes that socket_mutex_ is locked and that there are no requests in
  15401. // flight
  15402. inline bool SSLClient::connect_with_proxy(
  15403. Socket &socket,
  15404. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15405. Response &res, bool &success, Error &error) {
  15406. success = true;
  15407. Response proxy_res;
  15408. if (!detail::process_client_socket(
  15409. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15410. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15411. start_time, [&](Stream &strm) {
  15412. Request req2;
  15413. req2.method = "CONNECT";
  15414. req2.path =
  15415. detail::make_host_and_port_string_always_port(host_, port_);
  15416. if (max_timeout_msec_ > 0) {
  15417. req2.start_time_ = std::chrono::steady_clock::now();
  15418. }
  15419. return process_request(strm, req2, proxy_res, false, error);
  15420. })) {
  15421. // Thread-safe to close everything because we are assuming there are no
  15422. // requests in flight
  15423. shutdown_ssl(socket, true);
  15424. shutdown_socket(socket);
  15425. close_socket(socket);
  15426. success = false;
  15427. return false;
  15428. }
  15429. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15430. if (!proxy_digest_auth_username_.empty() &&
  15431. !proxy_digest_auth_password_.empty()) {
  15432. std::map<std::string, std::string> auth;
  15433. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15434. // Close the current socket and create a new one for the authenticated
  15435. // request
  15436. shutdown_ssl(socket, true);
  15437. shutdown_socket(socket);
  15438. close_socket(socket);
  15439. // Create a new socket for the authenticated CONNECT request
  15440. if (!ensure_socket_connection(socket, error)) {
  15441. success = false;
  15442. output_error_log(error, nullptr);
  15443. return false;
  15444. }
  15445. proxy_res = Response();
  15446. if (!detail::process_client_socket(
  15447. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15448. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15449. start_time, [&](Stream &strm) {
  15450. Request req3;
  15451. req3.method = "CONNECT";
  15452. req3.path = detail::make_host_and_port_string_always_port(
  15453. host_, port_);
  15454. req3.headers.insert(detail::make_digest_authentication_header(
  15455. req3, auth, 1, detail::random_string(10),
  15456. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15457. true));
  15458. if (max_timeout_msec_ > 0) {
  15459. req3.start_time_ = std::chrono::steady_clock::now();
  15460. }
  15461. return process_request(strm, req3, proxy_res, false, error);
  15462. })) {
  15463. // Thread-safe to close everything because we are assuming there are
  15464. // no requests in flight
  15465. shutdown_ssl(socket, true);
  15466. shutdown_socket(socket);
  15467. close_socket(socket);
  15468. success = false;
  15469. return false;
  15470. }
  15471. }
  15472. }
  15473. }
  15474. // If status code is not 200, proxy request is failed.
  15475. // Set error to ProxyConnection and return proxy response
  15476. // as the response of the request
  15477. if (proxy_res.status != StatusCode::OK_200) {
  15478. error = Error::ProxyConnection;
  15479. output_error_log(error, nullptr);
  15480. res = std::move(proxy_res);
  15481. // Thread-safe to close everything because we are assuming there are
  15482. // no requests in flight
  15483. shutdown_ssl(socket, true);
  15484. shutdown_socket(socket);
  15485. close_socket(socket);
  15486. return false;
  15487. }
  15488. return true;
  15489. }
  15490. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15491. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15492. if (is_proxy_enabled_for_host(host_)) { return true; }
  15493. if (!initialize_ssl(socket, error)) {
  15494. shutdown_socket(socket);
  15495. close_socket(socket);
  15496. return false;
  15497. }
  15498. return true;
  15499. }
  15500. // SSL HTTP client implementation
  15501. inline SSLClient::SSLClient(const std::string &host)
  15502. : SSLClient(host, 443, std::string(), std::string()) {}
  15503. inline SSLClient::SSLClient(const std::string &host, int port)
  15504. : SSLClient(host, port, std::string(), std::string()) {}
  15505. inline void SSLClient::init_ctx() {
  15506. ctx_ = tls::create_client_context();
  15507. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15508. }
  15509. inline void SSLClient::reset_ctx_on_error() {
  15510. last_backend_error_ = tls::get_error();
  15511. tls::free_context(ctx_);
  15512. ctx_ = nullptr;
  15513. }
  15514. inline SSLClient::SSLClient(const std::string &host, int port,
  15515. const std::string &client_cert_path,
  15516. const std::string &client_key_path,
  15517. const std::string &private_key_password)
  15518. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15519. init_ctx();
  15520. if (!ctx_) { return; }
  15521. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15522. const char *password =
  15523. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15524. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15525. client_key_path.c_str(), password)) {
  15526. reset_ctx_on_error();
  15527. }
  15528. }
  15529. }
  15530. inline SSLClient::SSLClient(const std::string &host, int port,
  15531. const PemMemory &pem)
  15532. : ClientImpl(host, port) {
  15533. init_ctx();
  15534. if (!ctx_) { return; }
  15535. if (pem.cert_pem && pem.key_pem) {
  15536. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15537. pem.private_key_password)) {
  15538. reset_ctx_on_error();
  15539. }
  15540. }
  15541. }
  15542. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15543. if (ca_cert_store && ctx_) {
  15544. // set_ca_store takes ownership of ca_cert_store
  15545. tls::set_ca_store(ctx_, ca_cert_store);
  15546. ca_cert_store_set_ = true;
  15547. } else if (ca_cert_store) {
  15548. tls::free_ca_store(ca_cert_store);
  15549. }
  15550. }
  15551. inline void
  15552. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15553. if (!ctx_) { return; }
  15554. tls::set_verify_callback(ctx_, verifier);
  15555. }
  15556. inline void SSLClient::set_session_verifier(
  15557. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15558. session_verifier_ = std::move(verifier);
  15559. }
  15560. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15561. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15562. enable_windows_cert_verification_ = enabled;
  15563. }
  15564. #endif
  15565. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15566. std::size_t size) {
  15567. if (ctx_ && ca_cert && size > 0) {
  15568. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15569. tls::load_ca_pem(ctx_, ca_cert, size);
  15570. }
  15571. }
  15572. inline bool SSLClient::load_certs() {
  15573. auto ret = true;
  15574. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15575. // one client is shared across concurrent requests here.
  15576. std::call_once(initialize_cert_, [&]() {
  15577. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15578. ret = detail::load_client_ca_config(
  15579. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15580. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15581. last_backend_error_);
  15582. });
  15583. return ret;
  15584. }
  15585. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15586. // Load CA certificates if server verification is enabled
  15587. if (server_certificate_verification_) {
  15588. if (!load_certs()) {
  15589. error = Error::SSLLoadingCerts;
  15590. output_error_log(error, nullptr);
  15591. return false;
  15592. }
  15593. }
  15594. detail::ClientTlsSessionOptions options;
  15595. options.server_hostname_verification = server_hostname_verification_;
  15596. options.session_verifier = session_verifier_;
  15597. options.ctx_mutex = &ctx_mutex_;
  15598. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15599. // Skip Schannel when a custom CA cert is specified, as the Windows
  15600. // certificate store would not know about user-provided CA certificates.
  15601. // Also skip when system CA trust is explicitly disabled.
  15602. options.windows_cert_verification =
  15603. enable_windows_cert_verification_ &&
  15604. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15605. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15606. #endif
  15607. tls::session_t session = nullptr;
  15608. // Use scope_exit to ensure session is freed on error paths
  15609. bool success = false;
  15610. auto session_guard = detail::scope_exit([&] {
  15611. if (!success) { tls::free_session(session); }
  15612. });
  15613. detail::ClientTlsSessionError tls_error;
  15614. if (!detail::setup_client_tls_session(
  15615. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15616. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15617. options)) {
  15618. error = tls_error.error;
  15619. last_ssl_error_ = tls_error.ssl_error;
  15620. last_backend_error_ = tls_error.backend_error;
  15621. output_error_log(error, nullptr);
  15622. return false;
  15623. }
  15624. success = true;
  15625. socket.ssl = session;
  15626. return true;
  15627. }
  15628. inline void Client::set_digest_auth(const std::string &username,
  15629. const std::string &password) {
  15630. cli_->set_digest_auth(username, password);
  15631. }
  15632. inline void Client::set_proxy_digest_auth(const std::string &username,
  15633. const std::string &password) {
  15634. cli_->set_proxy_digest_auth(username, password);
  15635. }
  15636. inline void Client::enable_server_certificate_verification(bool enabled) {
  15637. cli_->enable_server_certificate_verification(enabled);
  15638. }
  15639. inline void Client::enable_server_hostname_verification(bool enabled) {
  15640. cli_->enable_server_hostname_verification(enabled);
  15641. }
  15642. inline void Client::enable_system_ca(bool enabled) {
  15643. cli_->enable_system_ca(enabled);
  15644. }
  15645. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15646. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15647. if (is_ssl_) {
  15648. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15649. enabled);
  15650. }
  15651. }
  15652. #endif
  15653. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15654. const std::string &ca_cert_dir_path) {
  15655. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15656. }
  15657. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15658. if (is_ssl_) {
  15659. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15660. } else if (ca_cert_store) {
  15661. tls::free_ca_store(ca_cert_store);
  15662. }
  15663. }
  15664. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15665. if (is_ssl_) {
  15666. // Use the PEM-based path so the CA data is retained for redirect transfer
  15667. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15668. }
  15669. }
  15670. inline void
  15671. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15672. if (is_ssl_) {
  15673. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15674. std::move(verifier));
  15675. }
  15676. }
  15677. inline void Client::set_session_verifier(
  15678. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15679. if (is_ssl_) {
  15680. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15681. }
  15682. }
  15683. inline tls::ctx_t Client::tls_context() const {
  15684. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15685. return nullptr;
  15686. }
  15687. #endif // CPPHTTPLIB_SSL_ENABLED
  15688. /*
  15689. * Group 7: TLS abstraction layer - Common API
  15690. */
  15691. #ifdef CPPHTTPLIB_SSL_ENABLED
  15692. namespace tls {
  15693. // Helper for PeerCert construction
  15694. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15695. return PeerCert(get_peer_cert(session));
  15696. }
  15697. namespace impl {
  15698. inline VerifyCallback &get_verify_callback() {
  15699. static thread_local VerifyCallback callback;
  15700. return callback;
  15701. }
  15702. inline VerifyCallback &get_mbedtls_verify_callback() {
  15703. static thread_local VerifyCallback callback;
  15704. return callback;
  15705. }
  15706. // Check if a string is an IPv4 address
  15707. inline bool is_ipv4_address(const std::string &str) {
  15708. int dots = 0;
  15709. for (char c : str) {
  15710. if (c == '.') {
  15711. dots++;
  15712. } else if (!detail::is_ascii_digit(c)) {
  15713. return false;
  15714. }
  15715. }
  15716. return dots == 3;
  15717. }
  15718. // Parse IPv4 address string to bytes
  15719. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15720. const char *p = str.c_str();
  15721. for (int i = 0; i < 4; i++) {
  15722. if (i > 0) {
  15723. if (*p != '.') { return false; }
  15724. p++;
  15725. }
  15726. int val = 0;
  15727. int digits = 0;
  15728. while (detail::is_ascii_digit(*p)) {
  15729. val = val * 10 + (*p - '0');
  15730. if (val > 255) { return false; }
  15731. p++;
  15732. digits++;
  15733. }
  15734. if (digits == 0) { return false; }
  15735. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15736. if (digits > 1 && *(p - digits) == '0') { return false; }
  15737. out[i] = static_cast<unsigned char>(val);
  15738. }
  15739. return *p == '\0';
  15740. }
  15741. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15742. // `out` must have room for at least 16 bytes. Returns the address length
  15743. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15744. // literal. Used to match a host against iPAddress SANs the same way the
  15745. // OpenSSL backend does via X509_check_ip.
  15746. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15747. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15748. struct in6_addr addr6 = {};
  15749. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15750. memcpy(out, &addr6, 16);
  15751. return 16;
  15752. }
  15753. return 0;
  15754. }
  15755. #ifdef _WIN32
  15756. // Enumerate Windows system certificates and call callback with DER data
  15757. template <typename Callback>
  15758. inline bool enumerate_windows_system_certs(Callback cb) {
  15759. bool loaded = false;
  15760. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15761. for (auto store_name : store_names) {
  15762. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15763. if (hStore) {
  15764. PCCERT_CONTEXT pContext = nullptr;
  15765. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15766. nullptr) {
  15767. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15768. loaded = true;
  15769. }
  15770. }
  15771. CertCloseStore(hStore, 0);
  15772. }
  15773. }
  15774. return loaded;
  15775. }
  15776. #endif
  15777. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15778. // Enumerate macOS Keychain certificates and call callback with DER data
  15779. template <typename Callback>
  15780. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15781. bool loaded = false;
  15782. const SecTrustSettingsDomain domains[] = {
  15783. kSecTrustSettingsDomainSystem,
  15784. kSecTrustSettingsDomainAdmin,
  15785. kSecTrustSettingsDomainUser,
  15786. };
  15787. for (auto domain : domains) {
  15788. CFArrayRef certs = nullptr;
  15789. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15790. if (status != errSecSuccess || !certs) {
  15791. if (certs) CFRelease(certs);
  15792. continue;
  15793. }
  15794. CFIndex count = CFArrayGetCount(certs);
  15795. for (CFIndex i = 0; i < count; i++) {
  15796. SecCertificateRef cert =
  15797. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15798. CFDataRef data = SecCertificateCopyData(cert);
  15799. if (data) {
  15800. if (cb(CFDataGetBytePtr(data),
  15801. static_cast<size_t>(CFDataGetLength(data)))) {
  15802. loaded = true;
  15803. }
  15804. CFRelease(data);
  15805. }
  15806. }
  15807. CFRelease(certs);
  15808. }
  15809. return loaded;
  15810. }
  15811. #endif
  15812. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15813. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  15814. // Common CA certificate file paths on Linux/Unix
  15815. inline const char **system_ca_paths() {
  15816. static const char *paths[] = {
  15817. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  15818. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  15819. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  15820. "/etc/pki/tls/cacert.pem", // OpenELEC
  15821. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  15822. nullptr};
  15823. return paths;
  15824. }
  15825. // Common CA certificate directory paths on Linux/Unix
  15826. inline const char **system_ca_dirs() {
  15827. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  15828. "/etc/pki/tls/certs", // RHEL/CentOS
  15829. "/usr/share/ca-certificates", // Other
  15830. nullptr};
  15831. return dirs;
  15832. }
  15833. #endif
  15834. } // namespace impl
  15835. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  15836. const char *ca_dir) {
  15837. if (!ctx) { return false; }
  15838. bool success = true;
  15839. if (ca_file && *ca_file) {
  15840. if (!load_ca_file(ctx, ca_file)) { success = false; }
  15841. }
  15842. if (ca_dir && *ca_dir) {
  15843. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  15844. }
  15845. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15846. // Set CA list for client certificate request (CertificateRequest message)
  15847. if (ca_file && *ca_file) {
  15848. auto list = SSL_load_client_CA_file(ca_file);
  15849. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  15850. }
  15851. #endif
  15852. return success;
  15853. }
  15854. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15855. const char *password) {
  15856. return set_client_cert_pem(ctx, cert, key, password);
  15857. }
  15858. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  15859. const char *key_path, const char *password) {
  15860. return set_client_cert_file(ctx, cert_path, key_path, password);
  15861. }
  15862. // PeerCert implementation
  15863. inline PeerCert::PeerCert() = default;
  15864. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  15865. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  15866. other.cert_ = nullptr;
  15867. }
  15868. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  15869. if (this != &other) {
  15870. if (cert_) { free_cert(cert_); }
  15871. cert_ = other.cert_;
  15872. other.cert_ = nullptr;
  15873. }
  15874. return *this;
  15875. }
  15876. inline PeerCert::~PeerCert() {
  15877. if (cert_) { free_cert(cert_); }
  15878. }
  15879. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  15880. inline std::string PeerCert::subject_cn() const {
  15881. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  15882. }
  15883. inline std::string PeerCert::issuer_name() const {
  15884. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  15885. }
  15886. inline bool PeerCert::check_hostname(const char *hostname) const {
  15887. return cert_ ? verify_hostname(cert_, hostname) : false;
  15888. }
  15889. inline std::vector<SanEntry> PeerCert::sans() const {
  15890. std::vector<SanEntry> result;
  15891. if (cert_) { get_cert_sans(cert_, result); }
  15892. return result;
  15893. }
  15894. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  15895. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  15896. }
  15897. inline std::string PeerCert::serial() const {
  15898. return cert_ ? get_cert_serial(cert_) : std::string();
  15899. }
  15900. // VerifyContext method implementations
  15901. inline std::string VerifyContext::subject_cn() const {
  15902. return cert ? get_cert_subject_cn(cert) : std::string();
  15903. }
  15904. inline std::string VerifyContext::issuer_name() const {
  15905. return cert ? get_cert_issuer_name(cert) : std::string();
  15906. }
  15907. inline bool VerifyContext::check_hostname(const char *hostname) const {
  15908. return cert ? verify_hostname(cert, hostname) : false;
  15909. }
  15910. inline std::vector<SanEntry> VerifyContext::sans() const {
  15911. std::vector<SanEntry> result;
  15912. if (cert) { get_cert_sans(cert, result); }
  15913. return result;
  15914. }
  15915. inline bool VerifyContext::validity(time_t &not_before,
  15916. time_t &not_after) const {
  15917. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  15918. }
  15919. inline std::string VerifyContext::serial() const {
  15920. return cert ? get_cert_serial(cert) : std::string();
  15921. }
  15922. // TlsError static method implementation
  15923. inline std::string TlsError::verify_error_to_string(long error_code) {
  15924. return verify_error_string(error_code);
  15925. }
  15926. } // namespace tls
  15927. // Request::peer_cert() implementation
  15928. inline tls::PeerCert Request::peer_cert() const {
  15929. return tls::get_peer_cert_from_session(ssl);
  15930. }
  15931. // Request::sni() implementation
  15932. inline std::string Request::sni() const {
  15933. if (!ssl) { return std::string(); }
  15934. const char *s = tls::get_sni(ssl);
  15935. return s ? std::string(s) : std::string();
  15936. }
  15937. #endif // CPPHTTPLIB_SSL_ENABLED
  15938. /*
  15939. * Group 8: TLS abstraction layer - OpenSSL backend
  15940. */
  15941. /*
  15942. * OpenSSL Backend Implementation
  15943. */
  15944. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15945. namespace tls {
  15946. namespace impl {
  15947. // Helper to map OpenSSL SSL_get_error to ErrorCode
  15948. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  15949. switch (ssl_error) {
  15950. case SSL_ERROR_NONE: return ErrorCode::Success;
  15951. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  15952. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  15953. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  15954. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  15955. case SSL_ERROR_SSL:
  15956. default: return ErrorCode::Fatal;
  15957. }
  15958. }
  15959. // Helper: Create client CA list from PEM string
  15960. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  15961. // Caller takes ownership of returned list
  15962. inline STACK_OF(X509_NAME) *
  15963. create_client_ca_list_from_pem(const char *ca_pem) {
  15964. if (!ca_pem) { return nullptr; }
  15965. auto ca_list = sk_X509_NAME_new_null();
  15966. if (!ca_list) { return nullptr; }
  15967. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  15968. if (!bio) {
  15969. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  15970. return nullptr;
  15971. }
  15972. X509 *cert = nullptr;
  15973. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15974. nullptr) {
  15975. const X509_NAME *name = X509_get_subject_name(cert);
  15976. if (name) {
  15977. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  15978. }
  15979. X509_free(cert);
  15980. }
  15981. BIO_free(bio);
  15982. return ca_list;
  15983. }
  15984. // OpenSSL verify callback wrapper
  15985. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  15986. auto &callback = get_verify_callback();
  15987. if (!callback) { return preverify_ok; }
  15988. // Get SSL object from X509_STORE_CTX
  15989. auto ssl = static_cast<SSL *>(
  15990. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  15991. if (!ssl) { return preverify_ok; }
  15992. // Get current certificate and depth
  15993. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  15994. int depth = X509_STORE_CTX_get_error_depth(ctx);
  15995. int error = X509_STORE_CTX_get_error(ctx);
  15996. // Build context
  15997. VerifyContext verify_ctx;
  15998. verify_ctx.session = static_cast<session_t>(ssl);
  15999. verify_ctx.cert = static_cast<cert_t>(cert);
  16000. verify_ctx.depth = depth;
  16001. verify_ctx.preverify_ok = (preverify_ok != 0);
  16002. verify_ctx.error_code = error;
  16003. verify_ctx.error_string =
  16004. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16005. return callback(verify_ctx) ? 1 : 0;
  16006. }
  16007. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16008. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16009. // that must be released with release_store_objects
  16010. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16011. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16012. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16013. #endif
  16014. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16015. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16016. return X509_STORE_get1_objects(store);
  16017. #else
  16018. return X509_STORE_get0_objects(store);
  16019. #endif
  16020. }
  16021. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16022. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16023. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16024. #else
  16025. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16026. #endif
  16027. }
  16028. } // namespace impl
  16029. inline ctx_t create_client_context() {
  16030. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16031. if (ctx) {
  16032. // Disable auto-retry to properly handle non-blocking I/O
  16033. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16034. // Set minimum TLS version
  16035. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16036. }
  16037. return static_cast<ctx_t>(ctx);
  16038. }
  16039. inline void free_context(ctx_t ctx) {
  16040. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16041. }
  16042. inline bool set_min_version(ctx_t ctx, Version version) {
  16043. if (!ctx) return false;
  16044. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16045. static_cast<int>(version)) == 1;
  16046. }
  16047. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16048. if (!ctx || !pem || len == 0) return false;
  16049. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16050. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16051. if (!store) return false;
  16052. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16053. if (!bio) return false;
  16054. bool ok = true;
  16055. X509 *cert = nullptr;
  16056. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16057. nullptr) {
  16058. if (X509_STORE_add_cert(store, cert) != 1) {
  16059. // Ignore duplicate errors
  16060. auto err = ERR_peek_last_error();
  16061. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16062. ok = false;
  16063. }
  16064. }
  16065. X509_free(cert);
  16066. if (!ok) break;
  16067. }
  16068. BIO_free(bio);
  16069. // Clear any "no more certificates" errors
  16070. ERR_clear_error();
  16071. return ok;
  16072. }
  16073. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16074. if (!ctx || !file_path) return false;
  16075. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16076. nullptr) == 1;
  16077. }
  16078. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16079. if (!ctx || !dir_path) return false;
  16080. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16081. dir_path) == 1;
  16082. }
  16083. inline bool load_system_certs(ctx_t ctx) {
  16084. if (!ctx) return false;
  16085. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16086. #ifdef _WIN32
  16087. // Windows: Load from system certificate store (ROOT and CA)
  16088. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16089. if (!store) return false;
  16090. bool loaded_any = false;
  16091. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16092. for (auto store_name : store_names) {
  16093. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16094. if (!hStore) continue;
  16095. PCCERT_CONTEXT pContext = nullptr;
  16096. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16097. nullptr) {
  16098. const unsigned char *data = pContext->pbCertEncoded;
  16099. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16100. if (x509) {
  16101. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16102. X509_free(x509);
  16103. }
  16104. }
  16105. CertCloseStore(hStore, 0);
  16106. }
  16107. return loaded_any;
  16108. #elif defined(__APPLE__)
  16109. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16110. // macOS: Load from Keychain
  16111. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16112. if (!store) return false;
  16113. bool loaded_any = false;
  16114. const SecTrustSettingsDomain domains[] = {
  16115. kSecTrustSettingsDomainSystem,
  16116. kSecTrustSettingsDomainAdmin,
  16117. kSecTrustSettingsDomainUser,
  16118. };
  16119. for (auto domain : domains) {
  16120. CFArrayRef certs = nullptr;
  16121. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16122. !certs) {
  16123. if (certs) CFRelease(certs);
  16124. continue;
  16125. }
  16126. auto count = CFArrayGetCount(certs);
  16127. for (CFIndex i = 0; i < count; i++) {
  16128. auto cert = reinterpret_cast<SecCertificateRef>(
  16129. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16130. CFDataRef der = SecCertificateCopyData(cert);
  16131. if (der) {
  16132. const unsigned char *data = CFDataGetBytePtr(der);
  16133. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16134. if (x509) {
  16135. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16136. X509_free(x509);
  16137. }
  16138. CFRelease(der);
  16139. }
  16140. }
  16141. CFRelease(certs);
  16142. }
  16143. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16144. #else
  16145. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16146. #endif
  16147. #else
  16148. // Other Unix: use default verify paths
  16149. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16150. #endif
  16151. }
  16152. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16153. const char *password) {
  16154. if (!ctx || !cert || !key) return false;
  16155. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16156. // Load certificate
  16157. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16158. if (!cert_bio) return false;
  16159. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16160. BIO_free(cert_bio);
  16161. if (!x509) return false;
  16162. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16163. X509_free(x509);
  16164. if (!cert_ok) return false;
  16165. // Load private key
  16166. auto key_bio = BIO_new_mem_buf(key, -1);
  16167. if (!key_bio) return false;
  16168. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16169. password ? const_cast<char *>(password)
  16170. : nullptr);
  16171. BIO_free(key_bio);
  16172. if (!pkey) return false;
  16173. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16174. EVP_PKEY_free(pkey);
  16175. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16176. }
  16177. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16178. const char *key_path, const char *password) {
  16179. if (!ctx || !cert_path || !key_path) return false;
  16180. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16181. if (password && password[0] != '\0') {
  16182. SSL_CTX_set_default_passwd_cb_userdata(
  16183. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16184. }
  16185. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16186. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16187. }
  16188. inline ctx_t create_server_context() {
  16189. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16190. if (ctx) {
  16191. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16192. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16193. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16194. }
  16195. return static_cast<ctx_t>(ctx);
  16196. }
  16197. inline void set_verify_client(ctx_t ctx, bool require) {
  16198. if (!ctx) return;
  16199. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16200. require
  16201. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16202. : SSL_VERIFY_NONE,
  16203. nullptr);
  16204. }
  16205. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16206. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16207. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16208. SSL *ssl = SSL_new(ssl_ctx);
  16209. if (!ssl) return nullptr;
  16210. // Disable auto-retry for proper non-blocking I/O handling
  16211. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16212. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16213. if (!bio) {
  16214. SSL_free(ssl);
  16215. return nullptr;
  16216. }
  16217. SSL_set_bio(ssl, bio, bio);
  16218. return static_cast<session_t>(ssl);
  16219. }
  16220. inline void free_session(session_t session) {
  16221. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16222. }
  16223. inline bool set_sni(session_t session, const char *hostname,
  16224. bool /*verify_hostname*/) {
  16225. if (!session || !hostname) return false;
  16226. auto ssl = static_cast<SSL *>(session);
  16227. // Set SNI (Server Name Indication) only - does not enable verification.
  16228. // OpenSSL never binds identity checking to SNI (that happens post-
  16229. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16230. #if defined(OPENSSL_IS_BORINGSSL)
  16231. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16232. #else
  16233. // Direct call instead of macro to suppress -Wold-style-cast warning
  16234. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16235. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16236. #endif
  16237. }
  16238. inline TlsError connect(session_t session) {
  16239. if (!session) { return TlsError(); }
  16240. auto ssl = static_cast<SSL *>(session);
  16241. auto ret = SSL_connect(ssl);
  16242. TlsError err;
  16243. if (ret == 1) {
  16244. err.code = ErrorCode::Success;
  16245. } else {
  16246. auto ssl_err = SSL_get_error(ssl, ret);
  16247. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16248. err.backend_code = ERR_get_error();
  16249. }
  16250. return err;
  16251. }
  16252. inline TlsError accept(session_t session) {
  16253. if (!session) { return TlsError(); }
  16254. auto ssl = static_cast<SSL *>(session);
  16255. auto ret = SSL_accept(ssl);
  16256. TlsError err;
  16257. if (ret == 1) {
  16258. err.code = ErrorCode::Success;
  16259. } else {
  16260. auto ssl_err = SSL_get_error(ssl, ret);
  16261. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16262. err.backend_code = ERR_get_error();
  16263. }
  16264. return err;
  16265. }
  16266. inline bool connect_nonblocking(session_t session, socket_t sock,
  16267. time_t timeout_sec, time_t timeout_usec,
  16268. TlsError *err) {
  16269. if (!session) {
  16270. if (err) { err->code = ErrorCode::Fatal; }
  16271. return false;
  16272. }
  16273. auto ssl = static_cast<SSL *>(session);
  16274. auto bio = SSL_get_rbio(ssl);
  16275. // Set non-blocking mode for handshake
  16276. detail::set_nonblocking(sock, true);
  16277. if (bio) { BIO_set_nbio(bio, 1); }
  16278. auto cleanup = detail::scope_exit([&]() {
  16279. // Restore blocking mode after handshake
  16280. if (bio) { BIO_set_nbio(bio, 0); }
  16281. detail::set_nonblocking(sock, false);
  16282. });
  16283. auto res = 0;
  16284. while ((res = SSL_connect(ssl)) != 1) {
  16285. auto ssl_err = SSL_get_error(ssl, res);
  16286. switch (ssl_err) {
  16287. case SSL_ERROR_WANT_READ:
  16288. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16289. continue;
  16290. }
  16291. break;
  16292. case SSL_ERROR_WANT_WRITE:
  16293. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16294. continue;
  16295. }
  16296. break;
  16297. default: break;
  16298. }
  16299. if (err) {
  16300. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16301. err->backend_code = ERR_get_error();
  16302. }
  16303. return false;
  16304. }
  16305. if (err) { err->code = ErrorCode::Success; }
  16306. return true;
  16307. }
  16308. inline bool accept_nonblocking(session_t session, socket_t sock,
  16309. time_t timeout_sec, time_t timeout_usec,
  16310. TlsError *err) {
  16311. if (!session) {
  16312. if (err) { err->code = ErrorCode::Fatal; }
  16313. return false;
  16314. }
  16315. auto ssl = static_cast<SSL *>(session);
  16316. auto bio = SSL_get_rbio(ssl);
  16317. // Set non-blocking mode for handshake
  16318. detail::set_nonblocking(sock, true);
  16319. if (bio) { BIO_set_nbio(bio, 1); }
  16320. auto cleanup = detail::scope_exit([&]() {
  16321. // Restore blocking mode after handshake
  16322. if (bio) { BIO_set_nbio(bio, 0); }
  16323. detail::set_nonblocking(sock, false);
  16324. });
  16325. auto res = 0;
  16326. while ((res = SSL_accept(ssl)) != 1) {
  16327. auto ssl_err = SSL_get_error(ssl, res);
  16328. switch (ssl_err) {
  16329. case SSL_ERROR_WANT_READ:
  16330. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16331. continue;
  16332. }
  16333. break;
  16334. case SSL_ERROR_WANT_WRITE:
  16335. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16336. continue;
  16337. }
  16338. break;
  16339. default: break;
  16340. }
  16341. if (err) {
  16342. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16343. err->backend_code = ERR_get_error();
  16344. }
  16345. return false;
  16346. }
  16347. if (err) { err->code = ErrorCode::Success; }
  16348. return true;
  16349. }
  16350. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16351. if (!session || !buf) {
  16352. err.code = ErrorCode::Fatal;
  16353. return -1;
  16354. }
  16355. auto ssl = static_cast<SSL *>(session);
  16356. constexpr auto max_len =
  16357. static_cast<size_t>((std::numeric_limits<int>::max)());
  16358. if (len > max_len) { len = max_len; }
  16359. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16360. if (ret > 0) {
  16361. err.code = ErrorCode::Success;
  16362. return ret;
  16363. }
  16364. auto ssl_err = SSL_get_error(ssl, ret);
  16365. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16366. if (err.code == ErrorCode::PeerClosed) {
  16367. return 0;
  16368. } // Gracefully handle the peer closed state.
  16369. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16370. return -1;
  16371. }
  16372. inline ssize_t write(session_t session, const void *buf, size_t len,
  16373. TlsError &err) {
  16374. if (!session || !buf) {
  16375. err.code = ErrorCode::Fatal;
  16376. return -1;
  16377. }
  16378. auto ssl = static_cast<SSL *>(session);
  16379. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16380. if (ret > 0) {
  16381. err.code = ErrorCode::Success;
  16382. return ret;
  16383. }
  16384. auto ssl_err = SSL_get_error(ssl, ret);
  16385. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16386. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16387. return -1;
  16388. }
  16389. inline int pending(const_session_t session) {
  16390. if (!session) return 0;
  16391. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16392. }
  16393. inline void shutdown(session_t session, bool graceful) {
  16394. if (!session) return;
  16395. auto ssl = static_cast<SSL *>(session);
  16396. if (graceful) {
  16397. // First call sends close_notify
  16398. if (SSL_shutdown(ssl) == 0) {
  16399. // Second call waits for peer's close_notify
  16400. SSL_shutdown(ssl);
  16401. }
  16402. }
  16403. }
  16404. inline bool is_peer_closed(session_t session, socket_t sock) {
  16405. if (!session) return true;
  16406. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16407. detail::set_nonblocking(sock, true);
  16408. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16409. auto ssl = static_cast<SSL *>(session);
  16410. char buf;
  16411. auto ret = SSL_peek(ssl, &buf, 1);
  16412. if (ret > 0) return false;
  16413. auto err = SSL_get_error(ssl, ret);
  16414. return err == SSL_ERROR_ZERO_RETURN;
  16415. }
  16416. inline cert_t get_peer_cert(const_session_t session) {
  16417. if (!session) return nullptr;
  16418. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16419. static_cast<SSL *>(const_cast<void *>(session))));
  16420. }
  16421. inline void free_cert(cert_t cert) {
  16422. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16423. }
  16424. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16425. if (!cert || !hostname) return false;
  16426. auto x509 = static_cast<X509 *>(cert);
  16427. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16428. if (detail::is_ip_address(hostname)) {
  16429. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16430. }
  16431. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16432. }
  16433. inline uint64_t hostname_mismatch_code() {
  16434. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16435. }
  16436. inline long get_verify_result(const_session_t session) {
  16437. if (!session) return X509_V_ERR_UNSPECIFIED;
  16438. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16439. }
  16440. inline std::string get_cert_subject_cn(cert_t cert) {
  16441. if (!cert) return "";
  16442. auto x509 = static_cast<X509 *>(cert);
  16443. auto subject_name = X509_get_subject_name(x509);
  16444. if (!subject_name) return "";
  16445. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16446. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16447. if (idx < 0) return "";
  16448. auto entry = X509_NAME_get_entry(subject_name, idx);
  16449. if (!entry) return "";
  16450. auto data = X509_NAME_ENTRY_get_data(entry);
  16451. if (!data) return "";
  16452. return std::string(
  16453. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16454. static_cast<size_t>(ASN1_STRING_length(data)));
  16455. }
  16456. inline std::string get_cert_issuer_name(cert_t cert) {
  16457. if (!cert) return "";
  16458. auto x509 = static_cast<X509 *>(cert);
  16459. auto issuer_name = X509_get_issuer_name(x509);
  16460. if (!issuer_name) return "";
  16461. char buf[256];
  16462. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16463. return std::string(buf);
  16464. }
  16465. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16466. sans.clear();
  16467. if (!cert) return false;
  16468. auto x509 = static_cast<X509 *>(cert);
  16469. auto names = static_cast<GENERAL_NAMES *>(
  16470. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16471. if (!names) return true; // No SANs is valid
  16472. auto count = sk_GENERAL_NAME_num(names);
  16473. for (decltype(count) i = 0; i < count; i++) {
  16474. auto gen = sk_GENERAL_NAME_value(names, i);
  16475. if (!gen) continue;
  16476. SanEntry entry;
  16477. switch (gen->type) {
  16478. case GEN_DNS:
  16479. entry.type = SanType::DNS;
  16480. if (gen->d.dNSName) {
  16481. entry.value = std::string(
  16482. reinterpret_cast<const char *>(
  16483. ASN1_STRING_get0_data(gen->d.dNSName)),
  16484. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16485. }
  16486. break;
  16487. case GEN_IPADD:
  16488. entry.type = SanType::IP;
  16489. if (gen->d.iPAddress) {
  16490. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16491. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16492. if (len == 4) {
  16493. // IPv4
  16494. char buf[INET_ADDRSTRLEN];
  16495. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16496. entry.value = buf;
  16497. } else if (len == 16) {
  16498. // IPv6
  16499. char buf[INET6_ADDRSTRLEN];
  16500. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16501. entry.value = buf;
  16502. }
  16503. }
  16504. break;
  16505. case GEN_EMAIL:
  16506. entry.type = SanType::EMAIL;
  16507. if (gen->d.rfc822Name) {
  16508. entry.value = std::string(
  16509. reinterpret_cast<const char *>(
  16510. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16511. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16512. }
  16513. break;
  16514. case GEN_URI:
  16515. entry.type = SanType::URI;
  16516. if (gen->d.uniformResourceIdentifier) {
  16517. entry.value = std::string(
  16518. reinterpret_cast<const char *>(
  16519. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16520. static_cast<size_t>(
  16521. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16522. }
  16523. break;
  16524. default: entry.type = SanType::OTHER; break;
  16525. }
  16526. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16527. }
  16528. GENERAL_NAMES_free(names);
  16529. return true;
  16530. }
  16531. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16532. time_t &not_after) {
  16533. if (!cert) return false;
  16534. auto x509 = static_cast<X509 *>(cert);
  16535. auto nb = X509_get0_notBefore(x509);
  16536. auto na = X509_get0_notAfter(x509);
  16537. if (!nb || !na) return false;
  16538. ASN1_TIME *epoch = ASN1_TIME_new();
  16539. if (!epoch) return false;
  16540. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16541. if (!ASN1_TIME_set(epoch, 0)) return false;
  16542. int pday, psec;
  16543. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16544. not_before = 86400 * (time_t)pday + psec;
  16545. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16546. not_after = 86400 * (time_t)pday + psec;
  16547. return true;
  16548. }
  16549. inline std::string get_cert_serial(cert_t cert) {
  16550. if (!cert) return "";
  16551. auto x509 = static_cast<X509 *>(cert);
  16552. auto serial = X509_get_serialNumber(x509);
  16553. if (!serial) return "";
  16554. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16555. if (!bn) return "";
  16556. auto hex = BN_bn2hex(bn);
  16557. BN_free(bn);
  16558. if (!hex) return "";
  16559. std::string result(hex);
  16560. OPENSSL_free(hex);
  16561. return result;
  16562. }
  16563. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16564. if (!cert) return false;
  16565. auto x509 = static_cast<X509 *>(cert);
  16566. auto len = i2d_X509(x509, nullptr);
  16567. if (len < 0) return false;
  16568. der.resize(static_cast<size_t>(len));
  16569. auto p = der.data();
  16570. i2d_X509(x509, &p);
  16571. return true;
  16572. }
  16573. inline const char *get_sni(const_session_t session) {
  16574. if (!session) return nullptr;
  16575. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16576. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16577. }
  16578. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16579. inline uint64_t get_error() { return ERR_get_error(); }
  16580. inline std::string error_string(uint64_t code) {
  16581. char buf[256];
  16582. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16583. return std::string(buf);
  16584. }
  16585. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16586. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16587. if (!mem) { return nullptr; }
  16588. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16589. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16590. if (!inf) { return nullptr; }
  16591. auto store = X509_STORE_new();
  16592. if (store) {
  16593. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16594. auto itmp = sk_X509_INFO_value(inf, i);
  16595. if (!itmp) { continue; }
  16596. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16597. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16598. }
  16599. }
  16600. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16601. return static_cast<ca_store_t>(store);
  16602. }
  16603. inline void free_ca_store(ca_store_t store) {
  16604. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16605. }
  16606. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16607. if (!ctx || !store) { return false; }
  16608. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16609. auto x509_store = static_cast<X509_STORE *>(store);
  16610. // Check if same store is already set
  16611. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16612. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16613. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16614. return true;
  16615. }
  16616. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16617. certs.clear();
  16618. if (!ctx) { return 0; }
  16619. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16620. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16621. if (!store) { return 0; }
  16622. auto objs = impl::get_store_objects(store);
  16623. if (!objs) { return 0; }
  16624. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16625. auto count = sk_X509_OBJECT_num(objs);
  16626. for (decltype(count) i = 0; i < count; i++) {
  16627. auto obj = sk_X509_OBJECT_value(objs, i);
  16628. if (!obj) { continue; }
  16629. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16630. auto x509 = X509_OBJECT_get0_X509(obj);
  16631. if (x509) {
  16632. // Increment reference count so caller can free it
  16633. X509_up_ref(x509);
  16634. certs.push_back(static_cast<cert_t>(x509));
  16635. }
  16636. }
  16637. }
  16638. return certs.size();
  16639. }
  16640. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16641. std::vector<std::string> names;
  16642. if (!ctx) { return names; }
  16643. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16644. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16645. if (!store) { return names; }
  16646. auto objs = impl::get_store_objects(store);
  16647. if (!objs) { return names; }
  16648. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16649. auto count = sk_X509_OBJECT_num(objs);
  16650. for (decltype(count) i = 0; i < count; i++) {
  16651. auto obj = sk_X509_OBJECT_value(objs, i);
  16652. if (!obj) { continue; }
  16653. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16654. auto x509 = X509_OBJECT_get0_X509(obj);
  16655. if (x509) {
  16656. auto subject = X509_get_subject_name(x509);
  16657. if (subject) {
  16658. char buf[512];
  16659. X509_NAME_oneline(subject, buf, sizeof(buf));
  16660. names.push_back(buf);
  16661. }
  16662. }
  16663. }
  16664. }
  16665. return names;
  16666. }
  16667. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16668. const char *key_pem, const char *password) {
  16669. if (!ctx || !cert_pem || !key_pem) { return false; }
  16670. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16671. // Load certificate from PEM
  16672. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16673. if (!cert_bio) { return false; }
  16674. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16675. BIO_free(cert_bio);
  16676. if (!cert) { return false; }
  16677. // Load private key from PEM
  16678. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16679. if (!key_bio) {
  16680. X509_free(cert);
  16681. return false;
  16682. }
  16683. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16684. password ? const_cast<char *>(password)
  16685. : nullptr);
  16686. BIO_free(key_bio);
  16687. if (!key) {
  16688. X509_free(cert);
  16689. return false;
  16690. }
  16691. // Update certificate and key
  16692. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16693. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16694. X509_free(cert);
  16695. EVP_PKEY_free(key);
  16696. return ret;
  16697. }
  16698. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16699. if (!ctx || !ca_pem) { return false; }
  16700. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16701. // Create new X509_STORE from PEM
  16702. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16703. if (!store) { return false; }
  16704. // SSL_CTX_set_cert_store takes ownership
  16705. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16706. // Set client CA list for client certificate request
  16707. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16708. if (ca_list) {
  16709. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16710. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16711. }
  16712. return true;
  16713. }
  16714. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16715. if (!ctx) { return false; }
  16716. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16717. impl::get_verify_callback() = std::move(callback);
  16718. if (impl::get_verify_callback()) {
  16719. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16720. } else {
  16721. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16722. }
  16723. return true;
  16724. }
  16725. inline long get_verify_error(const_session_t session) {
  16726. if (!session) { return -1; }
  16727. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16728. return SSL_get_verify_result(ssl);
  16729. }
  16730. inline std::string verify_error_string(long error_code) {
  16731. if (error_code == X509_V_OK) { return ""; }
  16732. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16733. return str ? str : "unknown error";
  16734. }
  16735. } // namespace tls
  16736. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16737. /*
  16738. * Group 9: TLS abstraction layer - Mbed TLS backend
  16739. */
  16740. /*
  16741. * Mbed TLS Backend Implementation
  16742. */
  16743. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16744. namespace tls {
  16745. namespace impl {
  16746. // Mbed TLS session wrapper
  16747. struct MbedTlsSession {
  16748. mbedtls_ssl_context ssl;
  16749. socket_t sock = INVALID_SOCKET;
  16750. std::string hostname; // For client: set via set_sni
  16751. std::string sni_hostname; // For server: received from client via SNI callback
  16752. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16753. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16754. // (e.g. a response that arrived while this side was still in its post-write
  16755. // check), the byte is pushed back here and served by the next read().
  16756. unsigned char peeked_byte = 0;
  16757. bool has_peeked_byte = false;
  16758. // Set by set_sni() when the caller disabled hostname verification, so the
  16759. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16760. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16761. // OpenSSL and wolfSSL keep them independent).
  16762. bool suppress_hostname_mismatch = false;
  16763. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16764. // decide which verify callback to install when hostname verification is
  16765. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16766. // wired for this context, or a self-contained one otherwise, so a session
  16767. // that never opted into a callback never consults the process-wide
  16768. // set_verify_callback() slot (which some other, unrelated client may have
  16769. // populated).
  16770. bool has_verify_callback = false;
  16771. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16772. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16773. MbedTlsSession(const MbedTlsSession &) = delete;
  16774. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16775. };
  16776. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16777. // queue)
  16778. inline int &mbedtls_last_error() {
  16779. static thread_local int err = 0;
  16780. return err;
  16781. }
  16782. // Helper to map Mbed TLS error to ErrorCode
  16783. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16784. uint32_t verify_flags) {
  16785. if (ret == 0) { return ErrorCode::Success; }
  16786. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16787. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16788. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16789. return ErrorCode::PeerClosed;
  16790. }
  16791. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16792. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16793. out_errno = errno;
  16794. return ErrorCode::SyscallError;
  16795. }
  16796. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16797. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16798. // the handshake's chain verification (see set_sni()); a mismatch there
  16799. // is reported the same way as any other verify_flags bit. Report it as
  16800. // HostnameMismatch, matching the other backends and the post-handshake
  16801. // identity check below, but only when naming is the sole problem -
  16802. // if the chain itself is also untrusted/expired/etc., that takes
  16803. // priority over the naming detail.
  16804. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16805. return ErrorCode::HostnameMismatch;
  16806. }
  16807. return ErrorCode::CertVerifyFailed;
  16808. }
  16809. return ErrorCode::Fatal;
  16810. }
  16811. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16812. // return value, including the verify-flags-dependent HostnameMismatch
  16813. // mapping; shared by connect() and connect_nonblocking() so the
  16814. // backend_code policy for that mapping only lives in one place.
  16815. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  16816. int ret) {
  16817. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  16818. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  16819. err.backend_code = err.code == ErrorCode::HostnameMismatch
  16820. ? static_cast<uint64_t>(verify_flags)
  16821. : static_cast<uint64_t>(-ret);
  16822. }
  16823. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  16824. // non-fatal notification delivered between records, not an error and not
  16825. // application data, so I/O calls that see it should just be retried. Kept in
  16826. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  16827. // splitting the closing brace across an #if.
  16828. inline bool mbedtls_is_session_ticket(int ret) {
  16829. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  16830. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  16831. #else
  16832. (void)ret;
  16833. return false;
  16834. #endif
  16835. }
  16836. // BIO-like send callback for Mbed TLS
  16837. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  16838. size_t len) {
  16839. auto sock = *static_cast<socket_t *>(ctx);
  16840. #ifdef _WIN32
  16841. auto ret =
  16842. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  16843. if (ret == SOCKET_ERROR) {
  16844. int err = WSAGetLastError();
  16845. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  16846. return MBEDTLS_ERR_NET_SEND_FAILED;
  16847. }
  16848. #else
  16849. auto ret = send(sock, buf, len, 0);
  16850. if (ret < 0) {
  16851. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16852. return MBEDTLS_ERR_SSL_WANT_WRITE;
  16853. }
  16854. return MBEDTLS_ERR_NET_SEND_FAILED;
  16855. }
  16856. #endif
  16857. return static_cast<int>(ret);
  16858. }
  16859. // BIO-like recv callback for Mbed TLS
  16860. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  16861. auto sock = *static_cast<socket_t *>(ctx);
  16862. #ifdef _WIN32
  16863. auto ret =
  16864. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  16865. if (ret == SOCKET_ERROR) {
  16866. int err = WSAGetLastError();
  16867. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  16868. return MBEDTLS_ERR_NET_RECV_FAILED;
  16869. }
  16870. #else
  16871. auto ret = recv(sock, buf, len, 0);
  16872. if (ret < 0) {
  16873. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16874. return MBEDTLS_ERR_SSL_WANT_READ;
  16875. }
  16876. return MBEDTLS_ERR_NET_RECV_FAILED;
  16877. }
  16878. #endif
  16879. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  16880. return static_cast<int>(ret);
  16881. }
  16882. // MbedTlsContext constructor/destructor implementations
  16883. inline MbedTlsContext::MbedTlsContext() {
  16884. mbedtls_ssl_config_init(&conf);
  16885. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16886. mbedtls_entropy_init(&entropy);
  16887. mbedtls_ctr_drbg_init(&ctr_drbg);
  16888. #endif
  16889. mbedtls_x509_crt_init(&ca_chain);
  16890. mbedtls_x509_crt_init(&own_cert);
  16891. mbedtls_pk_init(&own_key);
  16892. }
  16893. inline MbedTlsContext::~MbedTlsContext() {
  16894. mbedtls_pk_free(&own_key);
  16895. mbedtls_x509_crt_free(&own_cert);
  16896. mbedtls_x509_crt_free(&ca_chain);
  16897. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16898. mbedtls_ctr_drbg_free(&ctr_drbg);
  16899. mbedtls_entropy_free(&entropy);
  16900. #endif
  16901. mbedtls_ssl_config_free(&conf);
  16902. }
  16903. // Thread-local storage for SNI captured during handshake
  16904. // This is needed because the SNI callback doesn't have a way to pass
  16905. // session-specific data before the session is fully set up
  16906. inline std::string &mbedpending_sni() {
  16907. static thread_local std::string sni;
  16908. return sni;
  16909. }
  16910. // SNI callback for Mbed TLS server to capture client's SNI hostname
  16911. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  16912. const unsigned char *name, size_t name_len) {
  16913. (void)p_ctx;
  16914. (void)ssl;
  16915. // Store SNI name in thread-local storage
  16916. // It will be retrieved and stored in the session after handshake
  16917. if (name && name_len > 0) {
  16918. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  16919. } else {
  16920. mbedpending_sni().clear();
  16921. }
  16922. return 0; // Accept any SNI
  16923. }
  16924. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  16925. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  16926. }
  16927. // Verify callback used when hostname verification is disabled for a session
  16928. // that has no user-supplied verify callback of its own (MbedTlsSession::
  16929. // has_verify_callback is false). Deliberately does not consult
  16930. // get_verify_callback(): that slot is process-wide, so reading it here would
  16931. // pick up whatever another, unrelated client last installed there.
  16932. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  16933. mbedtls_x509_crt *, int,
  16934. uint32_t *flags) {
  16935. (void)data;
  16936. mbedtls_clear_cn_mismatch(flags);
  16937. return 0;
  16938. }
  16939. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16940. int cert_depth, uint32_t *flags);
  16941. // MbedTLS verify callback wrapper
  16942. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16943. int cert_depth, uint32_t *flags) {
  16944. // data points to the MbedTlsSession
  16945. auto *session = static_cast<MbedTlsSession *>(data);
  16946. // set_sni() disabled hostname verification for this session: drop the
  16947. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  16948. // the OpenSSL/wolfSSL backends where identity checking is independent of
  16949. // SNI. The final pass/fail decision still comes from the remaining flags
  16950. // (or, below, from the user's own verify callback).
  16951. if (session && session->suppress_hostname_mismatch) {
  16952. mbedtls_clear_cn_mismatch(flags);
  16953. }
  16954. auto &callback = get_verify_callback();
  16955. if (!callback) { return 0; } // Continue with default verification
  16956. // Build context
  16957. VerifyContext verify_ctx;
  16958. verify_ctx.session = static_cast<session_t>(session);
  16959. verify_ctx.cert = static_cast<cert_t>(crt);
  16960. verify_ctx.depth = cert_depth;
  16961. verify_ctx.preverify_ok = (*flags == 0);
  16962. verify_ctx.error_code = static_cast<long>(*flags);
  16963. // Convert Mbed TLS flags to error string
  16964. static thread_local char error_buf[256];
  16965. if (*flags != 0) {
  16966. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  16967. verify_ctx.error_string = error_buf;
  16968. } else {
  16969. verify_ctx.error_string = nullptr;
  16970. }
  16971. bool accepted = callback(verify_ctx);
  16972. if (accepted) {
  16973. *flags = 0; // Clear all error flags
  16974. return 0;
  16975. }
  16976. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  16977. }
  16978. } // namespace impl
  16979. inline ctx_t create_client_context() {
  16980. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16981. if (!ctx) { return nullptr; }
  16982. ctx->is_server = false;
  16983. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16984. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16985. if (!detail::ensure_mbedtls_psa_crypto()) {
  16986. delete ctx;
  16987. return nullptr;
  16988. }
  16989. int ret;
  16990. #else
  16991. // Seed the random number generator
  16992. const char *pers = "httplib_client";
  16993. int ret = mbedtls_ctr_drbg_seed(
  16994. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16995. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16996. if (ret != 0) {
  16997. impl::mbedtls_last_error() = ret;
  16998. delete ctx;
  16999. return nullptr;
  17000. }
  17001. #endif
  17002. // Set up SSL config for client
  17003. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17004. MBEDTLS_SSL_TRANSPORT_STREAM,
  17005. MBEDTLS_SSL_PRESET_DEFAULT);
  17006. if (ret != 0) {
  17007. impl::mbedtls_last_error() = ret;
  17008. delete ctx;
  17009. return nullptr;
  17010. }
  17011. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17012. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17013. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17014. #endif
  17015. // Default: verify peer certificate
  17016. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17017. // Set minimum TLS version to 1.2
  17018. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17019. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17020. #else
  17021. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17022. MBEDTLS_SSL_MINOR_VERSION_3);
  17023. #endif
  17024. return static_cast<ctx_t>(ctx);
  17025. }
  17026. inline ctx_t create_server_context() {
  17027. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17028. if (!ctx) { return nullptr; }
  17029. ctx->is_server = true;
  17030. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17031. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17032. if (!detail::ensure_mbedtls_psa_crypto()) {
  17033. delete ctx;
  17034. return nullptr;
  17035. }
  17036. int ret;
  17037. #else
  17038. // Seed the random number generator
  17039. const char *pers = "httplib_server";
  17040. int ret = mbedtls_ctr_drbg_seed(
  17041. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17042. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17043. if (ret != 0) {
  17044. impl::mbedtls_last_error() = ret;
  17045. delete ctx;
  17046. return nullptr;
  17047. }
  17048. #endif
  17049. // Set up SSL config for server
  17050. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17051. MBEDTLS_SSL_TRANSPORT_STREAM,
  17052. MBEDTLS_SSL_PRESET_DEFAULT);
  17053. if (ret != 0) {
  17054. impl::mbedtls_last_error() = ret;
  17055. delete ctx;
  17056. return nullptr;
  17057. }
  17058. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17059. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17060. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17061. #endif
  17062. // Default: don't verify client
  17063. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17064. // Set minimum TLS version to 1.2
  17065. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17066. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17067. #else
  17068. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17069. MBEDTLS_SSL_MINOR_VERSION_3);
  17070. #endif
  17071. // Set SNI callback to capture client's SNI hostname
  17072. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17073. return static_cast<ctx_t>(ctx);
  17074. }
  17075. inline void free_context(ctx_t ctx) {
  17076. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17077. }
  17078. inline bool set_min_version(ctx_t ctx, Version version) {
  17079. if (!ctx) { return false; }
  17080. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17081. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17082. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17083. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17084. if (version >= Version::TLS1_3) {
  17085. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17086. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17087. #endif
  17088. }
  17089. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17090. #else
  17091. // Mbed TLS 2.x uses major/minor version numbers
  17092. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17093. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17094. if (version >= Version::TLS1_3) {
  17095. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17096. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17097. #else
  17098. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17099. #endif
  17100. }
  17101. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17102. #endif
  17103. return true;
  17104. }
  17105. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17106. if (!ctx || !pem) { return false; }
  17107. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17108. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17109. // Add null terminator if not present
  17110. std::string pem_str(pem, len);
  17111. int ret = mbedtls_x509_crt_parse(
  17112. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17113. pem_str.size() + 1);
  17114. if (ret != 0) {
  17115. impl::mbedtls_last_error() = ret;
  17116. return false;
  17117. }
  17118. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17119. return true;
  17120. }
  17121. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17122. if (!ctx || !file_path) { return false; }
  17123. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17124. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17125. if (ret != 0) {
  17126. impl::mbedtls_last_error() = ret;
  17127. return false;
  17128. }
  17129. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17130. return true;
  17131. }
  17132. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17133. if (!ctx || !dir_path) { return false; }
  17134. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17135. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17136. if (ret < 0) { // Returns number of certs on success, negative on error
  17137. impl::mbedtls_last_error() = ret;
  17138. return false;
  17139. }
  17140. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17141. return true;
  17142. }
  17143. inline bool load_system_certs(ctx_t ctx) {
  17144. if (!ctx) { return false; }
  17145. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17146. bool loaded = false;
  17147. #ifdef _WIN32
  17148. loaded = impl::enumerate_windows_system_certs(
  17149. [&](const unsigned char *data, size_t len) {
  17150. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17151. });
  17152. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17153. loaded = impl::enumerate_macos_keychain_certs(
  17154. [&](const unsigned char *data, size_t len) {
  17155. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17156. });
  17157. #else
  17158. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17159. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17160. loaded = true;
  17161. break;
  17162. }
  17163. }
  17164. if (!loaded) {
  17165. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17166. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17167. loaded = true;
  17168. break;
  17169. }
  17170. }
  17171. }
  17172. #endif
  17173. if (loaded) {
  17174. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17175. }
  17176. return loaded;
  17177. }
  17178. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17179. const char *password) {
  17180. if (!ctx || !cert || !key) { return false; }
  17181. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17182. // Parse certificate
  17183. std::string cert_str(cert);
  17184. int ret = mbedtls_x509_crt_parse(
  17185. &mctx->own_cert,
  17186. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17187. cert_str.size() + 1);
  17188. if (ret != 0) {
  17189. impl::mbedtls_last_error() = ret;
  17190. return false;
  17191. }
  17192. // Parse private key
  17193. std::string key_str(key);
  17194. const unsigned char *pwd =
  17195. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17196. size_t pwd_len = password ? strlen(password) : 0;
  17197. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17198. ret = mbedtls_pk_parse_key(
  17199. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17200. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17201. &mctx->ctr_drbg);
  17202. #else
  17203. ret = mbedtls_pk_parse_key(
  17204. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17205. key_str.size() + 1, pwd, pwd_len);
  17206. #endif
  17207. if (ret != 0) {
  17208. impl::mbedtls_last_error() = ret;
  17209. return false;
  17210. }
  17211. // Verify that the certificate and private key match.
  17212. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17213. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17214. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17215. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17216. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17217. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17218. #else
  17219. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17220. #endif
  17221. if (ret != 0) {
  17222. impl::mbedtls_last_error() = ret;
  17223. return false;
  17224. }
  17225. #endif
  17226. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17227. if (ret != 0) {
  17228. impl::mbedtls_last_error() = ret;
  17229. return false;
  17230. }
  17231. return true;
  17232. }
  17233. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17234. const char *key_path, const char *password) {
  17235. if (!ctx || !cert_path || !key_path) { return false; }
  17236. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17237. // Parse certificate file
  17238. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17239. if (ret != 0) {
  17240. impl::mbedtls_last_error() = ret;
  17241. return false;
  17242. }
  17243. // Parse private key file
  17244. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17245. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17246. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17247. #else
  17248. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17249. #endif
  17250. if (ret != 0) {
  17251. impl::mbedtls_last_error() = ret;
  17252. return false;
  17253. }
  17254. // Verify that the certificate and private key match.
  17255. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17256. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17257. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17258. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17259. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17260. #else
  17261. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17262. #endif
  17263. if (ret != 0) {
  17264. impl::mbedtls_last_error() = ret;
  17265. return false;
  17266. }
  17267. #endif
  17268. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17269. if (ret != 0) {
  17270. impl::mbedtls_last_error() = ret;
  17271. return false;
  17272. }
  17273. return true;
  17274. }
  17275. inline void set_verify_client(ctx_t ctx, bool require) {
  17276. if (!ctx) { return; }
  17277. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17278. mctx->verify_client = require;
  17279. if (require) {
  17280. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17281. } else {
  17282. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17283. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17284. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17285. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17286. : MBEDTLS_SSL_VERIFY_NONE);
  17287. }
  17288. }
  17289. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17290. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17291. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17292. auto session = new (std::nothrow) impl::MbedTlsSession();
  17293. if (!session) { return nullptr; }
  17294. session->sock = sock;
  17295. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17296. if (ret != 0) {
  17297. impl::mbedtls_last_error() = ret;
  17298. delete session;
  17299. return nullptr;
  17300. }
  17301. // Explicitly opt out of in-handshake hostname verification by default;
  17302. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17303. // fails outright when no hostname was set. set_sni() installs the real
  17304. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17305. // caller verifies the certificate identity post-handshake via
  17306. // verify_hostname().
  17307. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17308. // Set BIO callbacks
  17309. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17310. impl::mbedtls_net_recv_cb, nullptr);
  17311. // Set per-session verify callback with session pointer if callback is
  17312. // registered
  17313. session->has_verify_callback = mctx->has_verify_callback;
  17314. if (mctx->has_verify_callback) {
  17315. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17316. session);
  17317. }
  17318. return static_cast<session_t>(session);
  17319. }
  17320. inline void free_session(session_t session) {
  17321. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17322. }
  17323. inline bool set_sni(session_t session, const char *hostname,
  17324. bool verify_hostname) {
  17325. if (!session || !hostname) { return false; }
  17326. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17327. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17328. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17329. // independently, so a disabled hostname check is handled below by masking
  17330. // the resulting mismatch flag instead of skipping this call.
  17331. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17332. if (ret != 0) {
  17333. impl::mbedtls_last_error() = ret;
  17334. return false;
  17335. }
  17336. msession->hostname = hostname;
  17337. if (!verify_hostname) {
  17338. msession->suppress_hostname_mismatch = true;
  17339. // If a user verify callback is already wired for this session,
  17340. // mbedtls_verify_callback() masks the mismatch flag itself before
  17341. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17342. // here would be redundant. Otherwise install the self-contained masking
  17343. // callback, which never touches the process-wide callback slot.
  17344. if (!msession->has_verify_callback) {
  17345. mbedtls_ssl_set_verify(&msession->ssl,
  17346. impl::mbedtls_mask_hostname_mismatch_callback,
  17347. msession);
  17348. }
  17349. }
  17350. return true;
  17351. }
  17352. inline TlsError connect(session_t session) {
  17353. TlsError err;
  17354. if (!session) {
  17355. err.code = ErrorCode::Fatal;
  17356. return err;
  17357. }
  17358. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17359. int ret;
  17360. do {
  17361. ret = mbedtls_ssl_handshake(&msession->ssl);
  17362. } while (impl::mbedtls_is_session_ticket(ret));
  17363. if (ret == 0) {
  17364. err.code = ErrorCode::Success;
  17365. } else {
  17366. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17367. impl::mbedtls_last_error() = ret;
  17368. }
  17369. return err;
  17370. }
  17371. inline TlsError accept(session_t session) {
  17372. // Same as connect for Mbed TLS - handshake works for both client and server
  17373. auto result = connect(session);
  17374. // After successful handshake, capture SNI from thread-local storage
  17375. if (result.code == ErrorCode::Success && session) {
  17376. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17377. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17378. impl::mbedpending_sni().clear();
  17379. }
  17380. return result;
  17381. }
  17382. inline bool connect_nonblocking(session_t session, socket_t sock,
  17383. time_t timeout_sec, time_t timeout_usec,
  17384. TlsError *err) {
  17385. if (!session) {
  17386. if (err) { err->code = ErrorCode::Fatal; }
  17387. return false;
  17388. }
  17389. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17390. // Set socket to non-blocking mode
  17391. detail::set_nonblocking(sock, true);
  17392. auto cleanup =
  17393. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17394. int ret;
  17395. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17396. // Non-fatal TLS 1.3 ticket; retry immediately.
  17397. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17398. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17399. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17400. continue;
  17401. }
  17402. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17403. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17404. continue;
  17405. }
  17406. }
  17407. // TlsError or timeout
  17408. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17409. impl::mbedtls_last_error() = ret;
  17410. return false;
  17411. }
  17412. if (err) { err->code = ErrorCode::Success; }
  17413. return true;
  17414. }
  17415. inline bool accept_nonblocking(session_t session, socket_t sock,
  17416. time_t timeout_sec, time_t timeout_usec,
  17417. TlsError *err) {
  17418. // Same implementation as connect for Mbed TLS
  17419. bool result =
  17420. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17421. // After successful handshake, capture SNI from thread-local storage
  17422. if (result && session) {
  17423. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17424. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17425. impl::mbedpending_sni().clear();
  17426. }
  17427. return result;
  17428. }
  17429. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17430. if (!session || !buf) {
  17431. err.code = ErrorCode::Fatal;
  17432. return -1;
  17433. }
  17434. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17435. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17436. if (msession->has_peeked_byte) {
  17437. if (len == 0) { return 0; }
  17438. auto p = static_cast<unsigned char *>(buf);
  17439. p[0] = msession->peeked_byte;
  17440. msession->has_peeked_byte = false;
  17441. size_t n = 1;
  17442. // Top up with any already-decrypted bytes without risking a block.
  17443. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17444. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17445. if (extra > 0) { n += static_cast<size_t>(extra); }
  17446. }
  17447. err.code = ErrorCode::Success;
  17448. return static_cast<ssize_t>(n);
  17449. }
  17450. int ret;
  17451. do {
  17452. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17453. len);
  17454. } while (impl::mbedtls_is_session_ticket(ret));
  17455. if (ret > 0) {
  17456. err.code = ErrorCode::Success;
  17457. return static_cast<ssize_t>(ret);
  17458. }
  17459. if (ret == 0) {
  17460. err.code = ErrorCode::PeerClosed;
  17461. return 0;
  17462. }
  17463. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17464. err.backend_code = static_cast<uint64_t>(-ret);
  17465. impl::mbedtls_last_error() = ret;
  17466. // mbedTLS signals a clean close_notify via a negative error code rather
  17467. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17468. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17469. return -1;
  17470. }
  17471. inline ssize_t write(session_t session, const void *buf, size_t len,
  17472. TlsError &err) {
  17473. if (!session || !buf) {
  17474. err.code = ErrorCode::Fatal;
  17475. return -1;
  17476. }
  17477. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17478. int ret;
  17479. do {
  17480. ret = mbedtls_ssl_write(&msession->ssl,
  17481. static_cast<const unsigned char *>(buf), len);
  17482. } while (impl::mbedtls_is_session_ticket(ret));
  17483. if (ret > 0) {
  17484. err.code = ErrorCode::Success;
  17485. return static_cast<ssize_t>(ret);
  17486. }
  17487. if (ret == 0) {
  17488. err.code = ErrorCode::PeerClosed;
  17489. return 0;
  17490. }
  17491. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17492. err.backend_code = static_cast<uint64_t>(-ret);
  17493. impl::mbedtls_last_error() = ret;
  17494. return -1;
  17495. }
  17496. inline int pending(const_session_t session) {
  17497. if (!session) { return 0; }
  17498. auto msession =
  17499. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17500. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17501. (msession->has_peeked_byte ? 1 : 0);
  17502. }
  17503. inline void shutdown(session_t session, bool graceful) {
  17504. if (!session) { return; }
  17505. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17506. if (graceful) {
  17507. // Try to send close_notify, but don't block forever
  17508. int ret;
  17509. int attempts = 0;
  17510. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17511. attempts < 3) {
  17512. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17513. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17514. break;
  17515. }
  17516. attempts++;
  17517. }
  17518. }
  17519. }
  17520. inline bool is_peer_closed(session_t session, socket_t sock) {
  17521. if (!session || sock == INVALID_SOCKET) { return true; }
  17522. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17523. // Check if there's already decrypted or pushed-back data available.
  17524. // If so, the connection is definitely alive.
  17525. if (msession->has_peeked_byte ||
  17526. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17527. return false;
  17528. }
  17529. // Set socket to non-blocking to avoid blocking on read
  17530. detail::set_nonblocking(sock, true);
  17531. auto cleanup =
  17532. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17533. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17534. // on application data — e.g. a response that already arrived — push the
  17535. // byte back so the next read() delivers it instead of losing it.
  17536. unsigned char buf;
  17537. int ret;
  17538. do {
  17539. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17540. } while (impl::mbedtls_is_session_ticket(ret));
  17541. // If we got data or WANT_READ (would block), connection is alive
  17542. if (ret > 0) {
  17543. msession->peeked_byte = buf;
  17544. msession->has_peeked_byte = true;
  17545. return false;
  17546. }
  17547. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17548. // If we get a peer close notify or a connection reset, the peer is closed
  17549. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17550. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17551. }
  17552. inline cert_t get_peer_cert(const_session_t session) {
  17553. if (!session) { return nullptr; }
  17554. auto msession =
  17555. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17556. // Mbed TLS returns a pointer to the internal peer cert chain.
  17557. // WARNING: This pointer is only valid while the session is active.
  17558. // Do not use the certificate after calling free_session().
  17559. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17560. return const_cast<mbedtls_x509_crt *>(cert);
  17561. }
  17562. inline void free_cert(cert_t cert) {
  17563. // Mbed TLS: peer certificate is owned by the SSL context.
  17564. // No-op here, but callers should still call this for cross-backend
  17565. // portability.
  17566. (void)cert;
  17567. }
  17568. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17569. if (!cert || !hostname) { return false; }
  17570. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17571. std::string host_str(hostname);
  17572. // Check if hostname is an IP address (IPv4 or IPv6)
  17573. unsigned char ip_bytes[16];
  17574. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17575. auto is_ip = ip_len > 0;
  17576. // Check Subject Alternative Names (SAN)
  17577. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17578. // - DNS names: raw string bytes
  17579. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17580. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17581. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17582. const unsigned char *p = san->buf.p;
  17583. size_t len = san->buf.len;
  17584. if (is_ip) {
  17585. // For an IP host, only a matching iPAddress SAN of the same family
  17586. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17587. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17588. } else {
  17589. // Check if this SAN is a DNS name (printable ASCII string)
  17590. bool is_dns = len > 0;
  17591. for (size_t i = 0; i < len && is_dns; i++) {
  17592. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17593. }
  17594. if (is_dns) {
  17595. std::string san_name(reinterpret_cast<const char *>(p), len);
  17596. if (detail::match_hostname(san_name, host_str)) { return true; }
  17597. }
  17598. }
  17599. san = san->next;
  17600. }
  17601. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17602. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17603. // the OpenSSL backend's X509_check_ip behaves the same way).
  17604. if (!is_ip) {
  17605. char cn[256];
  17606. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17607. if (ret > 0) {
  17608. std::string cn_str(cn);
  17609. // Look for "CN=" in the DN string
  17610. size_t cn_pos = cn_str.find("CN=");
  17611. if (cn_pos != std::string::npos) {
  17612. size_t start = cn_pos + 3;
  17613. size_t end = cn_str.find(',', start);
  17614. std::string cn_value =
  17615. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17616. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17617. }
  17618. }
  17619. }
  17620. return false;
  17621. }
  17622. inline uint64_t hostname_mismatch_code() {
  17623. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17624. }
  17625. inline long get_verify_result(const_session_t session) {
  17626. if (!session) { return -1; }
  17627. auto msession =
  17628. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17629. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17630. // Return 0 (X509_V_OK equivalent) if verification passed
  17631. return flags == 0 ? 0 : static_cast<long>(flags);
  17632. }
  17633. inline std::string get_cert_subject_cn(cert_t cert) {
  17634. if (!cert) return "";
  17635. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17636. // Find the CN in the subject
  17637. const mbedtls_x509_name *name = &x509->subject;
  17638. while (name != nullptr) {
  17639. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17640. return std::string(reinterpret_cast<const char *>(name->val.p),
  17641. name->val.len);
  17642. }
  17643. name = name->next;
  17644. }
  17645. return "";
  17646. }
  17647. inline std::string get_cert_issuer_name(cert_t cert) {
  17648. if (!cert) return "";
  17649. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17650. // Build a human-readable issuer name string
  17651. char buf[512];
  17652. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17653. if (ret < 0) return "";
  17654. return std::string(buf);
  17655. }
  17656. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17657. sans.clear();
  17658. if (!cert) return false;
  17659. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17660. // Parse the Subject Alternative Name extension
  17661. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17662. while (cur != nullptr) {
  17663. if (cur->buf.len > 0) {
  17664. // Mbed TLS stores SAN as ASN.1 sequences
  17665. // The tag byte indicates the type
  17666. const unsigned char *p = cur->buf.p;
  17667. size_t len = cur->buf.len;
  17668. // First byte is the tag
  17669. unsigned char tag = *p;
  17670. p++;
  17671. len--;
  17672. // Parse length (simple single-byte length assumed)
  17673. if (len > 0 && *p < 0x80) {
  17674. size_t value_len = *p;
  17675. p++;
  17676. len--;
  17677. if (value_len <= len) {
  17678. SanEntry entry;
  17679. // ASN.1 context tags for GeneralName
  17680. switch (tag & 0x1F) {
  17681. case 2: // dNSName
  17682. entry.type = SanType::DNS;
  17683. entry.value =
  17684. std::string(reinterpret_cast<const char *>(p), value_len);
  17685. break;
  17686. case 7: // iPAddress
  17687. entry.type = SanType::IP;
  17688. if (value_len == 4) {
  17689. // IPv4
  17690. char buf[16];
  17691. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17692. entry.value = buf;
  17693. } else if (value_len == 16) {
  17694. // IPv6
  17695. char buf[64];
  17696. snprintf(buf, sizeof(buf),
  17697. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17698. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17699. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17700. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17701. entry.value = buf;
  17702. }
  17703. break;
  17704. case 1: // rfc822Name (email)
  17705. entry.type = SanType::EMAIL;
  17706. entry.value =
  17707. std::string(reinterpret_cast<const char *>(p), value_len);
  17708. break;
  17709. case 6: // uniformResourceIdentifier
  17710. entry.type = SanType::URI;
  17711. entry.value =
  17712. std::string(reinterpret_cast<const char *>(p), value_len);
  17713. break;
  17714. default: entry.type = SanType::OTHER; break;
  17715. }
  17716. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17717. }
  17718. }
  17719. }
  17720. cur = cur->next;
  17721. }
  17722. return true;
  17723. }
  17724. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17725. time_t &not_after) {
  17726. if (!cert) return false;
  17727. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17728. // Convert mbedtls_x509_time to time_t
  17729. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17730. struct tm tm_time = {};
  17731. tm_time.tm_year = t.year - 1900;
  17732. tm_time.tm_mon = t.mon - 1;
  17733. tm_time.tm_mday = t.day;
  17734. tm_time.tm_hour = t.hour;
  17735. tm_time.tm_min = t.min;
  17736. tm_time.tm_sec = t.sec;
  17737. #ifdef _WIN32
  17738. return _mkgmtime(&tm_time);
  17739. #else
  17740. return timegm(&tm_time);
  17741. #endif
  17742. };
  17743. not_before = to_time_t(x509->valid_from);
  17744. not_after = to_time_t(x509->valid_to);
  17745. return true;
  17746. }
  17747. inline std::string get_cert_serial(cert_t cert) {
  17748. if (!cert) return "";
  17749. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17750. // Convert serial number to hex string
  17751. std::string result;
  17752. result.reserve(x509->serial.len * 2);
  17753. for (size_t i = 0; i < x509->serial.len; i++) {
  17754. char hex[3];
  17755. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17756. result += hex;
  17757. }
  17758. return result;
  17759. }
  17760. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17761. if (!cert) return false;
  17762. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17763. if (!crt->raw.p || crt->raw.len == 0) return false;
  17764. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17765. return true;
  17766. }
  17767. inline const char *get_sni(const_session_t session) {
  17768. if (!session) return nullptr;
  17769. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17770. // For server: return SNI received from client during handshake
  17771. if (!msession->sni_hostname.empty()) {
  17772. return msession->sni_hostname.c_str();
  17773. }
  17774. // For client: return the hostname set via set_sni
  17775. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17776. return nullptr;
  17777. }
  17778. inline uint64_t peek_error() {
  17779. // Mbed TLS doesn't have an error queue, return the last error
  17780. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17781. }
  17782. inline uint64_t get_error() {
  17783. // Mbed TLS doesn't have an error queue, return and clear the last error
  17784. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17785. impl::mbedtls_last_error() = 0;
  17786. return err;
  17787. }
  17788. inline std::string error_string(uint64_t code) {
  17789. char buf[256];
  17790. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17791. return std::string(buf);
  17792. }
  17793. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17794. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17795. if (!ca_chain) { return nullptr; }
  17796. mbedtls_x509_crt_init(ca_chain);
  17797. // mbedtls_x509_crt_parse expects null-terminated PEM
  17798. int ret = mbedtls_x509_crt_parse(ca_chain,
  17799. reinterpret_cast<const unsigned char *>(pem),
  17800. len + 1); // +1 for null terminator
  17801. if (ret != 0) {
  17802. // Try without +1 in case PEM is already null-terminated
  17803. ret = mbedtls_x509_crt_parse(
  17804. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17805. if (ret != 0) {
  17806. mbedtls_x509_crt_free(ca_chain);
  17807. delete ca_chain;
  17808. return nullptr;
  17809. }
  17810. }
  17811. return static_cast<ca_store_t>(ca_chain);
  17812. }
  17813. inline void free_ca_store(ca_store_t store) {
  17814. if (store) {
  17815. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17816. mbedtls_x509_crt_free(ca_chain);
  17817. delete ca_chain;
  17818. }
  17819. }
  17820. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17821. if (!ctx || !store) { return false; }
  17822. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17823. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17824. // Free existing CA chain
  17825. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17826. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17827. // Copy the CA chain (deep copy)
  17828. // Parse from the raw data of the source cert
  17829. mbedtls_x509_crt *src = ca_chain;
  17830. while (src != nullptr) {
  17831. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  17832. src->raw.len);
  17833. if (ret != 0) {
  17834. free_ca_store(store);
  17835. return false;
  17836. }
  17837. src = src->next;
  17838. }
  17839. // This function takes ownership of the store; the chain was deep-copied
  17840. // above, so release the source
  17841. free_ca_store(store);
  17842. // Update the SSL config to use the new CA chain
  17843. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17844. return true;
  17845. }
  17846. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17847. certs.clear();
  17848. if (!ctx) { return 0; }
  17849. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17850. // Iterate through the CA chain
  17851. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17852. while (cert != nullptr && cert->raw.len > 0) {
  17853. // Create a copy of the certificate for the caller
  17854. auto *copy = new mbedtls_x509_crt;
  17855. mbedtls_x509_crt_init(copy);
  17856. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  17857. if (ret == 0) {
  17858. certs.push_back(static_cast<cert_t>(copy));
  17859. } else {
  17860. mbedtls_x509_crt_free(copy);
  17861. delete copy;
  17862. }
  17863. cert = cert->next;
  17864. }
  17865. return certs.size();
  17866. }
  17867. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17868. std::vector<std::string> names;
  17869. if (!ctx) { return names; }
  17870. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17871. // Iterate through the CA chain
  17872. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17873. while (cert != nullptr && cert->raw.len > 0) {
  17874. char buf[512];
  17875. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  17876. if (ret > 0) { names.push_back(buf); }
  17877. cert = cert->next;
  17878. }
  17879. return names;
  17880. }
  17881. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17882. const char *key_pem, const char *password) {
  17883. if (!ctx || !cert_pem || !key_pem) { return false; }
  17884. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17885. // Free existing certificate and key
  17886. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  17887. mbedtls_pk_free(&mbed_ctx->own_key);
  17888. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  17889. mbedtls_pk_init(&mbed_ctx->own_key);
  17890. // Parse certificate PEM
  17891. int ret = mbedtls_x509_crt_parse(
  17892. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  17893. strlen(cert_pem) + 1);
  17894. if (ret != 0) {
  17895. impl::mbedtls_last_error() = ret;
  17896. return false;
  17897. }
  17898. // Parse private key PEM
  17899. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17900. ret = mbedtls_pk_parse_key(
  17901. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17902. strlen(key_pem) + 1,
  17903. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17904. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  17905. &mbed_ctx->ctr_drbg);
  17906. #else
  17907. ret = mbedtls_pk_parse_key(
  17908. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17909. strlen(key_pem) + 1,
  17910. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17911. password ? strlen(password) : 0);
  17912. #endif
  17913. if (ret != 0) {
  17914. impl::mbedtls_last_error() = ret;
  17915. return false;
  17916. }
  17917. // Configure SSL to use the new certificate and key
  17918. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  17919. &mbed_ctx->own_key);
  17920. if (ret != 0) {
  17921. impl::mbedtls_last_error() = ret;
  17922. return false;
  17923. }
  17924. return true;
  17925. }
  17926. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17927. if (!ctx || !ca_pem) { return false; }
  17928. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17929. // Free existing CA chain
  17930. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17931. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17932. // Parse CA PEM
  17933. int ret = mbedtls_x509_crt_parse(
  17934. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  17935. strlen(ca_pem) + 1);
  17936. if (ret != 0) {
  17937. impl::mbedtls_last_error() = ret;
  17938. return false;
  17939. }
  17940. // Update SSL config to use new CA chain
  17941. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17942. return true;
  17943. }
  17944. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17945. if (!ctx) { return false; }
  17946. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17947. impl::get_verify_callback() = std::move(callback);
  17948. mbed_ctx->has_verify_callback =
  17949. static_cast<bool>(impl::get_verify_callback());
  17950. if (mbed_ctx->has_verify_callback) {
  17951. // Set OPTIONAL mode to ensure callback is called even when verification
  17952. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  17953. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  17954. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  17955. nullptr);
  17956. } else {
  17957. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  17958. }
  17959. return true;
  17960. }
  17961. inline long get_verify_error(const_session_t session) {
  17962. if (!session) { return -1; }
  17963. auto *msession =
  17964. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17965. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  17966. }
  17967. inline std::string verify_error_string(long error_code) {
  17968. if (error_code == 0) { return ""; }
  17969. char buf[256];
  17970. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  17971. static_cast<uint32_t>(error_code));
  17972. // Remove trailing newline if present
  17973. std::string result(buf);
  17974. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  17975. result.pop_back();
  17976. }
  17977. return result;
  17978. }
  17979. } // namespace tls
  17980. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  17981. /*
  17982. * Group 10: TLS abstraction layer - wolfSSL backend
  17983. */
  17984. /*
  17985. * wolfSSL Backend Implementation
  17986. */
  17987. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  17988. namespace tls {
  17989. namespace impl {
  17990. // wolfSSL session wrapper
  17991. struct WolfSSLSession {
  17992. WOLFSSL *ssl = nullptr;
  17993. socket_t sock = INVALID_SOCKET;
  17994. std::string hostname; // For client: set via set_sni
  17995. std::string sni_hostname; // For server: received from client via SNI callback
  17996. WolfSSLSession() = default;
  17997. ~WolfSSLSession() {
  17998. if (ssl) { wolfSSL_free(ssl); }
  17999. }
  18000. WolfSSLSession(const WolfSSLSession &) = delete;
  18001. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18002. };
  18003. // Thread-local error code accessor for wolfSSL
  18004. inline uint64_t &wolfssl_last_error() {
  18005. static thread_local uint64_t err = 0;
  18006. return err;
  18007. }
  18008. // Helper to map wolfSSL error to ErrorCode.
  18009. // ssl_error is the value from wolfSSL_get_error().
  18010. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18011. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18012. int &out_errno) {
  18013. switch (ssl_error) {
  18014. case SSL_ERROR_NONE: return ErrorCode::Success;
  18015. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18016. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18017. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18018. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18019. default:
  18020. if (ssl) {
  18021. // wolfSSL stores the low-level error code as a negative value.
  18022. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18023. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18024. if (low_err == DOMAIN_NAME_MISMATCH) {
  18025. return ErrorCode::HostnameMismatch;
  18026. }
  18027. // Check verify result to distinguish cert verification from generic SSL
  18028. // errors.
  18029. long vr = wolfSSL_get_verify_result(ssl);
  18030. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18031. }
  18032. return ErrorCode::Fatal;
  18033. }
  18034. }
  18035. // WolfSSLContext constructor/destructor implementations
  18036. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18037. inline WolfSSLContext::~WolfSSLContext() {
  18038. if (ctx) { wolfSSL_CTX_free(ctx); }
  18039. }
  18040. // Thread-local storage for SNI captured during handshake
  18041. inline std::string &wolfssl_pending_sni() {
  18042. static thread_local std::string sni;
  18043. return sni;
  18044. }
  18045. // SNI callback for wolfSSL server to capture client's SNI hostname
  18046. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18047. (void)ret;
  18048. (void)exArg;
  18049. void *name_data = nullptr;
  18050. unsigned short name_len =
  18051. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18052. if (name_data && name_len > 0) {
  18053. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18054. name_len);
  18055. } else {
  18056. wolfssl_pending_sni().clear();
  18057. }
  18058. return 0; // Continue regardless
  18059. }
  18060. // wolfSSL verify callback wrapper
  18061. inline int wolfssl_verify_callback(int preverify_ok,
  18062. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18063. auto &callback = get_verify_callback();
  18064. if (!callback) { return preverify_ok; }
  18065. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18066. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18067. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18068. // Get the WOLFSSL object from the X509_STORE_CTX
  18069. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18070. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18071. VerifyContext verify_ctx;
  18072. verify_ctx.session = static_cast<session_t>(ssl);
  18073. verify_ctx.cert = static_cast<cert_t>(cert);
  18074. verify_ctx.depth = depth;
  18075. verify_ctx.preverify_ok = (preverify_ok != 0);
  18076. verify_ctx.error_code = static_cast<long>(err);
  18077. if (err != 0) {
  18078. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18079. } else {
  18080. verify_ctx.error_string = nullptr;
  18081. }
  18082. bool accepted = callback(verify_ctx);
  18083. return accepted ? 1 : 0;
  18084. }
  18085. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18086. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18087. wolfSSL_CTX_set_default_passwd_cb(
  18088. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18089. auto *pwd = static_cast<const char *>(userdata);
  18090. if (!pwd) return 0;
  18091. auto len = static_cast<int>(strlen(pwd));
  18092. if (len > size) len = size;
  18093. memcpy(buf, pwd, static_cast<size_t>(len));
  18094. return len;
  18095. });
  18096. }
  18097. } // namespace impl
  18098. inline ctx_t create_client_context() {
  18099. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18100. if (!ctx) { return nullptr; }
  18101. ctx->is_server = false;
  18102. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18103. if (!method) {
  18104. delete ctx;
  18105. return nullptr;
  18106. }
  18107. ctx->ctx = wolfSSL_CTX_new(method);
  18108. if (!ctx->ctx) {
  18109. delete ctx;
  18110. return nullptr;
  18111. }
  18112. // Default: verify peer certificate
  18113. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18114. return static_cast<ctx_t>(ctx);
  18115. }
  18116. inline ctx_t create_server_context() {
  18117. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18118. if (!ctx) { return nullptr; }
  18119. ctx->is_server = true;
  18120. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18121. if (!method) {
  18122. delete ctx;
  18123. return nullptr;
  18124. }
  18125. ctx->ctx = wolfSSL_CTX_new(method);
  18126. if (!ctx->ctx) {
  18127. delete ctx;
  18128. return nullptr;
  18129. }
  18130. // Default: don't verify client
  18131. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18132. // Enable SNI on server
  18133. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18134. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18135. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18136. return static_cast<ctx_t>(ctx);
  18137. }
  18138. inline void free_context(ctx_t ctx) {
  18139. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18140. }
  18141. inline bool set_min_version(ctx_t ctx, Version version) {
  18142. if (!ctx) { return false; }
  18143. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18144. int min_ver = WOLFSSL_TLSV1_2;
  18145. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18146. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18147. }
  18148. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18149. if (!ctx || !pem) { return false; }
  18150. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18151. int ret = wolfSSL_CTX_load_verify_buffer(
  18152. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18153. static_cast<long>(len), SSL_FILETYPE_PEM);
  18154. if (ret != SSL_SUCCESS) {
  18155. impl::wolfssl_last_error() =
  18156. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18157. return false;
  18158. }
  18159. wctx->ca_pem_data_.append(pem, len);
  18160. return true;
  18161. }
  18162. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18163. if (!ctx || !file_path) { return false; }
  18164. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18165. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18166. if (ret != SSL_SUCCESS) {
  18167. impl::wolfssl_last_error() =
  18168. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18169. return false;
  18170. }
  18171. return true;
  18172. }
  18173. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18174. if (!ctx || !dir_path) { return false; }
  18175. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18176. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18177. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18178. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18179. // immediately. Return true even on failure since the CA file may have
  18180. // already been loaded, matching OpenSSL's lenient behavior.
  18181. (void)ret;
  18182. return true;
  18183. }
  18184. inline bool load_system_certs(ctx_t ctx) {
  18185. if (!ctx) { return false; }
  18186. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18187. bool loaded = false;
  18188. #ifdef _WIN32
  18189. loaded = impl::enumerate_windows_system_certs(
  18190. [&](const unsigned char *data, size_t len) {
  18191. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18192. static_cast<long>(len),
  18193. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18194. });
  18195. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18196. loaded = impl::enumerate_macos_keychain_certs(
  18197. [&](const unsigned char *data, size_t len) {
  18198. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18199. static_cast<long>(len),
  18200. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18201. });
  18202. #else
  18203. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18204. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18205. SSL_SUCCESS) {
  18206. loaded = true;
  18207. break;
  18208. }
  18209. }
  18210. if (!loaded) {
  18211. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18212. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18213. SSL_SUCCESS) {
  18214. loaded = true;
  18215. break;
  18216. }
  18217. }
  18218. }
  18219. #endif
  18220. return loaded;
  18221. }
  18222. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18223. const char *password) {
  18224. if (!ctx || !cert || !key) { return false; }
  18225. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18226. // Load certificate
  18227. int ret = wolfSSL_CTX_use_certificate_buffer(
  18228. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18229. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18230. if (ret != SSL_SUCCESS) {
  18231. impl::wolfssl_last_error() =
  18232. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18233. return false;
  18234. }
  18235. // Set password callback if password is provided
  18236. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18237. // Load private key
  18238. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18239. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18240. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18241. if (ret != SSL_SUCCESS) {
  18242. impl::wolfssl_last_error() =
  18243. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18244. return false;
  18245. }
  18246. // Verify that the certificate and private key match
  18247. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18248. }
  18249. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18250. const char *key_path, const char *password) {
  18251. if (!ctx || !cert_path || !key_path) { return false; }
  18252. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18253. // Load certificate file
  18254. int ret =
  18255. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18256. if (ret != SSL_SUCCESS) {
  18257. impl::wolfssl_last_error() =
  18258. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18259. return false;
  18260. }
  18261. // Set password callback if password is provided
  18262. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18263. // Load private key file
  18264. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18265. if (ret != SSL_SUCCESS) {
  18266. impl::wolfssl_last_error() =
  18267. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18268. return false;
  18269. }
  18270. // Verify that the certificate and private key match
  18271. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18272. }
  18273. inline void set_verify_client(ctx_t ctx, bool require) {
  18274. if (!ctx) { return; }
  18275. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18276. wctx->verify_client = require;
  18277. if (require) {
  18278. wolfSSL_CTX_set_verify(
  18279. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18280. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18281. } else {
  18282. if (wctx->has_verify_callback) {
  18283. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18284. impl::wolfssl_verify_callback);
  18285. } else {
  18286. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18287. }
  18288. }
  18289. }
  18290. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18291. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18292. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18293. auto session = new (std::nothrow) impl::WolfSSLSession();
  18294. if (!session) { return nullptr; }
  18295. session->sock = sock;
  18296. session->ssl = wolfSSL_new(wctx->ctx);
  18297. if (!session->ssl) {
  18298. impl::wolfssl_last_error() =
  18299. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18300. delete session;
  18301. return nullptr;
  18302. }
  18303. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18304. return static_cast<session_t>(session);
  18305. }
  18306. inline void free_session(session_t session) {
  18307. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18308. }
  18309. inline bool set_sni(session_t session, const char *hostname,
  18310. bool verify_hostname) {
  18311. if (!session || !hostname) { return false; }
  18312. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18313. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18314. static_cast<word16>(strlen(hostname)));
  18315. if (ret != WOLFSSL_SUCCESS) {
  18316. impl::wolfssl_last_error() =
  18317. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18318. return false;
  18319. }
  18320. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18321. // separately from the SNI extension sent above; skip it when hostname
  18322. // verification is disabled so only the chain is checked, matching OpenSSL.
  18323. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18324. wsession->hostname = hostname;
  18325. return true;
  18326. }
  18327. inline TlsError connect(session_t session) {
  18328. TlsError err;
  18329. if (!session) {
  18330. err.code = ErrorCode::Fatal;
  18331. return err;
  18332. }
  18333. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18334. int ret = wolfSSL_connect(wsession->ssl);
  18335. if (ret == SSL_SUCCESS) {
  18336. err.code = ErrorCode::Success;
  18337. } else {
  18338. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18339. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18340. err.backend_code = static_cast<uint64_t>(ssl_error);
  18341. impl::wolfssl_last_error() = err.backend_code;
  18342. }
  18343. return err;
  18344. }
  18345. inline TlsError accept(session_t session) {
  18346. TlsError err;
  18347. if (!session) {
  18348. err.code = ErrorCode::Fatal;
  18349. return err;
  18350. }
  18351. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18352. int ret = wolfSSL_accept(wsession->ssl);
  18353. if (ret == SSL_SUCCESS) {
  18354. err.code = ErrorCode::Success;
  18355. // Capture SNI from thread-local storage after successful handshake
  18356. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18357. impl::wolfssl_pending_sni().clear();
  18358. } else {
  18359. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18360. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18361. err.backend_code = static_cast<uint64_t>(ssl_error);
  18362. impl::wolfssl_last_error() = err.backend_code;
  18363. }
  18364. return err;
  18365. }
  18366. inline bool connect_nonblocking(session_t session, socket_t sock,
  18367. time_t timeout_sec, time_t timeout_usec,
  18368. TlsError *err) {
  18369. if (!session) {
  18370. if (err) { err->code = ErrorCode::Fatal; }
  18371. return false;
  18372. }
  18373. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18374. // Set socket to non-blocking mode
  18375. detail::set_nonblocking(sock, true);
  18376. auto cleanup =
  18377. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18378. int ret;
  18379. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18380. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18381. if (ssl_error == SSL_ERROR_WANT_READ) {
  18382. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18383. continue;
  18384. }
  18385. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18386. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18387. continue;
  18388. }
  18389. }
  18390. // Error or timeout
  18391. if (err) {
  18392. err->code =
  18393. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18394. err->backend_code = static_cast<uint64_t>(ssl_error);
  18395. }
  18396. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18397. return false;
  18398. }
  18399. if (err) { err->code = ErrorCode::Success; }
  18400. return true;
  18401. }
  18402. inline bool accept_nonblocking(session_t session, socket_t sock,
  18403. time_t timeout_sec, time_t timeout_usec,
  18404. TlsError *err) {
  18405. if (!session) {
  18406. if (err) { err->code = ErrorCode::Fatal; }
  18407. return false;
  18408. }
  18409. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18410. // Set socket to non-blocking mode
  18411. detail::set_nonblocking(sock, true);
  18412. auto cleanup =
  18413. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18414. int ret;
  18415. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18416. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18417. if (ssl_error == SSL_ERROR_WANT_READ) {
  18418. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18419. continue;
  18420. }
  18421. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18422. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18423. continue;
  18424. }
  18425. }
  18426. // Error or timeout
  18427. if (err) {
  18428. err->code =
  18429. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18430. err->backend_code = static_cast<uint64_t>(ssl_error);
  18431. }
  18432. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18433. return false;
  18434. }
  18435. if (err) { err->code = ErrorCode::Success; }
  18436. // Capture SNI from thread-local storage after successful handshake
  18437. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18438. impl::wolfssl_pending_sni().clear();
  18439. return true;
  18440. }
  18441. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18442. if (!session || !buf) {
  18443. err.code = ErrorCode::Fatal;
  18444. return -1;
  18445. }
  18446. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18447. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18448. if (ret > 0) {
  18449. err.code = ErrorCode::Success;
  18450. return static_cast<ssize_t>(ret);
  18451. }
  18452. if (ret == 0) {
  18453. err.code = ErrorCode::PeerClosed;
  18454. return 0;
  18455. }
  18456. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18457. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18458. err.backend_code = static_cast<uint64_t>(ssl_error);
  18459. impl::wolfssl_last_error() = err.backend_code;
  18460. return -1;
  18461. }
  18462. inline ssize_t write(session_t session, const void *buf, size_t len,
  18463. TlsError &err) {
  18464. if (!session || !buf) {
  18465. err.code = ErrorCode::Fatal;
  18466. return -1;
  18467. }
  18468. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18469. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18470. if (ret > 0) {
  18471. err.code = ErrorCode::Success;
  18472. return static_cast<ssize_t>(ret);
  18473. }
  18474. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18475. // Treat this as an error (return -1) so callers don't spin in a
  18476. // write loop adding zero to the offset.
  18477. if (ret == 0) {
  18478. err.code = ErrorCode::PeerClosed;
  18479. return -1;
  18480. }
  18481. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18482. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18483. err.backend_code = static_cast<uint64_t>(ssl_error);
  18484. impl::wolfssl_last_error() = err.backend_code;
  18485. return -1;
  18486. }
  18487. inline int pending(const_session_t session) {
  18488. if (!session) { return 0; }
  18489. auto wsession =
  18490. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18491. return wolfSSL_pending(wsession->ssl);
  18492. }
  18493. inline void shutdown(session_t session, bool graceful) {
  18494. if (!session) { return; }
  18495. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18496. if (graceful) {
  18497. int ret;
  18498. int attempts = 0;
  18499. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18500. attempts < 3) {
  18501. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18502. if (ssl_error != SSL_ERROR_WANT_READ &&
  18503. ssl_error != SSL_ERROR_WANT_WRITE) {
  18504. break;
  18505. }
  18506. attempts++;
  18507. }
  18508. } else {
  18509. wolfSSL_shutdown(wsession->ssl);
  18510. }
  18511. }
  18512. inline bool is_peer_closed(session_t session, socket_t sock) {
  18513. if (!session || sock == INVALID_SOCKET) { return true; }
  18514. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18515. // Check if there's already decrypted data available
  18516. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18517. // Set socket to non-blocking to avoid blocking on read
  18518. detail::set_nonblocking(sock, true);
  18519. auto cleanup =
  18520. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18521. // Peek 1 byte to check connection status without consuming data
  18522. unsigned char buf;
  18523. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18524. // If we got data or WANT_READ (would block), connection is alive
  18525. if (ret > 0) { return false; }
  18526. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18527. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18528. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18529. ret == 0;
  18530. }
  18531. inline cert_t get_peer_cert(const_session_t session) {
  18532. if (!session) { return nullptr; }
  18533. auto wsession =
  18534. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18535. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18536. return static_cast<cert_t>(cert);
  18537. }
  18538. inline void free_cert(cert_t cert) {
  18539. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18540. }
  18541. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18542. if (!cert || !hostname) { return false; }
  18543. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18544. std::string host_str(hostname);
  18545. // Check if hostname is an IP address (IPv4 or IPv6)
  18546. unsigned char ip_bytes[16];
  18547. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18548. auto is_ip = ip_len > 0;
  18549. // Check Subject Alternative Names
  18550. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18551. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18552. if (san_names) {
  18553. int san_count = wolfSSL_sk_num(san_names);
  18554. for (int i = 0; i < san_count; i++) {
  18555. auto *names =
  18556. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18557. if (!names) continue;
  18558. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18559. // DNS name
  18560. unsigned char *dns_name = nullptr;
  18561. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18562. if (dns_name && dns_len > 0) {
  18563. std::string san_name(reinterpret_cast<char *>(dns_name),
  18564. static_cast<size_t>(dns_len));
  18565. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18566. if (detail::match_hostname(san_name, host_str)) {
  18567. wolfSSL_sk_free(san_names);
  18568. return true;
  18569. }
  18570. }
  18571. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18572. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18573. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18574. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18575. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18576. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18577. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18578. wolfSSL_sk_free(san_names);
  18579. return true;
  18580. }
  18581. }
  18582. }
  18583. wolfSSL_sk_free(san_names);
  18584. }
  18585. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18586. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18587. // the OpenSSL backend's X509_check_ip behaves the same way).
  18588. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18589. if (subject) {
  18590. char cn[256] = {};
  18591. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18592. sizeof(cn));
  18593. if (cn_len > 0) {
  18594. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18595. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18596. }
  18597. }
  18598. return false;
  18599. }
  18600. inline uint64_t hostname_mismatch_code() {
  18601. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18602. }
  18603. inline long get_verify_result(const_session_t session) {
  18604. if (!session) { return -1; }
  18605. auto wsession =
  18606. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18607. long result = wolfSSL_get_verify_result(wsession->ssl);
  18608. return result;
  18609. }
  18610. inline std::string get_cert_subject_cn(cert_t cert) {
  18611. if (!cert) return "";
  18612. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18613. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18614. if (!subject) return "";
  18615. char cn[256] = {};
  18616. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18617. sizeof(cn));
  18618. if (cn_len <= 0) return "";
  18619. return std::string(cn, static_cast<size_t>(cn_len));
  18620. }
  18621. inline std::string get_cert_issuer_name(cert_t cert) {
  18622. if (!cert) return "";
  18623. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18624. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18625. if (!issuer) return "";
  18626. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18627. if (!name_str) return "";
  18628. std::string result(name_str);
  18629. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18630. return result;
  18631. }
  18632. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18633. sans.clear();
  18634. if (!cert) return false;
  18635. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18636. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18637. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18638. if (!san_names) return true; // No SANs is not an error
  18639. int count = wolfSSL_sk_num(san_names);
  18640. for (int i = 0; i < count; i++) {
  18641. auto *name =
  18642. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18643. if (!name) continue;
  18644. SanEntry entry;
  18645. switch (name->type) {
  18646. case WOLFSSL_GEN_DNS: {
  18647. entry.type = SanType::DNS;
  18648. unsigned char *dns_name = nullptr;
  18649. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18650. if (dns_name && dns_len > 0) {
  18651. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18652. static_cast<size_t>(dns_len));
  18653. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18654. }
  18655. break;
  18656. }
  18657. case WOLFSSL_GEN_IPADD: {
  18658. entry.type = SanType::IP;
  18659. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18660. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18661. if (ip_data && ip_len == 4) {
  18662. char buf[16];
  18663. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18664. ip_data[2], ip_data[3]);
  18665. entry.value = buf;
  18666. } else if (ip_data && ip_len == 16) {
  18667. char buf[64];
  18668. snprintf(buf, sizeof(buf),
  18669. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18670. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18671. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18672. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18673. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18674. ip_data[14], ip_data[15]);
  18675. entry.value = buf;
  18676. }
  18677. break;
  18678. }
  18679. case WOLFSSL_GEN_EMAIL:
  18680. entry.type = SanType::EMAIL;
  18681. {
  18682. unsigned char *email = nullptr;
  18683. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18684. if (email && email_len > 0) {
  18685. entry.value = std::string(reinterpret_cast<char *>(email),
  18686. static_cast<size_t>(email_len));
  18687. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18688. }
  18689. }
  18690. break;
  18691. case WOLFSSL_GEN_URI:
  18692. entry.type = SanType::URI;
  18693. {
  18694. unsigned char *uri = nullptr;
  18695. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18696. &uri, name->d.uniformResourceIdentifier);
  18697. if (uri && uri_len > 0) {
  18698. entry.value = std::string(reinterpret_cast<char *>(uri),
  18699. static_cast<size_t>(uri_len));
  18700. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18701. }
  18702. }
  18703. break;
  18704. default: entry.type = SanType::OTHER; break;
  18705. }
  18706. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18707. }
  18708. wolfSSL_sk_free(san_names);
  18709. return true;
  18710. }
  18711. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18712. time_t &not_after) {
  18713. if (!cert) return false;
  18714. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18715. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18716. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18717. if (!nb || !na) return false;
  18718. // wolfSSL_ASN1_TIME_to_tm is available
  18719. struct tm tm_nb = {}, tm_na = {};
  18720. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18721. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18722. #ifdef _WIN32
  18723. not_before = _mkgmtime(&tm_nb);
  18724. not_after = _mkgmtime(&tm_na);
  18725. #else
  18726. not_before = timegm(&tm_nb);
  18727. not_after = timegm(&tm_na);
  18728. #endif
  18729. return true;
  18730. }
  18731. inline std::string get_cert_serial(cert_t cert) {
  18732. if (!cert) return "";
  18733. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18734. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18735. if (!serial_asn1) return "";
  18736. // Get the serial number data
  18737. int len = serial_asn1->length;
  18738. unsigned char *data = serial_asn1->data;
  18739. if (!data || len <= 0) return "";
  18740. std::string result;
  18741. result.reserve(static_cast<size_t>(len) * 2);
  18742. for (int i = 0; i < len; i++) {
  18743. char hex[3];
  18744. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18745. result += hex;
  18746. }
  18747. return result;
  18748. }
  18749. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18750. if (!cert) return false;
  18751. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18752. int der_len = 0;
  18753. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18754. if (!der_data || der_len <= 0) return false;
  18755. der.assign(der_data, der_data + der_len);
  18756. return true;
  18757. }
  18758. inline const char *get_sni(const_session_t session) {
  18759. if (!session) return nullptr;
  18760. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18761. // For server: return SNI received from client during handshake
  18762. if (!wsession->sni_hostname.empty()) {
  18763. return wsession->sni_hostname.c_str();
  18764. }
  18765. // For client: return the hostname set via set_sni
  18766. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18767. return nullptr;
  18768. }
  18769. inline uint64_t peek_error() {
  18770. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18771. }
  18772. inline uint64_t get_error() {
  18773. uint64_t err = impl::wolfssl_last_error();
  18774. impl::wolfssl_last_error() = 0;
  18775. return err;
  18776. }
  18777. inline std::string error_string(uint64_t code) {
  18778. char buf[256];
  18779. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18780. return std::string(buf);
  18781. }
  18782. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18783. if (!pem || len == 0) { return nullptr; }
  18784. // Validate by attempting to load into a temporary ctx
  18785. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18786. if (!tmp_ctx) { return nullptr; }
  18787. int ret = wolfSSL_CTX_load_verify_buffer(
  18788. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18789. static_cast<long>(len), SSL_FILETYPE_PEM);
  18790. wolfSSL_CTX_free(tmp_ctx);
  18791. if (ret != SSL_SUCCESS) { return nullptr; }
  18792. return static_cast<ca_store_t>(
  18793. new impl::WolfSSLCAStore{std::string(pem, len)});
  18794. }
  18795. inline void free_ca_store(ca_store_t store) {
  18796. delete static_cast<impl::WolfSSLCAStore *>(store);
  18797. }
  18798. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18799. if (!ctx || !store) { return false; }
  18800. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18801. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18802. int ret = wolfSSL_CTX_load_verify_buffer(
  18803. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18804. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18805. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18806. // This function takes ownership of the store; the PEM data was copied into
  18807. // the context, so release the source
  18808. free_ca_store(store);
  18809. return ret == SSL_SUCCESS;
  18810. }
  18811. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18812. certs.clear();
  18813. if (!ctx) { return 0; }
  18814. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18815. if (wctx->ca_pem_data_.empty()) { return 0; }
  18816. const std::string &pem = wctx->ca_pem_data_;
  18817. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18818. const std::string end_marker = "-----END CERTIFICATE-----";
  18819. size_t pos = 0;
  18820. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18821. size_t end_pos = pem.find(end_marker, pos);
  18822. if (end_pos == std::string::npos) { break; }
  18823. end_pos += end_marker.size();
  18824. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18825. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18826. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18827. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18828. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18829. pos = end_pos;
  18830. }
  18831. return certs.size();
  18832. }
  18833. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18834. std::vector<std::string> names;
  18835. if (!ctx) { return names; }
  18836. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18837. if (wctx->ca_pem_data_.empty()) { return names; }
  18838. const std::string &pem = wctx->ca_pem_data_;
  18839. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18840. const std::string end_marker = "-----END CERTIFICATE-----";
  18841. size_t pos = 0;
  18842. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18843. size_t end_pos = pem.find(end_marker, pos);
  18844. if (end_pos == std::string::npos) { break; }
  18845. end_pos += end_marker.size();
  18846. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18847. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18848. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18849. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18850. if (x509) {
  18851. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18852. if (subject) {
  18853. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  18854. if (name_str) {
  18855. names.push_back(name_str);
  18856. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18857. }
  18858. }
  18859. wolfSSL_X509_free(x509);
  18860. }
  18861. pos = end_pos;
  18862. }
  18863. return names;
  18864. }
  18865. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18866. const char *key_pem, const char *password) {
  18867. if (!ctx || !cert_pem || !key_pem) { return false; }
  18868. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18869. // Load new certificate
  18870. int ret = wolfSSL_CTX_use_certificate_buffer(
  18871. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  18872. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  18873. if (ret != SSL_SUCCESS) {
  18874. impl::wolfssl_last_error() =
  18875. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18876. return false;
  18877. }
  18878. // Set password if provided
  18879. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18880. // Load new private key
  18881. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18882. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  18883. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  18884. if (ret != SSL_SUCCESS) {
  18885. impl::wolfssl_last_error() =
  18886. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18887. return false;
  18888. }
  18889. return true;
  18890. }
  18891. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18892. if (!ctx || !ca_pem) { return false; }
  18893. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18894. int ret = wolfSSL_CTX_load_verify_buffer(
  18895. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  18896. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  18897. if (ret != SSL_SUCCESS) {
  18898. impl::wolfssl_last_error() =
  18899. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18900. return false;
  18901. }
  18902. return true;
  18903. }
  18904. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18905. if (!ctx) { return false; }
  18906. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18907. impl::get_verify_callback() = std::move(callback);
  18908. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  18909. if (wctx->has_verify_callback) {
  18910. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18911. impl::wolfssl_verify_callback);
  18912. } else {
  18913. wolfSSL_CTX_set_verify(
  18914. wctx->ctx,
  18915. wctx->verify_client
  18916. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  18917. : SSL_VERIFY_NONE,
  18918. nullptr);
  18919. }
  18920. return true;
  18921. }
  18922. inline long get_verify_error(const_session_t session) {
  18923. if (!session) { return -1; }
  18924. auto *wsession =
  18925. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18926. return wolfSSL_get_verify_result(wsession->ssl);
  18927. }
  18928. inline std::string verify_error_string(long error_code) {
  18929. if (error_code == 0) { return ""; }
  18930. const char *str =
  18931. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  18932. return str ? std::string(str) : std::string();
  18933. }
  18934. } // namespace tls
  18935. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  18936. // WebSocket implementation
  18937. namespace ws {
  18938. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  18939. bool fin) {
  18940. std::lock_guard<std::mutex> lock(write_mutex_);
  18941. if (closed_) { return false; }
  18942. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  18943. }
  18944. inline ReadResult WebSocket::read(std::string &msg) {
  18945. std::unique_lock<std::mutex> read_lock(read_mutex_);
  18946. while (!closed_) {
  18947. Opcode opcode;
  18948. std::string payload;
  18949. bool fin;
  18950. impl::FrameRead r =
  18951. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  18952. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  18953. // A timeout landed on a frame boundary: the connection is untouched and
  18954. // still usable, so hand control back without closing it.
  18955. if (r == impl::FrameRead::Timeout) { return Timeout; }
  18956. if (r != impl::FrameRead::Ok) {
  18957. closed_ = true;
  18958. return Fail;
  18959. }
  18960. switch (opcode) {
  18961. case Opcode::Ping: {
  18962. std::lock_guard<std::mutex> lock(write_mutex_);
  18963. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  18964. payload.size(), true, !is_server_);
  18965. continue;
  18966. }
  18967. case Opcode::Pong: {
  18968. std::lock_guard<std::mutex> lock(ping_mutex_);
  18969. unacked_pings_ = 0;
  18970. continue;
  18971. }
  18972. case Opcode::Close: {
  18973. if (!closed_.exchange(true)) {
  18974. // Echo close frame back
  18975. std::lock_guard<std::mutex> lock(write_mutex_);
  18976. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18977. payload.size(), true, !is_server_);
  18978. }
  18979. return Fail;
  18980. }
  18981. case Opcode::Text:
  18982. case Opcode::Binary: {
  18983. auto result = opcode == Opcode::Text ? Text : Binary;
  18984. msg = std::move(payload);
  18985. // Handle fragmentation
  18986. if (!fin) {
  18987. while (true) {
  18988. Opcode cont_opcode;
  18989. std::string cont_payload;
  18990. bool cont_fin;
  18991. // A timeout is not reportable here: half of a fragmented message is
  18992. // already in `msg` and read() has no way to resume it, so it is a
  18993. // failure like any other. Timeouts are only ever seen on a message
  18994. // boundary.
  18995. if (impl::read_websocket_frame(
  18996. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  18997. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  18998. impl::FrameRead::Ok) {
  18999. closed_ = true;
  19000. return Fail;
  19001. }
  19002. if (cont_opcode == Opcode::Ping) {
  19003. std::lock_guard<std::mutex> lock(write_mutex_);
  19004. detail::write_websocket_frame(
  19005. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19006. true, !is_server_);
  19007. continue;
  19008. }
  19009. if (cont_opcode == Opcode::Pong) {
  19010. std::lock_guard<std::mutex> lock(ping_mutex_);
  19011. unacked_pings_ = 0;
  19012. continue;
  19013. }
  19014. if (cont_opcode == Opcode::Close) {
  19015. if (!closed_.exchange(true)) {
  19016. std::lock_guard<std::mutex> lock(write_mutex_);
  19017. detail::write_websocket_frame(
  19018. strm_, Opcode::Close, cont_payload.data(),
  19019. cont_payload.size(), true, !is_server_);
  19020. }
  19021. return Fail;
  19022. }
  19023. // RFC 6455: continuation frames must use opcode 0x0
  19024. if (cont_opcode != Opcode::Continuation) {
  19025. closed_ = true;
  19026. return Fail;
  19027. }
  19028. msg += cont_payload;
  19029. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19030. closed_ = true;
  19031. return Fail;
  19032. }
  19033. if (cont_fin) { break; }
  19034. }
  19035. }
  19036. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19037. if (result == Text && !impl::is_valid_utf8(msg)) {
  19038. // close() takes the read lock to wait for the peer's Close reply, so
  19039. // it must not run while this thread still holds it.
  19040. read_lock.unlock();
  19041. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19042. return Fail;
  19043. }
  19044. return result;
  19045. }
  19046. default: closed_ = true; return Fail;
  19047. }
  19048. }
  19049. return Fail;
  19050. }
  19051. inline bool WebSocket::send(const std::string &data) {
  19052. return send_frame(Opcode::Text, data.data(), data.size());
  19053. }
  19054. inline bool WebSocket::send(const char *data, size_t len) {
  19055. return send_frame(Opcode::Binary, data, len);
  19056. }
  19057. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19058. if (closed_.exchange(true)) { return; }
  19059. ping_cv_.notify_all();
  19060. std::string payload;
  19061. auto code = static_cast<uint16_t>(status);
  19062. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19063. payload.push_back(static_cast<char>(code & 0xFF));
  19064. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19065. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19066. payload += reason.substr(0, 123);
  19067. {
  19068. std::lock_guard<std::mutex> lock(write_mutex_);
  19069. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19070. payload.size(), true, !is_server_);
  19071. }
  19072. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19073. // Close response before closing the TCP connection.
  19074. //
  19075. // Wait only when no other thread is parsing frames. When one is, it is the
  19076. // thread positioned to see the peer's reply, and reading here would take
  19077. // bytes out of the message it is assembling. Bailing out also leaves the
  19078. // stream, including its read timeout, entirely to that thread.
  19079. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19080. if (!read_lock.owns_lock()) { return; }
  19081. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19082. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19083. Opcode op;
  19084. std::string resp;
  19085. bool fin;
  19086. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19087. impl::FrameRead::Ok) {
  19088. if (op == Opcode::Close) { break; }
  19089. }
  19090. }
  19091. inline WebSocket::~WebSocket() {
  19092. {
  19093. std::lock_guard<std::mutex> lock(ping_mutex_);
  19094. closed_ = true;
  19095. }
  19096. ping_cv_.notify_all();
  19097. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19098. }
  19099. inline void WebSocket::start_heartbeat() {
  19100. if (ping_interval_sec_ == 0) { return; }
  19101. ping_thread_ = std::thread([this]() {
  19102. std::unique_lock<std::mutex> lock(ping_mutex_);
  19103. while (!closed_) {
  19104. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19105. if (closed_) { break; }
  19106. // If the peer has failed to respond to the previous pings, give up.
  19107. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19108. // opt-in liveness check controlled by max_missed_pongs_.
  19109. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19110. lock.unlock();
  19111. close(CloseStatus::GoingAway, "pong timeout");
  19112. return;
  19113. }
  19114. lock.unlock();
  19115. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19116. lock.lock();
  19117. closed_ = true;
  19118. break;
  19119. }
  19120. lock.lock();
  19121. unacked_pings_++;
  19122. }
  19123. });
  19124. }
  19125. inline const Request &WebSocket::request() const { return req_; }
  19126. inline bool WebSocket::is_open() const { return !closed_; }
  19127. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19128. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19129. // poll(), where 0 would instead mean "return immediately", so hand it the
  19130. // negative poll uses for an unbounded wait.
  19131. if (sec == 0 && usec == 0) { sec = -1; }
  19132. strm_.set_read_timeout(sec, usec);
  19133. }
  19134. // WebSocketClient implementation
  19135. inline WebSocketClient::WebSocketClient(
  19136. const std::string &scheme_host_port_path, const Headers &headers)
  19137. : headers_(headers) {
  19138. detail::UrlComponents uc;
  19139. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19140. !uc.host.empty() && !uc.path.empty()) {
  19141. auto &scheme = uc.scheme;
  19142. #ifdef CPPHTTPLIB_SSL_ENABLED
  19143. if (scheme != "ws" && scheme != "wss") {
  19144. #else
  19145. if (scheme != "ws") {
  19146. #endif
  19147. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19148. std::string msg = "'" + scheme + "' scheme is not supported.";
  19149. throw std::invalid_argument(msg);
  19150. #endif
  19151. return;
  19152. }
  19153. auto is_ssl = scheme == "wss";
  19154. host_ = std::move(uc.host);
  19155. port_ = is_ssl ? 443 : 80;
  19156. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19157. path_ = std::move(uc.path);
  19158. if (!uc.query.empty()) { path_ += uc.query; }
  19159. #ifdef CPPHTTPLIB_SSL_ENABLED
  19160. is_ssl_ = is_ssl;
  19161. if (is_ssl_) {
  19162. // The context lives as long as the client so that CA configuration
  19163. // survives reconnects; sessions are created per connection.
  19164. tls_ctx_ = tls::create_client_context();
  19165. if (!tls_ctx_) { return; }
  19166. }
  19167. #else
  19168. if (is_ssl) { return; }
  19169. #endif
  19170. is_valid_ = true;
  19171. }
  19172. }
  19173. #ifdef CPPHTTPLIB_SSL_ENABLED
  19174. inline WebSocketClient::WebSocketClient(
  19175. const std::string &scheme_host_port_path, const PemMemory &pem,
  19176. const Headers &headers)
  19177. : WebSocketClient(scheme_host_port_path, headers) {
  19178. // For ws:// URLs the client certificate is silently ignored, consistent
  19179. // with the TLS-only setters such as set_ca_cert_path().
  19180. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19181. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19182. pem.private_key_password)) {
  19183. tls::free_context(tls_ctx_);
  19184. tls_ctx_ = nullptr;
  19185. is_valid_ = false;
  19186. }
  19187. }
  19188. }
  19189. #endif
  19190. inline WebSocketClient::~WebSocketClient() {
  19191. shutdown_and_close();
  19192. #ifdef CPPHTTPLIB_SSL_ENABLED
  19193. if (tls_ctx_) {
  19194. tls::free_context(tls_ctx_);
  19195. tls_ctx_ = nullptr;
  19196. }
  19197. #endif
  19198. }
  19199. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19200. inline void WebSocketClient::shutdown_and_close() {
  19201. // Send the close frame while the TLS session is still alive: ws_ holds an
  19202. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19203. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19204. if (ws_ && ws_->is_open()) { ws_->close(); }
  19205. ws_.reset();
  19206. #ifdef CPPHTTPLIB_SSL_ENABLED
  19207. if (is_ssl_) {
  19208. if (tls_session_) {
  19209. tls::shutdown(tls_session_, true);
  19210. tls::free_session(tls_session_);
  19211. tls_session_ = nullptr;
  19212. }
  19213. }
  19214. #endif
  19215. if (sock_ != INVALID_SOCKET) {
  19216. detail::shutdown_socket(sock_);
  19217. detail::close_socket(sock_);
  19218. sock_ = INVALID_SOCKET;
  19219. }
  19220. }
  19221. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19222. Error &error, int &ssl_error,
  19223. uint64_t &ssl_backend_error) {
  19224. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19225. // The streams wait with poll(), where 0 instead means "return immediately",
  19226. // so they are given the negative poll uses for an unbounded wait.
  19227. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19228. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19229. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19230. // The handshake belongs to establishing the connection, so an unset read
  19231. // timeout leaves it bounded by the connection timeout instead of forever.
  19232. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19233. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19234. #ifdef CPPHTTPLIB_SSL_ENABLED
  19235. if (is_ssl_) {
  19236. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19237. // is not safe to call concurrently on one client to begin with, since
  19238. // nothing else here is guarded either.
  19239. if (server_certificate_verification_ && !certs_loaded_) {
  19240. uint64_t backend_error = 0;
  19241. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19242. ca_cert_dir_path_, custom_ca_loaded_,
  19243. system_ca_mode_, backend_error);
  19244. certs_loaded_ = true;
  19245. }
  19246. detail::ClientTlsSessionOptions options;
  19247. options.server_hostname_verification = server_hostname_verification_;
  19248. detail::ClientTlsSessionError tls_error;
  19249. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19250. server_certificate_verification_,
  19251. hs_sec, hs_usec, &tls_error,
  19252. options)) {
  19253. error = tls_error.error;
  19254. ssl_error = tls_error.ssl_error;
  19255. ssl_backend_error = tls_error.backend_error;
  19256. return false;
  19257. }
  19258. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19259. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19260. write_timeout_usec_));
  19261. return true;
  19262. }
  19263. #else
  19264. (void)error;
  19265. (void)ssl_error;
  19266. (void)ssl_backend_error;
  19267. (void)hs_sec;
  19268. (void)hs_usec;
  19269. #endif
  19270. strm = std::unique_ptr<Stream>(
  19271. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19272. write_timeout_sec_, write_timeout_usec_));
  19273. return true;
  19274. }
  19275. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19276. #ifdef CPPHTTPLIB_SSL_ENABLED
  19277. auto is_ssl = is_ssl_;
  19278. #else
  19279. auto is_ssl = false;
  19280. #endif
  19281. if (!req.has_header("Host")) {
  19282. req.headers.emplace("Host", detail::make_default_host_header_value(
  19283. host_, port_, is_ssl, address_family_));
  19284. }
  19285. detail::add_default_user_agent_header(req);
  19286. }
  19287. inline Result WebSocketClient::connect() {
  19288. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19289. shutdown_and_close();
  19290. // Check is custom IP or hostname specified for host_
  19291. std::string connect_host;
  19292. std::string ip;
  19293. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19294. auto error = Error::Success;
  19295. sock_ = detail::create_client_socket(
  19296. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19297. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19298. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19299. write_timeout_usec_, interface_, error);
  19300. if (sock_ == INVALID_SOCKET) {
  19301. if (error == Error::Success) { error = Error::Connection; }
  19302. return Result{error, -1, Headers{}};
  19303. }
  19304. std::unique_ptr<Stream> strm;
  19305. auto stream_error = Error::SSLConnection;
  19306. int ssl_error = 0;
  19307. uint64_t ssl_backend_error = 0;
  19308. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19309. shutdown_and_close();
  19310. #ifdef CPPHTTPLIB_SSL_ENABLED
  19311. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19312. #else
  19313. return Result{stream_error, -1, Headers{}};
  19314. #endif
  19315. }
  19316. Request req;
  19317. req.method = "GET";
  19318. req.path = path_;
  19319. req.headers = headers_;
  19320. prepare_default_headers(req);
  19321. detail::WebSocketUpgradeResponse upgrade;
  19322. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19323. shutdown_and_close();
  19324. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19325. }
  19326. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19327. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19328. websocket_ping_interval_sec_,
  19329. websocket_max_missed_pongs_));
  19330. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19331. }
  19332. inline ReadResult WebSocketClient::read(std::string &msg) {
  19333. if (!ws_) { return Fail; }
  19334. return ws_->read(msg);
  19335. }
  19336. inline bool WebSocketClient::send(const std::string &data) {
  19337. if (!ws_) { return false; }
  19338. return ws_->send(data);
  19339. }
  19340. inline bool WebSocketClient::send(const char *data, size_t len) {
  19341. if (!ws_) { return false; }
  19342. return ws_->send(data, len);
  19343. }
  19344. inline void WebSocketClient::close(CloseStatus status,
  19345. const std::string &reason) {
  19346. if (ws_) { ws_->close(status, reason); }
  19347. }
  19348. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19349. inline const std::string &WebSocketClient::subprotocol() const {
  19350. return subprotocol_;
  19351. }
  19352. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19353. read_timeout_sec_ = sec;
  19354. read_timeout_usec_ = usec;
  19355. // The members above only seed the next connect(); read() consults the
  19356. // stream, so an already-open connection has to be told directly.
  19357. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19358. }
  19359. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19360. write_timeout_sec_ = sec;
  19361. write_timeout_usec_ = usec;
  19362. }
  19363. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19364. websocket_ping_interval_sec_ = sec;
  19365. }
  19366. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19367. websocket_max_missed_pongs_ = count;
  19368. }
  19369. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19370. inline void WebSocketClient::set_address_family(int family) {
  19371. address_family_ = family;
  19372. }
  19373. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19374. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19375. socket_options_ = std::move(socket_options);
  19376. }
  19377. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19378. connection_timeout_sec_ = sec;
  19379. connection_timeout_usec_ = usec;
  19380. }
  19381. inline void WebSocketClient::set_interface(const std::string &intf) {
  19382. interface_ = intf;
  19383. }
  19384. inline void WebSocketClient::set_hostname_addr_map(
  19385. std::map<std::string, std::string> addr_map) {
  19386. addr_map_ = std::move(addr_map);
  19387. }
  19388. #ifdef CPPHTTPLIB_SSL_ENABLED
  19389. inline void
  19390. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19391. const std::string &ca_cert_dir_path) {
  19392. ca_cert_file_path_ = ca_cert_file_path;
  19393. ca_cert_dir_path_ = ca_cert_dir_path;
  19394. }
  19395. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19396. if (store && tls_ctx_) {
  19397. // set_ca_store takes ownership of store
  19398. tls::set_ca_store(tls_ctx_, store);
  19399. custom_ca_loaded_ = true;
  19400. } else if (store) {
  19401. tls::free_ca_store(store);
  19402. }
  19403. }
  19404. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19405. std::size_t size) {
  19406. if (tls_ctx_ && ca_cert && size > 0) {
  19407. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19408. custom_ca_loaded_ = true;
  19409. }
  19410. }
  19411. inline void
  19412. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19413. server_certificate_verification_ = enabled;
  19414. }
  19415. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19416. server_hostname_verification_ = enabled;
  19417. }
  19418. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19419. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19420. }
  19421. #endif // CPPHTTPLIB_SSL_ENABLED
  19422. } // namespace ws
  19423. // ----------------------------------------------------------------------------
  19424. } // namespace httplib
  19425. #endif // CPPHTTPLIB_HTTPLIB_H