httplib.h 767 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693
  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. #ifndef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  170. #define CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND 300
  171. #endif
  172. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  173. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  174. #endif
  175. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  176. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  177. #endif
  178. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  179. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  180. #endif
  181. /*
  182. * Headers
  183. */
  184. #ifdef _WIN32
  185. #ifndef _CRT_SECURE_NO_WARNINGS
  186. #define _CRT_SECURE_NO_WARNINGS
  187. #endif //_CRT_SECURE_NO_WARNINGS
  188. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  189. #define _CRT_NONSTDC_NO_DEPRECATE
  190. #endif //_CRT_NONSTDC_NO_DEPRECATE
  191. #if defined(_MSC_VER)
  192. #if _MSC_VER < 1900
  193. #error Sorry, Visual Studio versions prior to 2015 are not supported
  194. #endif
  195. #pragma comment(lib, "ws2_32.lib")
  196. #ifndef _SSIZE_T_DEFINED
  197. using ssize_t = __int64;
  198. #define _SSIZE_T_DEFINED
  199. #endif
  200. #endif // _MSC_VER
  201. #ifndef S_ISREG
  202. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  203. #endif // S_ISREG
  204. #ifndef S_ISDIR
  205. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  206. #endif // S_ISDIR
  207. #ifndef NOMINMAX
  208. #define NOMINMAX
  209. #endif // NOMINMAX
  210. #include <io.h>
  211. #include <winsock2.h>
  212. #include <ws2tcpip.h>
  213. #if defined(__has_include)
  214. #if __has_include(<afunix.h>)
  215. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  216. #include <afunix.h>
  217. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  218. #endif
  219. #endif
  220. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  221. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  222. #endif
  223. using nfds_t = unsigned long;
  224. using socket_t = SOCKET;
  225. using socklen_t = int;
  226. #else // not _WIN32
  227. #include <arpa/inet.h>
  228. #if !defined(_AIX) && !defined(__MVS__)
  229. #include <ifaddrs.h>
  230. #endif
  231. #ifdef __MVS__
  232. #include <strings.h>
  233. #ifndef NI_MAXHOST
  234. #define NI_MAXHOST 1025
  235. #endif
  236. #endif
  237. #include <net/if.h>
  238. #include <netdb.h>
  239. #include <netinet/in.h>
  240. #ifdef __linux__
  241. #include <resolv.h>
  242. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  243. #endif
  244. #include <csignal>
  245. #include <netinet/tcp.h>
  246. #include <poll.h>
  247. #include <pthread.h>
  248. #include <sys/mman.h>
  249. #include <sys/socket.h>
  250. #include <sys/un.h>
  251. #include <unistd.h>
  252. using socket_t = int;
  253. #ifndef INVALID_SOCKET
  254. #define INVALID_SOCKET (-1)
  255. #endif
  256. #endif //_WIN32
  257. #if defined(__APPLE__)
  258. #include <TargetConditionals.h>
  259. #endif
  260. #include <algorithm>
  261. #include <array>
  262. #include <atomic>
  263. #include <cassert>
  264. #include <chrono>
  265. #include <climits>
  266. #include <condition_variable>
  267. #include <cstdlib>
  268. #include <cstring>
  269. #include <errno.h>
  270. #include <exception>
  271. #include <fcntl.h>
  272. #include <fstream>
  273. #include <functional>
  274. #include <iomanip>
  275. #include <iostream>
  276. #include <iterator>
  277. #include <list>
  278. #include <map>
  279. #include <memory>
  280. #include <mutex>
  281. #include <random>
  282. #include <regex>
  283. #include <set>
  284. #include <sstream>
  285. #include <string>
  286. #include <sys/stat.h>
  287. #include <system_error>
  288. #include <thread>
  289. #include <type_traits>
  290. #include <unordered_map>
  291. #include <unordered_set>
  292. #include <utility>
  293. #include <vector>
  294. // On macOS with a TLS backend, enable Keychain root certificates by default
  295. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  296. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  297. // only; on those platforms the user must provide a CA bundle explicitly.
  298. #if defined(__APPLE__) && defined(__clang__) && \
  299. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  300. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  301. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  302. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  303. #if TARGET_OS_OSX
  304. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  305. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  306. #endif
  307. #endif
  308. #endif
  309. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  310. defined(__APPLE__) && !TARGET_OS_OSX
  311. #error \
  312. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  313. #endif
  314. // On Windows, enable Schannel certificate verification by default
  315. // unless the user explicitly opts out.
  316. #if defined(_WIN32) && \
  317. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  318. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  319. #endif
  320. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  321. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  322. #if TARGET_OS_MAC && defined(__clang__)
  323. #include <CFNetwork/CFHost.h>
  324. #include <CoreFoundation/CoreFoundation.h>
  325. #endif
  326. #endif
  327. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  328. #ifdef _WIN32
  329. #include <wincrypt.h>
  330. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  331. // used
  332. #undef X509_NAME
  333. #undef X509_CERT_PAIR
  334. #undef X509_EXTENSIONS
  335. #undef PKCS7_SIGNER_INFO
  336. #ifdef _MSC_VER
  337. #pragma comment(lib, "crypt32.lib")
  338. #endif
  339. #endif // _WIN32
  340. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  341. #if TARGET_OS_OSX
  342. #include <Security/Security.h>
  343. #endif
  344. #endif
  345. #include <openssl/err.h>
  346. #include <openssl/evp.h>
  347. #include <openssl/ssl.h>
  348. #include <openssl/x509v3.h>
  349. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  350. #include <openssl/applink.c>
  351. #endif
  352. #include <iostream>
  353. #include <sstream>
  354. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  355. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  356. #error Please use OpenSSL or a current version of BoringSSL
  357. #endif
  358. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  359. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  360. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  361. #endif
  362. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  363. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  364. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  365. // in with this first include group so the version gating below can use it.
  366. #include <mbedtls/error.h>
  367. #include <mbedtls/net_sockets.h>
  368. #include <mbedtls/oid.h>
  369. #include <mbedtls/pk.h>
  370. #include <mbedtls/ssl.h>
  371. #include <mbedtls/version.h>
  372. #include <mbedtls/x509_crt.h>
  373. #if MBEDTLS_VERSION_MAJOR >= 4
  374. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  375. #include <psa/crypto.h>
  376. #else
  377. #include <mbedtls/ctr_drbg.h>
  378. #include <mbedtls/entropy.h>
  379. #include <mbedtls/md5.h>
  380. #include <mbedtls/sha1.h>
  381. #include <mbedtls/sha256.h>
  382. #include <mbedtls/sha512.h>
  383. #endif
  384. #ifdef _WIN32
  385. #include <wincrypt.h>
  386. #ifdef _MSC_VER
  387. #pragma comment(lib, "crypt32.lib")
  388. #endif
  389. #endif // _WIN32
  390. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  391. #if TARGET_OS_OSX
  392. #include <Security/Security.h>
  393. #endif
  394. #endif
  395. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  396. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  397. #if MBEDTLS_VERSION_MAJOR >= 4
  398. #define CPPHTTPLIB_MBEDTLS_V4
  399. #endif
  400. #if MBEDTLS_VERSION_MAJOR >= 3
  401. #define CPPHTTPLIB_MBEDTLS_V3
  402. #endif
  403. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  404. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  405. #include <wolfssl/options.h>
  406. #include <wolfssl/openssl/x509v3.h>
  407. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  408. #ifndef WOLFSSL_GEN_EMAIL
  409. #define WOLFSSL_GEN_EMAIL 1
  410. #endif
  411. #ifndef WOLFSSL_GEN_DNS
  412. #define WOLFSSL_GEN_DNS 2
  413. #endif
  414. #ifndef WOLFSSL_GEN_URI
  415. #define WOLFSSL_GEN_URI 6
  416. #endif
  417. #ifndef WOLFSSL_GEN_IPADD
  418. #define WOLFSSL_GEN_IPADD 7
  419. #endif
  420. #include <wolfssl/ssl.h>
  421. #include <wolfssl/wolfcrypt/hash.h>
  422. #include <wolfssl/wolfcrypt/md5.h>
  423. #include <wolfssl/wolfcrypt/sha256.h>
  424. #include <wolfssl/wolfcrypt/sha512.h>
  425. #ifdef _WIN32
  426. #include <wincrypt.h>
  427. #ifdef _MSC_VER
  428. #pragma comment(lib, "crypt32.lib")
  429. #endif
  430. #endif // _WIN32
  431. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  432. #if TARGET_OS_OSX
  433. #include <Security/Security.h>
  434. #endif
  435. #endif
  436. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  437. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  438. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  439. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  440. #define CPPHTTPLIB_SSL_ENABLED
  441. #endif
  442. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  443. #include <zlib.h>
  444. #endif
  445. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  446. #include <brotli/decode.h>
  447. #include <brotli/encode.h>
  448. #endif
  449. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  450. #include <zstd.h>
  451. #endif
  452. /*
  453. * Declaration
  454. */
  455. namespace httplib {
  456. namespace ws {
  457. class WebSocket;
  458. } // namespace ws
  459. namespace detail {
  460. /*
  461. * Backport std::make_unique from C++14.
  462. *
  463. * NOTE: This code came up with the following stackoverflow post:
  464. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  465. *
  466. */
  467. template <class T, class... Args>
  468. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  469. make_unique(Args &&...args) {
  470. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  471. }
  472. template <class T>
  473. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  474. make_unique(std::size_t n) {
  475. typedef typename std::remove_extent<T>::type RT;
  476. return std::unique_ptr<T>(new RT[n]);
  477. }
  478. // Locale-independent ASCII character classification. The <cctype>
  479. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  480. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  481. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  482. // classified without regard to the locale.
  483. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  484. inline bool is_ascii_alpha(char c) {
  485. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  486. }
  487. inline bool is_ascii_alnum(char c) {
  488. return is_ascii_digit(c) || is_ascii_alpha(c);
  489. }
  490. namespace case_ignore {
  491. inline unsigned char to_lower(int c) {
  492. const static unsigned char table[256] = {
  493. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  494. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  495. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  496. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  497. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  498. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  499. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  500. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  501. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  502. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  503. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  504. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  505. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  506. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  507. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  508. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  509. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  510. 255,
  511. };
  512. return table[(unsigned char)(char)c];
  513. }
  514. inline std::string to_lower(const std::string &s) {
  515. std::string result = s;
  516. std::transform(
  517. result.begin(), result.end(), result.begin(),
  518. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  519. return result;
  520. }
  521. inline bool equal(const std::string &a, const std::string &b) {
  522. return a.size() == b.size() &&
  523. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  524. return to_lower(ca) == to_lower(cb);
  525. });
  526. }
  527. struct equal_to {
  528. bool operator()(const std::string &a, const std::string &b) const {
  529. return equal(a, b);
  530. }
  531. };
  532. struct hash {
  533. size_t operator()(const std::string &key) const {
  534. return hash_core(key.data(), key.size(), 0);
  535. }
  536. size_t hash_core(const char *s, size_t l, size_t h) const {
  537. return (l == 0) ? h
  538. : hash_core(s + 1, l - 1,
  539. // Unsets the 6 high bits of h, therefore no
  540. // overflow happens
  541. (((std::numeric_limits<size_t>::max)() >> 6) &
  542. h * 33) ^
  543. static_cast<unsigned char>(to_lower(*s)));
  544. }
  545. };
  546. template <typename T>
  547. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  548. detail::case_ignore::equal_to>;
  549. } // namespace case_ignore
  550. // This is based on
  551. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  552. struct scope_exit {
  553. explicit scope_exit(std::function<void(void)> &&f)
  554. : exit_function(std::move(f)), execute_on_destruction{true} {}
  555. scope_exit(scope_exit &&rhs) noexcept
  556. : exit_function(std::move(rhs.exit_function)),
  557. execute_on_destruction{rhs.execute_on_destruction} {
  558. rhs.release();
  559. }
  560. ~scope_exit() {
  561. if (execute_on_destruction) { this->exit_function(); }
  562. }
  563. void release() { this->execute_on_destruction = false; }
  564. private:
  565. scope_exit(const scope_exit &) = delete;
  566. void operator=(const scope_exit &) = delete;
  567. scope_exit &operator=(scope_exit &&) = delete;
  568. std::function<void(void)> exit_function;
  569. bool execute_on_destruction;
  570. };
  571. // Simple from_chars implementation for integer and double types (C++17
  572. // substitute)
  573. template <typename T> struct from_chars_result {
  574. const char *ptr;
  575. std::errc ec;
  576. };
  577. template <typename T>
  578. inline from_chars_result<T> from_chars(const char *first, const char *last,
  579. T &value, int base = 10) {
  580. value = 0;
  581. const char *p = first;
  582. bool negative = false;
  583. if (p != last && *p == '-') {
  584. negative = true;
  585. ++p;
  586. }
  587. if (p == last) { return {first, std::errc::invalid_argument}; }
  588. T result = 0;
  589. for (; p != last; ++p) {
  590. char c = *p;
  591. int digit = -1;
  592. if (is_ascii_digit(c)) {
  593. digit = c - '0';
  594. } else if ('a' <= c && c <= 'z') {
  595. digit = c - 'a' + 10;
  596. } else if ('A' <= c && c <= 'Z') {
  597. digit = c - 'A' + 10;
  598. } else {
  599. break;
  600. }
  601. if (digit < 0 || digit >= base) { break; }
  602. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  603. return {p, std::errc::result_out_of_range};
  604. }
  605. result = result * base + digit;
  606. }
  607. if (p == first || (negative && p == first + 1)) {
  608. return {first, std::errc::invalid_argument};
  609. }
  610. value = negative ? T(0) - result : result;
  611. return {p, std::errc{}};
  612. }
  613. // from_chars for double (hand-written, locale-independent)
  614. //
  615. // The only double consumed by this library is the HTTP quality value, whose
  616. // grammar is (RFC 9110 12.4.2):
  617. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  618. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  619. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  620. // '.' always the decimal separator (std::strtod would instead read it from the
  621. // global C locale, mis-parsing q-values once an embedder calls
  622. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  623. // the result to [0, 1], so inputs outside that range need not be distinguished
  624. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  625. // cases that exponent and wide-range handling would introduce.
  626. inline from_chars_result<double> from_chars(const char *first, const char *last,
  627. double &value) {
  628. value = 0.0;
  629. const char *p = first;
  630. // Each 1eN is exactly representable, so a single final division by the
  631. // matching entry yields a correctly-rounded result.
  632. static const double powers_of_ten[] = {
  633. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  634. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  635. const int max_frac_digits =
  636. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  637. // Accumulate digits into a 64-bit integer and remember how many were
  638. // fractional. Two independent caps keep this bounded and safe:
  639. // * accumulation saturates before mantissa could overflow uint64_t, and
  640. // * frac_digits is capped at max_frac_digits so it is always a valid index
  641. // into powers_of_ten (without this an input like "0.000...0" would never
  642. // grow mantissa, so the saturation cap alone would not bound it).
  643. // Both caps only drop digits far beyond the precision a q-value needs; any
  644. // value they would change is well outside [0, 1] and rejected by the caller.
  645. uint64_t mantissa = 0;
  646. int frac_digits = 0;
  647. bool seen_digit = false;
  648. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  649. auto accumulate = [&](char c) {
  650. if (mantissa <= limit) {
  651. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  652. return true;
  653. }
  654. return false;
  655. };
  656. for (; p != last && is_ascii_digit(*p); ++p) {
  657. seen_digit = true;
  658. accumulate(*p);
  659. }
  660. if (p != last && *p == '.') {
  661. ++p;
  662. for (; p != last && is_ascii_digit(*p); ++p) {
  663. seen_digit = true;
  664. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  665. }
  666. }
  667. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  668. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  669. return {p, std::errc{}};
  670. }
  671. inline bool parse_port(const char *s, size_t len, int &port) {
  672. int val = 0;
  673. auto r = from_chars(s, s + len, val);
  674. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  675. port = val;
  676. return true;
  677. }
  678. inline bool parse_port(const std::string &s, int &port) {
  679. return parse_port(s.data(), s.size(), port);
  680. }
  681. struct UrlComponents {
  682. std::string scheme;
  683. std::string host;
  684. std::string port;
  685. std::string path;
  686. std::string query;
  687. };
  688. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  689. uc = {};
  690. size_t pos = 0;
  691. auto sep = url.find("://");
  692. if (sep != std::string::npos) {
  693. uc.scheme = url.substr(0, sep);
  694. // Scheme must be [a-z]+ only
  695. if (uc.scheme.empty()) { return false; }
  696. for (auto c : uc.scheme) {
  697. if (c < 'a' || c > 'z') { return false; }
  698. }
  699. pos = sep + 3;
  700. } else if (url.compare(0, 2, "//") == 0) {
  701. pos = 2;
  702. }
  703. auto has_authority_prefix = pos > 0;
  704. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  705. url[0] != '?' && url[0] != '#');
  706. if (has_authority) {
  707. if (pos < url.size() && url[pos] == '[') {
  708. auto close = url.find(']', pos);
  709. if (close == std::string::npos) { return false; }
  710. uc.host = url.substr(pos + 1, close - pos - 1);
  711. // IPv6 host must be [a-fA-F0-9:]+ only
  712. if (uc.host.empty()) { return false; }
  713. for (auto c : uc.host) {
  714. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  715. (c >= 'A' && c <= 'F') || c == ':')) {
  716. return false;
  717. }
  718. }
  719. pos = close + 1;
  720. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  721. // path, query or fragment delimiter (or the end of input). Otherwise the
  722. // trailing bytes would be folded into the path while the connection
  723. // still targets the bracketed address.
  724. if (pos < url.size()) {
  725. auto c = url[pos];
  726. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  727. }
  728. } else {
  729. auto end = url.find_first_of(":/?#", pos);
  730. if (end == std::string::npos) { end = url.size(); }
  731. uc.host = url.substr(pos, end - pos);
  732. pos = end;
  733. }
  734. if (pos < url.size() && url[pos] == ':') {
  735. ++pos;
  736. auto end = url.find_first_of("/?#", pos);
  737. if (end == std::string::npos) { end = url.size(); }
  738. uc.port = url.substr(pos, end - pos);
  739. pos = end;
  740. }
  741. // Without :// or //, the entire input must be consumed as host[:port].
  742. // If there is leftover (path, query, etc.), this is not a valid
  743. // host[:port] string — clear and reparse as a plain path.
  744. if (!has_authority_prefix && pos < url.size()) {
  745. uc.host.clear();
  746. uc.port.clear();
  747. pos = 0;
  748. }
  749. }
  750. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  751. auto end = url.find_first_of("?#", pos);
  752. if (end == std::string::npos) { end = url.size(); }
  753. uc.path = url.substr(pos, end - pos);
  754. pos = end;
  755. }
  756. if (pos < url.size() && url[pos] == '?') {
  757. auto end = url.find('#', pos);
  758. if (end == std::string::npos) { end = url.size(); }
  759. uc.query = url.substr(pos, end - pos);
  760. }
  761. return true;
  762. }
  763. } // namespace detail
  764. enum class SSLVerifierResponse {
  765. // no decision has been made, use the built-in certificate verifier
  766. NoDecisionMade,
  767. // connection certificate is verified and accepted
  768. CertificateAccepted,
  769. // connection certificate was processed but is rejected
  770. CertificateRejected
  771. };
  772. // System CA loading policy for SSL clients. Auto (the default) loads system
  773. // CA certs only when no custom CA is configured; enable_system_ca() switches
  774. // to an explicit policy.
  775. enum class SystemCAMode { Auto, Enabled, Disabled };
  776. enum StatusCode {
  777. // Information responses
  778. Continue_100 = 100,
  779. SwitchingProtocol_101 = 101,
  780. Processing_102 = 102,
  781. EarlyHints_103 = 103,
  782. // Successful responses
  783. OK_200 = 200,
  784. Created_201 = 201,
  785. Accepted_202 = 202,
  786. NonAuthoritativeInformation_203 = 203,
  787. NoContent_204 = 204,
  788. ResetContent_205 = 205,
  789. PartialContent_206 = 206,
  790. MultiStatus_207 = 207,
  791. AlreadyReported_208 = 208,
  792. IMUsed_226 = 226,
  793. // Redirection messages
  794. MultipleChoices_300 = 300,
  795. MovedPermanently_301 = 301,
  796. Found_302 = 302,
  797. SeeOther_303 = 303,
  798. NotModified_304 = 304,
  799. UseProxy_305 = 305,
  800. unused_306 = 306,
  801. TemporaryRedirect_307 = 307,
  802. PermanentRedirect_308 = 308,
  803. // Client error responses
  804. BadRequest_400 = 400,
  805. Unauthorized_401 = 401,
  806. PaymentRequired_402 = 402,
  807. Forbidden_403 = 403,
  808. NotFound_404 = 404,
  809. MethodNotAllowed_405 = 405,
  810. NotAcceptable_406 = 406,
  811. ProxyAuthenticationRequired_407 = 407,
  812. RequestTimeout_408 = 408,
  813. Conflict_409 = 409,
  814. Gone_410 = 410,
  815. LengthRequired_411 = 411,
  816. PreconditionFailed_412 = 412,
  817. PayloadTooLarge_413 = 413,
  818. UriTooLong_414 = 414,
  819. UnsupportedMediaType_415 = 415,
  820. RangeNotSatisfiable_416 = 416,
  821. ExpectationFailed_417 = 417,
  822. ImATeapot_418 = 418,
  823. MisdirectedRequest_421 = 421,
  824. UnprocessableContent_422 = 422,
  825. Locked_423 = 423,
  826. FailedDependency_424 = 424,
  827. TooEarly_425 = 425,
  828. UpgradeRequired_426 = 426,
  829. PreconditionRequired_428 = 428,
  830. TooManyRequests_429 = 429,
  831. RequestHeaderFieldsTooLarge_431 = 431,
  832. UnavailableForLegalReasons_451 = 451,
  833. // Server error responses
  834. InternalServerError_500 = 500,
  835. NotImplemented_501 = 501,
  836. BadGateway_502 = 502,
  837. ServiceUnavailable_503 = 503,
  838. GatewayTimeout_504 = 504,
  839. HttpVersionNotSupported_505 = 505,
  840. VariantAlsoNegotiates_506 = 506,
  841. InsufficientStorage_507 = 507,
  842. LoopDetected_508 = 508,
  843. NotExtended_510 = 510,
  844. NetworkAuthenticationRequired_511 = 511,
  845. };
  846. namespace detail {
  847. // A multimap that keeps its entries in the order they were inserted.
  848. //
  849. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  850. // fields sharing a field name significant and forbids a proxy from reordering
  851. // them, and a query string's parameters are meaningful in the order the caller
  852. // wrote them. Neither standard container expresses it: std::unordered_multimap
  853. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  854. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  855. // key, which would drop control data such as Host behind whatever else the
  856. // message carries and alphabetise a query string.
  857. //
  858. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  859. // scan, which beats hashing for the handful of entries a message carries
  860. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  861. //
  862. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  863. // Params, whose parameter names are case-sensitive, not.
  864. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  865. public:
  866. using key_type = std::string;
  867. using mapped_type = Mapped;
  868. using value_type = std::pair<std::string, Mapped>;
  869. using size_type = std::size_t;
  870. using difference_type = std::ptrdiff_t;
  871. using reference = value_type &;
  872. using const_reference = const value_type &;
  873. private:
  874. static size_type npos() { return static_cast<size_type>(-1); }
  875. static bool keys_equal(const std::string &a, const std::string &b) {
  876. return KeyEqual()(a, b);
  877. }
  878. // Iterating yields every entry in insertion order, but equal_range() and
  879. // find() have to walk only the entries sharing one key, which are not
  880. // adjacent. Both are the same iterator type: key_idx_ selects between the
  881. // two traversals, and since equality compares only the position, an iterator
  882. // restricted to one key still compares equal to end().
  883. template <typename V> class iterator_t {
  884. public:
  885. using iterator_category = std::bidirectional_iterator_tag;
  886. using value_type = insertion_ordered_multimap::value_type;
  887. using difference_type = insertion_ordered_multimap::difference_type;
  888. using pointer = V *;
  889. using reference = V &;
  890. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  891. template <typename U,
  892. typename std::enable_if<std::is_convertible<U *, V *>::value,
  893. int>::type = 0>
  894. iterator_t(const iterator_t<U> &rhs)
  895. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  896. key_idx_(rhs.key_idx_) {}
  897. reference operator*() const { return data_[idx_]; }
  898. pointer operator->() const { return data_ + idx_; }
  899. iterator_t &operator++() {
  900. // Saturating, so that advancing past the last entry of a key (which
  901. // get_multimap_value() does when asked for an out-of-range id) stays at
  902. // end() instead of running off the container.
  903. if (idx_ >= size_) { return *this; }
  904. ++idx_;
  905. if (key_idx_ != npos()) {
  906. while (idx_ < size_ && !matches(idx_)) {
  907. ++idx_;
  908. }
  909. }
  910. return *this;
  911. }
  912. iterator_t operator++(int) {
  913. auto tmp = *this;
  914. ++*this;
  915. return tmp;
  916. }
  917. iterator_t &operator--() {
  918. if (idx_ == 0) { return *this; }
  919. --idx_;
  920. if (key_idx_ != npos()) {
  921. while (idx_ > 0 && !matches(idx_)) {
  922. --idx_;
  923. }
  924. }
  925. return *this;
  926. }
  927. iterator_t operator--(int) {
  928. auto tmp = *this;
  929. --*this;
  930. return tmp;
  931. }
  932. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  933. return idx_ == rhs.idx_;
  934. }
  935. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  936. return idx_ != rhs.idx_;
  937. }
  938. private:
  939. friend class insertion_ordered_multimap;
  940. template <typename> friend class iterator_t;
  941. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  942. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  943. bool matches(size_type i) const {
  944. return keys_equal(data_[i].first, data_[key_idx_].first);
  945. }
  946. V *data_;
  947. size_type idx_;
  948. size_type size_;
  949. size_type key_idx_;
  950. };
  951. public:
  952. using iterator = iterator_t<value_type>;
  953. using const_iterator = iterator_t<const value_type>;
  954. insertion_ordered_multimap() = default;
  955. insertion_ordered_multimap(std::initializer_list<value_type> il)
  956. : entries_(il) {}
  957. template <typename InputIt>
  958. insertion_ordered_multimap(InputIt first, InputIt last)
  959. : entries_(first, last) {}
  960. iterator begin() { return make_iter(0, npos()); }
  961. iterator end() { return make_iter(entries_.size(), npos()); }
  962. const_iterator begin() const { return make_citer(0, npos()); }
  963. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  964. const_iterator cbegin() const { return begin(); }
  965. const_iterator cend() const { return end(); }
  966. bool empty() const { return entries_.empty(); }
  967. size_type size() const { return entries_.size(); }
  968. void clear() { entries_.clear(); }
  969. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  970. iterator insert(const value_type &val) {
  971. entries_.push_back(val);
  972. return make_iter(entries_.size() - 1, npos());
  973. }
  974. iterator insert(value_type &&val) {
  975. entries_.push_back(std::move(val));
  976. return make_iter(entries_.size() - 1, npos());
  977. }
  978. template <typename... Args> iterator emplace(Args &&...args) {
  979. entries_.emplace_back(std::forward<Args>(args)...);
  980. return make_iter(entries_.size() - 1, npos());
  981. }
  982. // For entries that have to lead the message, such as the Host header field
  983. // (RFC 9110 5.3 recommends sending control data first).
  984. template <typename... Args> iterator emplace_front(Args &&...args) {
  985. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  986. return make_iter(0, npos());
  987. }
  988. iterator find(const std::string &key) {
  989. auto i = index_of(key);
  990. return i == npos() ? end() : make_iter(i, i);
  991. }
  992. const_iterator find(const std::string &key) const {
  993. auto i = index_of(key);
  994. return i == npos() ? end() : make_citer(i, i);
  995. }
  996. size_type count(const std::string &key) const {
  997. size_type n = 0;
  998. for (const auto &entry : entries_) {
  999. if (keys_equal(entry.first, key)) { n++; }
  1000. }
  1001. return n;
  1002. }
  1003. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1004. auto i = index_of(key);
  1005. return i == npos() ? std::make_pair(end(), end())
  1006. : std::make_pair(make_iter(i, i), end());
  1007. }
  1008. std::pair<const_iterator, const_iterator>
  1009. equal_range(const std::string &key) const {
  1010. auto i = index_of(key);
  1011. return i == npos() ? std::make_pair(end(), end())
  1012. : std::make_pair(make_citer(i, i), end());
  1013. }
  1014. size_type erase(const std::string &key) {
  1015. auto before = entries_.size();
  1016. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1017. [&](const value_type &entry) {
  1018. return keys_equal(entry.first, key);
  1019. }),
  1020. entries_.end());
  1021. return before - entries_.size();
  1022. }
  1023. iterator erase(const_iterator pos) {
  1024. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1025. return make_iter(pos.idx_, npos());
  1026. }
  1027. // Erases what iterating [first, last) would actually visit, so erasing an
  1028. // equal_range() removes only the entries with that key, not everything
  1029. // positioned between them.
  1030. iterator erase(const_iterator first, const_iterator last) {
  1031. auto from = first.idx_;
  1032. auto to = last.idx_;
  1033. if (from >= to) { return make_iter(from, npos()); }
  1034. auto begin_it = entries_.begin();
  1035. auto from_it = begin_it + static_cast<difference_type>(from);
  1036. auto to_it = begin_it + static_cast<difference_type>(to);
  1037. if (first.key_idx_ == npos()) {
  1038. entries_.erase(from_it, to_it);
  1039. } else {
  1040. auto key = entries_[first.key_idx_].first;
  1041. auto keep = from_it;
  1042. for (auto it = from_it; it != to_it; ++it) {
  1043. if (!keys_equal(it->first, key)) {
  1044. if (keep != it) { *keep = std::move(*it); }
  1045. ++keep;
  1046. }
  1047. }
  1048. if (keep != to_it) {
  1049. keep = std::move(to_it, entries_.end(), keep);
  1050. } else {
  1051. keep = entries_.end();
  1052. }
  1053. entries_.erase(keep, entries_.end());
  1054. }
  1055. return make_iter(from, npos());
  1056. }
  1057. friend bool operator==(const insertion_ordered_multimap &lhs,
  1058. const insertion_ordered_multimap &rhs) {
  1059. return lhs.entries_ == rhs.entries_;
  1060. }
  1061. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1062. const insertion_ordered_multimap &rhs) {
  1063. return !(lhs == rhs);
  1064. }
  1065. private:
  1066. size_type index_of(const std::string &key) const {
  1067. for (size_type i = 0; i < entries_.size(); i++) {
  1068. if (keys_equal(entries_[i].first, key)) { return i; }
  1069. }
  1070. return npos();
  1071. }
  1072. iterator make_iter(size_type idx, size_type key_idx) {
  1073. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1074. }
  1075. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1076. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1077. }
  1078. std::vector<value_type> entries_;
  1079. };
  1080. } // namespace detail
  1081. using Headers =
  1082. detail::insertion_ordered_multimap<std::string,
  1083. detail::case_ignore::equal_to>;
  1084. // Query parameter names are case-sensitive, unlike header field names.
  1085. using Params =
  1086. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1087. using Match = std::smatch;
  1088. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1089. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1090. /*
  1091. * detail: type-erased storage used by UserData.
  1092. * ABI-stable regardless of C++ standard — always uses this custom
  1093. * implementation instead of std::any.
  1094. */
  1095. namespace detail {
  1096. using any_type_id = const void *;
  1097. template <typename T> any_type_id any_typeid() noexcept {
  1098. static const char id = 0;
  1099. return &id;
  1100. }
  1101. struct any_storage {
  1102. virtual ~any_storage() = default;
  1103. virtual std::unique_ptr<any_storage> clone() const = 0;
  1104. virtual any_type_id type_id() const noexcept = 0;
  1105. };
  1106. template <typename T> struct any_value final : any_storage {
  1107. T value;
  1108. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1109. std::unique_ptr<any_storage> clone() const override {
  1110. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1111. }
  1112. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1113. };
  1114. } // namespace detail
  1115. class UserData {
  1116. public:
  1117. UserData() = default;
  1118. UserData(UserData &&) noexcept = default;
  1119. UserData &operator=(UserData &&) noexcept = default;
  1120. UserData(const UserData &o) {
  1121. for (const auto &e : o.entries_) {
  1122. if (e.second) { entries_[e.first] = e.second->clone(); }
  1123. }
  1124. }
  1125. UserData &operator=(const UserData &o) {
  1126. if (this != &o) {
  1127. entries_.clear();
  1128. for (const auto &e : o.entries_) {
  1129. if (e.second) { entries_[e.first] = e.second->clone(); }
  1130. }
  1131. }
  1132. return *this;
  1133. }
  1134. template <typename T> void set(const std::string &key, T &&value) {
  1135. using D = typename std::decay<T>::type;
  1136. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1137. }
  1138. template <typename T> T *get(const std::string &key) noexcept {
  1139. auto it = entries_.find(key);
  1140. if (it == entries_.end() || !it->second) { return nullptr; }
  1141. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1142. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1143. }
  1144. template <typename T> const T *get(const std::string &key) const noexcept {
  1145. auto it = entries_.find(key);
  1146. if (it == entries_.end() || !it->second) { return nullptr; }
  1147. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1148. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1149. }
  1150. bool has(const std::string &key) const noexcept {
  1151. return entries_.find(key) != entries_.end();
  1152. }
  1153. void erase(const std::string &key) { entries_.erase(key); }
  1154. void clear() noexcept { entries_.clear(); }
  1155. private:
  1156. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1157. entries_;
  1158. };
  1159. struct Response;
  1160. using ResponseHandler = std::function<bool(const Response &response)>;
  1161. struct FormData {
  1162. std::string name;
  1163. std::string content;
  1164. std::string filename;
  1165. std::string content_type;
  1166. Headers headers;
  1167. };
  1168. struct FormField {
  1169. std::string name;
  1170. std::string content;
  1171. Headers headers;
  1172. };
  1173. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1174. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1175. // should see the parts as they were sent. A std::multimap sorts by field name
  1176. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1177. // than the case-insensitive predicate Headers uses.
  1178. using FormFields =
  1179. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1180. using FormFiles =
  1181. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1182. struct MultipartFormData {
  1183. FormFields fields; // Text fields from multipart
  1184. FormFiles files; // Files from multipart
  1185. // Text field access
  1186. std::string get_field(const std::string &key, size_t id = 0) const;
  1187. std::vector<std::string> get_fields(const std::string &key) const;
  1188. bool has_field(const std::string &key) const;
  1189. size_t get_field_count(const std::string &key) const;
  1190. // File access
  1191. FormData get_file(const std::string &key, size_t id = 0) const;
  1192. std::vector<FormData> get_files(const std::string &key) const;
  1193. bool has_file(const std::string &key) const;
  1194. size_t get_file_count(const std::string &key) const;
  1195. };
  1196. struct UploadFormData {
  1197. std::string name;
  1198. std::string content;
  1199. std::string filename;
  1200. std::string content_type;
  1201. };
  1202. using UploadFormDataItems = std::vector<UploadFormData>;
  1203. class DataSink {
  1204. public:
  1205. DataSink() : os(&sb_), sb_(*this) {}
  1206. DataSink(const DataSink &) = delete;
  1207. DataSink &operator=(const DataSink &) = delete;
  1208. DataSink(DataSink &&) = delete;
  1209. DataSink &operator=(DataSink &&) = delete;
  1210. std::function<bool(const char *data, size_t data_len)> write;
  1211. // Only `write` is mandatory. The rest are defaulted so that a provider
  1212. // calling one on a writer that does not set it gets sensible behaviour
  1213. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1214. // `this` is safe: DataSink is neither copyable nor movable.
  1215. std::function<bool()> is_writable = []() { return true; };
  1216. std::function<void()> done = []() {};
  1217. std::function<void(const Headers &trailer)> done_with_trailer =
  1218. [this](const Headers & /*trailer*/) { done(); };
  1219. std::ostream os;
  1220. private:
  1221. class data_sink_streambuf final : public std::streambuf {
  1222. public:
  1223. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1224. protected:
  1225. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1226. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1227. return 0;
  1228. }
  1229. private:
  1230. DataSink &sink_;
  1231. };
  1232. data_sink_streambuf sb_;
  1233. };
  1234. using ContentProvider =
  1235. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1236. using ContentProviderWithoutLength =
  1237. std::function<bool(size_t offset, DataSink &sink)>;
  1238. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1239. struct FormDataProvider {
  1240. std::string name;
  1241. ContentProviderWithoutLength provider;
  1242. std::string filename;
  1243. std::string content_type;
  1244. };
  1245. using FormDataProviderItems = std::vector<FormDataProvider>;
  1246. inline FormDataProvider
  1247. make_file_provider(const std::string &name, const std::string &filepath,
  1248. const std::string &filename = std::string(),
  1249. const std::string &content_type = std::string()) {
  1250. FormDataProvider fdp;
  1251. fdp.name = name;
  1252. fdp.filename = filename.empty() ? filepath : filename;
  1253. fdp.content_type = content_type;
  1254. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1255. std::ifstream f(filepath, std::ios::binary);
  1256. if (!f) { return false; }
  1257. if (offset > 0) {
  1258. f.seekg(static_cast<std::streamoff>(offset));
  1259. if (!f.good()) {
  1260. sink.done();
  1261. return true;
  1262. }
  1263. }
  1264. char buf[8192];
  1265. f.read(buf, sizeof(buf));
  1266. auto n = static_cast<size_t>(f.gcount());
  1267. if (n > 0) { return sink.write(buf, n); }
  1268. sink.done(); // EOF
  1269. return true;
  1270. };
  1271. return fdp;
  1272. }
  1273. inline std::pair<size_t, ContentProvider>
  1274. make_file_body(const std::string &filepath) {
  1275. size_t size = 0;
  1276. {
  1277. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1278. if (!f) { return {0, ContentProvider{}}; }
  1279. size = static_cast<size_t>(f.tellg());
  1280. }
  1281. ContentProvider provider = [filepath](size_t offset, size_t length,
  1282. DataSink &sink) -> bool {
  1283. std::ifstream f(filepath, std::ios::binary);
  1284. if (!f) { return false; }
  1285. f.seekg(static_cast<std::streamoff>(offset));
  1286. if (!f.good()) { return false; }
  1287. char buf[8192];
  1288. while (length > 0) {
  1289. auto to_read = (std::min)(sizeof(buf), length);
  1290. f.read(buf, static_cast<std::streamsize>(to_read));
  1291. auto n = static_cast<size_t>(f.gcount());
  1292. // The file is shorter than the size make_file_body() measured, which the
  1293. // caller has already committed to as Content-Length. The body cannot be
  1294. // completed, so fail as every other error here does.
  1295. if (n == 0) { return false; }
  1296. if (!sink.write(buf, n)) { return false; }
  1297. length -= n;
  1298. }
  1299. return true;
  1300. };
  1301. return {size, std::move(provider)};
  1302. }
  1303. using ContentReceiverWithProgress = std::function<bool(
  1304. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1305. using ContentReceiver =
  1306. std::function<bool(const char *data, size_t data_length)>;
  1307. using FormDataHeader = std::function<bool(const FormData &file)>;
  1308. class ContentReader {
  1309. public:
  1310. using Reader = std::function<bool(ContentReceiver receiver)>;
  1311. using FormDataReader =
  1312. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1313. ContentReader(Reader reader, FormDataReader multipart_reader)
  1314. : reader_(std::move(reader)),
  1315. formdata_reader_(std::move(multipart_reader)) {}
  1316. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1317. return formdata_reader_(std::move(header), std::move(receiver));
  1318. }
  1319. bool operator()(ContentReceiver receiver) const {
  1320. return reader_(std::move(receiver));
  1321. }
  1322. Reader reader_;
  1323. FormDataReader formdata_reader_;
  1324. };
  1325. using Range = std::pair<ssize_t, ssize_t>;
  1326. using Ranges = std::vector<Range>;
  1327. #ifdef CPPHTTPLIB_SSL_ENABLED
  1328. // TLS abstraction layer - public type definitions and API
  1329. namespace tls {
  1330. // Opaque handles (defined as void* for abstraction)
  1331. using ctx_t = void *;
  1332. using session_t = void *;
  1333. using const_session_t = const void *; // For read-only session access
  1334. using cert_t = void *;
  1335. using ca_store_t = void *;
  1336. // TLS versions
  1337. enum class Version {
  1338. TLS1_2 = 0x0303,
  1339. TLS1_3 = 0x0304,
  1340. };
  1341. // Subject Alternative Names (SAN) entry types
  1342. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1343. // SAN entry structure
  1344. struct SanEntry {
  1345. SanType type;
  1346. std::string value;
  1347. };
  1348. // Verification context for certificate verification callback
  1349. struct VerifyContext {
  1350. session_t session; // TLS session handle
  1351. cert_t cert; // Current certificate being verified
  1352. int depth; // Certificate chain depth (0 = leaf)
  1353. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1354. long error_code; // Backend-specific error code (0 = no error)
  1355. const char *error_string; // Human-readable error description
  1356. // Certificate introspection methods
  1357. std::string subject_cn() const;
  1358. std::string issuer_name() const;
  1359. bool check_hostname(const char *hostname) const;
  1360. std::vector<SanEntry> sans() const;
  1361. bool validity(time_t &not_before, time_t &not_after) const;
  1362. std::string serial() const;
  1363. };
  1364. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1365. // TlsError codes for TLS operations (backend-independent)
  1366. enum class ErrorCode : int {
  1367. Success = 0,
  1368. WantRead, // Non-blocking: need to wait for read
  1369. WantWrite, // Non-blocking: need to wait for write
  1370. PeerClosed, // Peer closed the connection
  1371. Fatal, // Unrecoverable error
  1372. SyscallError, // System call error (check sys_errno)
  1373. CertVerifyFailed, // Certificate verification failed
  1374. HostnameMismatch, // Hostname verification failed
  1375. };
  1376. // TLS error information
  1377. struct TlsError {
  1378. ErrorCode code = ErrorCode::Fatal;
  1379. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1380. int sys_errno = 0; // errno when SyscallError
  1381. // Convert verification error code to human-readable string
  1382. static std::string verify_error_to_string(long error_code);
  1383. };
  1384. // RAII wrapper for peer certificate
  1385. class PeerCert {
  1386. public:
  1387. PeerCert();
  1388. PeerCert(PeerCert &&other) noexcept;
  1389. PeerCert &operator=(PeerCert &&other) noexcept;
  1390. ~PeerCert();
  1391. PeerCert(const PeerCert &) = delete;
  1392. PeerCert &operator=(const PeerCert &) = delete;
  1393. explicit operator bool() const;
  1394. std::string subject_cn() const;
  1395. std::string issuer_name() const;
  1396. bool check_hostname(const char *hostname) const;
  1397. std::vector<SanEntry> sans() const;
  1398. bool validity(time_t &not_before, time_t &not_after) const;
  1399. std::string serial() const;
  1400. private:
  1401. explicit PeerCert(cert_t cert);
  1402. cert_t cert_ = nullptr;
  1403. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1404. };
  1405. // Callback for TLS context setup (used by SSLServer constructor)
  1406. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1407. } // namespace tls
  1408. #endif
  1409. struct Request {
  1410. std::string method;
  1411. std::string path;
  1412. std::string matched_route;
  1413. Params params;
  1414. Headers headers;
  1415. Headers trailers;
  1416. std::string body;
  1417. std::string remote_addr;
  1418. int remote_port = -1;
  1419. std::string local_addr;
  1420. int local_port = -1;
  1421. // for server
  1422. std::string version;
  1423. std::string target;
  1424. MultipartFormData form;
  1425. Ranges ranges;
  1426. Match matches;
  1427. std::unordered_map<std::string, std::string> path_params;
  1428. std::function<bool()> is_connection_closed = []() { return true; };
  1429. // for client
  1430. std::vector<std::string> accept_content_types;
  1431. ResponseHandler response_handler;
  1432. ContentReceiverWithProgress content_receiver;
  1433. DownloadProgress download_progress;
  1434. UploadProgress upload_progress;
  1435. bool has_header(const std::string &key) const;
  1436. std::string get_header_value(const std::string &key, const char *def = "",
  1437. size_t id = 0) const;
  1438. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1439. size_t id = 0) const;
  1440. size_t get_header_value_count(const std::string &key) const;
  1441. void set_header(const std::string &key, const std::string &val);
  1442. bool has_trailer(const std::string &key) const;
  1443. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1444. size_t get_trailer_value_count(const std::string &key) const;
  1445. bool has_param(const std::string &key) const;
  1446. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1447. std::vector<std::string> get_param_values(const std::string &key) const;
  1448. size_t get_param_value_count(const std::string &key) const;
  1449. bool is_multipart_form_data() const;
  1450. // private members...
  1451. bool body_consumed_ = false;
  1452. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1453. size_t content_length_ = 0;
  1454. ContentProvider content_provider_;
  1455. bool is_chunked_content_provider_ = false;
  1456. size_t authorization_count_ = 0;
  1457. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1458. (std::chrono::steady_clock::time_point::min)();
  1459. #ifdef CPPHTTPLIB_SSL_ENABLED
  1460. tls::const_session_t ssl = nullptr;
  1461. tls::PeerCert peer_cert() const;
  1462. std::string sni() const;
  1463. #endif
  1464. };
  1465. namespace detail {
  1466. // Declared up here, away from the rest of the compression helpers, because
  1467. // `Response` stores one.
  1468. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1469. } // namespace detail
  1470. struct Response {
  1471. std::string version;
  1472. int status = -1;
  1473. std::string reason;
  1474. Headers headers;
  1475. Headers trailers;
  1476. std::string body;
  1477. std::string location; // Redirect location
  1478. // User-defined context — set by pre-routing/pre-request handlers and read
  1479. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1480. UserData user_data;
  1481. bool has_header(const std::string &key) const;
  1482. std::string get_header_value(const std::string &key, const char *def = "",
  1483. size_t id = 0) const;
  1484. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1485. size_t id = 0) const;
  1486. size_t get_header_value_count(const std::string &key) const;
  1487. void set_header(const std::string &key, const std::string &val);
  1488. bool has_trailer(const std::string &key) const;
  1489. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1490. size_t get_trailer_value_count(const std::string &key) const;
  1491. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1492. void set_content(const char *s, size_t n, const std::string &content_type);
  1493. void set_content(const std::string &s, const std::string &content_type);
  1494. void set_content(std::string &&s, const std::string &content_type);
  1495. void set_content_provider(
  1496. size_t length, const std::string &content_type, ContentProvider provider,
  1497. ContentProviderResourceReleaser resource_releaser = nullptr);
  1498. void set_content_provider(
  1499. const std::string &content_type, ContentProviderWithoutLength provider,
  1500. ContentProviderResourceReleaser resource_releaser = nullptr);
  1501. void set_chunked_content_provider(
  1502. const std::string &content_type, ContentProviderWithoutLength provider,
  1503. ContentProviderResourceReleaser resource_releaser = nullptr);
  1504. void set_file_content(const std::string &path,
  1505. const std::string &content_type);
  1506. void set_file_content(const std::string &path);
  1507. Response() = default;
  1508. Response(const Response &) = default;
  1509. Response &operator=(const Response &) = default;
  1510. Response(Response &&) = default;
  1511. Response &operator=(Response &&) = default;
  1512. ~Response() {
  1513. if (content_provider_resource_releaser_) {
  1514. content_provider_resource_releaser_(content_provider_success_);
  1515. }
  1516. }
  1517. // private members...
  1518. size_t content_length_ = 0;
  1519. ContentProvider content_provider_;
  1520. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1521. bool is_chunked_content_provider_ = false;
  1522. bool content_provider_success_ = false;
  1523. std::string file_content_path_;
  1524. std::string file_content_content_type_;
  1525. // Content coding chosen for the response body, decided once so that the
  1526. // headers and the body cannot disagree: where the file is opened for a
  1527. // file-backed content provider (keeping the ETag honest), and in
  1528. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1529. // for every other kind of response.
  1530. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1531. };
  1532. enum class Error {
  1533. Success = 0,
  1534. Unknown,
  1535. Connection,
  1536. BindIPAddress,
  1537. Read,
  1538. Write,
  1539. ExceedRedirectCount,
  1540. Canceled,
  1541. SSLConnection,
  1542. SSLLoadingCerts,
  1543. SSLServerVerification,
  1544. SSLServerHostnameVerification,
  1545. UnsupportedMultipartBoundaryChars,
  1546. Compression,
  1547. ConnectionTimeout,
  1548. ProxyConnection,
  1549. ConnectionClosed,
  1550. Timeout,
  1551. ResourceExhaustion,
  1552. TooManyFormDataFiles,
  1553. ExceedMaxPayloadSize,
  1554. ExceedUriMaxLength,
  1555. ExceedMaxSocketDescriptorCount,
  1556. InvalidRequestLine,
  1557. InvalidHTTPMethod,
  1558. InvalidHTTPVersion,
  1559. InvalidHeaders,
  1560. MultipartParsing,
  1561. OpenFile,
  1562. Listen,
  1563. GetSockName,
  1564. UnsupportedAddressFamily,
  1565. HTTPParsing,
  1566. InvalidRangeHeader,
  1567. UnsupportedContentEncoding,
  1568. WebSocketHandshake,
  1569. UserCallbackException,
  1570. // For internal use only
  1571. SSLPeerCouldBeClosed_,
  1572. };
  1573. std::string to_string(Error error);
  1574. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1575. class Stream {
  1576. public:
  1577. virtual ~Stream() = default;
  1578. virtual bool is_readable() const = 0;
  1579. virtual bool wait_readable() const = 0;
  1580. virtual bool wait_writable() const = 0;
  1581. virtual bool is_peer_alive() const { return wait_writable(); }
  1582. virtual ssize_t read(char *ptr, size_t size) = 0;
  1583. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1584. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1585. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1586. virtual socket_t socket() const = 0;
  1587. virtual time_t duration() const = 0;
  1588. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1589. (void)sec;
  1590. (void)usec;
  1591. }
  1592. // Bytes already pulled off the socket and sitting in this stream's own
  1593. // buffer. Exposing them lets a line reader scan for a terminator in one
  1594. // pass instead of asking for a byte at a time. A stream that does no
  1595. // buffering of its own reports none, and readers fall back to read().
  1596. virtual const char *buffered_data(size_t &size) const {
  1597. size = 0;
  1598. return nullptr;
  1599. }
  1600. // Discards `size` bytes previously returned by buffered_data().
  1601. virtual void consume_buffered(size_t size) { (void)size; }
  1602. ssize_t write(const char *ptr);
  1603. ssize_t write(const std::string &s);
  1604. Error get_error() const { return error_; }
  1605. protected:
  1606. Error error_ = Error::Success;
  1607. };
  1608. class TaskQueue {
  1609. public:
  1610. TaskQueue() = default;
  1611. virtual ~TaskQueue() = default;
  1612. virtual bool enqueue(std::function<void()> fn) = 0;
  1613. virtual void shutdown() = 0;
  1614. virtual void on_idle() {}
  1615. };
  1616. class ThreadPool final : public TaskQueue {
  1617. public:
  1618. explicit ThreadPool(
  1619. size_t n, size_t max_n = 0, size_t mqr = 0,
  1620. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1621. ThreadPool(const ThreadPool &) = delete;
  1622. ~ThreadPool() override = default;
  1623. bool enqueue(std::function<void()> fn) override;
  1624. void shutdown() override;
  1625. private:
  1626. void worker(bool is_dynamic);
  1627. void move_to_finished(std::thread::id id);
  1628. void cleanup_finished_threads();
  1629. size_t base_thread_count_;
  1630. size_t max_thread_count_;
  1631. size_t max_queued_requests_;
  1632. time_t idle_timeout_sec_;
  1633. size_t idle_thread_count_;
  1634. bool shutdown_;
  1635. std::list<std::function<void()>> jobs_;
  1636. std::vector<std::thread> threads_; // base threads
  1637. std::list<std::thread> dynamic_threads_; // dynamic threads
  1638. std::vector<std::thread>
  1639. finished_threads_; // exited dynamic threads awaiting join
  1640. std::condition_variable cond_;
  1641. std::mutex mutex_;
  1642. };
  1643. using Logger = std::function<void(const Request &, const Response &)>;
  1644. // Forward declaration for Error type
  1645. enum class Error;
  1646. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1647. using SocketOptions = std::function<void(socket_t sock)>;
  1648. void default_socket_options(socket_t sock);
  1649. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1650. const char *status_message(int status);
  1651. std::string to_string(Error error);
  1652. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1653. std::string get_bearer_token_auth(const Request &req);
  1654. namespace detail {
  1655. class MatcherBase {
  1656. public:
  1657. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1658. virtual ~MatcherBase() = default;
  1659. const std::string &pattern() const { return pattern_; }
  1660. // Match request path and populate its matches and
  1661. virtual bool match(Request &request) const = 0;
  1662. private:
  1663. std::string pattern_;
  1664. };
  1665. /**
  1666. * Captures parameters in request path and stores them in Request::path_params
  1667. *
  1668. * Capture name is a substring of a pattern from : to /.
  1669. * The rest of the pattern is matched against the request path directly
  1670. * Parameters are captured starting from the next character after
  1671. * the end of the last matched static pattern fragment until the next /.
  1672. *
  1673. * Example pattern:
  1674. * "/path/fragments/:capture/more/fragments/:second_capture"
  1675. * Static fragments:
  1676. * "/path/fragments/", "more/fragments/"
  1677. *
  1678. * Given the following request path:
  1679. * "/path/fragments/:1/more/fragments/:2"
  1680. * the resulting capture will be
  1681. * {{"capture", "1"}, {"second_capture", "2"}}
  1682. */
  1683. class PathParamsMatcher final : public MatcherBase {
  1684. public:
  1685. PathParamsMatcher(const std::string &pattern);
  1686. bool match(Request &request) const override;
  1687. private:
  1688. // Treat segment separators as the end of path parameter capture
  1689. // Does not need to handle query parameters as they are parsed before path
  1690. // matching
  1691. static constexpr char separator = '/';
  1692. // Contains static path fragments to match against, excluding the '/' after
  1693. // path params
  1694. // Fragments are separated by path params
  1695. std::vector<std::string> static_fragments_;
  1696. // Stores the names of the path parameters to be used as keys in the
  1697. // Request::path_params map
  1698. std::vector<std::string> param_names_;
  1699. };
  1700. /**
  1701. * Performs std::regex_match on request path
  1702. * and stores the result in Request::matches
  1703. *
  1704. * Note that regex match is performed directly on the whole request.
  1705. * This means that wildcard patterns may match multiple path segments with /:
  1706. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1707. */
  1708. class RegexMatcher final : public MatcherBase {
  1709. public:
  1710. RegexMatcher(const std::string &pattern)
  1711. : MatcherBase(pattern), regex_(pattern) {}
  1712. bool match(Request &request) const override;
  1713. private:
  1714. std::regex regex_;
  1715. };
  1716. int close_socket(socket_t sock) noexcept;
  1717. bool is_accept_resource_error();
  1718. bool is_accept_transient_error();
  1719. ssize_t write_headers(Stream &strm, const Headers &headers);
  1720. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1721. time_t usec);
  1722. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1723. const std::string &boundary);
  1724. ContentProvider
  1725. make_multipart_content_provider(const UploadFormDataItems &items,
  1726. const std::string &boundary);
  1727. } // namespace detail
  1728. bool is_valid_multipart_boundary(const std::string &boundary);
  1729. // Serializer for multipart/form-data request bodies. The boundary is owned
  1730. // by the writer so that per-part framing and the final terminator always
  1731. // agree. Field names and filenames are escaped following the WHATWG HTML
  1732. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1733. // in content types.
  1734. class MultipartFormDataWriter {
  1735. public:
  1736. MultipartFormDataWriter();
  1737. // precondition: is_valid_multipart_boundary(boundary)
  1738. explicit MultipartFormDataWriter(std::string boundary);
  1739. const std::string &boundary() const;
  1740. std::string content_type() const;
  1741. // In-memory items -> whole body (known length)
  1742. std::string serialize(const UploadFormDataItems &items) const;
  1743. size_t content_length(const UploadFormDataItems &items) const;
  1744. // Per-part framing for streaming via a content provider
  1745. std::string item_begin(const UploadFormData &item) const;
  1746. static std::string item_end();
  1747. std::string finish() const;
  1748. private:
  1749. std::string boundary_;
  1750. };
  1751. class Server {
  1752. public:
  1753. using Handler = std::function<void(const Request &, Response &)>;
  1754. using ExceptionHandler =
  1755. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1756. enum class HandlerResponse {
  1757. Handled,
  1758. Unhandled,
  1759. };
  1760. using HandlerWithResponse =
  1761. std::function<HandlerResponse(const Request &, Response &)>;
  1762. using HandlerWithContentReader = std::function<void(
  1763. const Request &, Response &, const ContentReader &content_reader)>;
  1764. using Expect100ContinueHandler =
  1765. std::function<int(const Request &, Response &)>;
  1766. using StartHandler = std::function<void()>;
  1767. using WebSocketHandler =
  1768. std::function<void(const Request &, ws::WebSocket &)>;
  1769. using SubProtocolSelector =
  1770. std::function<std::string(const std::vector<std::string> &protocols)>;
  1771. Server();
  1772. virtual ~Server();
  1773. virtual bool is_valid() const;
  1774. Server &Get(const std::string &pattern, Handler handler);
  1775. Server &Post(const std::string &pattern, Handler handler);
  1776. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1777. Server &Put(const std::string &pattern, Handler handler);
  1778. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1779. Server &Patch(const std::string &pattern, Handler handler);
  1780. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1781. Server &Delete(const std::string &pattern, Handler handler);
  1782. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1783. Server &Options(const std::string &pattern, Handler handler);
  1784. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1785. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1786. // server accept it; an unregistered method is still rejected with 400.
  1787. // `method` must be a valid HTTP method token and must not be one of the
  1788. // built-in methods, which have their own registration functions above. A
  1789. // rejected registration makes is_valid() return false, so listen() fails.
  1790. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1791. Handler handler);
  1792. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1793. HandlerWithContentReader handler);
  1794. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1795. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1796. SubProtocolSelector sub_protocol_selector);
  1797. bool set_base_dir(const std::string &dir,
  1798. const std::string &mount_point = std::string());
  1799. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1800. Headers headers = Headers());
  1801. bool remove_mount_point(const std::string &mount_point);
  1802. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1803. const std::string &mime);
  1804. Server &set_default_file_mimetype(const std::string &mime);
  1805. Server &set_file_request_handler(Handler handler);
  1806. template <class ErrorHandlerFunc>
  1807. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1808. return set_error_handler_core(
  1809. std::forward<ErrorHandlerFunc>(handler),
  1810. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1811. }
  1812. Server &set_exception_handler(ExceptionHandler handler);
  1813. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1814. Server &set_post_routing_handler(Handler handler);
  1815. Server &set_pre_request_handler(HandlerWithResponse handler);
  1816. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1817. Server &set_start_handler(StartHandler handler);
  1818. Server &set_logger(Logger logger);
  1819. Server &set_pre_compression_logger(Logger logger);
  1820. Server &set_error_logger(ErrorLogger error_logger);
  1821. Server &set_address_family(int family);
  1822. Server &set_tcp_nodelay(bool on);
  1823. Server &set_ipv6_v6only(bool on);
  1824. Server &set_socket_options(SocketOptions socket_options);
  1825. Server &set_default_headers(Headers headers);
  1826. Server &
  1827. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1828. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1829. Server &set_keep_alive_max_count(size_t count);
  1830. Server &set_keep_alive_timeout(time_t sec);
  1831. template <class Rep, class Period>
  1832. Server &
  1833. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1834. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1835. template <class Rep, class Period>
  1836. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1837. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1838. template <class Rep, class Period>
  1839. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1840. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1841. template <class Rep, class Period>
  1842. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1843. Server &set_payload_max_length(size_t length);
  1844. Server &set_static_file_compression(bool on);
  1845. Server &set_static_file_compression_min_length(size_t length);
  1846. Server &set_static_file_compression_max_length(size_t length);
  1847. Server &set_websocket_ping_interval(time_t sec);
  1848. template <class Rep, class Period>
  1849. Server &set_websocket_ping_interval(
  1850. const std::chrono::duration<Rep, Period> &duration);
  1851. Server &set_websocket_max_missed_pongs(int count);
  1852. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1853. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1854. bool listen_after_bind();
  1855. bool listen(const std::string &host, int port, int socket_flags = 0);
  1856. bool is_running() const;
  1857. void wait_until_ready() const;
  1858. void stop() noexcept;
  1859. void decommission();
  1860. std::function<TaskQueue *(void)> new_task_queue;
  1861. protected:
  1862. bool process_request(Stream &strm, const std::string &remote_addr,
  1863. int remote_port, const std::string &local_addr,
  1864. int local_port, bool close_connection,
  1865. bool &connection_closed,
  1866. const std::function<void(Request &)> &setup_request,
  1867. bool *websocket_upgraded = nullptr);
  1868. // Runs the per-connection serving loop and stops an exception thrown by a
  1869. // user callback from escaping the worker thread.
  1870. //
  1871. // process_request() wraps only routing() in a try/catch. Content providers,
  1872. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1873. // handlers all run outside it, and the task queue calls the job without a
  1874. // catch, so an exception from any of those would terminate the process.
  1875. //
  1876. // No 500 is possible here: by the time a content provider runs, the status
  1877. // line and headers are already on the wire. Report it through the error
  1878. // logger and drop the connection, which is what the peer observes either
  1879. // way. Other connections are unaffected.
  1880. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1881. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1882. return serve();
  1883. #else
  1884. try {
  1885. return serve();
  1886. } catch (...) {
  1887. // The error logger is a user callback too, so it must not be able to
  1888. // throw the guard back open.
  1889. try {
  1890. output_error_log(Error::UserCallbackException, nullptr);
  1891. } catch (...) {}
  1892. return false;
  1893. }
  1894. #endif
  1895. }
  1896. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1897. std::vector<std::string> trusted_proxies_;
  1898. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1899. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1900. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1901. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1902. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1903. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1904. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1905. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1906. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1907. bool static_file_compression_ = false;
  1908. size_t static_file_compression_min_length_ =
  1909. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1910. size_t static_file_compression_max_length_ =
  1911. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1912. time_t websocket_ping_interval_sec_ =
  1913. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1914. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1915. private:
  1916. using Handlers =
  1917. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1918. using HandlersForContentReader =
  1919. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1920. HandlerWithContentReader>>;
  1921. // Both handler tables for one custom method live in a single entry, so that
  1922. // routing() needs only one map lookup per request to reach either of them.
  1923. struct CustomHandlerEntry {
  1924. Handlers handlers;
  1925. HandlersForContentReader handlers_for_content_reader;
  1926. };
  1927. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1928. static std::unique_ptr<detail::MatcherBase>
  1929. make_matcher(const std::string &pattern);
  1930. static const std::set<std::string> &builtin_methods();
  1931. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1932. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1933. template <typename H>
  1934. Server &add_handler(
  1935. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1936. const std::string &pattern, H handler) {
  1937. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  1938. return *this;
  1939. }
  1940. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  1941. Server &set_error_handler_core(Handler handler, std::false_type);
  1942. socket_t create_server_socket(const std::string &host, int port,
  1943. int socket_flags,
  1944. SocketOptions socket_options) const;
  1945. int bind_internal(const std::string &host, int port, int socket_flags);
  1946. bool listen_internal();
  1947. bool routing(Request &req, Response &res, Stream &strm);
  1948. bool handle_file_request(Request &req, Response &res);
  1949. bool check_if_not_modified(const Request &req, Response &res,
  1950. const std::string &etag, time_t mtime) const;
  1951. bool check_if_range(Request &req, const std::string &etag,
  1952. time_t mtime) const;
  1953. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  1954. Stream &strm);
  1955. bool dispatch_request_for_content_reader(
  1956. Request &req, Response &res, ContentReader content_reader,
  1957. const HandlersForContentReader &handlers) const;
  1958. bool parse_request_line(const char *s, Request &req) const;
  1959. detail::EncodingType static_file_encoding(const Request &req,
  1960. const Response &res,
  1961. const std::string &content_type,
  1962. size_t length) const;
  1963. bool apply_static_file_compression(const Request &req, Response &res) const;
  1964. void apply_ranges(const Request &req, Response &res,
  1965. std::string &content_type, std::string &boundary) const;
  1966. bool write_response(Stream &strm, bool close_connection, Request &req,
  1967. Response &res);
  1968. bool write_response_with_content(Stream &strm, bool close_connection,
  1969. const Request &req, Response &res);
  1970. bool write_response_core(Stream &strm, bool close_connection,
  1971. const Request &req, Response &res,
  1972. bool need_apply_ranges);
  1973. bool write_content_with_provider(Stream &strm, const Request &req,
  1974. Response &res, const std::string &boundary,
  1975. const std::string &content_type);
  1976. bool read_content(Stream &strm, Request &req, Response &res);
  1977. bool read_content_with_content_receiver(Stream &strm, Request &req,
  1978. Response &res,
  1979. ContentReceiver receiver,
  1980. FormDataHeader multipart_header,
  1981. ContentReceiver multipart_receiver);
  1982. bool read_content_core(Stream &strm, Request &req, Response &res,
  1983. ContentReceiver receiver,
  1984. FormDataHeader multipart_header,
  1985. ContentReceiver multipart_receiver) const;
  1986. virtual bool process_and_close_socket(socket_t sock);
  1987. void output_log(const Request &req, const Response &res) const;
  1988. void output_pre_compression_log(const Request &req,
  1989. const Response &res) const;
  1990. void output_error_log(const Error &err, const Request *req) const;
  1991. std::atomic<bool> is_running_{false};
  1992. std::atomic<bool> is_decommissioned{false};
  1993. // Set when CustomRoute() refuses a registration. Written before listen(),
  1994. // read by is_valid() on the same thread, so it needs no synchronization.
  1995. bool has_invalid_registration_ = false;
  1996. struct MountPointEntry {
  1997. std::string mount_point;
  1998. std::string base_dir;
  1999. std::string resolved_base_dir;
  2000. Headers headers;
  2001. };
  2002. std::vector<MountPointEntry> base_dirs_;
  2003. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2004. std::string default_file_mimetype_ = "application/octet-stream";
  2005. Handler file_request_handler_;
  2006. Handlers get_handlers_;
  2007. Handlers post_handlers_;
  2008. HandlersForContentReader post_handlers_for_content_reader_;
  2009. Handlers put_handlers_;
  2010. HandlersForContentReader put_handlers_for_content_reader_;
  2011. Handlers patch_handlers_;
  2012. HandlersForContentReader patch_handlers_for_content_reader_;
  2013. Handlers delete_handlers_;
  2014. HandlersForContentReader delete_handlers_for_content_reader_;
  2015. Handlers options_handlers_;
  2016. CustomHandlers custom_handlers_;
  2017. struct WebSocketHandlerEntry {
  2018. std::unique_ptr<detail::MatcherBase> matcher;
  2019. WebSocketHandler handler;
  2020. SubProtocolSelector sub_protocol_selector;
  2021. };
  2022. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2023. WebSocketHandlers websocket_handlers_;
  2024. HandlerWithResponse error_handler_;
  2025. ExceptionHandler exception_handler_;
  2026. HandlerWithResponse pre_routing_handler_;
  2027. Handler post_routing_handler_;
  2028. HandlerWithResponse pre_request_handler_;
  2029. Expect100ContinueHandler expect_100_continue_handler_;
  2030. StartHandler start_handler_;
  2031. mutable std::mutex logger_mutex_;
  2032. Logger logger_;
  2033. Logger pre_compression_logger_;
  2034. ErrorLogger error_logger_;
  2035. int address_family_ = AF_UNSPEC;
  2036. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2037. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2038. SocketOptions socket_options_ = default_socket_options;
  2039. Headers default_headers_;
  2040. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2041. detail::write_headers;
  2042. };
  2043. class Result {
  2044. public:
  2045. Result() = default;
  2046. Result(std::unique_ptr<Response> &&res, Error err,
  2047. Headers &&request_headers = Headers{})
  2048. : res_(std::move(res)), err_(err),
  2049. request_headers_(std::move(request_headers)) {}
  2050. // Response
  2051. operator bool() const { return res_ != nullptr; }
  2052. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2053. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2054. const Response &value() const { return *res_; }
  2055. Response &value() { return *res_; }
  2056. const Response &operator*() const { return *res_; }
  2057. Response &operator*() { return *res_; }
  2058. const Response *operator->() const { return res_.get(); }
  2059. Response *operator->() { return res_.get(); }
  2060. // Error
  2061. Error error() const { return err_; }
  2062. // Request Headers
  2063. bool has_request_header(const std::string &key) const;
  2064. std::string get_request_header_value(const std::string &key,
  2065. const char *def = "",
  2066. size_t id = 0) const;
  2067. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2068. size_t id = 0) const;
  2069. size_t get_request_header_value_count(const std::string &key) const;
  2070. private:
  2071. std::unique_ptr<Response> res_;
  2072. Error err_ = Error::Unknown;
  2073. Headers request_headers_;
  2074. #ifdef CPPHTTPLIB_SSL_ENABLED
  2075. public:
  2076. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2077. int ssl_error)
  2078. : res_(std::move(res)), err_(err),
  2079. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2080. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2081. int ssl_error, uint64_t ssl_backend_error)
  2082. : res_(std::move(res)), err_(err),
  2083. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2084. ssl_backend_error_(ssl_backend_error) {}
  2085. int ssl_error() const { return ssl_error_; }
  2086. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2087. private:
  2088. int ssl_error_ = 0;
  2089. uint64_t ssl_backend_error_ = 0;
  2090. #endif
  2091. };
  2092. struct ClientConnection {
  2093. socket_t sock = INVALID_SOCKET;
  2094. bool is_open() const { return sock != INVALID_SOCKET; }
  2095. ClientConnection() = default;
  2096. ~ClientConnection();
  2097. ClientConnection(const ClientConnection &) = delete;
  2098. ClientConnection &operator=(const ClientConnection &) = delete;
  2099. ClientConnection(ClientConnection &&other) noexcept
  2100. : sock(other.sock)
  2101. #ifdef CPPHTTPLIB_SSL_ENABLED
  2102. ,
  2103. session(other.session)
  2104. #endif
  2105. {
  2106. other.sock = INVALID_SOCKET;
  2107. #ifdef CPPHTTPLIB_SSL_ENABLED
  2108. other.session = nullptr;
  2109. #endif
  2110. }
  2111. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2112. if (this != &other) {
  2113. sock = other.sock;
  2114. other.sock = INVALID_SOCKET;
  2115. #ifdef CPPHTTPLIB_SSL_ENABLED
  2116. session = other.session;
  2117. other.session = nullptr;
  2118. #endif
  2119. }
  2120. return *this;
  2121. }
  2122. #ifdef CPPHTTPLIB_SSL_ENABLED
  2123. tls::session_t session = nullptr;
  2124. #endif
  2125. };
  2126. namespace detail {
  2127. struct ChunkedDecoder;
  2128. struct BodyReader {
  2129. Stream *stream = nullptr;
  2130. bool has_content_length = false;
  2131. size_t content_length = 0;
  2132. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2133. size_t bytes_read = 0;
  2134. bool chunked = false;
  2135. bool eof = false;
  2136. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2137. Error last_error = Error::Success;
  2138. ssize_t read(char *buf, size_t len);
  2139. bool has_error() const { return last_error != Error::Success; }
  2140. };
  2141. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2142. size_t len) {
  2143. (void)stream;
  2144. return br.read(buf, len);
  2145. }
  2146. class decompressor;
  2147. enum class NoProxyKind {
  2148. Wildcard, // "*"
  2149. HostnameSuffix, // "example.com" or ".example.com"
  2150. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2151. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2152. };
  2153. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2154. // Lets one CIDR matcher cover both families.
  2155. using IPBytes = std::array<uint8_t, 16>;
  2156. struct NoProxyEntry {
  2157. NoProxyKind kind = NoProxyKind::Wildcard;
  2158. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2159. IPBytes net{};
  2160. int prefix_bits = 0;
  2161. };
  2162. struct NormalizedTarget {
  2163. std::string hostname; // lowercase; brackets and trailing dot removed
  2164. bool is_ipv4 = false;
  2165. bool is_ipv6 = false;
  2166. IPBytes ip{};
  2167. };
  2168. } // namespace detail
  2169. class ClientImpl {
  2170. public:
  2171. explicit ClientImpl(const std::string &host);
  2172. explicit ClientImpl(const std::string &host, int port);
  2173. explicit ClientImpl(const std::string &host, int port,
  2174. const std::string &client_cert_path,
  2175. const std::string &client_key_path);
  2176. virtual ~ClientImpl();
  2177. virtual bool is_valid() const;
  2178. struct StreamHandle {
  2179. std::unique_ptr<Response> response;
  2180. Error error = Error::Success;
  2181. StreamHandle() = default;
  2182. StreamHandle(const StreamHandle &) = delete;
  2183. StreamHandle &operator=(const StreamHandle &) = delete;
  2184. StreamHandle(StreamHandle &&) = default;
  2185. StreamHandle &operator=(StreamHandle &&) = default;
  2186. ~StreamHandle() = default;
  2187. bool is_valid() const {
  2188. return response != nullptr && error == Error::Success;
  2189. }
  2190. ssize_t read(char *buf, size_t len);
  2191. void parse_trailers_if_needed();
  2192. Error get_read_error() const { return body_reader_.last_error; }
  2193. bool has_read_error() const { return body_reader_.has_error(); }
  2194. bool trailers_parsed_ = false;
  2195. private:
  2196. friend class ClientImpl;
  2197. ssize_t read_with_decompression(char *buf, size_t len);
  2198. std::unique_ptr<ClientConnection> connection_;
  2199. std::unique_ptr<Stream> socket_stream_;
  2200. Stream *stream_ = nullptr;
  2201. detail::BodyReader body_reader_;
  2202. std::unique_ptr<detail::decompressor> decompressor_;
  2203. std::string decompress_buffer_;
  2204. size_t decompress_offset_ = 0;
  2205. size_t decompressed_bytes_read_ = 0;
  2206. };
  2207. // clang-format off
  2208. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2209. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2210. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2211. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2212. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2213. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2214. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2215. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2216. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2217. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2218. Result Head(const std::string &path);
  2219. Result Head(const std::string &path, const Headers &headers);
  2220. Result Post(const std::string &path);
  2221. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2222. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2223. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2224. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2225. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2226. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2227. Result Post(const std::string &path, const Params &params);
  2228. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2229. Result Post(const std::string &path, const Headers &headers);
  2230. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2231. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2232. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2233. 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);
  2234. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2235. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2236. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2237. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2238. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2239. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2240. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2241. Result Put(const std::string &path);
  2242. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2243. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2244. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2245. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2246. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2247. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2248. Result Put(const std::string &path, const Params &params);
  2249. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2250. Result Put(const std::string &path, const Headers &headers);
  2251. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2252. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2253. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2254. 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);
  2255. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2256. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2257. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2258. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2259. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2260. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2261. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2262. Result Patch(const std::string &path);
  2263. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2264. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2265. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2266. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2267. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2268. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2269. Result Patch(const std::string &path, const Params &params);
  2270. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2271. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2272. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2273. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2274. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2275. 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);
  2276. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2277. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2278. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2279. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2280. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2281. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2282. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2283. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2284. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2285. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2286. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2287. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2288. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2289. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2290. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2291. Result Options(const std::string &path);
  2292. Result Options(const std::string &path, const Headers &headers);
  2293. // clang-format on
  2294. // Streaming API: Open a stream for reading response body incrementally
  2295. // Socket ownership is transferred to StreamHandle for true streaming
  2296. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2297. StreamHandle open_stream(const std::string &method, const std::string &path,
  2298. const Params &params = {},
  2299. const Headers &headers = {},
  2300. const std::string &body = {},
  2301. const std::string &content_type = {});
  2302. bool send(Request &req, Response &res, Error &error);
  2303. Result send(const Request &req);
  2304. void stop();
  2305. std::string host() const;
  2306. int port() const;
  2307. size_t is_socket_open() const;
  2308. socket_t socket() const;
  2309. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2310. void set_default_headers(Headers headers);
  2311. void
  2312. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2313. void set_address_family(int family);
  2314. void set_tcp_nodelay(bool on);
  2315. void set_ipv6_v6only(bool on);
  2316. void set_socket_options(SocketOptions socket_options);
  2317. void set_connection_timeout(time_t sec, time_t usec = 0);
  2318. template <class Rep, class Period>
  2319. void
  2320. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2321. void set_read_timeout(time_t sec, time_t usec = 0);
  2322. template <class Rep, class Period>
  2323. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2324. void set_write_timeout(time_t sec, time_t usec = 0);
  2325. template <class Rep, class Period>
  2326. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2327. void set_max_timeout(time_t msec);
  2328. template <class Rep, class Period>
  2329. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2330. void set_basic_auth(const std::string &username, const std::string &password);
  2331. void set_bearer_token_auth(const std::string &token);
  2332. void set_keep_alive(bool on);
  2333. void set_follow_location(bool on);
  2334. void set_path_encode(bool on);
  2335. void set_compress(bool on);
  2336. void set_decompress(bool on);
  2337. void set_payload_max_length(size_t length);
  2338. void set_interface(const std::string &intf);
  2339. void set_proxy(const std::string &host, int port);
  2340. void set_proxy_basic_auth(const std::string &username,
  2341. const std::string &password);
  2342. void set_proxy_bearer_token_auth(const std::string &token);
  2343. void set_no_proxy(const std::vector<std::string> &patterns);
  2344. void set_logger(Logger logger);
  2345. void set_error_logger(ErrorLogger error_logger);
  2346. protected:
  2347. struct Socket {
  2348. socket_t sock = INVALID_SOCKET;
  2349. // For Mbed TLS compatibility: start_time for request timeout tracking
  2350. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2351. bool is_open() const { return sock != INVALID_SOCKET; }
  2352. #ifdef CPPHTTPLIB_SSL_ENABLED
  2353. tls::session_t ssl = nullptr;
  2354. #endif
  2355. };
  2356. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2357. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2358. virtual bool setup_proxy_connection(
  2359. Socket &socket,
  2360. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2361. Response &res, bool &success, Error &error);
  2362. bool is_proxy_enabled_for_host(const std::string &host) const;
  2363. // All of:
  2364. // shutdown_ssl
  2365. // shutdown_socket
  2366. // close_socket
  2367. // disconnect
  2368. // should ONLY be called when socket_mutex_ is locked, and only when
  2369. // no other thread is using the socket.
  2370. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2371. void shutdown_socket(Socket &socket) const;
  2372. void close_socket(Socket &socket);
  2373. void disconnect(bool gracefully);
  2374. bool process_request(Stream &strm, Request &req, Response &res,
  2375. bool close_connection, Error &error);
  2376. bool write_content_with_provider(Stream &strm, const Request &req,
  2377. Error &error) const;
  2378. void copy_settings(const ClientImpl &rhs);
  2379. void output_log(const Request &req, const Response &res) const;
  2380. void output_error_log(const Error &err, const Request *req) const;
  2381. // Socket endpoint information
  2382. const std::string host_;
  2383. const int port_;
  2384. // Current open socket
  2385. Socket socket_;
  2386. mutable std::mutex socket_mutex_;
  2387. std::recursive_mutex request_mutex_;
  2388. // These are all protected under socket_mutex
  2389. size_t socket_requests_in_flight_ = 0;
  2390. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2391. bool socket_should_be_closed_when_request_is_done_ = false;
  2392. // Hostname to connection target map. The value is an IP literal or another
  2393. // hostname; only the connection target changes, never the identity.
  2394. std::map<std::string, std::string> addr_map_;
  2395. // Default headers
  2396. Headers default_headers_;
  2397. // Header writer
  2398. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2399. detail::write_headers;
  2400. // Settings
  2401. std::string client_cert_path_;
  2402. std::string client_key_path_;
  2403. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2404. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2405. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2406. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2407. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2408. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2409. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2410. std::string basic_auth_username_;
  2411. std::string basic_auth_password_;
  2412. std::string bearer_token_auth_token_;
  2413. bool keep_alive_ = false;
  2414. bool follow_location_ = false;
  2415. bool path_encode_ = true;
  2416. int address_family_ = AF_UNSPEC;
  2417. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2418. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2419. SocketOptions socket_options_ = nullptr;
  2420. bool compress_ = false;
  2421. bool decompress_ = true;
  2422. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2423. bool has_payload_max_length_ = false;
  2424. std::string interface_;
  2425. std::string proxy_host_;
  2426. int proxy_port_ = -1;
  2427. std::string proxy_basic_auth_username_;
  2428. std::string proxy_basic_auth_password_;
  2429. std::string proxy_bearer_token_auth_token_;
  2430. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2431. mutable detail::NormalizedTarget host_normalized_;
  2432. mutable bool host_normalized_valid_ = false;
  2433. mutable std::mutex logger_mutex_;
  2434. Logger logger_;
  2435. ErrorLogger error_logger_;
  2436. private:
  2437. bool send_(Request &req, Response &res, Error &error);
  2438. Result send_(Request &&req);
  2439. socket_t create_client_socket(Error &error) const;
  2440. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2441. bool skip_100_continue = true) const;
  2442. bool write_request(Stream &strm, Request &req, bool close_connection,
  2443. Error &error, bool skip_body = false);
  2444. bool write_request_body(Stream &strm, Request &req, Error &error);
  2445. void prepare_default_headers(Request &r, bool for_stream,
  2446. const std::string &ct);
  2447. bool redirect(Request &req, Response &res, Error &error);
  2448. bool create_redirect_client(const std::string &scheme,
  2449. const std::string &host, int port, Request &req,
  2450. Response &res, const std::string &path,
  2451. const std::string &location, Error &error);
  2452. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2453. bool handle_request(Stream &strm, Request &req, Response &res,
  2454. bool close_connection, Error &error);
  2455. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2456. Request &req, const char *body, size_t content_length,
  2457. ContentProvider content_provider,
  2458. ContentProviderWithoutLength content_provider_without_length,
  2459. const std::string &content_type, ContentReceiver content_receiver,
  2460. Error &error);
  2461. Result send_with_content_provider_and_receiver(
  2462. const std::string &method, const std::string &path,
  2463. const Headers &headers, const char *body, size_t content_length,
  2464. ContentProvider content_provider,
  2465. ContentProviderWithoutLength content_provider_without_length,
  2466. const std::string &content_type, ContentReceiver content_receiver,
  2467. UploadProgress progress);
  2468. ContentProviderWithoutLength get_multipart_content_provider(
  2469. const std::string &boundary, const UploadFormDataItems &items,
  2470. const FormDataProviderItems &provider_items) const;
  2471. virtual bool
  2472. process_socket(const Socket &socket,
  2473. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2474. std::function<bool(Stream &strm)> callback);
  2475. virtual bool is_ssl() const;
  2476. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2477. #ifdef CPPHTTPLIB_SSL_ENABLED
  2478. public:
  2479. void set_digest_auth(const std::string &username,
  2480. const std::string &password);
  2481. void set_proxy_digest_auth(const std::string &username,
  2482. const std::string &password);
  2483. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2484. const std::string &ca_cert_dir_path = std::string());
  2485. void enable_server_certificate_verification(bool enabled);
  2486. void enable_server_hostname_verification(bool enabled);
  2487. void enable_system_ca(bool enabled);
  2488. protected:
  2489. std::string digest_auth_username_;
  2490. std::string digest_auth_password_;
  2491. std::string proxy_digest_auth_username_;
  2492. std::string proxy_digest_auth_password_;
  2493. std::string ca_cert_file_path_;
  2494. std::string ca_cert_dir_path_;
  2495. bool server_certificate_verification_ = true;
  2496. bool server_hostname_verification_ = true;
  2497. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2498. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2499. int last_ssl_error_ = 0;
  2500. uint64_t last_backend_error_ = 0;
  2501. #endif
  2502. };
  2503. class Client {
  2504. public:
  2505. // Universal interface
  2506. explicit Client(const std::string &scheme_host_port);
  2507. explicit Client(const std::string &scheme_host_port,
  2508. const std::string &client_cert_path,
  2509. const std::string &client_key_path);
  2510. // HTTP only interface
  2511. explicit Client(const std::string &host, int port);
  2512. explicit Client(const std::string &host, int port,
  2513. const std::string &client_cert_path,
  2514. const std::string &client_key_path);
  2515. Client(Client &&) = default;
  2516. Client &operator=(Client &&) = default;
  2517. ~Client();
  2518. bool is_valid() const;
  2519. // clang-format off
  2520. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2521. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2522. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2523. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2524. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2525. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2526. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2527. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2528. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2529. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2530. Result Head(const std::string &path);
  2531. Result Head(const std::string &path, const Headers &headers);
  2532. Result Post(const std::string &path);
  2533. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2534. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2535. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2536. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2537. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2538. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2539. Result Post(const std::string &path, const Params &params);
  2540. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2541. Result Post(const std::string &path, const Headers &headers);
  2542. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2543. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2544. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2545. 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);
  2546. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2547. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2548. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2549. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2550. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2551. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2552. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2553. Result Put(const std::string &path);
  2554. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2555. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2556. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2557. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2558. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2559. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2560. Result Put(const std::string &path, const Params &params);
  2561. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2562. Result Put(const std::string &path, const Headers &headers);
  2563. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2564. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2565. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2566. 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);
  2567. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2568. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2569. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2570. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2571. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2572. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2573. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2574. Result Patch(const std::string &path);
  2575. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2576. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2577. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2578. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2579. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2580. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2581. Result Patch(const std::string &path, const Params &params);
  2582. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2583. Result Patch(const std::string &path, const Headers &headers);
  2584. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2585. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2586. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2587. 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);
  2588. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2589. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2590. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2591. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2592. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2593. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2594. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2595. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2596. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2597. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2598. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2599. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2600. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2601. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2602. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2603. Result Options(const std::string &path);
  2604. Result Options(const std::string &path, const Headers &headers);
  2605. // clang-format on
  2606. // Streaming API: Open a stream for reading response body incrementally
  2607. // Socket ownership is transferred to StreamHandle for true streaming
  2608. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2609. ClientImpl::StreamHandle open_stream(const std::string &method,
  2610. const std::string &path,
  2611. const Params &params = {},
  2612. const Headers &headers = {},
  2613. const std::string &body = {},
  2614. const std::string &content_type = {});
  2615. bool send(Request &req, Response &res, Error &error);
  2616. Result send(const Request &req);
  2617. void stop();
  2618. std::string host() const;
  2619. int port() const;
  2620. size_t is_socket_open() const;
  2621. socket_t socket() const;
  2622. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2623. void set_default_headers(Headers headers);
  2624. void
  2625. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2626. void set_address_family(int family);
  2627. void set_tcp_nodelay(bool on);
  2628. void set_socket_options(SocketOptions socket_options);
  2629. void set_connection_timeout(time_t sec, time_t usec = 0);
  2630. template <class Rep, class Period>
  2631. void
  2632. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2633. void set_read_timeout(time_t sec, time_t usec = 0);
  2634. template <class Rep, class Period>
  2635. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2636. void set_write_timeout(time_t sec, time_t usec = 0);
  2637. template <class Rep, class Period>
  2638. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2639. void set_max_timeout(time_t msec);
  2640. template <class Rep, class Period>
  2641. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2642. void set_basic_auth(const std::string &username, const std::string &password);
  2643. void set_bearer_token_auth(const std::string &token);
  2644. void set_keep_alive(bool on);
  2645. void set_follow_location(bool on);
  2646. void set_path_encode(bool on);
  2647. void set_compress(bool on);
  2648. void set_decompress(bool on);
  2649. void set_payload_max_length(size_t length);
  2650. void set_interface(const std::string &intf);
  2651. void set_proxy(const std::string &host, int port);
  2652. void set_proxy_basic_auth(const std::string &username,
  2653. const std::string &password);
  2654. void set_proxy_bearer_token_auth(const std::string &token);
  2655. void set_no_proxy(const std::vector<std::string> &patterns);
  2656. void set_logger(Logger logger);
  2657. void set_error_logger(ErrorLogger error_logger);
  2658. private:
  2659. std::unique_ptr<ClientImpl> cli_;
  2660. #ifdef CPPHTTPLIB_SSL_ENABLED
  2661. public:
  2662. void set_digest_auth(const std::string &username,
  2663. const std::string &password);
  2664. void set_proxy_digest_auth(const std::string &username,
  2665. const std::string &password);
  2666. void enable_server_certificate_verification(bool enabled);
  2667. void enable_server_hostname_verification(bool enabled);
  2668. void enable_system_ca(bool enabled);
  2669. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2670. const std::string &ca_cert_dir_path = std::string());
  2671. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2672. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2673. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2674. void set_session_verifier(
  2675. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2676. tls::ctx_t tls_context() const;
  2677. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2678. void enable_windows_certificate_verification(bool enabled);
  2679. #endif
  2680. private:
  2681. bool is_ssl_ = false;
  2682. #endif
  2683. };
  2684. #ifdef CPPHTTPLIB_SSL_ENABLED
  2685. class SSLServer : public Server {
  2686. public:
  2687. SSLServer(const char *cert_path, const char *private_key_path,
  2688. const char *client_ca_cert_file_path = nullptr,
  2689. const char *client_ca_cert_dir_path = nullptr,
  2690. const char *private_key_password = nullptr);
  2691. struct PemMemory {
  2692. const char *cert_pem;
  2693. size_t cert_pem_len;
  2694. const char *key_pem;
  2695. size_t key_pem_len;
  2696. const char *client_ca_pem;
  2697. size_t client_ca_pem_len;
  2698. const char *private_key_password;
  2699. };
  2700. explicit SSLServer(const PemMemory &pem);
  2701. // The callback receives the ctx_t handle which can be cast to the
  2702. // appropriate backend type (SSL_CTX* for OpenSSL,
  2703. // tls::impl::MbedTlsContext* for Mbed TLS)
  2704. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2705. ~SSLServer() override;
  2706. bool is_valid() const override;
  2707. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2708. const char *client_ca_pem = nullptr,
  2709. const char *password = nullptr);
  2710. tls::ctx_t tls_context() const { return ctx_; }
  2711. int ssl_last_error() const { return last_ssl_error_; }
  2712. private:
  2713. bool process_and_close_socket(socket_t sock) override;
  2714. tls::ctx_t ctx_ = nullptr;
  2715. std::mutex ctx_mutex_;
  2716. int last_ssl_error_ = 0;
  2717. };
  2718. class SSLClient final : public ClientImpl {
  2719. public:
  2720. explicit SSLClient(const std::string &host);
  2721. explicit SSLClient(const std::string &host, int port);
  2722. explicit SSLClient(const std::string &host, int port,
  2723. const std::string &client_cert_path,
  2724. const std::string &client_key_path,
  2725. const std::string &private_key_password = std::string());
  2726. struct PemMemory {
  2727. const char *cert_pem;
  2728. size_t cert_pem_len;
  2729. const char *key_pem;
  2730. size_t key_pem_len;
  2731. const char *private_key_password;
  2732. };
  2733. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2734. ~SSLClient() override;
  2735. bool is_valid() const override;
  2736. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2737. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2738. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2739. // Post-handshake session verifier (backend-independent)
  2740. void set_session_verifier(
  2741. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2742. tls::ctx_t tls_context() const { return ctx_; }
  2743. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2744. void enable_windows_certificate_verification(bool enabled);
  2745. #endif
  2746. private:
  2747. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2748. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2749. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2750. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2751. bool
  2752. process_socket(const Socket &socket,
  2753. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2754. std::function<bool(Stream &strm)> callback) override;
  2755. bool is_ssl() const override;
  2756. bool setup_proxy_connection(
  2757. Socket &socket,
  2758. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2759. Response &res, bool &success, Error &error) override;
  2760. bool connect_with_proxy(
  2761. Socket &sock,
  2762. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2763. Response &res, bool &success, Error &error);
  2764. bool initialize_ssl(Socket &socket, Error &error);
  2765. void init_ctx();
  2766. void reset_ctx_on_error();
  2767. bool load_certs();
  2768. tls::ctx_t ctx_ = nullptr;
  2769. std::mutex ctx_mutex_;
  2770. std::once_flag initialize_cert_;
  2771. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2772. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2773. // Used to keep custom CA configuration exclusive with system CA loading.
  2774. bool ca_cert_store_set_ = false;
  2775. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2776. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2777. bool enable_windows_cert_verification_ = true;
  2778. #endif
  2779. friend class ClientImpl;
  2780. };
  2781. #endif // CPPHTTPLIB_SSL_ENABLED
  2782. namespace detail {
  2783. template <typename T, typename U>
  2784. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2785. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2786. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2787. duration - std::chrono::seconds(sec))
  2788. .count();
  2789. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2790. }
  2791. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2792. return N - 1;
  2793. }
  2794. inline bool is_numeric(const std::string &str) {
  2795. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2796. }
  2797. inline size_t get_header_value_u64(const Headers &headers,
  2798. const std::string &key, size_t def,
  2799. size_t id, bool &is_invalid_value) {
  2800. is_invalid_value = false;
  2801. auto rng = headers.equal_range(key);
  2802. auto it = rng.first;
  2803. std::advance(it, static_cast<ssize_t>(id));
  2804. if (it != rng.second) {
  2805. if (is_numeric(it->second)) {
  2806. // Parse at size_t width so an out-of-range Content-Length is reported
  2807. // rather than silently saturated/truncated (a value above 2^32 would
  2808. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2809. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2810. size_t val = 0;
  2811. const auto &s = it->second;
  2812. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2813. if (r.ec == std::errc::result_out_of_range) {
  2814. is_invalid_value = true;
  2815. return (std::numeric_limits<size_t>::max)();
  2816. }
  2817. return val;
  2818. } else {
  2819. is_invalid_value = true;
  2820. }
  2821. }
  2822. return def;
  2823. }
  2824. inline size_t get_header_value_u64(const Headers &headers,
  2825. const std::string &key, size_t def,
  2826. size_t id) {
  2827. auto dummy = false;
  2828. return get_header_value_u64(headers, key, def, id, dummy);
  2829. }
  2830. } // namespace detail
  2831. template <class Rep, class Period>
  2832. inline Server &
  2833. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2834. detail::duration_to_sec_and_usec(
  2835. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2836. return *this;
  2837. }
  2838. template <class Rep, class Period>
  2839. inline Server &
  2840. Server::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2841. detail::duration_to_sec_and_usec(
  2842. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2843. return *this;
  2844. }
  2845. template <class Rep, class Period>
  2846. inline Server &
  2847. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2848. detail::duration_to_sec_and_usec(
  2849. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2850. return *this;
  2851. }
  2852. template <class Rep, class Period>
  2853. inline void ClientImpl::set_connection_timeout(
  2854. const std::chrono::duration<Rep, Period> &duration) {
  2855. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2856. set_connection_timeout(sec, usec);
  2857. });
  2858. }
  2859. template <class Rep, class Period>
  2860. inline void ClientImpl::set_read_timeout(
  2861. const std::chrono::duration<Rep, Period> &duration) {
  2862. detail::duration_to_sec_and_usec(
  2863. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2864. }
  2865. template <class Rep, class Period>
  2866. inline void ClientImpl::set_write_timeout(
  2867. const std::chrono::duration<Rep, Period> &duration) {
  2868. detail::duration_to_sec_and_usec(
  2869. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2870. }
  2871. template <class Rep, class Period>
  2872. inline void ClientImpl::set_max_timeout(
  2873. const std::chrono::duration<Rep, Period> &duration) {
  2874. auto msec =
  2875. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2876. set_max_timeout(msec);
  2877. }
  2878. template <class Rep, class Period>
  2879. inline void Client::set_connection_timeout(
  2880. const std::chrono::duration<Rep, Period> &duration) {
  2881. cli_->set_connection_timeout(duration);
  2882. }
  2883. template <class Rep, class Period>
  2884. inline void
  2885. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2886. cli_->set_read_timeout(duration);
  2887. }
  2888. template <class Rep, class Period>
  2889. inline void
  2890. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2891. cli_->set_write_timeout(duration);
  2892. }
  2893. inline void Client::set_max_timeout(time_t msec) {
  2894. cli_->set_max_timeout(msec);
  2895. }
  2896. template <class Rep, class Period>
  2897. inline void
  2898. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2899. cli_->set_max_timeout(duration);
  2900. }
  2901. /*
  2902. * Forward declarations and types that will be part of the .h file if split into
  2903. * .h + .cc.
  2904. */
  2905. std::string hosted_at(const std::string &hostname);
  2906. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2907. // JavaScript-style URL encoding/decoding functions
  2908. std::string encode_uri_component(const std::string &value);
  2909. std::string encode_uri(const std::string &value);
  2910. std::string decode_uri_component(const std::string &value);
  2911. std::string decode_uri(const std::string &value);
  2912. // RFC 3986 compliant URL component encoding/decoding functions
  2913. std::string encode_path_component(const std::string &component);
  2914. std::string decode_path_component(const std::string &component);
  2915. std::string encode_query_component(const std::string &component,
  2916. bool space_as_plus = true);
  2917. std::string decode_query_component(const std::string &component,
  2918. bool plus_as_space = true);
  2919. std::string sanitize_filename(const std::string &filename);
  2920. std::string append_query_params(const std::string &path, const Params &params);
  2921. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2922. std::pair<std::string, std::string>
  2923. make_basic_authentication_header(const std::string &username,
  2924. const std::string &password,
  2925. bool is_proxy = false);
  2926. namespace detail {
  2927. #if defined(_WIN32)
  2928. inline std::wstring u8string_to_wstring(const char *s) {
  2929. if (!s) { return std::wstring(); }
  2930. auto len = static_cast<int>(strlen(s));
  2931. if (!len) { return std::wstring(); }
  2932. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2933. if (!wlen) { return std::wstring(); }
  2934. std::wstring ws;
  2935. ws.resize(wlen);
  2936. wlen = ::MultiByteToWideChar(
  2937. CP_UTF8, 0, s, len,
  2938. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  2939. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  2940. return ws;
  2941. }
  2942. #endif
  2943. struct FileStat {
  2944. FileStat(const std::string &path);
  2945. bool is_file() const;
  2946. bool is_dir() const;
  2947. time_t mtime() const;
  2948. size_t size() const;
  2949. private:
  2950. #if defined(_WIN32)
  2951. struct _stat st_;
  2952. #else
  2953. struct stat st_;
  2954. #endif
  2955. int ret_ = -1;
  2956. };
  2957. std::string make_host_and_port_string(const std::string &host, int port,
  2958. bool is_ssl);
  2959. template <typename T>
  2960. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  2961. Error &error);
  2962. std::string trim_copy(const std::string &s);
  2963. void divide(
  2964. const char *data, std::size_t size, char d,
  2965. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2966. fn);
  2967. void divide(
  2968. const std::string &str, char d,
  2969. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2970. fn);
  2971. void split(const char *b, const char *e, char d,
  2972. std::function<void(const char *, const char *)> fn);
  2973. void split(const char *b, const char *e, char d, size_t m,
  2974. std::function<void(const char *, const char *)> fn);
  2975. bool split_find(const char *b, const char *e, char d,
  2976. std::function<bool(const char *, const char *)> fn);
  2977. bool has_header_token(const Headers &headers, const std::string &key,
  2978. const std::string &token);
  2979. std::string websocket_accept_key(const std::string &client_key);
  2980. bool is_websocket_upgrade(const Request &req);
  2981. bool process_client_socket(
  2982. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  2983. time_t write_timeout_sec, time_t write_timeout_usec,
  2984. time_t max_timeout_msec,
  2985. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2986. std::function<bool(Stream &)> callback);
  2987. socket_t create_client_socket(const std::string &host, const std::string &ip,
  2988. int port, int address_family, bool tcp_nodelay,
  2989. bool ipv6_v6only, SocketOptions socket_options,
  2990. time_t connection_timeout_sec,
  2991. time_t connection_timeout_usec,
  2992. time_t read_timeout_sec, time_t read_timeout_usec,
  2993. time_t write_timeout_sec,
  2994. time_t write_timeout_usec,
  2995. const std::string &intf, Error &error);
  2996. const char *get_header_value(const Headers &headers, const std::string &key,
  2997. const char *def, size_t id);
  2998. std::string get_combined_header_value(const Headers &headers,
  2999. const std::string &key);
  3000. std::string params_to_query_str(const Params &params);
  3001. void parse_query_text(const char *data, std::size_t size, Params &params);
  3002. void parse_query_text(const std::string &s, Params &params);
  3003. bool parse_multipart_boundary(const std::string &content_type,
  3004. std::string &boundary);
  3005. bool parse_range_header(const std::string &s, Ranges &ranges);
  3006. bool parse_accept_header(const std::string &s,
  3007. std::vector<std::string> &content_types);
  3008. void parse_disposition_params(const std::string &s, Params &params);
  3009. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3010. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3011. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3012. EncodingType encoding_type(const Request &req, const Response &res,
  3013. const std::string &content_type);
  3014. EncodingType encoding_type(const Request &req, const Response &res);
  3015. class BufferStream final : public Stream {
  3016. public:
  3017. BufferStream() = default;
  3018. ~BufferStream() override = default;
  3019. bool is_readable() const override;
  3020. bool wait_readable() const override;
  3021. bool wait_writable() const override;
  3022. ssize_t read(char *ptr, size_t size) override;
  3023. ssize_t write(const char *ptr, size_t size) override;
  3024. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3025. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3026. socket_t socket() const override;
  3027. time_t duration() const override;
  3028. const std::string &get_buffer() const;
  3029. private:
  3030. std::string buffer;
  3031. size_t position = 0;
  3032. };
  3033. class compressor {
  3034. public:
  3035. virtual ~compressor() = default;
  3036. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3037. virtual bool compress(const char *data, size_t data_length, bool last,
  3038. Callback callback) = 0;
  3039. };
  3040. class decompressor {
  3041. public:
  3042. virtual ~decompressor() = default;
  3043. virtual bool is_valid() const = 0;
  3044. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3045. virtual bool decompress(const char *data, size_t data_length,
  3046. Callback callback) = 0;
  3047. };
  3048. class nocompressor final : public compressor {
  3049. public:
  3050. ~nocompressor() override = default;
  3051. bool compress(const char *data, size_t data_length, bool /*last*/,
  3052. Callback callback) override;
  3053. };
  3054. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3055. class gzip_compressor final : public compressor {
  3056. public:
  3057. gzip_compressor();
  3058. ~gzip_compressor() override;
  3059. bool compress(const char *data, size_t data_length, bool last,
  3060. Callback callback) override;
  3061. private:
  3062. bool is_valid_ = false;
  3063. z_stream strm_;
  3064. };
  3065. class gzip_decompressor final : public decompressor {
  3066. public:
  3067. gzip_decompressor();
  3068. ~gzip_decompressor() override;
  3069. bool is_valid() const override;
  3070. bool decompress(const char *data, size_t data_length,
  3071. Callback callback) override;
  3072. private:
  3073. bool is_valid_ = false;
  3074. z_stream strm_;
  3075. };
  3076. #endif
  3077. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3078. class brotli_compressor final : public compressor {
  3079. public:
  3080. brotli_compressor();
  3081. ~brotli_compressor();
  3082. bool compress(const char *data, size_t data_length, bool last,
  3083. Callback callback) override;
  3084. private:
  3085. BrotliEncoderState *state_ = nullptr;
  3086. };
  3087. class brotli_decompressor final : public decompressor {
  3088. public:
  3089. brotli_decompressor();
  3090. ~brotli_decompressor();
  3091. bool is_valid() const override;
  3092. bool decompress(const char *data, size_t data_length,
  3093. Callback callback) override;
  3094. private:
  3095. BrotliDecoderResult decoder_r;
  3096. BrotliDecoderState *decoder_s = nullptr;
  3097. };
  3098. #endif
  3099. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3100. class zstd_compressor : public compressor {
  3101. public:
  3102. zstd_compressor();
  3103. ~zstd_compressor();
  3104. bool compress(const char *data, size_t data_length, bool last,
  3105. Callback callback) override;
  3106. private:
  3107. ZSTD_CCtx *ctx_ = nullptr;
  3108. };
  3109. class zstd_decompressor : public decompressor {
  3110. public:
  3111. zstd_decompressor();
  3112. ~zstd_decompressor();
  3113. bool is_valid() const override;
  3114. bool decompress(const char *data, size_t data_length,
  3115. Callback callback) override;
  3116. private:
  3117. ZSTD_DCtx *ctx_ = nullptr;
  3118. };
  3119. #endif
  3120. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3121. // to store data. The call can set memory on stack for performance.
  3122. class stream_line_reader {
  3123. public:
  3124. stream_line_reader(Stream &strm, char *fixed_buffer,
  3125. size_t fixed_buffer_size);
  3126. const char *ptr() const;
  3127. size_t size() const;
  3128. bool end_with_crlf() const;
  3129. bool getline();
  3130. private:
  3131. void append(char c);
  3132. void append(const char *data, size_t size);
  3133. Stream &strm_;
  3134. char *fixed_buffer_;
  3135. const size_t fixed_buffer_size_;
  3136. size_t fixed_buffer_used_size_ = 0;
  3137. std::string growable_buffer_;
  3138. };
  3139. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3140. const Headers &src_headers);
  3141. struct ChunkedDecoder {
  3142. Stream &strm;
  3143. size_t chunk_remaining = 0;
  3144. bool finished = false;
  3145. char line_buf[64];
  3146. size_t last_chunk_total = 0;
  3147. size_t last_chunk_offset = 0;
  3148. explicit ChunkedDecoder(Stream &s);
  3149. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3150. size_t &out_chunk_total);
  3151. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3152. };
  3153. class mmap {
  3154. public:
  3155. mmap(const char *path);
  3156. ~mmap();
  3157. bool open(const char *path);
  3158. void close();
  3159. bool is_open() const;
  3160. size_t size() const;
  3161. const char *data() const;
  3162. private:
  3163. #if defined(_WIN32)
  3164. HANDLE hFile_ = NULL;
  3165. HANDLE hMapping_ = NULL;
  3166. #else
  3167. int fd_ = -1;
  3168. #endif
  3169. size_t size_ = 0;
  3170. void *addr_ = nullptr;
  3171. bool is_open_empty_file = false;
  3172. };
  3173. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3174. namespace fields {
  3175. bool is_token_char(char c);
  3176. bool is_token(const std::string &s);
  3177. bool is_field_name(const std::string &s);
  3178. bool is_vchar(char c);
  3179. bool is_obs_text(char c);
  3180. bool is_field_vchar(char c);
  3181. bool is_field_content(const std::string &s);
  3182. bool is_field_value(const std::string &s);
  3183. bool is_field_valid(const std::string &name, const std::string &value);
  3184. } // namespace fields
  3185. } // namespace detail
  3186. /*
  3187. * TLS Abstraction Layer Declarations
  3188. */
  3189. #ifdef CPPHTTPLIB_SSL_ENABLED
  3190. // TLS abstraction layer - backend-specific type declarations
  3191. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3192. namespace tls {
  3193. namespace impl {
  3194. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3195. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3196. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3197. struct MbedTlsContext {
  3198. mbedtls_ssl_config conf;
  3199. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3200. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3201. mbedtls_entropy_context entropy;
  3202. mbedtls_ctr_drbg_context ctr_drbg;
  3203. #endif
  3204. mbedtls_x509_crt ca_chain;
  3205. mbedtls_x509_crt own_cert;
  3206. mbedtls_pk_context own_key;
  3207. bool is_server = false;
  3208. bool verify_client = false;
  3209. bool has_verify_callback = false;
  3210. MbedTlsContext();
  3211. ~MbedTlsContext();
  3212. MbedTlsContext(const MbedTlsContext &) = delete;
  3213. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3214. };
  3215. } // namespace impl
  3216. } // namespace tls
  3217. #endif
  3218. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3219. namespace tls {
  3220. namespace impl {
  3221. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3222. // This struct is accessible via tls::impl for use in SSL context
  3223. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3224. struct WolfSSLContext {
  3225. WOLFSSL_CTX *ctx = nullptr;
  3226. bool is_server = false;
  3227. bool verify_client = false;
  3228. bool has_verify_callback = false;
  3229. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3230. WolfSSLContext();
  3231. ~WolfSSLContext();
  3232. WolfSSLContext(const WolfSSLContext &) = delete;
  3233. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3234. };
  3235. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3236. struct WolfSSLCAStore {
  3237. std::string pem_data;
  3238. };
  3239. } // namespace impl
  3240. } // namespace tls
  3241. #endif
  3242. #endif // CPPHTTPLIB_SSL_ENABLED
  3243. namespace stream {
  3244. class Result {
  3245. public:
  3246. Result();
  3247. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3248. Result(Result &&other) noexcept;
  3249. Result &operator=(Result &&other) noexcept;
  3250. Result(const Result &) = delete;
  3251. Result &operator=(const Result &) = delete;
  3252. // Response info
  3253. bool is_valid() const;
  3254. explicit operator bool() const;
  3255. int status() const;
  3256. const Headers &headers() const;
  3257. std::string get_header_value(const std::string &key,
  3258. const char *def = "") const;
  3259. bool has_header(const std::string &key) const;
  3260. Error error() const;
  3261. Error read_error() const;
  3262. bool has_read_error() const;
  3263. // Stream reading
  3264. bool next();
  3265. const char *data() const;
  3266. size_t size() const;
  3267. std::string read_all();
  3268. private:
  3269. ClientImpl::StreamHandle handle_;
  3270. std::string buffer_;
  3271. size_t current_size_ = 0;
  3272. size_t chunk_size_;
  3273. bool finished_ = false;
  3274. };
  3275. // GET
  3276. template <typename ClientType>
  3277. inline Result Get(ClientType &cli, const std::string &path,
  3278. size_t chunk_size = 8192) {
  3279. return Result{cli.open_stream("GET", path), chunk_size};
  3280. }
  3281. template <typename ClientType>
  3282. inline Result Get(ClientType &cli, const std::string &path,
  3283. const Headers &headers, size_t chunk_size = 8192) {
  3284. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3285. }
  3286. template <typename ClientType>
  3287. inline Result Get(ClientType &cli, const std::string &path,
  3288. const Params &params, size_t chunk_size = 8192) {
  3289. return Result{cli.open_stream("GET", path, params), chunk_size};
  3290. }
  3291. template <typename ClientType>
  3292. inline Result Get(ClientType &cli, const std::string &path,
  3293. const Params &params, const Headers &headers,
  3294. size_t chunk_size = 8192) {
  3295. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3296. }
  3297. // POST
  3298. template <typename ClientType>
  3299. inline Result Post(ClientType &cli, const std::string &path,
  3300. const std::string &body, const std::string &content_type,
  3301. size_t chunk_size = 8192) {
  3302. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3303. chunk_size};
  3304. }
  3305. template <typename ClientType>
  3306. inline Result Post(ClientType &cli, const std::string &path,
  3307. const Headers &headers, const std::string &body,
  3308. const std::string &content_type, size_t chunk_size = 8192) {
  3309. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3310. chunk_size};
  3311. }
  3312. template <typename ClientType>
  3313. inline Result Post(ClientType &cli, const std::string &path,
  3314. const Params &params, const std::string &body,
  3315. const std::string &content_type, size_t chunk_size = 8192) {
  3316. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3317. chunk_size};
  3318. }
  3319. template <typename ClientType>
  3320. inline Result Post(ClientType &cli, const std::string &path,
  3321. const Params &params, const Headers &headers,
  3322. const std::string &body, const std::string &content_type,
  3323. size_t chunk_size = 8192) {
  3324. return Result{
  3325. cli.open_stream("POST", path, params, headers, body, content_type),
  3326. chunk_size};
  3327. }
  3328. // PUT
  3329. template <typename ClientType>
  3330. inline Result Put(ClientType &cli, const std::string &path,
  3331. const std::string &body, const std::string &content_type,
  3332. size_t chunk_size = 8192) {
  3333. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3334. chunk_size};
  3335. }
  3336. template <typename ClientType>
  3337. inline Result Put(ClientType &cli, const std::string &path,
  3338. const Headers &headers, const std::string &body,
  3339. const std::string &content_type, size_t chunk_size = 8192) {
  3340. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3341. chunk_size};
  3342. }
  3343. template <typename ClientType>
  3344. inline Result Put(ClientType &cli, const std::string &path,
  3345. const Params &params, const std::string &body,
  3346. const std::string &content_type, size_t chunk_size = 8192) {
  3347. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3348. chunk_size};
  3349. }
  3350. template <typename ClientType>
  3351. inline Result Put(ClientType &cli, const std::string &path,
  3352. const Params &params, const Headers &headers,
  3353. const std::string &body, const std::string &content_type,
  3354. size_t chunk_size = 8192) {
  3355. return Result{
  3356. cli.open_stream("PUT", path, params, headers, body, content_type),
  3357. chunk_size};
  3358. }
  3359. // PATCH
  3360. template <typename ClientType>
  3361. inline Result Patch(ClientType &cli, const std::string &path,
  3362. const std::string &body, const std::string &content_type,
  3363. size_t chunk_size = 8192) {
  3364. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3365. chunk_size};
  3366. }
  3367. template <typename ClientType>
  3368. inline Result Patch(ClientType &cli, const std::string &path,
  3369. const Headers &headers, const std::string &body,
  3370. const std::string &content_type, size_t chunk_size = 8192) {
  3371. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3372. chunk_size};
  3373. }
  3374. template <typename ClientType>
  3375. inline Result Patch(ClientType &cli, const std::string &path,
  3376. const Params &params, const std::string &body,
  3377. const std::string &content_type, size_t chunk_size = 8192) {
  3378. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3379. chunk_size};
  3380. }
  3381. template <typename ClientType>
  3382. inline Result Patch(ClientType &cli, const std::string &path,
  3383. const Params &params, const Headers &headers,
  3384. const std::string &body, const std::string &content_type,
  3385. size_t chunk_size = 8192) {
  3386. return Result{
  3387. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3388. chunk_size};
  3389. }
  3390. // DELETE
  3391. template <typename ClientType>
  3392. inline Result Delete(ClientType &cli, const std::string &path,
  3393. size_t chunk_size = 8192) {
  3394. return Result{cli.open_stream("DELETE", path), chunk_size};
  3395. }
  3396. template <typename ClientType>
  3397. inline Result Delete(ClientType &cli, const std::string &path,
  3398. const Headers &headers, size_t chunk_size = 8192) {
  3399. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3400. }
  3401. template <typename ClientType>
  3402. inline Result Delete(ClientType &cli, const std::string &path,
  3403. const std::string &body, const std::string &content_type,
  3404. size_t chunk_size = 8192) {
  3405. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3406. chunk_size};
  3407. }
  3408. template <typename ClientType>
  3409. inline Result Delete(ClientType &cli, const std::string &path,
  3410. const Headers &headers, const std::string &body,
  3411. const std::string &content_type,
  3412. size_t chunk_size = 8192) {
  3413. return Result{
  3414. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3415. chunk_size};
  3416. }
  3417. template <typename ClientType>
  3418. inline Result Delete(ClientType &cli, const std::string &path,
  3419. const Params &params, size_t chunk_size = 8192) {
  3420. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3421. }
  3422. template <typename ClientType>
  3423. inline Result Delete(ClientType &cli, const std::string &path,
  3424. const Params &params, const Headers &headers,
  3425. size_t chunk_size = 8192) {
  3426. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3427. }
  3428. template <typename ClientType>
  3429. inline Result Delete(ClientType &cli, const std::string &path,
  3430. const Params &params, const std::string &body,
  3431. const std::string &content_type,
  3432. size_t chunk_size = 8192) {
  3433. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3434. chunk_size};
  3435. }
  3436. template <typename ClientType>
  3437. inline Result Delete(ClientType &cli, const std::string &path,
  3438. const Params &params, const Headers &headers,
  3439. const std::string &body, const std::string &content_type,
  3440. size_t chunk_size = 8192) {
  3441. return Result{
  3442. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3443. chunk_size};
  3444. }
  3445. // HEAD
  3446. template <typename ClientType>
  3447. inline Result Head(ClientType &cli, const std::string &path,
  3448. size_t chunk_size = 8192) {
  3449. return Result{cli.open_stream("HEAD", path), chunk_size};
  3450. }
  3451. template <typename ClientType>
  3452. inline Result Head(ClientType &cli, const std::string &path,
  3453. const Headers &headers, size_t chunk_size = 8192) {
  3454. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3455. }
  3456. template <typename ClientType>
  3457. inline Result Head(ClientType &cli, const std::string &path,
  3458. const Params &params, size_t chunk_size = 8192) {
  3459. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3460. }
  3461. template <typename ClientType>
  3462. inline Result Head(ClientType &cli, const std::string &path,
  3463. const Params &params, const Headers &headers,
  3464. size_t chunk_size = 8192) {
  3465. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3466. }
  3467. // OPTIONS
  3468. template <typename ClientType>
  3469. inline Result Options(ClientType &cli, const std::string &path,
  3470. size_t chunk_size = 8192) {
  3471. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3472. }
  3473. template <typename ClientType>
  3474. inline Result Options(ClientType &cli, const std::string &path,
  3475. const Headers &headers, size_t chunk_size = 8192) {
  3476. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3477. }
  3478. template <typename ClientType>
  3479. inline Result Options(ClientType &cli, const std::string &path,
  3480. const Params &params, size_t chunk_size = 8192) {
  3481. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3482. }
  3483. template <typename ClientType>
  3484. inline Result Options(ClientType &cli, const std::string &path,
  3485. const Params &params, const Headers &headers,
  3486. size_t chunk_size = 8192) {
  3487. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3488. }
  3489. } // namespace stream
  3490. namespace sse {
  3491. struct SSEMessage {
  3492. std::string event; // Event type (default: "message")
  3493. std::string data; // Event payload
  3494. std::string id; // Event ID for Last-Event-ID header
  3495. SSEMessage();
  3496. void clear();
  3497. };
  3498. class SSEClient {
  3499. public:
  3500. using MessageHandler = std::function<void(const SSEMessage &)>;
  3501. using ErrorHandler = std::function<void(Error)>;
  3502. using OpenHandler = std::function<void()>;
  3503. SSEClient(Client &client, const std::string &path);
  3504. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3505. ~SSEClient();
  3506. SSEClient(const SSEClient &) = delete;
  3507. SSEClient &operator=(const SSEClient &) = delete;
  3508. // Event handlers
  3509. SSEClient &on_message(MessageHandler handler);
  3510. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3511. SSEClient &on_open(OpenHandler handler);
  3512. SSEClient &on_error(ErrorHandler handler);
  3513. SSEClient &set_reconnect_interval(int ms);
  3514. SSEClient &set_max_reconnect_attempts(int n);
  3515. // Update headers (thread-safe)
  3516. SSEClient &set_headers(const Headers &headers);
  3517. // State accessors
  3518. bool is_connected() const;
  3519. const std::string &last_event_id() const;
  3520. // Blocking start - runs event loop with auto-reconnect
  3521. void start();
  3522. // Non-blocking start - runs in background thread
  3523. void start_async();
  3524. // Stop the client (thread-safe)
  3525. void stop();
  3526. private:
  3527. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3528. void run_event_loop();
  3529. void dispatch_event(const SSEMessage &msg);
  3530. bool should_reconnect(int count) const;
  3531. void wait_for_reconnect();
  3532. // Client and path
  3533. Client &client_;
  3534. std::string path_;
  3535. Headers headers_;
  3536. mutable std::mutex headers_mutex_;
  3537. // Callbacks
  3538. MessageHandler on_message_;
  3539. std::map<std::string, MessageHandler> event_handlers_;
  3540. OpenHandler on_open_;
  3541. ErrorHandler on_error_;
  3542. // Configuration
  3543. int reconnect_interval_ms_ = 3000;
  3544. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3545. // State
  3546. std::atomic<bool> running_{false};
  3547. std::atomic<bool> connected_{false};
  3548. std::string last_event_id_;
  3549. // Async support
  3550. std::thread async_thread_;
  3551. };
  3552. } // namespace sse
  3553. namespace ws {
  3554. enum class Opcode : uint8_t {
  3555. Continuation = 0x0,
  3556. Text = 0x1,
  3557. Binary = 0x2,
  3558. Close = 0x8,
  3559. Ping = 0x9,
  3560. Pong = 0xA,
  3561. };
  3562. enum class CloseStatus : uint16_t {
  3563. Normal = 1000,
  3564. GoingAway = 1001,
  3565. ProtocolError = 1002,
  3566. UnsupportedData = 1003,
  3567. NoStatus = 1005,
  3568. Abnormal = 1006,
  3569. InvalidPayload = 1007,
  3570. PolicyViolation = 1008,
  3571. MessageTooBig = 1009,
  3572. MandatoryExtension = 1010,
  3573. InternalError = 1011,
  3574. };
  3575. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2 };
  3576. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3577. // upgrade handshake fully succeeded. On failure error() identifies the
  3578. // failing layer; status()/headers() expose the server's upgrade response
  3579. // when one was received (status() is -1 otherwise).
  3580. class Result {
  3581. public:
  3582. Result() = default;
  3583. Result(Error err, int status, Headers &&headers)
  3584. : err_(err), status_(status), headers_(std::move(headers)) {}
  3585. explicit operator bool() const { return err_ == Error::Success; }
  3586. Error error() const { return err_; }
  3587. // Upgrade response info
  3588. int status() const { return status_; }
  3589. const Headers &headers() const { return headers_; }
  3590. std::string get_header_value(const std::string &key,
  3591. const char *def = "") const {
  3592. return detail::get_header_value(headers_, key, def, 0);
  3593. }
  3594. bool has_header(const std::string &key) const {
  3595. return headers_.find(key) != headers_.end();
  3596. }
  3597. #ifdef CPPHTTPLIB_SSL_ENABLED
  3598. Result(Error err, int status, Headers &&headers, int ssl_error,
  3599. uint64_t ssl_backend_error)
  3600. : err_(err), status_(status), headers_(std::move(headers)),
  3601. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3602. int ssl_error() const { return ssl_error_; }
  3603. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3604. #endif
  3605. private:
  3606. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3607. int status_ = -1;
  3608. Headers headers_;
  3609. #ifdef CPPHTTPLIB_SSL_ENABLED
  3610. int ssl_error_ = 0;
  3611. uint64_t ssl_backend_error_ = 0;
  3612. #endif
  3613. };
  3614. class WebSocket {
  3615. public:
  3616. WebSocket(const WebSocket &) = delete;
  3617. WebSocket &operator=(const WebSocket &) = delete;
  3618. ~WebSocket();
  3619. ReadResult read(std::string &msg);
  3620. bool send(const std::string &data);
  3621. bool send(const char *data, size_t len);
  3622. void close(CloseStatus status = CloseStatus::Normal,
  3623. const std::string &reason = "");
  3624. const Request &request() const;
  3625. bool is_open() const;
  3626. private:
  3627. friend class httplib::Server;
  3628. friend class WebSocketClient;
  3629. WebSocket(
  3630. Stream &strm, const Request &req, bool is_server,
  3631. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3632. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3633. : strm_(strm), req_(req), is_server_(is_server),
  3634. ping_interval_sec_(ping_interval_sec),
  3635. max_missed_pongs_(max_missed_pongs) {
  3636. start_heartbeat();
  3637. }
  3638. WebSocket(
  3639. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3640. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3641. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3642. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3643. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3644. max_missed_pongs_(max_missed_pongs) {
  3645. start_heartbeat();
  3646. }
  3647. void start_heartbeat();
  3648. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3649. Stream &strm_;
  3650. std::unique_ptr<Stream> owned_strm_;
  3651. Request req_;
  3652. bool is_server_;
  3653. time_t ping_interval_sec_;
  3654. int max_missed_pongs_;
  3655. int unacked_pings_ = 0;
  3656. std::atomic<bool> closed_{false};
  3657. std::mutex write_mutex_;
  3658. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3659. // may do so: read_websocket_frame() reads a payload until it has the whole
  3660. // declared length, so a second parser stealing bytes silently corrupts the
  3661. // message the first one is assembling.
  3662. std::mutex read_mutex_;
  3663. std::thread ping_thread_;
  3664. std::mutex ping_mutex_;
  3665. std::condition_variable ping_cv_;
  3666. };
  3667. class WebSocketClient {
  3668. public:
  3669. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3670. const Headers &headers = {});
  3671. ~WebSocketClient();
  3672. WebSocketClient(const WebSocketClient &) = delete;
  3673. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3674. bool is_valid() const;
  3675. Result connect();
  3676. ReadResult read(std::string &msg);
  3677. bool send(const std::string &data);
  3678. bool send(const char *data, size_t len);
  3679. void close(CloseStatus status = CloseStatus::Normal,
  3680. const std::string &reason = "");
  3681. bool is_open() const;
  3682. const std::string &subprotocol() const;
  3683. void set_read_timeout(time_t sec, time_t usec = 0);
  3684. template <class Rep, class Period>
  3685. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3686. void set_write_timeout(time_t sec, time_t usec = 0);
  3687. template <class Rep, class Period>
  3688. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3689. void set_websocket_ping_interval(time_t sec);
  3690. void set_websocket_max_missed_pongs(int count);
  3691. void set_tcp_nodelay(bool on);
  3692. void set_address_family(int family);
  3693. void set_ipv6_v6only(bool on);
  3694. void set_socket_options(SocketOptions socket_options);
  3695. void set_connection_timeout(time_t sec, time_t usec = 0);
  3696. template <class Rep, class Period>
  3697. void
  3698. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3699. void set_interface(const std::string &intf);
  3700. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3701. #ifdef CPPHTTPLIB_SSL_ENABLED
  3702. struct PemMemory {
  3703. const char *cert_pem;
  3704. size_t cert_pem_len;
  3705. const char *key_pem;
  3706. size_t key_pem_len;
  3707. const char *private_key_password;
  3708. };
  3709. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3710. const PemMemory &pem, const Headers &headers = {});
  3711. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3712. const std::string &ca_cert_dir_path = std::string());
  3713. void set_ca_cert_store(tls::ca_store_t store);
  3714. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3715. void enable_server_certificate_verification(bool enabled);
  3716. void enable_server_hostname_verification(bool enabled);
  3717. void enable_system_ca(bool enabled);
  3718. #endif
  3719. private:
  3720. void shutdown_and_close();
  3721. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3722. int &ssl_error, uint64_t &ssl_backend_error);
  3723. void prepare_default_headers(Request &req);
  3724. std::string host_;
  3725. int port_;
  3726. std::string path_;
  3727. Headers headers_;
  3728. std::string subprotocol_;
  3729. bool is_valid_ = false;
  3730. socket_t sock_ = INVALID_SOCKET;
  3731. std::unique_ptr<WebSocket> ws_;
  3732. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND;
  3733. time_t read_timeout_usec_ = 0;
  3734. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3735. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3736. time_t websocket_ping_interval_sec_ =
  3737. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3738. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3739. int address_family_ = AF_UNSPEC;
  3740. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3741. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3742. SocketOptions socket_options_ = nullptr;
  3743. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3744. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3745. std::string interface_;
  3746. // Hostname to connection target map. The value is an IP literal or another
  3747. // hostname; only the connection target changes, never the identity.
  3748. std::map<std::string, std::string> addr_map_;
  3749. #ifdef CPPHTTPLIB_SSL_ENABLED
  3750. bool is_ssl_ = false;
  3751. tls::ctx_t tls_ctx_ = nullptr;
  3752. tls::session_t tls_session_ = nullptr;
  3753. std::string ca_cert_file_path_;
  3754. std::string ca_cert_dir_path_;
  3755. bool custom_ca_loaded_ = false;
  3756. bool certs_loaded_ = false;
  3757. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3758. bool server_certificate_verification_ = true;
  3759. bool server_hostname_verification_ = true;
  3760. #endif
  3761. };
  3762. template <class Rep, class Period>
  3763. inline void WebSocketClient::set_read_timeout(
  3764. const std::chrono::duration<Rep, Period> &duration) {
  3765. detail::duration_to_sec_and_usec(
  3766. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3767. }
  3768. template <class Rep, class Period>
  3769. inline void WebSocketClient::set_write_timeout(
  3770. const std::chrono::duration<Rep, Period> &duration) {
  3771. detail::duration_to_sec_and_usec(
  3772. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3773. }
  3774. template <class Rep, class Period>
  3775. inline void WebSocketClient::set_connection_timeout(
  3776. const std::chrono::duration<Rep, Period> &duration) {
  3777. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3778. set_connection_timeout(sec, usec);
  3779. });
  3780. }
  3781. namespace impl {
  3782. bool is_valid_utf8(const std::string &s);
  3783. bool read_websocket_frame(Stream &strm, Opcode &opcode, std::string &payload,
  3784. bool &fin, bool expect_masked, size_t max_len);
  3785. } // namespace impl
  3786. } // namespace ws
  3787. // ----------------------------------------------------------------------------
  3788. /*
  3789. * Implementation that will be part of the .cc file if split into .h + .cc.
  3790. */
  3791. namespace stream {
  3792. // stream::Result implementations
  3793. inline Result::Result() : chunk_size_(8192) {}
  3794. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3795. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3796. inline Result::Result(Result &&other) noexcept
  3797. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3798. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3799. finished_(other.finished_) {
  3800. other.current_size_ = 0;
  3801. other.finished_ = true;
  3802. }
  3803. inline Result &Result::operator=(Result &&other) noexcept {
  3804. if (this != &other) {
  3805. handle_ = std::move(other.handle_);
  3806. buffer_ = std::move(other.buffer_);
  3807. current_size_ = other.current_size_;
  3808. chunk_size_ = other.chunk_size_;
  3809. finished_ = other.finished_;
  3810. other.current_size_ = 0;
  3811. other.finished_ = true;
  3812. }
  3813. return *this;
  3814. }
  3815. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3816. inline Result::operator bool() const { return is_valid(); }
  3817. inline int Result::status() const {
  3818. return handle_.response ? handle_.response->status : -1;
  3819. }
  3820. inline const Headers &Result::headers() const {
  3821. static const Headers empty_headers;
  3822. return handle_.response ? handle_.response->headers : empty_headers;
  3823. }
  3824. inline std::string Result::get_header_value(const std::string &key,
  3825. const char *def) const {
  3826. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3827. }
  3828. inline bool Result::has_header(const std::string &key) const {
  3829. return handle_.response ? handle_.response->has_header(key) : false;
  3830. }
  3831. inline Error Result::error() const { return handle_.error; }
  3832. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3833. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3834. inline bool Result::next() {
  3835. if (!handle_.is_valid() || finished_) { return false; }
  3836. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3837. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3838. if (n > 0) {
  3839. current_size_ = static_cast<size_t>(n);
  3840. return true;
  3841. }
  3842. current_size_ = 0;
  3843. finished_ = true;
  3844. return false;
  3845. }
  3846. inline const char *Result::data() const { return buffer_.data(); }
  3847. inline size_t Result::size() const { return current_size_; }
  3848. inline std::string Result::read_all() {
  3849. std::string result;
  3850. while (next()) {
  3851. result.append(data(), size());
  3852. }
  3853. return result;
  3854. }
  3855. } // namespace stream
  3856. namespace sse {
  3857. // SSEMessage implementations
  3858. inline SSEMessage::SSEMessage() : event("message") {}
  3859. inline void SSEMessage::clear() {
  3860. event = "message";
  3861. data.clear();
  3862. id.clear();
  3863. }
  3864. // SSEClient implementations
  3865. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3866. : client_(client), path_(path) {}
  3867. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3868. const Headers &headers)
  3869. : client_(client), path_(path), headers_(headers) {}
  3870. inline SSEClient::~SSEClient() { stop(); }
  3871. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3872. on_message_ = std::move(handler);
  3873. return *this;
  3874. }
  3875. inline SSEClient &SSEClient::on_event(const std::string &type,
  3876. MessageHandler handler) {
  3877. event_handlers_[type] = std::move(handler);
  3878. return *this;
  3879. }
  3880. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3881. on_open_ = std::move(handler);
  3882. return *this;
  3883. }
  3884. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3885. on_error_ = std::move(handler);
  3886. return *this;
  3887. }
  3888. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3889. reconnect_interval_ms_ = ms;
  3890. return *this;
  3891. }
  3892. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3893. max_reconnect_attempts_ = n;
  3894. return *this;
  3895. }
  3896. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3897. std::lock_guard<std::mutex> lock(headers_mutex_);
  3898. headers_ = headers;
  3899. return *this;
  3900. }
  3901. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3902. inline const std::string &SSEClient::last_event_id() const {
  3903. return last_event_id_;
  3904. }
  3905. inline void SSEClient::start() {
  3906. running_.store(true);
  3907. run_event_loop();
  3908. }
  3909. inline void SSEClient::start_async() {
  3910. running_.store(true);
  3911. async_thread_ = std::thread([this]() { run_event_loop(); });
  3912. }
  3913. inline void SSEClient::stop() {
  3914. running_.store(false);
  3915. client_.stop(); // Cancel any pending operations
  3916. if (async_thread_.joinable()) { async_thread_.join(); }
  3917. }
  3918. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  3919. int &retry_ms) {
  3920. // Blank line signals end of event
  3921. if (line.empty() || line == "\r") { return true; }
  3922. // Lines starting with ':' are comments (ignored)
  3923. if (!line.empty() && line[0] == ':') { return false; }
  3924. // Find the colon separator
  3925. auto colon_pos = line.find(':');
  3926. if (colon_pos == std::string::npos) {
  3927. // Line with no colon is treated as field name with empty value
  3928. return false;
  3929. }
  3930. auto field = line.substr(0, colon_pos);
  3931. std::string value;
  3932. // Value starts after colon, skip optional single space
  3933. if (colon_pos + 1 < line.size()) {
  3934. auto value_start = colon_pos + 1;
  3935. if (line[value_start] == ' ') { value_start++; }
  3936. value = line.substr(value_start);
  3937. // Remove trailing \r if present
  3938. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  3939. }
  3940. // Handle known fields
  3941. if (field == "event") {
  3942. msg.event = value;
  3943. } else if (field == "data") {
  3944. // Multiple data lines are concatenated with newlines
  3945. if (!msg.data.empty()) { msg.data += "\n"; }
  3946. msg.data += value;
  3947. } else if (field == "id") {
  3948. // Empty id is valid (clears the last event ID)
  3949. msg.id = value;
  3950. } else if (field == "retry") {
  3951. // Parse retry interval in milliseconds
  3952. {
  3953. int v = 0;
  3954. auto res =
  3955. detail::from_chars(value.data(), value.data() + value.size(), v);
  3956. if (res.ec == std::errc{}) { retry_ms = v; }
  3957. }
  3958. }
  3959. // Unknown fields are ignored per SSE spec
  3960. return false;
  3961. }
  3962. inline void SSEClient::run_event_loop() {
  3963. auto reconnect_count = 0;
  3964. while (running_.load()) {
  3965. // Build headers, including Last-Event-ID if we have one
  3966. Headers request_headers;
  3967. {
  3968. std::lock_guard<std::mutex> lock(headers_mutex_);
  3969. request_headers = headers_;
  3970. }
  3971. if (!last_event_id_.empty()) {
  3972. request_headers.emplace("Last-Event-ID", last_event_id_);
  3973. }
  3974. // Open streaming connection
  3975. auto result = stream::Get(client_, path_, request_headers);
  3976. // Connection error handling
  3977. if (!result) {
  3978. connected_.store(false);
  3979. if (on_error_) { on_error_(result.error()); }
  3980. if (!should_reconnect(reconnect_count)) { break; }
  3981. wait_for_reconnect();
  3982. reconnect_count++;
  3983. continue;
  3984. }
  3985. if (result.status() != StatusCode::OK_200) {
  3986. connected_.store(false);
  3987. if (on_error_) { on_error_(Error::Connection); }
  3988. // For certain errors, don't reconnect.
  3989. // Note: 401 is intentionally absent so that handlers can refresh
  3990. // credentials via set_headers() and let the client reconnect.
  3991. if (result.status() == StatusCode::NoContent_204 ||
  3992. result.status() == StatusCode::NotFound_404 ||
  3993. result.status() == StatusCode::Forbidden_403) {
  3994. break;
  3995. }
  3996. if (!should_reconnect(reconnect_count)) { break; }
  3997. wait_for_reconnect();
  3998. reconnect_count++;
  3999. continue;
  4000. }
  4001. // Connection successful
  4002. connected_.store(true);
  4003. reconnect_count = 0;
  4004. if (on_open_) { on_open_(); }
  4005. // Event receiving loop
  4006. std::string buffer;
  4007. SSEMessage current_msg;
  4008. while (running_.load() && result.next()) {
  4009. buffer.append(result.data(), result.size());
  4010. // Process complete lines in the buffer
  4011. size_t line_start = 0;
  4012. size_t newline_pos;
  4013. while ((newline_pos = buffer.find('\n', line_start)) !=
  4014. std::string::npos) {
  4015. auto line = buffer.substr(line_start, newline_pos - line_start);
  4016. line_start = newline_pos + 1;
  4017. // Parse the line and check if event is complete
  4018. auto event_complete =
  4019. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4020. if (event_complete && !current_msg.data.empty()) {
  4021. // Update last_event_id for reconnection
  4022. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4023. // Dispatch event to appropriate handler
  4024. dispatch_event(current_msg);
  4025. current_msg.clear();
  4026. }
  4027. }
  4028. // Keep unprocessed data in buffer
  4029. buffer.erase(0, line_start);
  4030. }
  4031. // Connection ended
  4032. connected_.store(false);
  4033. if (!running_.load()) { break; }
  4034. // Check for read errors
  4035. if (result.has_read_error()) {
  4036. if (on_error_) { on_error_(result.read_error()); }
  4037. }
  4038. if (!should_reconnect(reconnect_count)) { break; }
  4039. wait_for_reconnect();
  4040. reconnect_count++;
  4041. }
  4042. connected_.store(false);
  4043. }
  4044. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4045. // Check for specific event type handler first
  4046. auto it = event_handlers_.find(msg.event);
  4047. if (it != event_handlers_.end()) {
  4048. it->second(msg);
  4049. return;
  4050. }
  4051. // Fall back to generic message handler
  4052. if (on_message_) { on_message_(msg); }
  4053. }
  4054. inline bool SSEClient::should_reconnect(int count) const {
  4055. if (!running_.load()) { return false; }
  4056. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4057. return count < max_reconnect_attempts_;
  4058. }
  4059. inline void SSEClient::wait_for_reconnect() {
  4060. // Use small increments to check running_ flag frequently
  4061. auto waited = 0;
  4062. while (running_.load() && waited < reconnect_interval_ms_) {
  4063. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4064. waited += 100;
  4065. }
  4066. }
  4067. } // namespace sse
  4068. #ifdef CPPHTTPLIB_SSL_ENABLED
  4069. /*
  4070. * TLS abstraction layer - internal function declarations
  4071. * These are implementation details and not part of the public API.
  4072. */
  4073. namespace tls {
  4074. // Client context
  4075. ctx_t create_client_context();
  4076. void free_context(ctx_t ctx);
  4077. bool set_min_version(ctx_t ctx, Version version);
  4078. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4079. bool load_ca_file(ctx_t ctx, const char *file_path);
  4080. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4081. bool load_system_certs(ctx_t ctx);
  4082. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4083. const char *password);
  4084. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4085. const char *key_path, const char *password);
  4086. // Server context
  4087. ctx_t create_server_context();
  4088. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4089. const char *password);
  4090. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4091. const char *key_path, const char *password);
  4092. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4093. void set_verify_client(ctx_t ctx, bool require);
  4094. // Session management
  4095. session_t create_session(ctx_t ctx, socket_t sock);
  4096. void free_session(session_t session);
  4097. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4098. // Handshake (non-blocking capable)
  4099. TlsError connect(session_t session);
  4100. TlsError accept(session_t session);
  4101. // Handshake with timeout (blocking until timeout)
  4102. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4103. time_t timeout_usec, TlsError *err);
  4104. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4105. time_t timeout_usec, TlsError *err);
  4106. // I/O (non-blocking capable)
  4107. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4108. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4109. int pending(const_session_t session);
  4110. void shutdown(session_t session, bool graceful);
  4111. // Connection state
  4112. bool is_peer_closed(session_t session, socket_t sock);
  4113. // Certificate verification
  4114. cert_t get_peer_cert(const_session_t session);
  4115. void free_cert(cert_t cert);
  4116. bool verify_hostname(cert_t cert, const char *hostname);
  4117. uint64_t hostname_mismatch_code();
  4118. long get_verify_result(const_session_t session);
  4119. // Certificate introspection
  4120. std::string get_cert_subject_cn(cert_t cert);
  4121. std::string get_cert_issuer_name(cert_t cert);
  4122. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4123. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4124. std::string get_cert_serial(cert_t cert);
  4125. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4126. const char *get_sni(const_session_t session);
  4127. // CA store management
  4128. ca_store_t create_ca_store(const char *pem, size_t len);
  4129. void free_ca_store(ca_store_t store);
  4130. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4131. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4132. std::vector<std::string> get_ca_names(ctx_t ctx);
  4133. // Dynamic certificate update (for servers)
  4134. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4135. const char *password);
  4136. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4137. // Certificate verification callback
  4138. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4139. long get_verify_error(const_session_t session);
  4140. std::string verify_error_string(long error_code);
  4141. // TlsError information
  4142. uint64_t peek_error();
  4143. uint64_t get_error();
  4144. std::string error_string(uint64_t code);
  4145. } // namespace tls
  4146. #endif // CPPHTTPLIB_SSL_ENABLED
  4147. /*
  4148. * Group 1: detail namespace - Non-SSL utilities
  4149. */
  4150. namespace detail {
  4151. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4152. const void *optval, socklen_t optlen) {
  4153. return setsockopt(sock, level, optname,
  4154. #ifdef _WIN32
  4155. reinterpret_cast<const char *>(optval),
  4156. #else
  4157. optval,
  4158. #endif
  4159. optlen) == 0;
  4160. }
  4161. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4162. time_t sec, time_t usec) {
  4163. #ifdef _WIN32
  4164. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4165. #else
  4166. timeval timeout;
  4167. timeout.tv_sec = static_cast<long>(sec);
  4168. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4169. #endif
  4170. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4171. }
  4172. inline bool is_hex(char c, int &v) {
  4173. if (is_ascii_digit(c)) {
  4174. v = c - '0';
  4175. return true;
  4176. } else if ('A' <= c && c <= 'F') {
  4177. v = c - 'A' + 10;
  4178. return true;
  4179. } else if ('a' <= c && c <= 'f') {
  4180. v = c - 'a' + 10;
  4181. return true;
  4182. }
  4183. return false;
  4184. }
  4185. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4186. int &val) {
  4187. if (i >= s.size()) { return false; }
  4188. val = 0;
  4189. for (; cnt; i++, cnt--) {
  4190. if (!s[i]) { return false; }
  4191. auto v = 0;
  4192. if (is_hex(s[i], v)) {
  4193. val = val * 16 + v;
  4194. } else {
  4195. return false;
  4196. }
  4197. }
  4198. return true;
  4199. }
  4200. inline std::string from_i_to_hex(size_t n) {
  4201. static const auto charset = "0123456789abcdef";
  4202. std::string ret;
  4203. do {
  4204. ret = charset[n & 15] + ret;
  4205. n >>= 4;
  4206. } while (n > 0);
  4207. return ret;
  4208. }
  4209. inline std::string compute_etag(const FileStat &fs,
  4210. const std::string &suffix = std::string()) {
  4211. if (!fs.is_file()) { return std::string(); }
  4212. // If mtime cannot be determined (negative value indicates an error
  4213. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4214. // value like 0 could collide with a real file that legitimately has
  4215. // mtime == 0 (epoch) and lead to misleading validators.
  4216. auto mtime_raw = fs.mtime();
  4217. if (mtime_raw < 0) { return std::string(); }
  4218. auto mtime = static_cast<size_t>(mtime_raw);
  4219. auto size = fs.size();
  4220. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4221. from_i_to_hex(size) + suffix + "\"";
  4222. }
  4223. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4224. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4225. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4226. inline std::string file_mtime_to_http_date(time_t mtime) {
  4227. if (mtime < 0) { return std::string(); }
  4228. struct tm tm_buf;
  4229. #ifdef _WIN32
  4230. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4231. #else
  4232. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4233. #endif
  4234. char buf[64];
  4235. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4236. return std::string();
  4237. }
  4238. return std::string(buf);
  4239. }
  4240. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4241. inline time_t parse_http_date(const std::string &date_str) {
  4242. struct tm tm_buf;
  4243. // Create a classic locale object once for all parsing attempts
  4244. const std::locale classic_locale = std::locale::classic();
  4245. // Try to parse using std::get_time (C++11, cross-platform)
  4246. auto try_parse = [&](const char *fmt) -> bool {
  4247. std::istringstream ss(date_str);
  4248. ss.imbue(classic_locale);
  4249. memset(&tm_buf, 0, sizeof(tm_buf));
  4250. ss >> std::get_time(&tm_buf, fmt);
  4251. return !ss.fail();
  4252. };
  4253. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4254. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4255. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4256. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4257. // asctime format: "Sun Nov 6 08:49:37 1994"
  4258. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4259. return static_cast<time_t>(-1);
  4260. }
  4261. }
  4262. }
  4263. #ifdef _WIN32
  4264. return _mkgmtime(&tm_buf);
  4265. #elif defined _AIX
  4266. return mktime(&tm_buf);
  4267. #else
  4268. return timegm(&tm_buf);
  4269. #endif
  4270. }
  4271. inline bool is_weak_etag(const std::string &s) {
  4272. // Check if the string is a weak ETag (starts with 'W/"')
  4273. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4274. }
  4275. inline bool is_strong_etag(const std::string &s) {
  4276. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4277. // chars)
  4278. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4279. }
  4280. inline size_t to_utf8(int code, char *buff) {
  4281. if (code < 0x0080) {
  4282. buff[0] = static_cast<char>(code & 0x7F);
  4283. return 1;
  4284. } else if (code < 0x0800) {
  4285. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4286. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4287. return 2;
  4288. } else if (code < 0xD800) {
  4289. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4290. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4291. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4292. return 3;
  4293. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4294. return 0;
  4295. } else if (code < 0x10000) {
  4296. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4297. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4298. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4299. return 3;
  4300. } else if (code < 0x110000) {
  4301. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4302. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4303. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4304. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4305. return 4;
  4306. }
  4307. // NOTREACHED
  4308. return 0;
  4309. }
  4310. } // namespace detail
  4311. namespace ws {
  4312. namespace impl {
  4313. inline bool is_valid_utf8(const std::string &s) {
  4314. size_t i = 0;
  4315. auto n = s.size();
  4316. while (i < n) {
  4317. auto c = static_cast<unsigned char>(s[i]);
  4318. size_t len;
  4319. uint32_t cp;
  4320. if (c < 0x80) {
  4321. i++;
  4322. continue;
  4323. } else if ((c & 0xE0) == 0xC0) {
  4324. len = 2;
  4325. cp = c & 0x1F;
  4326. } else if ((c & 0xF0) == 0xE0) {
  4327. len = 3;
  4328. cp = c & 0x0F;
  4329. } else if ((c & 0xF8) == 0xF0) {
  4330. len = 4;
  4331. cp = c & 0x07;
  4332. } else {
  4333. return false;
  4334. }
  4335. if (i + len > n) { return false; }
  4336. for (size_t j = 1; j < len; j++) {
  4337. auto b = static_cast<unsigned char>(s[i + j]);
  4338. if ((b & 0xC0) != 0x80) { return false; }
  4339. cp = (cp << 6) | (b & 0x3F);
  4340. }
  4341. // Overlong encoding check
  4342. if (len == 2 && cp < 0x80) { return false; }
  4343. if (len == 3 && cp < 0x800) { return false; }
  4344. if (len == 4 && cp < 0x10000) { return false; }
  4345. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4346. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4347. if (cp > 0x10FFFF) { return false; }
  4348. i += len;
  4349. }
  4350. return true;
  4351. }
  4352. } // namespace impl
  4353. } // namespace ws
  4354. namespace detail {
  4355. // NOTE: This code came up with the following stackoverflow post:
  4356. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4357. inline std::string base64_encode(const std::string &in) {
  4358. static const auto lookup =
  4359. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4360. std::string out;
  4361. out.reserve(in.size());
  4362. // Unsigned: the accumulator is never masked, so with a signed int the
  4363. // `val << 8` below overflows once enough bytes are folded in (undefined
  4364. // behaviour before C++20). Only the low bits are ever emitted, so the
  4365. // wrap-around of an unsigned accumulator does not affect the output.
  4366. uint32_t val = 0;
  4367. auto valb = -6;
  4368. for (auto c : in) {
  4369. val = (val << 8) + static_cast<uint8_t>(c);
  4370. valb += 8;
  4371. while (valb >= 0) {
  4372. out.push_back(lookup[(val >> valb) & 0x3F]);
  4373. valb -= 6;
  4374. }
  4375. }
  4376. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4377. while (out.size() % 4) {
  4378. out.push_back('=');
  4379. }
  4380. return out;
  4381. }
  4382. inline std::string sha1(const std::string &input) {
  4383. // RFC 3174 SHA-1 implementation
  4384. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4385. return (x << n) | (x >> (32 - n));
  4386. };
  4387. uint32_t h0 = 0x67452301;
  4388. uint32_t h1 = 0xEFCDAB89;
  4389. uint32_t h2 = 0x98BADCFE;
  4390. uint32_t h3 = 0x10325476;
  4391. uint32_t h4 = 0xC3D2E1F0;
  4392. // Pre-processing: adding padding bits
  4393. std::string msg = input;
  4394. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4395. msg.push_back(static_cast<char>(0x80u));
  4396. while (msg.size() % 64 != 56) {
  4397. msg.push_back(0);
  4398. }
  4399. // Append original length in bits as 64-bit big-endian
  4400. for (int i = 56; i >= 0; i -= 8) {
  4401. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4402. }
  4403. // Process each 512-bit chunk
  4404. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4405. uint32_t w[80];
  4406. for (size_t i = 0; i < 16; i++) {
  4407. w[i] =
  4408. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4409. << 24) |
  4410. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4411. << 16) |
  4412. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4413. << 8) |
  4414. (static_cast<uint32_t>(
  4415. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4416. }
  4417. for (int i = 16; i < 80; i++) {
  4418. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4419. }
  4420. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4421. for (int i = 0; i < 80; i++) {
  4422. uint32_t f, k;
  4423. if (i < 20) {
  4424. f = (b & c) | ((~b) & d);
  4425. k = 0x5A827999;
  4426. } else if (i < 40) {
  4427. f = b ^ c ^ d;
  4428. k = 0x6ED9EBA1;
  4429. } else if (i < 60) {
  4430. f = (b & c) | (b & d) | (c & d);
  4431. k = 0x8F1BBCDC;
  4432. } else {
  4433. f = b ^ c ^ d;
  4434. k = 0xCA62C1D6;
  4435. }
  4436. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4437. e = d;
  4438. d = c;
  4439. c = left_rotate(b, 30);
  4440. b = a;
  4441. a = temp;
  4442. }
  4443. h0 += a;
  4444. h1 += b;
  4445. h2 += c;
  4446. h3 += d;
  4447. h4 += e;
  4448. }
  4449. // Produce the final hash as a 20-byte binary string
  4450. std::string hash(20, '\0');
  4451. for (size_t i = 0; i < 4; i++) {
  4452. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4453. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4454. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4455. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4456. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4457. }
  4458. return hash;
  4459. }
  4460. inline std::string websocket_accept_key(const std::string &client_key) {
  4461. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4462. return base64_encode(sha1(client_key + magic));
  4463. }
  4464. inline bool is_websocket_upgrade(const Request &req) {
  4465. if (req.method != "GET") { return false; }
  4466. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4467. // list of protocols and asks recipients to match each name
  4468. // case-insensitively, so look for the token rather than compare the whole
  4469. // field value.
  4470. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4471. // Check Connection: Upgrade
  4472. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4473. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4474. // RFC 6455 Section 4.2.1
  4475. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4476. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4477. return false;
  4478. }
  4479. static const std::string b64chars =
  4480. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4481. for (size_t i = 0; i < 22; i++) {
  4482. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4483. }
  4484. // Check Sec-WebSocket-Version: 13
  4485. auto version = req.get_header_value("Sec-WebSocket-Version");
  4486. if (version != "13") { return false; }
  4487. return true;
  4488. }
  4489. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4490. const char *data, size_t len, bool fin,
  4491. bool mask) {
  4492. // First byte: FIN + opcode
  4493. uint8_t header[2];
  4494. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4495. (static_cast<uint8_t>(opcode) & 0x0F));
  4496. // Second byte: MASK + payload length
  4497. if (len < 126) {
  4498. header[1] = static_cast<uint8_t>(len);
  4499. if (mask) { header[1] |= 0x80; }
  4500. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4501. } else if (len <= 0xFFFF) {
  4502. header[1] = 126;
  4503. if (mask) { header[1] |= 0x80; }
  4504. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4505. uint8_t ext[2];
  4506. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4507. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4508. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4509. } else {
  4510. header[1] = 127;
  4511. if (mask) { header[1] |= 0x80; }
  4512. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4513. uint8_t ext[8];
  4514. for (int i = 7; i >= 0; i--) {
  4515. ext[7 - i] =
  4516. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4517. }
  4518. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4519. }
  4520. if (mask) {
  4521. // Generate random mask key
  4522. thread_local std::mt19937 rng(std::random_device{}());
  4523. uint8_t mask_key[4];
  4524. auto r = rng();
  4525. std::memcpy(mask_key, &r, 4);
  4526. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4527. // Write masked payload in chunks
  4528. const size_t chunk_size = 4096;
  4529. std::vector<char> buf((std::min)(len, chunk_size));
  4530. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4531. size_t n = (std::min)(chunk_size, len - offset);
  4532. for (size_t i = 0; i < n; i++) {
  4533. buf[i] =
  4534. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4535. }
  4536. if (strm.write(buf.data(), n) < 0) { return false; }
  4537. }
  4538. } else {
  4539. if (len > 0) {
  4540. if (strm.write(data, len) < 0) { return false; }
  4541. }
  4542. }
  4543. return true;
  4544. }
  4545. } // namespace detail
  4546. namespace ws {
  4547. namespace impl {
  4548. inline bool read_websocket_frame(Stream &strm, Opcode &opcode,
  4549. std::string &payload, bool &fin,
  4550. bool expect_masked, size_t max_len) {
  4551. // Read first 2 bytes
  4552. uint8_t header[2];
  4553. if (strm.read(reinterpret_cast<char *>(header), 2) != 2) { return false; }
  4554. fin = (header[0] & 0x80) != 0;
  4555. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4556. if (header[0] & 0x70) { return false; }
  4557. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4558. bool masked = (header[1] & 0x80) != 0;
  4559. uint64_t payload_len = header[1] & 0x7F;
  4560. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4561. // MUST have a payload length of 125 bytes or less
  4562. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4563. if (is_control) {
  4564. if (!fin) { return false; }
  4565. if (payload_len > 125) { return false; }
  4566. }
  4567. if (masked != expect_masked) { return false; }
  4568. // Extended payload length
  4569. if (payload_len == 126) {
  4570. uint8_t ext[2];
  4571. if (strm.read(reinterpret_cast<char *>(ext), 2) != 2) { return false; }
  4572. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4573. } else if (payload_len == 127) {
  4574. uint8_t ext[8];
  4575. if (strm.read(reinterpret_cast<char *>(ext), 8) != 8) { return false; }
  4576. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4577. if (ext[0] & 0x80) { return false; }
  4578. payload_len = 0;
  4579. for (int i = 0; i < 8; i++) {
  4580. payload_len = (payload_len << 8) | ext[i];
  4581. }
  4582. }
  4583. if (payload_len > max_len) { return false; }
  4584. // Read mask key if present
  4585. uint8_t mask_key[4] = {0};
  4586. if (masked) {
  4587. if (strm.read(reinterpret_cast<char *>(mask_key), 4) != 4) { return false; }
  4588. }
  4589. // Read payload
  4590. payload.resize(static_cast<size_t>(payload_len));
  4591. if (payload_len > 0) {
  4592. size_t total_read = 0;
  4593. while (total_read < payload_len) {
  4594. auto n = strm.read(&payload[total_read],
  4595. static_cast<size_t>(payload_len - total_read));
  4596. if (n <= 0) { return false; }
  4597. total_read += static_cast<size_t>(n);
  4598. }
  4599. }
  4600. // Unmask if needed
  4601. if (masked) {
  4602. for (size_t i = 0; i < payload.size(); i++) {
  4603. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4604. }
  4605. }
  4606. return true;
  4607. }
  4608. } // namespace impl
  4609. } // namespace ws
  4610. namespace detail {
  4611. inline bool is_valid_path(const std::string &path) {
  4612. size_t level = 0;
  4613. size_t i = 0;
  4614. // Skip slash
  4615. while (i < path.size() && path[i] == '/') {
  4616. i++;
  4617. }
  4618. while (i < path.size()) {
  4619. // Read component
  4620. auto beg = i;
  4621. while (i < path.size() && path[i] != '/') {
  4622. if (path[i] == '\0') {
  4623. return false;
  4624. } else if (path[i] == '\\') {
  4625. return false;
  4626. }
  4627. i++;
  4628. }
  4629. auto len = i - beg;
  4630. assert(len > 0);
  4631. if (!path.compare(beg, len, ".")) {
  4632. ;
  4633. } else if (!path.compare(beg, len, "..")) {
  4634. if (level == 0) { return false; }
  4635. level--;
  4636. } else {
  4637. level++;
  4638. }
  4639. // Skip slash
  4640. while (i < path.size() && path[i] == '/') {
  4641. i++;
  4642. }
  4643. }
  4644. return true;
  4645. }
  4646. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4647. #if defined(_WIN32)
  4648. char buf[_MAX_PATH];
  4649. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4650. resolved = buf;
  4651. #elif defined(PATH_MAX)
  4652. char buf[PATH_MAX];
  4653. if (realpath(path, buf) == nullptr) { return false; }
  4654. resolved = buf;
  4655. #else
  4656. auto buf = realpath(path, nullptr);
  4657. auto guard = scope_exit([&]() { std::free(buf); });
  4658. if (buf == nullptr) { return false; }
  4659. resolved = buf;
  4660. #endif
  4661. return true;
  4662. }
  4663. inline bool is_path_within_base(const std::string &resolved_path,
  4664. const std::string &resolved_base) {
  4665. #if defined(_WIN32)
  4666. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4667. resolved_base.size()) == 0;
  4668. #else
  4669. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4670. resolved_base.size()) == 0;
  4671. #endif
  4672. }
  4673. inline FileStat::FileStat(const std::string &path) {
  4674. #if defined(_WIN32)
  4675. auto wpath = u8string_to_wstring(path.c_str());
  4676. ret_ = _wstat(wpath.c_str(), &st_);
  4677. #else
  4678. ret_ = stat(path.c_str(), &st_);
  4679. #endif
  4680. }
  4681. inline bool FileStat::is_file() const {
  4682. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4683. }
  4684. inline bool FileStat::is_dir() const {
  4685. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4686. }
  4687. inline time_t FileStat::mtime() const {
  4688. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4689. : static_cast<time_t>(-1);
  4690. }
  4691. inline size_t FileStat::size() const {
  4692. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4693. }
  4694. inline std::string encode_path(const std::string &s) {
  4695. std::string result;
  4696. result.reserve(s.size());
  4697. for (size_t i = 0; s[i]; i++) {
  4698. switch (s[i]) {
  4699. case ' ': result += "%20"; break;
  4700. case '+': result += "%2B"; break;
  4701. case '\r': result += "%0D"; break;
  4702. case '\n': result += "%0A"; break;
  4703. case '\'': result += "%27"; break;
  4704. case ',': result += "%2C"; break;
  4705. // case ':': result += "%3A"; break; // ok? probably...
  4706. case ';': result += "%3B"; break;
  4707. default:
  4708. auto c = static_cast<uint8_t>(s[i]);
  4709. if (c >= 0x80) {
  4710. result += '%';
  4711. char hex[4];
  4712. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4713. assert(len == 2);
  4714. result.append(hex, static_cast<size_t>(len));
  4715. } else {
  4716. result += s[i];
  4717. }
  4718. break;
  4719. }
  4720. }
  4721. return result;
  4722. }
  4723. inline std::string file_extension(const std::string &path) {
  4724. std::smatch m;
  4725. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4726. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4727. return std::string();
  4728. }
  4729. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4730. template <typename T>
  4731. inline bool parse_header(const char *beg, const char *end, T fn);
  4732. template <typename T>
  4733. inline bool parse_header(const char *beg, const char *end, T fn) {
  4734. // Skip trailing spaces and tabs.
  4735. while (beg < end && is_space_or_tab(end[-1])) {
  4736. end--;
  4737. }
  4738. auto p = beg;
  4739. while (p < end && *p != ':') {
  4740. p++;
  4741. }
  4742. auto name = std::string(beg, p);
  4743. if (!detail::fields::is_field_name(name)) { return false; }
  4744. if (p == end) { return false; }
  4745. auto key_end = p;
  4746. if (*p++ != ':') { return false; }
  4747. while (p < end && is_space_or_tab(*p)) {
  4748. p++;
  4749. }
  4750. if (p <= end) {
  4751. auto key_len = key_end - beg;
  4752. if (!key_len) { return false; }
  4753. auto key = std::string(beg, key_end);
  4754. auto val = std::string(p, end);
  4755. if (!detail::fields::is_field_value(val)) { return false; }
  4756. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4757. // percent-decoded by the recipient. Applications that need to interpret a
  4758. // value as a URI component should call httplib::decode_uri_component()
  4759. // (or decode_path_component()) explicitly.
  4760. fn(key, val);
  4761. return true;
  4762. }
  4763. return false;
  4764. }
  4765. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4766. const Headers &src_headers) {
  4767. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4768. // transfer coding is complete when a chunk with a chunk-size of zero is
  4769. // received, possibly followed by a trailer section, and finally terminated by
  4770. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4771. //
  4772. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4773. // doesn't care for the existence of the final CRLF. In other words, it seems
  4774. // to be ok whether the final CRLF exists or not in the chunked data.
  4775. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4776. //
  4777. // According to the reference code in RFC 9112, cpp-httplib now allows
  4778. // chunked transfer coding data without the final CRLF.
  4779. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4780. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4781. "transfer-encoding",
  4782. "content-length",
  4783. "host",
  4784. "authorization",
  4785. "www-authenticate",
  4786. "proxy-authenticate",
  4787. "proxy-authorization",
  4788. "cookie",
  4789. "set-cookie",
  4790. "cache-control",
  4791. "expect",
  4792. "max-forwards",
  4793. "pragma",
  4794. "range",
  4795. "te",
  4796. "age",
  4797. "expires",
  4798. "date",
  4799. "location",
  4800. "retry-after",
  4801. "vary",
  4802. "warning",
  4803. "content-encoding",
  4804. "content-type",
  4805. "content-range",
  4806. "trailer"};
  4807. case_ignore::unordered_set<std::string> declared_trailers;
  4808. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4809. if (!trailer_header.empty()) {
  4810. // split() trims each token and skips empty ones, so the name arrives ready
  4811. // to look up.
  4812. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4813. ',', [&](const char *b, const char *e) {
  4814. std::string key(b, e);
  4815. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4816. declared_trailers.insert(key);
  4817. }
  4818. });
  4819. }
  4820. size_t trailer_header_count = 0;
  4821. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4822. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4823. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4824. constexpr auto line_terminator_len = 2;
  4825. auto line_beg = line_reader.ptr();
  4826. auto line_end =
  4827. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4828. if (!parse_header(line_beg, line_end,
  4829. [&](const std::string &key, const std::string &val) {
  4830. if (declared_trailers.find(key) !=
  4831. declared_trailers.end()) {
  4832. dest.emplace(key, val);
  4833. trailer_header_count++;
  4834. }
  4835. })) {
  4836. return false;
  4837. }
  4838. if (!line_reader.getline()) { return false; }
  4839. }
  4840. return true;
  4841. }
  4842. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4843. size_t right) {
  4844. while (b + left < e && is_space_or_tab(b[left])) {
  4845. left++;
  4846. }
  4847. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4848. right--;
  4849. }
  4850. return std::make_pair(left, right);
  4851. }
  4852. inline std::string trim_copy(const std::string &s) {
  4853. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4854. return s.substr(r.first, r.second - r.first);
  4855. }
  4856. inline std::string trim_double_quotes_copy(const std::string &s) {
  4857. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4858. return s.substr(1, s.size() - 2);
  4859. }
  4860. return s;
  4861. }
  4862. inline void
  4863. divide(const char *data, std::size_t size, char d,
  4864. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4865. fn) {
  4866. const auto it = std::find(data, data + size, d);
  4867. const auto found = static_cast<std::size_t>(it != data + size);
  4868. const auto lhs_data = data;
  4869. const auto lhs_size = static_cast<std::size_t>(it - data);
  4870. const auto rhs_data = it + found;
  4871. const auto rhs_size = size - lhs_size - found;
  4872. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4873. }
  4874. inline void
  4875. divide(const std::string &str, char d,
  4876. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4877. fn) {
  4878. divide(str.data(), str.size(), d, std::move(fn));
  4879. }
  4880. inline void split(const char *b, const char *e, char d,
  4881. std::function<void(const char *, const char *)> fn) {
  4882. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  4883. }
  4884. inline void split(const char *b, const char *e, char d, size_t m,
  4885. std::function<void(const char *, const char *)> fn) {
  4886. size_t i = 0;
  4887. size_t beg = 0;
  4888. size_t count = 1;
  4889. while (e ? (b + i < e) : (b[i] != '\0')) {
  4890. if (b[i] == d && count < m) {
  4891. auto r = trim(b, e, beg, i);
  4892. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4893. beg = i + 1;
  4894. count++;
  4895. }
  4896. i++;
  4897. }
  4898. if (i) {
  4899. auto r = trim(b, e, beg, i);
  4900. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4901. }
  4902. }
  4903. // Same contract as split(), except that a delimiter inside a quoted-string is
  4904. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  4905. // quoted-string, and ';' and '=' are legal characters inside one.
  4906. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  4907. std::function<void(const char *, const char *)> fn) {
  4908. size_t i = 0;
  4909. size_t beg = 0;
  4910. size_t count = 1;
  4911. auto in_quotes = false;
  4912. while (e ? (b + i < e) : (b[i] != '\0')) {
  4913. if (b[i] == '"') {
  4914. in_quotes = !in_quotes;
  4915. } else if (b[i] == d && !in_quotes && count < m) {
  4916. auto r = trim(b, e, beg, i);
  4917. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4918. beg = i + 1;
  4919. count++;
  4920. }
  4921. i++;
  4922. }
  4923. if (i) {
  4924. auto r = trim(b, e, beg, i);
  4925. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4926. }
  4927. }
  4928. inline void split_unquoted(const char *b, const char *e, char d,
  4929. std::function<void(const char *, const char *)> fn) {
  4930. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  4931. std::move(fn));
  4932. }
  4933. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  4934. // key a token, so the first '=' is the separator even when the value is a
  4935. // quoted-string carrying more of them.
  4936. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  4937. std::string &val) {
  4938. divide(
  4939. b, static_cast<std::size_t>(e - b), '=',
  4940. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  4941. const auto kr = trim(kb, kb + klen, 0, klen);
  4942. key.assign(kb + kr.first, kb + kr.second);
  4943. const auto vr = trim(vb, vb + vlen, 0, vlen);
  4944. val.assign(vb + vr.first, vb + vr.second);
  4945. });
  4946. }
  4947. inline bool split_find(const char *b, const char *e, char d, size_t m,
  4948. std::function<bool(const char *, const char *)> fn) {
  4949. size_t i = 0;
  4950. size_t beg = 0;
  4951. size_t count = 1;
  4952. while (e ? (b + i < e) : (b[i] != '\0')) {
  4953. if (b[i] == d && count < m) {
  4954. auto r = trim(b, e, beg, i);
  4955. if (r.first < r.second) {
  4956. auto found = fn(&b[r.first], &b[r.second]);
  4957. if (found) { return true; }
  4958. }
  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) {
  4967. auto found = fn(&b[r.first], &b[r.second]);
  4968. if (found) { return true; }
  4969. }
  4970. }
  4971. return false;
  4972. }
  4973. inline bool split_find(const char *b, const char *e, char d,
  4974. std::function<bool(const char *, const char *)> fn) {
  4975. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  4976. std::move(fn));
  4977. }
  4978. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  4979. size_t fixed_buffer_size)
  4980. : strm_(strm), fixed_buffer_(fixed_buffer),
  4981. fixed_buffer_size_(fixed_buffer_size) {}
  4982. inline const char *stream_line_reader::ptr() const {
  4983. if (growable_buffer_.empty()) {
  4984. return fixed_buffer_;
  4985. } else {
  4986. return growable_buffer_.data();
  4987. }
  4988. }
  4989. inline size_t stream_line_reader::size() const {
  4990. if (growable_buffer_.empty()) {
  4991. return fixed_buffer_used_size_;
  4992. } else {
  4993. return growable_buffer_.size();
  4994. }
  4995. }
  4996. inline bool stream_line_reader::end_with_crlf() const {
  4997. auto end = ptr() + size();
  4998. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  4999. }
  5000. inline bool stream_line_reader::getline() {
  5001. fixed_buffer_used_size_ = 0;
  5002. growable_buffer_.clear();
  5003. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5004. char prev_byte = 0;
  5005. #endif
  5006. for (size_t i = 0;; i++) {
  5007. // Fast path: whatever the stream has already buffered can be scanned for
  5008. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5009. // call, a bounds check and a one-byte copy per character of the request.
  5010. size_t buffered_size = 0;
  5011. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5012. auto take = buffered_size;
  5013. auto terminated = false;
  5014. for (size_t at = 0; at < buffered_size;) {
  5015. auto nl = static_cast<const char *>(
  5016. memchr(buffered + at, '\n', buffered_size - at));
  5017. if (!nl) { break; }
  5018. auto pos = static_cast<size_t>(nl - buffered);
  5019. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5020. take = pos + 1;
  5021. terminated = true;
  5022. break;
  5023. #else
  5024. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5025. // be the last byte of an earlier chunk, hence prev_byte.
  5026. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5027. take = pos + 1;
  5028. terminated = true;
  5029. break;
  5030. }
  5031. at = pos + 1;
  5032. #endif
  5033. }
  5034. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5035. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5036. prev_byte = buffered[take - 1];
  5037. #endif
  5038. append(buffered, take);
  5039. strm_.consume_buffered(take);
  5040. i += take;
  5041. if (terminated) { return true; }
  5042. continue;
  5043. }
  5044. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5045. // Treat exceptionally long lines as an error to
  5046. // prevent infinite loops/memory exhaustion
  5047. return false;
  5048. }
  5049. char byte;
  5050. auto n = strm_.read(&byte, 1);
  5051. if (n < 0) {
  5052. return false;
  5053. } else if (n == 0) {
  5054. if (i == 0) {
  5055. return false;
  5056. } else {
  5057. break;
  5058. }
  5059. }
  5060. append(byte);
  5061. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5062. if (byte == '\n') { break; }
  5063. #else
  5064. if (prev_byte == '\r' && byte == '\n') { break; }
  5065. prev_byte = byte;
  5066. #endif
  5067. }
  5068. return true;
  5069. }
  5070. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5071. inline void stream_line_reader::append(const char *data, size_t size) {
  5072. // Once the line has outgrown the fixed buffer everything must keep going to
  5073. // the growable one, even if a later chunk would have fit. Without the
  5074. // emptiness check a short append after a long one would land in the fixed
  5075. // buffer, which ptr() and size() no longer look at, and be lost.
  5076. if (growable_buffer_.empty() &&
  5077. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5078. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5079. fixed_buffer_used_size_ += size;
  5080. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5081. } else {
  5082. // Unlike the per-character overload, this can be the very first append of
  5083. // the line, so the fixed buffer may hold nothing and carry no terminator
  5084. // yet. assign() takes an explicit length and does not need one.
  5085. if (growable_buffer_.empty()) {
  5086. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5087. }
  5088. growable_buffer_.append(data, size);
  5089. }
  5090. }
  5091. inline mmap::mmap(const char *path) { open(path); }
  5092. inline mmap::~mmap() { close(); }
  5093. inline bool mmap::open(const char *path) {
  5094. close();
  5095. #if defined(_WIN32)
  5096. auto wpath = u8string_to_wstring(path);
  5097. if (wpath.empty()) { return false; }
  5098. hFile_ =
  5099. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5100. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5101. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5102. LARGE_INTEGER size{};
  5103. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5104. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5105. // See:
  5106. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5107. if (static_cast<ULONGLONG>(size.QuadPart) >
  5108. (std::numeric_limits<decltype(size_)>::max)()) {
  5109. // `size_t` might be 32-bits, on 32-bits Windows.
  5110. return false;
  5111. }
  5112. size_ = static_cast<size_t>(size.QuadPart);
  5113. hMapping_ =
  5114. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5115. // Special treatment for an empty file...
  5116. if (hMapping_ == NULL && size_ == 0) {
  5117. close();
  5118. is_open_empty_file = true;
  5119. return true;
  5120. }
  5121. if (hMapping_ == NULL) {
  5122. close();
  5123. return false;
  5124. }
  5125. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5126. if (addr_ == nullptr) {
  5127. close();
  5128. return false;
  5129. }
  5130. #else
  5131. fd_ = ::open(path, O_RDONLY);
  5132. if (fd_ == -1) { return false; }
  5133. struct stat sb;
  5134. if (fstat(fd_, &sb) == -1) {
  5135. close();
  5136. return false;
  5137. }
  5138. size_ = static_cast<size_t>(sb.st_size);
  5139. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5140. // Special treatment for an empty file...
  5141. if (addr_ == MAP_FAILED && size_ == 0) {
  5142. close();
  5143. is_open_empty_file = true;
  5144. return false;
  5145. }
  5146. if (addr_ == MAP_FAILED) {
  5147. // Clear the sentinel before `close()`, since `is_open()` only checks
  5148. // `addr_` against nullptr and `munmap()` must not be called with it.
  5149. addr_ = nullptr;
  5150. close();
  5151. return false;
  5152. }
  5153. #endif
  5154. return true;
  5155. }
  5156. inline bool mmap::is_open() const {
  5157. return is_open_empty_file ? true : addr_ != nullptr;
  5158. }
  5159. inline size_t mmap::size() const { return size_; }
  5160. inline const char *mmap::data() const {
  5161. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5162. }
  5163. inline void mmap::close() {
  5164. #if defined(_WIN32)
  5165. if (addr_) {
  5166. ::UnmapViewOfFile(addr_);
  5167. addr_ = nullptr;
  5168. }
  5169. if (hMapping_) {
  5170. ::CloseHandle(hMapping_);
  5171. hMapping_ = NULL;
  5172. }
  5173. if (hFile_ != INVALID_HANDLE_VALUE) {
  5174. ::CloseHandle(hFile_);
  5175. hFile_ = INVALID_HANDLE_VALUE;
  5176. }
  5177. is_open_empty_file = false;
  5178. #else
  5179. if (addr_ != nullptr) {
  5180. munmap(addr_, size_);
  5181. addr_ = nullptr;
  5182. }
  5183. if (fd_ != -1) {
  5184. ::close(fd_);
  5185. fd_ = -1;
  5186. }
  5187. #endif
  5188. size_ = 0;
  5189. }
  5190. inline int close_socket(socket_t sock) noexcept {
  5191. #ifdef _WIN32
  5192. return closesocket(sock);
  5193. #else
  5194. return close(sock);
  5195. #endif
  5196. }
  5197. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5198. ssize_t res = 0;
  5199. while (true) {
  5200. res = fn();
  5201. if (res < 0 && errno == EINTR) {
  5202. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5203. continue;
  5204. }
  5205. break;
  5206. }
  5207. return res;
  5208. }
  5209. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5210. return handle_EINTR([&]() {
  5211. return recv(sock,
  5212. #ifdef _WIN32
  5213. static_cast<char *>(ptr), static_cast<int>(size),
  5214. #else
  5215. ptr, size,
  5216. #endif
  5217. flags);
  5218. });
  5219. }
  5220. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5221. int flags) {
  5222. return handle_EINTR([&]() {
  5223. return send(sock,
  5224. #ifdef _WIN32
  5225. static_cast<const char *>(ptr), static_cast<int>(size),
  5226. #else
  5227. ptr, size,
  5228. #endif
  5229. flags);
  5230. });
  5231. }
  5232. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5233. #ifdef _WIN32
  5234. return ::WSAPoll(fds, nfds, timeout);
  5235. #else
  5236. return ::poll(fds, nfds, timeout);
  5237. #endif
  5238. }
  5239. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5240. time_t usec) {
  5241. struct pollfd pfd;
  5242. pfd.fd = sock;
  5243. pfd.events = events;
  5244. pfd.revents = 0;
  5245. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5246. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5247. }
  5248. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5249. return select_impl(sock, POLLIN, sec, usec);
  5250. }
  5251. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5252. return select_impl(sock, POLLOUT, sec, usec);
  5253. }
  5254. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5255. time_t usec) {
  5256. struct pollfd pfd_read;
  5257. pfd_read.fd = sock;
  5258. pfd_read.events = POLLIN | POLLOUT;
  5259. pfd_read.revents = 0;
  5260. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5261. auto poll_res =
  5262. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5263. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5264. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5265. auto error = 0;
  5266. socklen_t len = sizeof(error);
  5267. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5268. reinterpret_cast<char *>(&error), &len);
  5269. auto successful = res >= 0 && !error;
  5270. return successful ? Error::Success : Error::Connection;
  5271. }
  5272. return Error::Connection;
  5273. }
  5274. inline bool is_socket_alive(socket_t sock) {
  5275. const auto val = detail::select_read(sock, 0, 0);
  5276. if (val == 0) {
  5277. return true;
  5278. } else if (val < 0 && errno == EBADF) {
  5279. return false;
  5280. }
  5281. char buf[1];
  5282. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5283. }
  5284. class SocketStream final : public Stream {
  5285. public:
  5286. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5287. time_t write_timeout_sec, time_t write_timeout_usec,
  5288. time_t max_timeout_msec = 0,
  5289. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5290. (std::chrono::steady_clock::time_point::min)());
  5291. ~SocketStream() override;
  5292. bool is_readable() const override;
  5293. bool wait_readable() const override;
  5294. bool wait_writable() const override;
  5295. bool is_peer_alive() const override;
  5296. ssize_t read(char *ptr, size_t size) override;
  5297. ssize_t write(const char *ptr, size_t size) override;
  5298. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5299. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5300. socket_t socket() const override;
  5301. time_t duration() const override;
  5302. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5303. const char *buffered_data(size_t &size) const override;
  5304. void consume_buffered(size_t size) override;
  5305. // The caller has just seen this socket become readable. Lets the next read
  5306. // skip its own readiness wait, which would otherwise ask the kernel a
  5307. // question that was answered a moment ago. Consumed by that read.
  5308. void set_readable_hint() { readable_hint_ = true; }
  5309. private:
  5310. bool ensure_readable();
  5311. socket_t sock_;
  5312. time_t read_timeout_sec_;
  5313. time_t read_timeout_usec_;
  5314. time_t write_timeout_sec_;
  5315. time_t write_timeout_usec_;
  5316. time_t max_timeout_msec_;
  5317. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5318. std::vector<char> read_buff_;
  5319. size_t read_buff_off_ = 0;
  5320. size_t read_buff_content_size_ = 0;
  5321. bool readable_hint_ = false;
  5322. static const size_t read_buff_size_ = 1024l * 4;
  5323. };
  5324. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5325. time_t keep_alive_timeout_sec) {
  5326. using namespace std::chrono;
  5327. const auto interval_usec =
  5328. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5329. // Avoid expensive `steady_clock::now()` call for the first time
  5330. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5331. const auto start = steady_clock::now() - microseconds{interval_usec};
  5332. const auto timeout = seconds{keep_alive_timeout_sec};
  5333. while (true) {
  5334. if (svr_sock == INVALID_SOCKET) {
  5335. break; // Server socket is closed
  5336. }
  5337. auto val = select_read(sock, 0, interval_usec);
  5338. if (val < 0) {
  5339. break; // Ssocket error
  5340. } else if (val == 0) {
  5341. if (steady_clock::now() - start > timeout) {
  5342. break; // Timeout
  5343. }
  5344. } else {
  5345. return true; // Ready for read
  5346. }
  5347. }
  5348. return false;
  5349. }
  5350. template <typename T>
  5351. inline bool
  5352. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5353. size_t keep_alive_max_count,
  5354. time_t keep_alive_timeout_sec, T callback) {
  5355. assert(keep_alive_max_count > 0);
  5356. auto ret = false;
  5357. auto count = keep_alive_max_count;
  5358. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5359. auto close_connection = count == 1;
  5360. auto connection_closed = false;
  5361. ret = callback(close_connection, connection_closed);
  5362. if (!ret || connection_closed) { break; }
  5363. count--;
  5364. }
  5365. return ret;
  5366. }
  5367. template <typename T>
  5368. inline bool
  5369. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5370. size_t keep_alive_max_count,
  5371. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5372. time_t read_timeout_usec, time_t write_timeout_sec,
  5373. time_t write_timeout_usec, T callback) {
  5374. return process_server_socket_core(
  5375. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5376. [&](bool close_connection, bool &connection_closed) {
  5377. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5378. write_timeout_sec, write_timeout_usec);
  5379. // process_server_socket_core() only gets here once keep_alive() has
  5380. // seen the socket go readable.
  5381. strm.set_readable_hint();
  5382. return callback(strm, close_connection, connection_closed);
  5383. });
  5384. }
  5385. inline bool process_client_socket(
  5386. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5387. time_t write_timeout_sec, time_t write_timeout_usec,
  5388. time_t max_timeout_msec,
  5389. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5390. std::function<bool(Stream &)> callback) {
  5391. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5392. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5393. start_time);
  5394. return callback(strm);
  5395. }
  5396. inline int shutdown_socket(socket_t sock) noexcept {
  5397. #ifdef _WIN32
  5398. return shutdown(sock, SD_BOTH);
  5399. #else
  5400. return shutdown(sock, SHUT_RDWR);
  5401. #endif
  5402. }
  5403. // Half-closes the write side and drains any in-flight/queued bytes before
  5404. // the final shutdown+close. Closing with unread data in the receive queue
  5405. // (or bytes arriving after the receive side is closed) makes the stack send
  5406. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5407. // response as a failed read even though it was fully written.
  5408. inline void drain_and_close_socket(socket_t sock) noexcept {
  5409. #ifdef _WIN32
  5410. shutdown(sock, SD_SEND);
  5411. #else
  5412. shutdown(sock, SHUT_WR);
  5413. #endif
  5414. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5415. size_t total = 0;
  5416. const auto deadline = std::chrono::steady_clock::now() +
  5417. std::chrono::milliseconds(100); // bound #1
  5418. while (total < size_t(1024u * 1024u)) { // bound #2
  5419. const auto remaining =
  5420. std::chrono::duration_cast<std::chrono::microseconds>(
  5421. deadline - std::chrono::steady_clock::now())
  5422. .count();
  5423. if (remaining <= 0) { break; }
  5424. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5425. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5426. if (n <= 0) { break; }
  5427. total += static_cast<size_t>(n);
  5428. }
  5429. shutdown_socket(sock);
  5430. close_socket(sock);
  5431. }
  5432. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5433. if (s.size() > 1 && s[0] == '\0') {
  5434. auto ret = s;
  5435. ret[0] = '@';
  5436. return ret;
  5437. }
  5438. return s;
  5439. }
  5440. inline std::string
  5441. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5442. if (s.size() > 1 && s[0] == '@') {
  5443. auto ret = s;
  5444. ret[0] = '\0';
  5445. return ret;
  5446. }
  5447. return s;
  5448. }
  5449. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5450. const struct addrinfo *hints,
  5451. struct addrinfo **res, time_t timeout_sec) {
  5452. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5453. if (timeout_sec <= 0) {
  5454. // No timeout specified, use standard getaddrinfo
  5455. return getaddrinfo(node, service, hints, res);
  5456. }
  5457. #ifdef _WIN32
  5458. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5459. OVERLAPPED overlapped = {};
  5460. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5461. if (!event) { return EAI_FAIL; }
  5462. overlapped.hEvent = event;
  5463. PADDRINFOEXW result_addrinfo = nullptr;
  5464. HANDLE cancel_handle = nullptr;
  5465. ADDRINFOEXW hints_ex = {};
  5466. if (hints) {
  5467. hints_ex.ai_flags = hints->ai_flags;
  5468. hints_ex.ai_family = hints->ai_family;
  5469. hints_ex.ai_socktype = hints->ai_socktype;
  5470. hints_ex.ai_protocol = hints->ai_protocol;
  5471. }
  5472. auto wnode = u8string_to_wstring(node);
  5473. auto wservice = u8string_to_wstring(service);
  5474. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5475. hints ? &hints_ex : nullptr, &result_addrinfo,
  5476. nullptr, &overlapped, nullptr, &cancel_handle);
  5477. if (ret == WSA_IO_PENDING) {
  5478. auto wait_result =
  5479. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5480. if (wait_result == WAIT_TIMEOUT) {
  5481. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5482. ::CloseHandle(event);
  5483. return EAI_AGAIN;
  5484. }
  5485. DWORD bytes_returned;
  5486. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5487. &bytes_returned, FALSE)) {
  5488. ::CloseHandle(event);
  5489. return ::WSAGetLastError();
  5490. }
  5491. }
  5492. ::CloseHandle(event);
  5493. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5494. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5495. return 0;
  5496. }
  5497. return ret;
  5498. #elif TARGET_OS_MAC && defined(__clang__)
  5499. if (!node) { return EAI_NONAME; }
  5500. // macOS implementation using CFHost API for asynchronous DNS resolution
  5501. CFStringRef hostname_ref = CFStringCreateWithCString(
  5502. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5503. if (!hostname_ref) { return EAI_MEMORY; }
  5504. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5505. CFRelease(hostname_ref);
  5506. if (!host_ref) { return EAI_MEMORY; }
  5507. // Set up context for callback
  5508. struct CFHostContext {
  5509. bool completed = false;
  5510. bool success = false;
  5511. CFArrayRef addresses = nullptr;
  5512. std::mutex mutex;
  5513. std::condition_variable cv;
  5514. } context;
  5515. CFHostClientContext client_context;
  5516. memset(&client_context, 0, sizeof(client_context));
  5517. client_context.info = &context;
  5518. // Set callback
  5519. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5520. const CFStreamError *error, void *info) {
  5521. auto ctx = static_cast<CFHostContext *>(info);
  5522. std::lock_guard<std::mutex> lock(ctx->mutex);
  5523. if (error && error->error != 0) {
  5524. ctx->success = false;
  5525. } else {
  5526. Boolean hasBeenResolved;
  5527. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5528. if (ctx->addresses && hasBeenResolved) {
  5529. CFRetain(ctx->addresses);
  5530. ctx->success = true;
  5531. } else {
  5532. ctx->success = false;
  5533. }
  5534. }
  5535. ctx->completed = true;
  5536. ctx->cv.notify_one();
  5537. };
  5538. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5539. CFRelease(host_ref);
  5540. return EAI_SYSTEM;
  5541. }
  5542. // Schedule on run loop
  5543. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5544. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5545. // Start resolution
  5546. CFStreamError stream_error;
  5547. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5548. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5549. CFRelease(host_ref);
  5550. return EAI_FAIL;
  5551. }
  5552. // Wait for completion with timeout
  5553. auto timeout_time =
  5554. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5555. bool timed_out = false;
  5556. {
  5557. std::unique_lock<std::mutex> lock(context.mutex);
  5558. while (!context.completed) {
  5559. auto now = std::chrono::steady_clock::now();
  5560. if (now >= timeout_time) {
  5561. timed_out = true;
  5562. break;
  5563. }
  5564. // Run the runloop for a short time
  5565. lock.unlock();
  5566. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5567. lock.lock();
  5568. }
  5569. }
  5570. // Clean up
  5571. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5572. CFHostSetClient(host_ref, nullptr, nullptr);
  5573. if (timed_out || !context.completed) {
  5574. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5575. CFRelease(host_ref);
  5576. return EAI_AGAIN;
  5577. }
  5578. if (!context.success || !context.addresses) {
  5579. CFRelease(host_ref);
  5580. return EAI_NODATA;
  5581. }
  5582. // Convert CFArray to addrinfo
  5583. CFIndex count = CFArrayGetCount(context.addresses);
  5584. if (count == 0) {
  5585. CFRelease(context.addresses);
  5586. CFRelease(host_ref);
  5587. return EAI_NODATA;
  5588. }
  5589. struct addrinfo *result_addrinfo = nullptr;
  5590. struct addrinfo **current = &result_addrinfo;
  5591. for (CFIndex i = 0; i < count; i++) {
  5592. CFDataRef addr_data =
  5593. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5594. if (!addr_data) continue;
  5595. const struct sockaddr *sockaddr_ptr =
  5596. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5597. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5598. // Allocate addrinfo structure
  5599. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5600. if (!*current) {
  5601. freeaddrinfo(result_addrinfo);
  5602. CFRelease(context.addresses);
  5603. CFRelease(host_ref);
  5604. return EAI_MEMORY;
  5605. }
  5606. memset(*current, 0, sizeof(struct addrinfo));
  5607. // Set up addrinfo fields
  5608. (*current)->ai_family = sockaddr_ptr->sa_family;
  5609. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5610. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5611. (*current)->ai_addrlen = sockaddr_len;
  5612. // Copy sockaddr
  5613. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5614. if (!(*current)->ai_addr) {
  5615. freeaddrinfo(result_addrinfo);
  5616. CFRelease(context.addresses);
  5617. CFRelease(host_ref);
  5618. return EAI_MEMORY;
  5619. }
  5620. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5621. // Set port if service is specified
  5622. if (service && *service) {
  5623. int port = 0;
  5624. if (parse_port(service, strlen(service), port)) {
  5625. if (sockaddr_ptr->sa_family == AF_INET) {
  5626. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5627. ->sin_port = htons(static_cast<uint16_t>(port));
  5628. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5629. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5630. ->sin6_port = htons(static_cast<uint16_t>(port));
  5631. }
  5632. }
  5633. }
  5634. current = &((*current)->ai_next);
  5635. }
  5636. CFRelease(context.addresses);
  5637. CFRelease(host_ref);
  5638. *res = result_addrinfo;
  5639. return 0;
  5640. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5641. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5642. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5643. // the resolver worker still references the stack-local gaicb. The cancel
  5644. // path therefore waits (gai_suspend with no timeout) for the worker to
  5645. // actually finish before letting the stack frame go. The trade-off is that
  5646. // a wedged DNS server can hold this thread for the system resolver timeout
  5647. // (~30s by default) past the caller's connection timeout.
  5648. struct gaicb request {};
  5649. struct gaicb *requests[1] = {&request};
  5650. struct sigevent sevp {};
  5651. struct timespec timeout {
  5652. timeout_sec, 0
  5653. };
  5654. request.ar_name = node;
  5655. request.ar_service = service;
  5656. request.ar_request = hints;
  5657. sevp.sigev_notify = SIGEV_NONE;
  5658. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5659. if (rc != 0) { return rc; }
  5660. auto cleanup = scope_exit([&] {
  5661. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5662. });
  5663. int wait_result = gai_suspend(requests, 1, &timeout);
  5664. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5665. int gai_result = gai_error(&request);
  5666. if (gai_result == 0) {
  5667. *res = request.ar_result;
  5668. request.ar_result = nullptr;
  5669. return 0;
  5670. }
  5671. return gai_result;
  5672. }
  5673. gai_cancel(&request);
  5674. while (gai_error(&request) == EAI_INPROGRESS) {
  5675. gai_suspend(requests, 1, nullptr);
  5676. }
  5677. return wait_result;
  5678. #else
  5679. // Fallback implementation using thread-based timeout for other Unix systems.
  5680. struct GetAddrInfoState {
  5681. ~GetAddrInfoState() {
  5682. if (info) { freeaddrinfo(info); }
  5683. }
  5684. std::mutex mutex;
  5685. std::condition_variable result_cv;
  5686. bool completed = false;
  5687. int result = EAI_SYSTEM;
  5688. std::string node;
  5689. std::string service;
  5690. struct addrinfo hints;
  5691. struct addrinfo *info = nullptr;
  5692. };
  5693. // Allocate on the heap, so the resolver thread can keep using the data.
  5694. auto state = std::make_shared<GetAddrInfoState>();
  5695. if (node) { state->node = node; }
  5696. state->service = service;
  5697. state->hints = *hints;
  5698. std::thread resolve_thread([state]() {
  5699. auto thread_result =
  5700. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5701. &state->info);
  5702. std::lock_guard<std::mutex> lock(state->mutex);
  5703. state->result = thread_result;
  5704. state->completed = true;
  5705. state->result_cv.notify_one();
  5706. });
  5707. // Wait for completion or timeout
  5708. std::unique_lock<std::mutex> lock(state->mutex);
  5709. auto finished =
  5710. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5711. [&] { return state->completed; });
  5712. if (finished) {
  5713. // Operation completed within timeout
  5714. resolve_thread.join();
  5715. *res = state->info;
  5716. state->info = nullptr; // Pass ownership to caller
  5717. return state->result;
  5718. } else {
  5719. // Timeout occurred
  5720. resolve_thread.detach(); // Let the thread finish in background
  5721. return EAI_AGAIN; // Return timeout error
  5722. }
  5723. #endif
  5724. #else
  5725. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5726. return getaddrinfo(node, service, hints, res);
  5727. #endif
  5728. }
  5729. template <typename BindOrConnect>
  5730. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5731. int address_family, int socket_flags, bool tcp_nodelay,
  5732. bool ipv6_v6only, SocketOptions socket_options,
  5733. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5734. // Get address info
  5735. const char *node = nullptr;
  5736. struct addrinfo hints;
  5737. struct addrinfo *result;
  5738. memset(&hints, 0, sizeof(struct addrinfo));
  5739. hints.ai_socktype = SOCK_STREAM;
  5740. hints.ai_protocol = IPPROTO_IP;
  5741. if (!ip.empty()) {
  5742. node = ip.c_str();
  5743. // Ask getaddrinfo to convert IP in c-string to address
  5744. hints.ai_family = AF_UNSPEC;
  5745. hints.ai_flags = AI_NUMERICHOST;
  5746. } else {
  5747. if (!host.empty()) { node = host.c_str(); }
  5748. hints.ai_family = address_family;
  5749. hints.ai_flags = socket_flags;
  5750. }
  5751. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5752. if (hints.ai_family == AF_UNIX) {
  5753. const auto addrlen = host.length();
  5754. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5755. #ifdef SOCK_CLOEXEC
  5756. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5757. hints.ai_protocol);
  5758. #else
  5759. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5760. #endif
  5761. if (sock != INVALID_SOCKET) {
  5762. sockaddr_un addr{};
  5763. addr.sun_family = AF_UNIX;
  5764. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5765. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5766. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5767. hints.ai_addrlen = static_cast<socklen_t>(
  5768. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5769. #ifndef SOCK_CLOEXEC
  5770. #ifndef _WIN32
  5771. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5772. #endif
  5773. #endif
  5774. if (socket_options) { socket_options(sock); }
  5775. #ifdef _WIN32
  5776. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5777. // remove the option.
  5778. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5779. #endif
  5780. bool dummy;
  5781. if (!bind_or_connect(sock, hints, dummy)) {
  5782. close_socket(sock);
  5783. sock = INVALID_SOCKET;
  5784. }
  5785. }
  5786. return sock;
  5787. }
  5788. #endif
  5789. auto service = std::to_string(port);
  5790. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5791. timeout_sec)) {
  5792. #if defined __linux__ && !defined __ANDROID__
  5793. res_init();
  5794. #endif
  5795. return INVALID_SOCKET;
  5796. }
  5797. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5798. for (auto rp = result; rp; rp = rp->ai_next) {
  5799. // Create a socket
  5800. #ifdef _WIN32
  5801. auto sock =
  5802. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5803. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5804. /**
  5805. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5806. * and above the socket creation fails on older Windows Systems.
  5807. *
  5808. * Let's try to create a socket the old way in this case.
  5809. *
  5810. * Reference:
  5811. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5812. *
  5813. * WSA_FLAG_NO_HANDLE_INHERIT:
  5814. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5815. * SP1, and later
  5816. *
  5817. */
  5818. if (sock == INVALID_SOCKET) {
  5819. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5820. }
  5821. #else
  5822. #ifdef SOCK_CLOEXEC
  5823. auto sock =
  5824. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5825. #else
  5826. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5827. #endif
  5828. #endif
  5829. if (sock == INVALID_SOCKET) { continue; }
  5830. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5831. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5832. close_socket(sock);
  5833. continue;
  5834. }
  5835. #endif
  5836. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5837. if (rp->ai_family == AF_INET6) {
  5838. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5839. }
  5840. if (socket_options) { socket_options(sock); }
  5841. // bind or connect
  5842. auto quit = false;
  5843. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5844. close_socket(sock);
  5845. if (quit) { break; }
  5846. }
  5847. return INVALID_SOCKET;
  5848. }
  5849. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5850. #ifdef _WIN32
  5851. auto flags = nonblocking ? 1UL : 0UL;
  5852. ioctlsocket(sock, FIONBIO, &flags);
  5853. #else
  5854. auto flags = fcntl(sock, F_GETFL, 0);
  5855. fcntl(sock, F_SETFL,
  5856. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5857. #endif
  5858. }
  5859. inline bool is_connection_error() {
  5860. #ifdef _WIN32
  5861. return WSAGetLastError() != WSAEWOULDBLOCK;
  5862. #else
  5863. return errno != EINPROGRESS;
  5864. #endif
  5865. }
  5866. // accept() failed because the process or the network stack is temporarily out
  5867. // of resources. The listening socket is still usable, so back off briefly and
  5868. // try again.
  5869. inline bool is_accept_resource_error() {
  5870. #ifdef _WIN32
  5871. auto err = WSAGetLastError();
  5872. return err == WSAEMFILE || err == WSAENOBUFS;
  5873. #else
  5874. auto err = errno;
  5875. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  5876. #endif
  5877. }
  5878. // accept() failed for a reason that says nothing about the listening socket:
  5879. // the pending connection went away before it could be accepted, or the call
  5880. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  5881. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  5882. // connection that way.
  5883. inline bool is_accept_transient_error() {
  5884. #ifdef _WIN32
  5885. auto err = WSAGetLastError();
  5886. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  5887. err == WSAECONNABORTED;
  5888. #else
  5889. auto err = errno;
  5890. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  5891. err == ECONNABORTED;
  5892. #endif
  5893. }
  5894. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  5895. struct addrinfo hints;
  5896. struct addrinfo *result;
  5897. memset(&hints, 0, sizeof(struct addrinfo));
  5898. hints.ai_family = AF_UNSPEC;
  5899. hints.ai_socktype = SOCK_STREAM;
  5900. hints.ai_protocol = 0;
  5901. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  5902. return false;
  5903. }
  5904. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5905. auto ret = false;
  5906. for (auto rp = result; rp; rp = rp->ai_next) {
  5907. const auto &ai = *rp;
  5908. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  5909. ret = true;
  5910. break;
  5911. }
  5912. }
  5913. return ret;
  5914. }
  5915. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  5916. #define USE_IF2IP
  5917. #endif
  5918. #ifdef USE_IF2IP
  5919. inline std::string if2ip(int address_family, const std::string &ifn) {
  5920. struct ifaddrs *ifap;
  5921. getifaddrs(&ifap);
  5922. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  5923. std::string addr_candidate;
  5924. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  5925. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  5926. (AF_UNSPEC == address_family ||
  5927. ifa->ifa_addr->sa_family == address_family)) {
  5928. if (ifa->ifa_addr->sa_family == AF_INET) {
  5929. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  5930. char buf[INET_ADDRSTRLEN];
  5931. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  5932. return std::string(buf, INET_ADDRSTRLEN);
  5933. }
  5934. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  5935. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  5936. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  5937. char buf[INET6_ADDRSTRLEN] = {};
  5938. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  5939. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  5940. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  5941. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  5942. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  5943. } else {
  5944. return std::string(buf, INET6_ADDRSTRLEN);
  5945. }
  5946. }
  5947. }
  5948. }
  5949. }
  5950. }
  5951. return addr_candidate;
  5952. }
  5953. #endif
  5954. inline socket_t create_client_socket(
  5955. const std::string &host, const std::string &ip, int port,
  5956. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  5957. SocketOptions socket_options, time_t connection_timeout_sec,
  5958. time_t connection_timeout_usec, time_t read_timeout_sec,
  5959. time_t read_timeout_usec, time_t write_timeout_sec,
  5960. time_t write_timeout_usec, const std::string &intf, Error &error) {
  5961. auto sock = create_socket(
  5962. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  5963. std::move(socket_options),
  5964. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  5965. if (!intf.empty()) {
  5966. #ifdef USE_IF2IP
  5967. auto ip_from_if = if2ip(address_family, intf);
  5968. if (ip_from_if.empty()) { ip_from_if = intf; }
  5969. if (!bind_ip_address(sock2, ip_from_if)) {
  5970. error = Error::BindIPAddress;
  5971. return false;
  5972. }
  5973. #endif
  5974. }
  5975. set_nonblocking(sock2, true);
  5976. auto ret =
  5977. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  5978. if (ret < 0) {
  5979. if (is_connection_error()) {
  5980. error = Error::Connection;
  5981. return false;
  5982. }
  5983. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  5984. connection_timeout_usec);
  5985. if (error != Error::Success) {
  5986. if (error == Error::ConnectionTimeout) { quit = true; }
  5987. return false;
  5988. }
  5989. }
  5990. set_nonblocking(sock2, false);
  5991. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  5992. read_timeout_usec);
  5993. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  5994. write_timeout_usec);
  5995. error = Error::Success;
  5996. return true;
  5997. },
  5998. connection_timeout_sec); // Pass DNS timeout
  5999. if (sock != INVALID_SOCKET) {
  6000. error = Error::Success;
  6001. } else {
  6002. if (error == Error::Success) { error = Error::Connection; }
  6003. }
  6004. return sock;
  6005. }
  6006. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6007. socklen_t addr_len, std::string &ip, int &port) {
  6008. if (addr.ss_family == AF_INET) {
  6009. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6010. } else if (addr.ss_family == AF_INET6) {
  6011. port =
  6012. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6013. } else {
  6014. return false;
  6015. }
  6016. std::array<char, NI_MAXHOST> ipstr{};
  6017. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6018. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6019. 0, NI_NUMERICHOST)) {
  6020. return false;
  6021. }
  6022. ip = ipstr.data();
  6023. return true;
  6024. }
  6025. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6026. struct sockaddr_storage addr;
  6027. socklen_t addr_len = sizeof(addr);
  6028. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6029. &addr_len)) {
  6030. get_ip_and_port(addr, addr_len, ip, port);
  6031. }
  6032. }
  6033. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6034. struct sockaddr_storage addr;
  6035. socklen_t addr_len = sizeof(addr);
  6036. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6037. &addr_len)) {
  6038. #ifndef _WIN32
  6039. if (addr.ss_family == AF_UNIX) {
  6040. #if defined(__linux__)
  6041. struct ucred ucred;
  6042. socklen_t len = sizeof(ucred);
  6043. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6044. port = ucred.pid;
  6045. }
  6046. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6047. pid_t pid;
  6048. socklen_t len = sizeof(pid);
  6049. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6050. port = pid;
  6051. }
  6052. #endif
  6053. return;
  6054. }
  6055. #endif
  6056. get_ip_and_port(addr, addr_len, ip, port);
  6057. }
  6058. }
  6059. // Recursive form retained so operator""_t below can compute hashes for
  6060. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6061. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6062. // instead, which is iterative and stack-safe.
  6063. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6064. unsigned int h) {
  6065. return (l == 0)
  6066. ? h
  6067. : str2tag_core(
  6068. s + 1, l - 1,
  6069. // Unsets the 6 high bits of h, therefore no overflow happens
  6070. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6071. h * 33) ^
  6072. static_cast<unsigned char>(*s));
  6073. }
  6074. inline unsigned int str2tag(const std::string &s) {
  6075. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6076. // for compile-time UDL evaluation of short string literals, but at runtime
  6077. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6078. // would blow the stack with one frame per character.
  6079. unsigned int h = 0;
  6080. for (auto c : s) {
  6081. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6082. static_cast<unsigned char>(c);
  6083. }
  6084. return h;
  6085. }
  6086. namespace udl {
  6087. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6088. return str2tag_core(s, l, 0);
  6089. }
  6090. } // namespace udl
  6091. inline std::string
  6092. find_content_type(const std::string &path,
  6093. const std::map<std::string, std::string> &user_data,
  6094. const std::string &default_content_type) {
  6095. auto ext = file_extension(path);
  6096. auto it = user_data.find(ext);
  6097. if (it != user_data.end()) { return it->second; }
  6098. using udl::operator""_t;
  6099. switch (str2tag(ext)) {
  6100. default: return default_content_type;
  6101. case "css"_t: return "text/css";
  6102. case "csv"_t: return "text/csv";
  6103. case "htm"_t:
  6104. case "html"_t: return "text/html";
  6105. case "js"_t:
  6106. case "mjs"_t: return "text/javascript";
  6107. case "txt"_t: return "text/plain";
  6108. case "vtt"_t: return "text/vtt";
  6109. case "apng"_t: return "image/apng";
  6110. case "avif"_t: return "image/avif";
  6111. case "bmp"_t: return "image/bmp";
  6112. case "gif"_t: return "image/gif";
  6113. case "png"_t: return "image/png";
  6114. case "svg"_t: return "image/svg+xml";
  6115. case "webp"_t: return "image/webp";
  6116. case "ico"_t: return "image/x-icon";
  6117. case "tif"_t: return "image/tiff";
  6118. case "tiff"_t: return "image/tiff";
  6119. case "jpg"_t:
  6120. case "jpeg"_t: return "image/jpeg";
  6121. case "mp4"_t: return "video/mp4";
  6122. case "mpeg"_t: return "video/mpeg";
  6123. case "webm"_t: return "video/webm";
  6124. case "mp3"_t: return "audio/mp3";
  6125. case "mpga"_t: return "audio/mpeg";
  6126. case "weba"_t: return "audio/webm";
  6127. case "wav"_t: return "audio/wave";
  6128. case "otf"_t: return "font/otf";
  6129. case "ttf"_t: return "font/ttf";
  6130. case "woff"_t: return "font/woff";
  6131. case "woff2"_t: return "font/woff2";
  6132. case "7z"_t: return "application/x-7z-compressed";
  6133. case "atom"_t: return "application/atom+xml";
  6134. case "pdf"_t: return "application/pdf";
  6135. case "json"_t: return "application/json";
  6136. case "rss"_t: return "application/rss+xml";
  6137. case "tar"_t: return "application/x-tar";
  6138. case "xht"_t:
  6139. case "xhtml"_t: return "application/xhtml+xml";
  6140. case "xslt"_t: return "application/xslt+xml";
  6141. case "xml"_t: return "application/xml";
  6142. case "gz"_t: return "application/gzip";
  6143. case "zip"_t: return "application/zip";
  6144. case "wasm"_t: return "application/wasm";
  6145. }
  6146. }
  6147. inline std::string
  6148. extract_media_type(const std::string &content_type,
  6149. std::map<std::string, std::string> *params = nullptr) {
  6150. // Extract type/subtype from Content-Type value (RFC 2045)
  6151. // e.g. "application/json; charset=utf-8" -> "application/json"
  6152. auto media_type = content_type;
  6153. auto semicolon_pos = media_type.find(';');
  6154. if (semicolon_pos != std::string::npos) {
  6155. auto param_str = media_type.substr(semicolon_pos + 1);
  6156. media_type = media_type.substr(0, semicolon_pos);
  6157. if (params) {
  6158. // Parse parameters: key=value pairs separated by ';'
  6159. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6160. [&](const char *b, const char *e) {
  6161. std::string key;
  6162. std::string val;
  6163. divide_param_pair(b, e, key, val);
  6164. if (!key.empty()) {
  6165. params->emplace(trim_copy(key),
  6166. trim_double_quotes_copy(val));
  6167. }
  6168. });
  6169. }
  6170. }
  6171. // Trim whitespace from media type
  6172. return trim_copy(media_type);
  6173. }
  6174. inline bool can_compress_content_type(const std::string &content_type) {
  6175. using udl::operator""_t;
  6176. auto mime_type = extract_media_type(content_type);
  6177. auto tag = str2tag(mime_type);
  6178. switch (tag) {
  6179. case "image/svg+xml"_t:
  6180. case "application/javascript"_t:
  6181. case "application/x-javascript"_t:
  6182. case "application/json"_t:
  6183. case "application/ld+json"_t:
  6184. case "application/xml"_t:
  6185. case "application/xhtml+xml"_t:
  6186. case "application/rss+xml"_t:
  6187. case "application/atom+xml"_t:
  6188. case "application/xslt+xml"_t:
  6189. case "application/protobuf"_t: return true;
  6190. case "text/event-stream"_t: return false;
  6191. default: return !mime_type.rfind("text/", 0);
  6192. }
  6193. }
  6194. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6195. double &quality) {
  6196. quality = 1.0;
  6197. token.clear();
  6198. // Split on first ';': left = token name, right = parameters
  6199. const char *params_b = nullptr;
  6200. std::size_t params_len = 0;
  6201. divide(
  6202. b, static_cast<std::size_t>(e - b), ';',
  6203. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6204. auto r = trim(lb, lb + llen, 0, llen);
  6205. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6206. params_b = rb;
  6207. params_len = rlen;
  6208. });
  6209. if (token.empty()) { return false; }
  6210. if (params_len == 0) { return true; }
  6211. // Scan parameters for q= (stops on first match)
  6212. bool invalid = false;
  6213. split_find(params_b, params_b + params_len, ';',
  6214. (std::numeric_limits<size_t>::max)(),
  6215. [&](const char *pb, const char *pe) -> bool {
  6216. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6217. auto len = static_cast<size_t>(pe - pb);
  6218. if (len < 2) { return false; }
  6219. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6220. return false;
  6221. }
  6222. // Trim the value portion
  6223. auto r = trim(pb, pe, 2, len);
  6224. if (r.first >= r.second) {
  6225. invalid = true;
  6226. return true;
  6227. }
  6228. double v = 0.0;
  6229. auto res = from_chars(pb + r.first, pb + r.second, v);
  6230. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6231. invalid = true;
  6232. return true;
  6233. }
  6234. quality = v;
  6235. return true;
  6236. });
  6237. return !invalid;
  6238. }
  6239. inline EncodingType encoding_type(const Request &req,
  6240. const std::string &content_type) {
  6241. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6242. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6243. if (s.empty()) { return EncodingType::None; }
  6244. // Single-pass: iterate tokens and track the best supported encoding.
  6245. // Server preference breaks ties (br > gzip > zstd).
  6246. EncodingType best = EncodingType::None;
  6247. double best_q = 0.0; // q=0 means "not acceptable"
  6248. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6249. auto priority = [](EncodingType t) -> int {
  6250. switch (t) {
  6251. case EncodingType::Brotli: return 0;
  6252. case EncodingType::Gzip: return 1;
  6253. case EncodingType::Zstd: return 2;
  6254. default: return 3;
  6255. }
  6256. };
  6257. std::string name;
  6258. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6259. double quality = 1.0;
  6260. if (!parse_quality(b, e, name, quality)) { return; }
  6261. if (quality <= 0.0) { return; }
  6262. EncodingType type = EncodingType::None;
  6263. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6264. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6265. #endif
  6266. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6267. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6268. type = EncodingType::Gzip;
  6269. }
  6270. #endif
  6271. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6272. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6273. type = EncodingType::Zstd;
  6274. }
  6275. #endif
  6276. if (type == EncodingType::None) { return; }
  6277. // Higher q-value wins; for equal q, server preference breaks ties
  6278. if (quality > best_q ||
  6279. (quality == best_q && priority(type) < priority(best))) {
  6280. best_q = quality;
  6281. best = type;
  6282. }
  6283. });
  6284. return best;
  6285. }
  6286. // `content_type` is taken separately because a file-backed response has not
  6287. // been given one yet when its coding has to be decided.
  6288. inline EncodingType encoding_type(const Request &req, const Response &res,
  6289. const std::string &content_type) {
  6290. // The response already names a content coding of its own: a handler serving
  6291. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6292. // point whose headers name the coding its files are stored in. Applying one
  6293. // on top of that would double-encode the body and append a second
  6294. // `Content-Encoding` field line.
  6295. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6296. return encoding_type(req, content_type);
  6297. }
  6298. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6299. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6300. }
  6301. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6302. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6303. if (type == EncodingType::Gzip) {
  6304. return detail::make_unique<gzip_compressor>();
  6305. }
  6306. #endif
  6307. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6308. if (type == EncodingType::Brotli) {
  6309. return detail::make_unique<brotli_compressor>();
  6310. }
  6311. #endif
  6312. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6313. if (type == EncodingType::Zstd) {
  6314. return detail::make_unique<zstd_compressor>();
  6315. }
  6316. #endif
  6317. (void)type;
  6318. return nullptr;
  6319. }
  6320. inline const char *encoding_name(EncodingType type) {
  6321. switch (type) {
  6322. case EncodingType::Gzip: return "gzip";
  6323. case EncodingType::Brotli: return "br";
  6324. case EncodingType::Zstd: return "zstd";
  6325. default: return "";
  6326. }
  6327. }
  6328. inline bool nocompressor::compress(const char *data, size_t data_length,
  6329. bool /*last*/, Callback callback) {
  6330. if (!data_length) { return true; }
  6331. return callback(data, data_length);
  6332. }
  6333. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6334. inline gzip_compressor::gzip_compressor() {
  6335. std::memset(&strm_, 0, sizeof(strm_));
  6336. strm_.zalloc = Z_NULL;
  6337. strm_.zfree = Z_NULL;
  6338. strm_.opaque = Z_NULL;
  6339. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6340. Z_DEFAULT_STRATEGY) == Z_OK;
  6341. }
  6342. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6343. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6344. bool last, Callback callback) {
  6345. assert(is_valid_);
  6346. do {
  6347. constexpr size_t max_avail_in =
  6348. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6349. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6350. (std::min)(data_length, max_avail_in));
  6351. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6352. data_length -= strm_.avail_in;
  6353. data += strm_.avail_in;
  6354. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6355. auto ret = Z_OK;
  6356. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6357. do {
  6358. strm_.avail_out = static_cast<uInt>(buff.size());
  6359. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6360. ret = deflate(&strm_, flush);
  6361. if (ret == Z_STREAM_ERROR) { return false; }
  6362. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6363. return false;
  6364. }
  6365. } while (strm_.avail_out == 0);
  6366. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6367. (flush == Z_NO_FLUSH && ret == Z_OK));
  6368. assert(strm_.avail_in == 0);
  6369. } while (data_length > 0);
  6370. return true;
  6371. }
  6372. inline gzip_decompressor::gzip_decompressor() {
  6373. std::memset(&strm_, 0, sizeof(strm_));
  6374. strm_.zalloc = Z_NULL;
  6375. strm_.zfree = Z_NULL;
  6376. strm_.opaque = Z_NULL;
  6377. // 15 is the value of wbits, which should be at the maximum possible value
  6378. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6379. // that the stream type should be automatically detected either gzip or
  6380. // deflate.
  6381. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6382. }
  6383. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6384. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6385. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6386. Callback callback) {
  6387. assert(is_valid_);
  6388. auto ret = Z_OK;
  6389. do {
  6390. constexpr size_t max_avail_in =
  6391. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6392. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6393. (std::min)(data_length, max_avail_in));
  6394. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6395. data_length -= strm_.avail_in;
  6396. data += strm_.avail_in;
  6397. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6398. while (strm_.avail_in > 0 && ret == Z_OK) {
  6399. strm_.avail_out = static_cast<uInt>(buff.size());
  6400. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6401. ret = inflate(&strm_, Z_NO_FLUSH);
  6402. assert(ret != Z_STREAM_ERROR);
  6403. switch (ret) {
  6404. case Z_NEED_DICT:
  6405. case Z_DATA_ERROR:
  6406. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6407. }
  6408. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6409. return false;
  6410. }
  6411. }
  6412. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6413. } while (data_length > 0);
  6414. return true;
  6415. }
  6416. #endif
  6417. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6418. inline brotli_compressor::brotli_compressor() {
  6419. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6420. }
  6421. inline brotli_compressor::~brotli_compressor() {
  6422. BrotliEncoderDestroyInstance(state_);
  6423. }
  6424. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6425. bool last, Callback callback) {
  6426. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6427. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6428. auto available_in = data_length;
  6429. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6430. for (;;) {
  6431. if (last) {
  6432. if (BrotliEncoderIsFinished(state_)) { break; }
  6433. } else {
  6434. if (!available_in) { break; }
  6435. }
  6436. auto available_out = buff.size();
  6437. auto next_out = buff.data();
  6438. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6439. &available_out, &next_out, nullptr)) {
  6440. return false;
  6441. }
  6442. auto output_bytes = buff.size() - available_out;
  6443. if (output_bytes) {
  6444. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6445. }
  6446. }
  6447. return true;
  6448. }
  6449. inline brotli_decompressor::brotli_decompressor() {
  6450. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6451. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6452. : BROTLI_DECODER_RESULT_ERROR;
  6453. }
  6454. inline brotli_decompressor::~brotli_decompressor() {
  6455. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6456. }
  6457. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6458. inline bool brotli_decompressor::decompress(const char *data,
  6459. size_t data_length,
  6460. Callback callback) {
  6461. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6462. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6463. return 0;
  6464. }
  6465. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6466. size_t avail_in = data_length;
  6467. size_t total_out;
  6468. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6469. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6470. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6471. char *next_out = buff.data();
  6472. size_t avail_out = buff.size();
  6473. decoder_r = BrotliDecoderDecompressStream(
  6474. decoder_s, &avail_in, &next_in, &avail_out,
  6475. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6476. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6477. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6478. }
  6479. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6480. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6481. }
  6482. #endif
  6483. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6484. inline zstd_compressor::zstd_compressor() {
  6485. ctx_ = ZSTD_createCCtx();
  6486. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6487. }
  6488. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6489. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6490. bool last, Callback callback) {
  6491. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6492. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6493. ZSTD_inBuffer input = {data, data_length, 0};
  6494. bool finished;
  6495. do {
  6496. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6497. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6498. if (ZSTD_isError(remaining)) { return false; }
  6499. if (!callback(buff.data(), output.pos)) { return false; }
  6500. finished = last ? (remaining == 0) : (input.pos == input.size);
  6501. } while (!finished);
  6502. return true;
  6503. }
  6504. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6505. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6506. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6507. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6508. Callback callback) {
  6509. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6510. ZSTD_inBuffer input = {data, data_length, 0};
  6511. while (input.pos < input.size) {
  6512. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6513. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6514. if (ZSTD_isError(remaining)) { return false; }
  6515. if (!callback(buff.data(), output.pos)) { return false; }
  6516. }
  6517. return true;
  6518. }
  6519. #endif
  6520. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6521. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6522. // unknown coding, and its payload would be handed back still compressed.
  6523. inline bool is_zlib_encoding(const std::string &encoding) {
  6524. return case_ignore::equal(encoding, "gzip") ||
  6525. case_ignore::equal(encoding, "deflate");
  6526. }
  6527. inline bool is_brotli_encoding(const std::string &encoding) {
  6528. return case_ignore::equal(encoding, "br");
  6529. }
  6530. inline bool is_zstd_encoding(const std::string &encoding) {
  6531. return case_ignore::equal(encoding, "zstd");
  6532. }
  6533. // Returns true if the content coding is one cpp-httplib is able to decompress
  6534. // when the corresponding support is compiled in.
  6535. inline bool is_known_content_encoding(const std::string &encoding) {
  6536. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6537. is_zstd_encoding(encoding);
  6538. }
  6539. inline std::unique_ptr<decompressor>
  6540. create_decompressor(const std::string &encoding) {
  6541. std::unique_ptr<decompressor> decompressor;
  6542. if (is_zlib_encoding(encoding)) {
  6543. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6544. decompressor = detail::make_unique<gzip_decompressor>();
  6545. #endif
  6546. } else if (is_brotli_encoding(encoding)) {
  6547. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6548. decompressor = detail::make_unique<brotli_decompressor>();
  6549. #endif
  6550. } else if (is_zstd_encoding(encoding)) {
  6551. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6552. decompressor = detail::make_unique<zstd_decompressor>();
  6553. #endif
  6554. }
  6555. return decompressor;
  6556. }
  6557. // Returns the best available compressor and its Content-Encoding name.
  6558. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6559. inline std::pair<std::unique_ptr<compressor>, const char *>
  6560. create_compressor() {
  6561. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6562. return {detail::make_unique<brotli_compressor>(), "br"};
  6563. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6564. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6565. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6566. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6567. #else
  6568. return {nullptr, nullptr};
  6569. #endif
  6570. }
  6571. inline bool is_prohibited_header_name(const std::string &name) {
  6572. using udl::operator""_t;
  6573. switch (str2tag(name)) {
  6574. case "REMOTE_ADDR"_t:
  6575. case "REMOTE_PORT"_t:
  6576. case "LOCAL_ADDR"_t:
  6577. case "LOCAL_PORT"_t: return true;
  6578. default: return false;
  6579. }
  6580. }
  6581. inline bool has_header(const Headers &headers, const std::string &key) {
  6582. if (is_prohibited_header_name(key)) { return false; }
  6583. return headers.find(key) != headers.end();
  6584. }
  6585. inline const char *get_header_value(const Headers &headers,
  6586. const std::string &key, const char *def,
  6587. size_t id) {
  6588. if (is_prohibited_header_name(key)) {
  6589. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6590. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6591. throw std::invalid_argument(msg);
  6592. #else
  6593. return "";
  6594. #endif
  6595. }
  6596. auto rng = headers.equal_range(key);
  6597. auto it = rng.first;
  6598. std::advance(it, static_cast<ssize_t>(id));
  6599. if (it != rng.second) { return it->second.c_str(); }
  6600. return def;
  6601. }
  6602. inline size_t get_header_value_count(const Headers &headers,
  6603. const std::string &key) {
  6604. return headers.count(key);
  6605. }
  6606. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6607. // list may be sent as several field lines, and the combined field value is
  6608. // those values joined by commas in the order they were received. Callers that
  6609. // parse such a list must work on the combined value; reading only the first
  6610. // occurrence silently drops whatever the later field lines carry.
  6611. inline std::string get_combined_header_value(const Headers &headers,
  6612. const std::string &key) {
  6613. std::string combined;
  6614. auto rng = headers.equal_range(key);
  6615. for (auto it = rng.first; it != rng.second; ++it) {
  6616. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6617. // elements, so an empty field line must not contribute a bare comma to the
  6618. // combined value.
  6619. if (it->second.empty()) { continue; }
  6620. if (!combined.empty()) { combined += ", "; }
  6621. combined += it->second;
  6622. }
  6623. return combined;
  6624. }
  6625. inline bool has_header_token(const Headers &headers, const std::string &key,
  6626. const std::string &token) {
  6627. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6628. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6629. // several lines. Match complete tokens rather than searching the raw value,
  6630. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6631. auto rng = headers.equal_range(key);
  6632. for (auto it = rng.first; it != rng.second; ++it) {
  6633. const auto &value = it->second;
  6634. if (split_find(value.data(), value.data() + value.size(), ',',
  6635. [&](const char *b, const char *e) {
  6636. return case_ignore::equal(std::string(b, e), token);
  6637. })) {
  6638. return true;
  6639. }
  6640. }
  6641. return false;
  6642. }
  6643. template <typename Map>
  6644. inline typename Map::mapped_type
  6645. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6646. auto rng = m.equal_range(key);
  6647. auto it = rng.first;
  6648. std::advance(it, static_cast<ssize_t>(id));
  6649. if (it != rng.second) { return it->second; }
  6650. return typename Map::mapped_type();
  6651. }
  6652. inline void set_header(Headers &headers, const std::string &key,
  6653. const std::string &val) {
  6654. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6655. }
  6656. inline bool read_headers(Stream &strm, Headers &headers) {
  6657. const auto bufsiz = 2048;
  6658. char buf[bufsiz];
  6659. stream_line_reader line_reader(strm, buf, bufsiz);
  6660. size_t header_count = 0;
  6661. for (;;) {
  6662. if (!line_reader.getline()) { return false; }
  6663. // Check if the line ends with CRLF.
  6664. auto line_terminator_len = 2;
  6665. if (line_reader.end_with_crlf()) {
  6666. // Blank line indicates end of headers.
  6667. if (line_reader.size() == 2) { break; }
  6668. } else {
  6669. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6670. // Blank line indicates end of headers.
  6671. if (line_reader.size() == 1) { break; }
  6672. line_terminator_len = 1;
  6673. #else
  6674. continue; // Skip invalid line.
  6675. #endif
  6676. }
  6677. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6678. // Check header count limit
  6679. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6680. // Exclude line terminator
  6681. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6682. if (!parse_header(line_reader.ptr(), end,
  6683. [&](const std::string &key, const std::string &val) {
  6684. headers.emplace(key, val);
  6685. })) {
  6686. return false;
  6687. }
  6688. header_count++;
  6689. }
  6690. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6691. // headers that have different values to prevent request smuggling.
  6692. auto cl_range = headers.equal_range("Content-Length");
  6693. if (cl_range.first != cl_range.second) {
  6694. const auto &first_val = cl_range.first->second;
  6695. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6696. if (it->second != first_val) { return false; }
  6697. }
  6698. }
  6699. return true;
  6700. }
  6701. inline bool parse_status_line(const char *line, std::string &version,
  6702. int &status, std::string &reason) {
  6703. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6704. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6705. #else
  6706. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6707. #endif
  6708. std::cmatch m;
  6709. if (!std::regex_match(line, m, re)) { return false; }
  6710. version = std::string(m[1]);
  6711. status = std::stoi(std::string(m[2]));
  6712. reason = std::string(m[3]);
  6713. return true;
  6714. }
  6715. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6716. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6717. struct WebSocketUpgradeResponse {
  6718. Error error = Error::Success;
  6719. int status = -1;
  6720. Headers headers;
  6721. std::string selected_subprotocol;
  6722. };
  6723. inline bool read_websocket_upgrade_response(Stream &strm,
  6724. const std::string &expected_accept,
  6725. WebSocketUpgradeResponse &upgrade) {
  6726. // Read status line
  6727. const auto bufsiz = 2048;
  6728. char buf[bufsiz];
  6729. stream_line_reader line_reader(strm, buf, bufsiz);
  6730. if (!line_reader.getline()) {
  6731. upgrade.error = Error::Read;
  6732. return false;
  6733. }
  6734. std::string version;
  6735. std::string reason;
  6736. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6737. upgrade.error = Error::WebSocketHandshake;
  6738. return false;
  6739. }
  6740. // Read the headers even for a rejection so the caller can see why the
  6741. // server refused the upgrade. A non-101 response may carry a body; it is
  6742. // deliberately left unread since the caller closes the socket right away.
  6743. if (!read_headers(strm, upgrade.headers)) {
  6744. upgrade.error = Error::Read;
  6745. return false;
  6746. }
  6747. const auto &headers = upgrade.headers;
  6748. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6749. upgrade.error = Error::WebSocketHandshake;
  6750. return false;
  6751. }
  6752. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6753. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6754. upgrade.error = Error::WebSocketHandshake;
  6755. return false;
  6756. }
  6757. // Verify Connection: Upgrade
  6758. if (!has_header_token(headers, "Connection", "upgrade")) {
  6759. upgrade.error = Error::WebSocketHandshake;
  6760. return false;
  6761. }
  6762. // Verify Sec-WebSocket-Accept header value
  6763. auto it = headers.find("Sec-WebSocket-Accept");
  6764. if (it == headers.end() || it->second != expected_accept) {
  6765. upgrade.error = Error::WebSocketHandshake;
  6766. return false;
  6767. }
  6768. // Extract negotiated subprotocol
  6769. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6770. if (proto_it != headers.end()) {
  6771. upgrade.selected_subprotocol = proto_it->second;
  6772. }
  6773. return true;
  6774. }
  6775. enum class ReadContentResult {
  6776. Success, // Successfully read the content
  6777. PayloadTooLarge, // The content exceeds the specified payload limit
  6778. Error // An error occurred while reading the content
  6779. };
  6780. inline ReadContentResult read_content_with_length(
  6781. Stream &strm, size_t len, DownloadProgress progress,
  6782. ContentReceiverWithProgress out,
  6783. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6784. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6785. detail::BodyReader br;
  6786. br.stream = &strm;
  6787. br.has_content_length = true;
  6788. br.content_length = len;
  6789. br.payload_max_length = payload_max_length;
  6790. br.chunked = false;
  6791. br.bytes_read = 0;
  6792. br.last_error = Error::Success;
  6793. size_t r = 0;
  6794. while (r < len) {
  6795. auto read_len = static_cast<size_t>(len - r);
  6796. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6797. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6798. if (n <= 0) {
  6799. // Check if it was a payload size error
  6800. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6801. return ReadContentResult::PayloadTooLarge;
  6802. }
  6803. return ReadContentResult::Error;
  6804. }
  6805. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6806. return ReadContentResult::Error;
  6807. }
  6808. r += static_cast<size_t>(n);
  6809. if (progress) {
  6810. if (!progress(r, len)) { return ReadContentResult::Error; }
  6811. }
  6812. }
  6813. return ReadContentResult::Success;
  6814. }
  6815. inline ReadContentResult
  6816. read_content_without_length(Stream &strm, size_t payload_max_length,
  6817. ContentReceiverWithProgress out) {
  6818. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6819. size_t r = 0;
  6820. for (;;) {
  6821. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6822. if (n == 0) { return ReadContentResult::Success; }
  6823. if (n < 0) { return ReadContentResult::Error; }
  6824. // Check if adding this data would exceed the payload limit
  6825. if (r > payload_max_length ||
  6826. payload_max_length - r < static_cast<size_t>(n)) {
  6827. return ReadContentResult::PayloadTooLarge;
  6828. }
  6829. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6830. return ReadContentResult::Error;
  6831. }
  6832. r += static_cast<size_t>(n);
  6833. }
  6834. return ReadContentResult::Success;
  6835. }
  6836. template <typename T>
  6837. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6838. size_t payload_max_length,
  6839. ContentReceiverWithProgress out) {
  6840. detail::ChunkedDecoder dec(strm);
  6841. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6842. size_t total_len = 0;
  6843. for (;;) {
  6844. size_t chunk_offset = 0;
  6845. size_t chunk_total = 0;
  6846. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6847. if (n < 0) { return ReadContentResult::Error; }
  6848. if (n == 0) {
  6849. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6850. return ReadContentResult::Error;
  6851. }
  6852. return ReadContentResult::Success;
  6853. }
  6854. if (total_len > payload_max_length ||
  6855. payload_max_length - total_len < static_cast<size_t>(n)) {
  6856. return ReadContentResult::PayloadTooLarge;
  6857. }
  6858. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6859. return ReadContentResult::Error;
  6860. }
  6861. total_len += static_cast<size_t>(n);
  6862. }
  6863. }
  6864. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6865. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6866. // is the final transfer coding. A single field value may list several
  6867. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6868. // several Transfer-Encoding lines, which combine into one comma-separated
  6869. // list in the order the lines were received. Headers preserves that order,
  6870. // so the final coding is the last token of the last line. Match it
  6871. // case-insensitively rather than comparing the whole value against
  6872. // "chunked".
  6873. //
  6874. // Security: reading a chunked message as unframed leaves its body in the
  6875. // socket, where a keep-alive connection parses it as a smuggled request.
  6876. // Server::process_request() answers 400 and closes when the final coding is
  6877. // not chunked, so a request whose framing cannot be determined never
  6878. // reaches the "no body" path.
  6879. auto rng = headers.equal_range("Transfer-Encoding");
  6880. if (rng.first == rng.second) { return false; }
  6881. // Cleared per line, so a trailing line carrying no coding at all leaves the
  6882. // combined list ending in nothing rather than inheriting the line before it.
  6883. std::string last_coding;
  6884. for (auto it = rng.first; it != rng.second; ++it) {
  6885. const auto &value = it->second;
  6886. last_coding.clear();
  6887. split(value.data(), value.data() + value.size(), ',',
  6888. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  6889. }
  6890. return case_ignore::equal(last_coding, "chunked");
  6891. }
  6892. template <typename T, typename U>
  6893. bool prepare_content_receiver(T &x, int &status,
  6894. ContentReceiverWithProgress receiver,
  6895. bool decompress, size_t payload_max_length,
  6896. bool &exceed_payload_max_length, U callback) {
  6897. if (decompress) {
  6898. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  6899. std::unique_ptr<decompressor> decompressor;
  6900. if (!encoding.empty()) {
  6901. // A coding we know about but were not built with is an error. An
  6902. // unrecognized coding (including "identity") is left alone and the
  6903. // payload is passed through as-is, since some servers misuse the header,
  6904. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  6905. decompressor = detail::create_decompressor(encoding);
  6906. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  6907. status = StatusCode::UnsupportedMediaType_415;
  6908. return false;
  6909. }
  6910. }
  6911. if (decompressor) {
  6912. if (decompressor->is_valid()) {
  6913. size_t decompressed_size = 0;
  6914. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  6915. size_t off, size_t len) {
  6916. return decompressor->decompress(
  6917. buf, n, [&](const char *buf2, size_t n2) {
  6918. // Guard against zip-bomb: check
  6919. // decompressed size against limit.
  6920. if (payload_max_length > 0 &&
  6921. (decompressed_size >= payload_max_length ||
  6922. n2 > payload_max_length - decompressed_size)) {
  6923. exceed_payload_max_length = true;
  6924. return false;
  6925. }
  6926. decompressed_size += n2;
  6927. return receiver(buf2, n2, off, len);
  6928. });
  6929. };
  6930. return callback(std::move(out));
  6931. } else {
  6932. status = StatusCode::InternalServerError_500;
  6933. return false;
  6934. }
  6935. }
  6936. }
  6937. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  6938. size_t len) {
  6939. return receiver(buf, n, off, len);
  6940. };
  6941. return callback(std::move(out));
  6942. }
  6943. template <typename T>
  6944. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  6945. DownloadProgress progress,
  6946. ContentReceiverWithProgress receiver, bool decompress) {
  6947. bool exceed_payload_max_length = false;
  6948. return prepare_content_receiver(
  6949. x, status, std::move(receiver), decompress, payload_max_length,
  6950. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  6951. auto ret = true;
  6952. // Note: exceed_payload_max_length may also be set by the decompressor
  6953. // wrapper in prepare_content_receiver when the decompressed payload
  6954. // size exceeds the limit.
  6955. if (is_chunked_transfer_encoding(x.headers)) {
  6956. auto result = read_content_chunked(strm, x, payload_max_length, out);
  6957. if (result == ReadContentResult::Success) {
  6958. ret = true;
  6959. } else if (result == ReadContentResult::PayloadTooLarge) {
  6960. exceed_payload_max_length = true;
  6961. ret = false;
  6962. } else {
  6963. ret = false;
  6964. }
  6965. } else if (!has_header(x.headers, "Content-Length")) {
  6966. auto result =
  6967. read_content_without_length(strm, payload_max_length, out);
  6968. if (result == ReadContentResult::Success) {
  6969. ret = true;
  6970. } else if (result == ReadContentResult::PayloadTooLarge) {
  6971. exceed_payload_max_length = true;
  6972. ret = false;
  6973. } else {
  6974. ret = false;
  6975. }
  6976. } else {
  6977. auto is_invalid_value = false;
  6978. auto len = get_header_value_u64(x.headers, "Content-Length",
  6979. (std::numeric_limits<size_t>::max)(),
  6980. 0, is_invalid_value);
  6981. if (is_invalid_value) {
  6982. ret = false;
  6983. } else if (len > 0) {
  6984. auto result = read_content_with_length(
  6985. strm, len, std::move(progress), out, payload_max_length);
  6986. ret = (result == ReadContentResult::Success);
  6987. if (result == ReadContentResult::PayloadTooLarge) {
  6988. exceed_payload_max_length = true;
  6989. }
  6990. }
  6991. }
  6992. if (!ret) {
  6993. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  6994. : StatusCode::BadRequest_400;
  6995. }
  6996. return ret;
  6997. });
  6998. }
  6999. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7000. const std::string &path) {
  7001. // A request target must not carry CR/LF (or other control octets); otherwise
  7002. // a value smuggled into it splits the request line and injects headers or a
  7003. // whole request. The same field-value check already guards header values in
  7004. // check_and_write_headers and the request target in
  7005. // perform_websocket_handshake; apply it here too.
  7006. if (!fields::is_field_value(path)) { return -1; }
  7007. std::string s = method;
  7008. s += ' ';
  7009. s += path;
  7010. s += " HTTP/1.1\r\n";
  7011. return strm.write(s.data(), s.size());
  7012. }
  7013. inline ssize_t write_response_line(Stream &strm, int status) {
  7014. std::string s = "HTTP/1.1 ";
  7015. s += std::to_string(status);
  7016. s += ' ';
  7017. s += httplib::status_message(status);
  7018. s += "\r\n";
  7019. return strm.write(s.data(), s.size());
  7020. }
  7021. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7022. ssize_t write_len = 0;
  7023. for (const auto &x : headers) {
  7024. // Skip fields with invalid names or values to prevent response splitting
  7025. // via CR/LF injection, matching set_header(). The client validates request
  7026. // headers up front in check_and_write_headers, but the server passes
  7027. // res.headers straight to this writer, and res.headers is a public field
  7028. // an application can populate directly with request-derived values.
  7029. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7030. std::string s;
  7031. s = x.first;
  7032. s += ": ";
  7033. s += x.second;
  7034. s += "\r\n";
  7035. auto len = strm.write(s.data(), s.size());
  7036. if (len < 0) { return len; }
  7037. write_len += len;
  7038. }
  7039. auto len = strm.write("\r\n");
  7040. if (len < 0) { return len; }
  7041. write_len += len;
  7042. return write_len;
  7043. }
  7044. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7045. size_t offset = 0;
  7046. while (offset < l) {
  7047. auto length = strm.write(d + offset, l - offset);
  7048. if (length < 0) { return false; }
  7049. offset += static_cast<size_t>(length);
  7050. }
  7051. return true;
  7052. }
  7053. template <typename T>
  7054. inline bool write_content_with_progress(Stream &strm,
  7055. const ContentProvider &content_provider,
  7056. size_t offset, size_t length,
  7057. T is_shutting_down,
  7058. const UploadProgress &upload_progress,
  7059. Error &error) {
  7060. size_t end_offset = offset + length;
  7061. size_t start_offset = offset;
  7062. auto ok = true;
  7063. auto finished = false;
  7064. DataSink data_sink;
  7065. data_sink.write = [&](const char *d, size_t l) -> bool {
  7066. if (ok) {
  7067. if (write_data(strm, d, l)) {
  7068. offset += l;
  7069. if (upload_progress && length > 0) {
  7070. size_t current_written = offset - start_offset;
  7071. if (!upload_progress(current_written, length)) {
  7072. ok = false;
  7073. return false;
  7074. }
  7075. }
  7076. } else {
  7077. ok = false;
  7078. }
  7079. }
  7080. return ok;
  7081. };
  7082. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7083. // The body is framed by `length`, so a provider that reports itself done
  7084. // early has truncated it. Record that and let the short-body check below
  7085. // fail the write, rather than calling the provider again forever.
  7086. data_sink.done = [&]() { finished = true; };
  7087. while (offset < end_offset && !finished && !is_shutting_down()) {
  7088. auto last_offset = offset;
  7089. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7090. error = Error::Write;
  7091. return false;
  7092. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7093. error = Error::Canceled;
  7094. return false;
  7095. } else if (!ok) {
  7096. error = Error::Write;
  7097. return false;
  7098. }
  7099. // A provider that reports success without writing anything and without
  7100. // reporting itself done gets handed the same offset and length again on
  7101. // the next pass, so it would spin here for as long as the peer stays
  7102. // connected. Treat making no progress as a short body, like done() early.
  7103. if (!finished && offset == last_offset) {
  7104. error = Error::Write;
  7105. return false;
  7106. }
  7107. }
  7108. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7109. error = Error::Write;
  7110. return false;
  7111. }
  7112. error = Error::Success;
  7113. return true;
  7114. }
  7115. template <typename T>
  7116. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7117. size_t offset, size_t length, T is_shutting_down,
  7118. Error &error) {
  7119. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7120. is_shutting_down, nullptr, error);
  7121. }
  7122. template <typename T>
  7123. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7124. size_t offset, size_t length,
  7125. const T &is_shutting_down) {
  7126. auto error = Error::Success;
  7127. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7128. error);
  7129. }
  7130. template <typename T>
  7131. inline bool
  7132. write_content_without_length(Stream &strm,
  7133. const ContentProvider &content_provider,
  7134. const T &is_shutting_down) {
  7135. size_t offset = 0;
  7136. auto data_available = true;
  7137. auto ok = true;
  7138. DataSink data_sink;
  7139. data_sink.write = [&](const char *d, size_t l) -> bool {
  7140. if (ok) {
  7141. offset += l;
  7142. if (!write_data(strm, d, l)) { ok = false; }
  7143. }
  7144. return ok;
  7145. };
  7146. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7147. data_sink.done = [&](void) { data_available = false; };
  7148. while (data_available && !is_shutting_down()) {
  7149. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7150. return false;
  7151. } else if (!content_provider(offset, 0, data_sink)) {
  7152. return false;
  7153. } else if (!ok) {
  7154. return false;
  7155. }
  7156. }
  7157. return !data_available; // true only if done() was called, false if shutting
  7158. // down
  7159. }
  7160. // Runs a known-length content provider to completion and compresses what it
  7161. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7162. // by an mmap hands the compressor a pointer straight into the mapping.
  7163. inline bool compress_content_provider(const ContentProvider &content_provider,
  7164. size_t length, compressor &cmp,
  7165. std::string &out) {
  7166. size_t offset = 0;
  7167. auto ok = true;
  7168. auto finished = false;
  7169. DataSink data_sink;
  7170. auto append = [&](const char *data, size_t data_len) {
  7171. out.append(data, data_len);
  7172. return true;
  7173. };
  7174. data_sink.write = [&](const char *d, size_t l) -> bool {
  7175. if (!ok) { return false; }
  7176. offset += l;
  7177. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7178. return ok;
  7179. };
  7180. // The body is framed by `length`, so a provider that reports itself done
  7181. // early has truncated it; the short-body check below turns that into a
  7182. // failure rather than calling the provider again forever.
  7183. data_sink.done = [&]() { finished = true; };
  7184. while (offset < length && !finished) {
  7185. auto prev_offset = offset;
  7186. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7187. return false;
  7188. }
  7189. // No Stream to block on here, so a provider that keeps returning true
  7190. // without writing would spin. Treat a pass that made no progress as a
  7191. // failure.
  7192. if (offset == prev_offset) { return false; }
  7193. }
  7194. if (offset != length) { return false; }
  7195. return cmp.compress(nullptr, 0, true, append);
  7196. }
  7197. // Serves `m` as the response body. `set_content_provider()` clears the coding,
  7198. // so recording it has to come after; keeping both here means a third
  7199. // file-serving path cannot get that order wrong.
  7200. inline void set_file_content_provider(Response &res,
  7201. const std::shared_ptr<mmap> &m,
  7202. const std::string &content_type,
  7203. EncodingType encoding) {
  7204. res.set_content_provider(
  7205. m->size(), content_type,
  7206. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7207. sink.write(m->data() + offset, length);
  7208. return true;
  7209. });
  7210. res.content_coding_ = encoding;
  7211. }
  7212. template <typename T, typename U>
  7213. inline bool
  7214. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7215. const T &is_shutting_down, U &compressor, Error &error) {
  7216. size_t offset = 0;
  7217. auto data_available = true;
  7218. auto ok = true;
  7219. DataSink data_sink;
  7220. data_sink.write = [&](const char *d, size_t l) -> bool {
  7221. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7222. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7223. // zero-length chunk is the terminator, so it must not be emitted here.
  7224. if (ok && l > 0) {
  7225. offset += l;
  7226. std::string payload;
  7227. if (compressor.compress(d, l, false,
  7228. [&](const char *data, size_t data_len) {
  7229. payload.append(data, data_len);
  7230. return true;
  7231. })) {
  7232. if (!payload.empty()) {
  7233. // Emit chunked response header and footer for each chunk
  7234. auto chunk =
  7235. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7236. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7237. }
  7238. } else {
  7239. ok = false;
  7240. }
  7241. }
  7242. return ok;
  7243. };
  7244. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7245. auto done_with_trailer = [&](const Headers *trailer) {
  7246. if (!ok) { return; }
  7247. data_available = false;
  7248. std::string payload;
  7249. if (!compressor.compress(nullptr, 0, true,
  7250. [&](const char *data, size_t data_len) {
  7251. payload.append(data, data_len);
  7252. return true;
  7253. })) {
  7254. ok = false;
  7255. return;
  7256. }
  7257. if (!payload.empty()) {
  7258. // Emit chunked response header and footer for each chunk
  7259. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7260. if (!write_data(strm, chunk.data(), chunk.size())) {
  7261. ok = false;
  7262. return;
  7263. }
  7264. }
  7265. constexpr const char done_marker[] = "0\r\n";
  7266. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7267. // Trailer
  7268. if (trailer) {
  7269. for (const auto &kv : *trailer) {
  7270. // Skip fields with invalid names or values to prevent response
  7271. // splitting via CR/LF injection, matching set_header().
  7272. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7273. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7274. if (!write_data(strm, field_line.data(), field_line.size())) {
  7275. ok = false;
  7276. }
  7277. }
  7278. }
  7279. constexpr const char crlf[] = "\r\n";
  7280. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7281. };
  7282. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7283. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7284. done_with_trailer(&trailer);
  7285. };
  7286. while (data_available && !is_shutting_down()) {
  7287. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7288. error = Error::Write;
  7289. return false;
  7290. } else if (!content_provider(offset, 0, data_sink)) {
  7291. error = Error::Canceled;
  7292. return false;
  7293. } else if (!ok) {
  7294. error = Error::Write;
  7295. return false;
  7296. }
  7297. }
  7298. if (data_available) { // exited due to is_shutting_down(), not done()
  7299. error = Error::Write;
  7300. return false;
  7301. }
  7302. error = Error::Success;
  7303. return true;
  7304. }
  7305. template <typename T, typename U>
  7306. inline bool write_content_chunked(Stream &strm,
  7307. const ContentProvider &content_provider,
  7308. const T &is_shutting_down, U &compressor) {
  7309. auto error = Error::Success;
  7310. return write_content_chunked(strm, content_provider, is_shutting_down,
  7311. compressor, error);
  7312. }
  7313. template <typename T>
  7314. inline bool redirect(T &cli, Request &req, Response &res,
  7315. const std::string &path, const std::string &location,
  7316. Error &error) {
  7317. Request new_req = req;
  7318. new_req.path = path;
  7319. new_req.redirect_count_ -= 1;
  7320. if (res.status == StatusCode::SeeOther_303 &&
  7321. (req.method != "GET" && req.method != "HEAD")) {
  7322. new_req.method = "GET";
  7323. new_req.body.clear();
  7324. new_req.headers.clear();
  7325. }
  7326. Response new_res;
  7327. auto ret = cli.send(new_req, new_res, error);
  7328. if (ret) {
  7329. req = std::move(new_req);
  7330. res = std::move(new_res);
  7331. if (res.location.empty()) { res.location = location; }
  7332. }
  7333. return ret;
  7334. }
  7335. inline std::string params_to_query_str(const Params &params) {
  7336. std::string query;
  7337. for (auto it = params.begin(); it != params.end(); ++it) {
  7338. if (it != params.begin()) { query += '&'; }
  7339. query += encode_query_component(it->first);
  7340. query += '=';
  7341. query += encode_query_component(it->second);
  7342. }
  7343. return query;
  7344. }
  7345. // Splits one "key=value" span of a query string at its first '='. A span with
  7346. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7347. // "?flag" keeps its name.
  7348. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7349. std::string &val) {
  7350. divide(b, static_cast<std::size_t>(e - b), '=',
  7351. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7352. std::size_t rhs_size) {
  7353. key.assign(lhs_data, lhs_size);
  7354. val.assign(rhs_data, rhs_size);
  7355. });
  7356. }
  7357. inline void parse_query_text(const char *data, std::size_t size,
  7358. Params &params) {
  7359. std::set<std::string> cache;
  7360. split(data, data + size, '&', [&](const char *b, const char *e) {
  7361. std::string kv(b, e);
  7362. if (cache.find(kv) != cache.end()) { return; }
  7363. cache.insert(std::move(kv));
  7364. std::string key;
  7365. std::string val;
  7366. divide_query_pair(b, e, key, val);
  7367. if (!key.empty()) {
  7368. params.emplace(decode_query_component(key), decode_query_component(val));
  7369. }
  7370. });
  7371. }
  7372. inline void parse_query_text(const std::string &s, Params &params) {
  7373. parse_query_text(s.data(), s.size(), params);
  7374. }
  7375. // Normalize a query string by decoding and re-encoding each key/value pair
  7376. // while preserving the original parameter order. This avoids double-encoding
  7377. // and ensures consistent encoding. It works on the raw string rather than
  7378. // parsing into Params and re-serializing, because that round trip cannot
  7379. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7380. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7381. // duplicated pairs.
  7382. inline std::string normalize_query_string(const std::string &query) {
  7383. std::string result;
  7384. split(query.data(), query.data() + query.size(), '&',
  7385. [&](const char *b, const char *e) {
  7386. std::string key;
  7387. std::string val;
  7388. divide_query_pair(b, e, key, val);
  7389. if (!key.empty()) {
  7390. auto dec_key = decode_query_component(key);
  7391. auto dec_val = decode_query_component(val);
  7392. if (!result.empty()) { result += '&'; }
  7393. result += encode_query_component(dec_key);
  7394. if (!val.empty() || std::find(b, e, '=') != e) {
  7395. result += '=';
  7396. result += encode_query_component(dec_val);
  7397. }
  7398. }
  7399. });
  7400. return result;
  7401. }
  7402. // Build the request target that goes on the wire from a caller-supplied path.
  7403. // Shared by the buffered send path and the streaming API so that both put the
  7404. // same bytes in the request line for the same input.
  7405. inline std::string encode_request_target(const std::string &target,
  7406. bool path_encode) {
  7407. // `substr(0, npos)` yields the whole string, which is what the no-query
  7408. // case needs.
  7409. auto query_pos = target.find('?');
  7410. auto path_part = target.substr(0, query_pos);
  7411. std::string query_part;
  7412. if (query_pos != std::string::npos) {
  7413. query_part = target.substr(query_pos + 1);
  7414. }
  7415. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7416. if (!query_part.empty()) {
  7417. // When path encoding is disabled the caller has supplied an already-encoded
  7418. // target and expects the exact bytes to be sent on the wire, so skip
  7419. // normalization for the query too. Normalizing would decode-then-re-encode
  7420. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7421. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7422. if (path_encode) {
  7423. auto normalized = normalize_query_string(query_part);
  7424. if (!normalized.empty()) {
  7425. result += '?';
  7426. result += normalized;
  7427. }
  7428. } else {
  7429. result += '?';
  7430. result += query_part;
  7431. }
  7432. }
  7433. return result;
  7434. }
  7435. inline bool parse_multipart_boundary(const std::string &content_type,
  7436. std::string &boundary) {
  7437. std::map<std::string, std::string> params;
  7438. extract_media_type(content_type, &params);
  7439. auto it = params.find("boundary");
  7440. if (it == params.end()) { return false; }
  7441. boundary = it->second;
  7442. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7443. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7444. // bytes costs a nearly full comparison at nearly every position: the
  7445. // boundary's length multiplies the worst-case cost of scanning a body.
  7446. return !boundary.empty() && boundary.size() <= 70;
  7447. }
  7448. inline void parse_disposition_params(const std::string &s, Params &params) {
  7449. std::set<std::string> cache;
  7450. split_unquoted(s.data(), s.data() + s.size(), ';',
  7451. [&](const char *b, const char *e) {
  7452. std::string kv(b, e);
  7453. if (cache.find(kv) != cache.end()) { return; }
  7454. cache.insert(kv);
  7455. std::string key;
  7456. std::string val;
  7457. divide_param_pair(b, e, key, val);
  7458. if (!key.empty()) {
  7459. params.emplace(trim_double_quotes_copy(key),
  7460. trim_double_quotes_copy(val));
  7461. }
  7462. });
  7463. }
  7464. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7465. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7466. #else
  7467. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7468. #endif
  7469. auto is_valid = [](const std::string &str) {
  7470. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7471. };
  7472. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7473. const auto pos = static_cast<size_t>(6);
  7474. const auto len = static_cast<size_t>(s.size() - 6);
  7475. auto all_valid_ranges = true;
  7476. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7477. if (!all_valid_ranges) { return; }
  7478. const auto it = std::find(b, e, '-');
  7479. if (it == e) {
  7480. all_valid_ranges = false;
  7481. return;
  7482. }
  7483. const auto lhs = std::string(b, it);
  7484. const auto rhs = std::string(it + 1, e);
  7485. if (!is_valid(lhs) || !is_valid(rhs)) {
  7486. all_valid_ranges = false;
  7487. return;
  7488. }
  7489. ssize_t first = -1;
  7490. if (!lhs.empty()) {
  7491. ssize_t v;
  7492. auto res = detail::from_chars(lhs.data(), lhs.data() + lhs.size(), v);
  7493. if (res.ec == std::errc{}) { first = v; }
  7494. }
  7495. ssize_t last = -1;
  7496. if (!rhs.empty()) {
  7497. ssize_t v;
  7498. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7499. if (res.ec == std::errc{}) { last = v; }
  7500. }
  7501. if ((first == -1 && last == -1) ||
  7502. (first != -1 && last != -1 && first > last)) {
  7503. all_valid_ranges = false;
  7504. return;
  7505. }
  7506. ranges.emplace_back(first, last);
  7507. });
  7508. return all_valid_ranges && !ranges.empty();
  7509. }
  7510. return false;
  7511. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7512. }
  7513. #else
  7514. } catch (...) { return false; }
  7515. #endif
  7516. inline bool parse_accept_header(const std::string &s,
  7517. std::vector<std::string> &content_types) {
  7518. content_types.clear();
  7519. // Empty string is considered valid (no preference)
  7520. if (s.empty()) { return true; }
  7521. struct AcceptEntry {
  7522. std::string media_type;
  7523. double quality;
  7524. int order;
  7525. };
  7526. std::vector<AcceptEntry> entries;
  7527. int order = 0;
  7528. bool has_invalid_entry = false;
  7529. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7530. // has to parse and ignore empty list elements, so a leading, trailing or
  7531. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7532. // split() skips them, and the header length limit bounds how many a sender
  7533. // can send, so ignoring all of them cannot be used as a denial-of-service
  7534. // vector.
  7535. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7536. std::string entry(b, e);
  7537. entry = trim_copy(entry);
  7538. AcceptEntry accept_entry;
  7539. accept_entry.order = order++;
  7540. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7541. accept_entry.media_type, accept_entry.quality)) {
  7542. has_invalid_entry = true;
  7543. return;
  7544. }
  7545. // Remove additional parameters from media type
  7546. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7547. // Basic validation of media type format
  7548. if (accept_entry.media_type.empty()) {
  7549. has_invalid_entry = true;
  7550. return;
  7551. }
  7552. // Check for basic media type format (should contain '/' or be '*')
  7553. if (accept_entry.media_type != "*" &&
  7554. accept_entry.media_type.find('/') == std::string::npos) {
  7555. has_invalid_entry = true;
  7556. return;
  7557. }
  7558. entries.push_back(std::move(accept_entry));
  7559. });
  7560. // Return false if any invalid entry was found
  7561. if (has_invalid_entry) { return false; }
  7562. // Sort by quality (descending), then by original order (ascending)
  7563. std::sort(entries.begin(), entries.end(),
  7564. [](const AcceptEntry &a, const AcceptEntry &b) {
  7565. if (a.quality != b.quality) {
  7566. return a.quality > b.quality; // Higher quality first
  7567. }
  7568. return a.order < b.order; // Earlier order first for same quality
  7569. });
  7570. // Extract sorted media types
  7571. content_types.reserve(entries.size());
  7572. for (auto &entry : entries) {
  7573. content_types.push_back(std::move(entry.media_type));
  7574. }
  7575. return true;
  7576. }
  7577. class FormDataParser {
  7578. public:
  7579. FormDataParser() = default;
  7580. void set_boundary(std::string &&boundary) {
  7581. boundary_ = std::move(boundary);
  7582. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7583. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7584. }
  7585. bool is_valid() const { return is_valid_; }
  7586. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7587. const ContentReceiver &content_callback) {
  7588. // Once the close delimiter has been seen the rest of the body is epilogue
  7589. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7590. // spread across reads is not copied in only to be erased right away.
  7591. if (state_ == 5) { return true; }
  7592. buf_append(buf, n);
  7593. while (buf_size() > 0) {
  7594. switch (state_) {
  7595. case 0: { // Initial boundary
  7596. auto pos = buf_find(dash_boundary_crlf_);
  7597. if (pos == buf_size()) {
  7598. // Not found yet: keep only a possible partial boundary at the tail so
  7599. // that a body which never contains the boundary cannot grow the
  7600. // buffer (and get rescanned from the start) without bound.
  7601. auto keep = dash_boundary_crlf_.size() - 1;
  7602. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7603. return true;
  7604. }
  7605. buf_erase(pos + dash_boundary_crlf_.size());
  7606. state_ = 1;
  7607. break;
  7608. }
  7609. case 1: { // New entry
  7610. clear_file_info();
  7611. state_ = 2;
  7612. break;
  7613. }
  7614. case 2: { // Headers
  7615. auto pos = buf_find(crlf_);
  7616. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7617. while (pos < buf_size()) {
  7618. // Empty line
  7619. if (pos == 0) {
  7620. if (!header_callback(file_)) {
  7621. is_valid_ = false;
  7622. return false;
  7623. }
  7624. buf_erase(crlf_.size());
  7625. state_ = 3;
  7626. break;
  7627. }
  7628. // Check header count limit
  7629. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7630. is_valid_ = false;
  7631. return false;
  7632. }
  7633. header_count_++;
  7634. const auto header = buf_head(pos);
  7635. if (!parse_header(header.data(), header.data() + header.size(),
  7636. [&](const std::string &, const std::string &) {})) {
  7637. is_valid_ = false;
  7638. return false;
  7639. }
  7640. // Parse and emplace space trimmed headers into a map
  7641. if (!parse_header(
  7642. header.data(), header.data() + header.size(),
  7643. [&](const std::string &key, const std::string &val) {
  7644. file_.headers.emplace(key, val);
  7645. })) {
  7646. is_valid_ = false;
  7647. return false;
  7648. }
  7649. constexpr const char header_content_type[] = "Content-Type:";
  7650. if (start_with_case_ignore(header, header_content_type)) {
  7651. file_.content_type =
  7652. trim_copy(header.substr(str_len(header_content_type)));
  7653. } else {
  7654. std::string disposition_params;
  7655. if (parse_content_disposition(header, disposition_params)) {
  7656. Params params;
  7657. parse_disposition_params(disposition_params, params);
  7658. auto it = params.find("name");
  7659. if (it != params.end()) {
  7660. file_.name = it->second;
  7661. } else {
  7662. is_valid_ = false;
  7663. return false;
  7664. }
  7665. it = params.find("filename");
  7666. if (it != params.end()) { file_.filename = it->second; }
  7667. it = params.find("filename*");
  7668. if (it != params.end()) {
  7669. // RFC 5987: only UTF-8 encoding is allowed
  7670. const auto &val = it->second;
  7671. constexpr const char utf8_prefix[] = "UTF-8''";
  7672. constexpr size_t prefix_len = str_len(utf8_prefix);
  7673. if (val.size() > prefix_len &&
  7674. start_with_case_ignore(val, utf8_prefix)) {
  7675. file_.filename = decode_path_component(
  7676. val.substr(prefix_len)); // override...
  7677. } else {
  7678. is_valid_ = false;
  7679. return false;
  7680. }
  7681. }
  7682. }
  7683. }
  7684. buf_erase(pos + crlf_.size());
  7685. pos = buf_find(crlf_);
  7686. }
  7687. if (state_ != 3) { return true; }
  7688. break;
  7689. }
  7690. case 3: { // Body
  7691. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7692. auto pos = buf_find(crlf_dash_boundary_);
  7693. if (pos < buf_size()) {
  7694. if (!content_callback(buf_data(), pos)) {
  7695. is_valid_ = false;
  7696. return false;
  7697. }
  7698. buf_erase(pos + crlf_dash_boundary_.size());
  7699. state_ = 4;
  7700. } else {
  7701. auto len = buf_size() - crlf_dash_boundary_.size();
  7702. if (len > 0) {
  7703. if (!content_callback(buf_data(), len)) {
  7704. is_valid_ = false;
  7705. return false;
  7706. }
  7707. buf_erase(len);
  7708. }
  7709. return true;
  7710. }
  7711. break;
  7712. }
  7713. case 4: { // Boundary
  7714. if (crlf_.size() > buf_size()) { return true; }
  7715. if (buf_start_with(crlf_)) {
  7716. buf_erase(crlf_.size());
  7717. state_ = 1;
  7718. } else if (buf_start_with(dash_)) {
  7719. buf_erase(dash_.size());
  7720. is_valid_ = true;
  7721. state_ = 5;
  7722. } else {
  7723. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7724. // accepted after a boundary; RFC 2046 allows transport-padding in
  7725. // between, but this parser has never supported it. Either way the
  7726. // body is already destined to be rejected, so fail now instead of
  7727. // buffering the rest of it. Both are two bytes, so the check above
  7728. // already guarantees enough buffered data to decide.
  7729. is_valid_ = false;
  7730. return false;
  7731. }
  7732. break;
  7733. }
  7734. case 5: { // Epilogue
  7735. buf_erase(buf_size());
  7736. break;
  7737. }
  7738. }
  7739. }
  7740. return true;
  7741. }
  7742. private:
  7743. void clear_file_info() {
  7744. file_.name.clear();
  7745. file_.filename.clear();
  7746. file_.content_type.clear();
  7747. file_.headers.clear();
  7748. header_count_ = 0;
  7749. }
  7750. bool start_with_case_ignore(const std::string &a, const char *b,
  7751. size_t offset = 0) const {
  7752. const auto b_len = strlen(b);
  7753. if (a.size() < offset + b_len) { return false; }
  7754. for (size_t i = 0; i < b_len; i++) {
  7755. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7756. return false;
  7757. }
  7758. }
  7759. return true;
  7760. }
  7761. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7762. // Returns true if header matches, with the params portion in `params_out`.
  7763. bool parse_content_disposition(const std::string &header,
  7764. std::string &params_out) const {
  7765. constexpr const char prefix[] = "Content-Disposition:";
  7766. constexpr size_t prefix_len = str_len(prefix);
  7767. if (!start_with_case_ignore(header, prefix)) { return false; }
  7768. // Skip whitespace after "Content-Disposition:"
  7769. auto pos = prefix_len;
  7770. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7771. pos++;
  7772. }
  7773. // Match "form-data;" (case-insensitive)
  7774. constexpr const char form_data[] = "form-data;";
  7775. constexpr size_t form_data_len = str_len(form_data);
  7776. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7777. pos += form_data_len;
  7778. // Skip whitespace after "form-data;"
  7779. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7780. pos++;
  7781. }
  7782. params_out = header.substr(pos);
  7783. return true;
  7784. }
  7785. const std::string dash_ = "--";
  7786. const std::string crlf_ = "\r\n";
  7787. std::string boundary_;
  7788. std::string dash_boundary_crlf_;
  7789. std::string crlf_dash_boundary_;
  7790. size_t state_ = 0;
  7791. bool is_valid_ = false;
  7792. FormData file_;
  7793. size_t header_count_ = 0;
  7794. // Buffer
  7795. bool start_with(const std::string &a, size_t spos, size_t epos,
  7796. const std::string &b) const {
  7797. if (epos - spos < b.size()) { return false; }
  7798. for (size_t i = 0; i < b.size(); i++) {
  7799. if (a[i + spos] != b[i]) { return false; }
  7800. }
  7801. return true;
  7802. }
  7803. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7804. const char *buf_data() const { return &buf_[buf_spos_]; }
  7805. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7806. bool buf_start_with(const std::string &s) const {
  7807. return start_with(buf_, buf_spos_, buf_epos_, s);
  7808. }
  7809. size_t buf_find(const std::string &s) const {
  7810. auto c = s.front();
  7811. size_t off = buf_spos_;
  7812. while (off < buf_epos_) {
  7813. auto pos = off;
  7814. while (true) {
  7815. if (pos == buf_epos_) { return buf_size(); }
  7816. if (buf_[pos] == c) { break; }
  7817. pos++;
  7818. }
  7819. auto remaining_size = buf_epos_ - pos;
  7820. if (s.size() > remaining_size) { return buf_size(); }
  7821. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7822. off = pos + 1;
  7823. }
  7824. return buf_size();
  7825. }
  7826. void buf_append(const char *data, size_t n) {
  7827. auto remaining_size = buf_size();
  7828. if (remaining_size > 0 && buf_spos_ > 0) {
  7829. for (size_t i = 0; i < remaining_size; i++) {
  7830. buf_[i] = buf_[buf_spos_ + i];
  7831. }
  7832. }
  7833. buf_spos_ = 0;
  7834. buf_epos_ = remaining_size;
  7835. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7836. for (size_t i = 0; i < n; i++) {
  7837. buf_[buf_epos_ + i] = data[i];
  7838. }
  7839. buf_epos_ += n;
  7840. }
  7841. void buf_erase(size_t size) { buf_spos_ += size; }
  7842. std::string buf_;
  7843. size_t buf_spos_ = 0;
  7844. size_t buf_epos_ = 0;
  7845. };
  7846. inline std::string random_string(size_t length) {
  7847. constexpr const char data[] =
  7848. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7849. thread_local auto engine([]() {
  7850. // std::random_device might actually be deterministic on some
  7851. // platforms, but due to lack of support in the c++ standard library,
  7852. // doing better requires either some ugly hacks or breaking portability.
  7853. std::random_device seed_gen;
  7854. // Request 128 bits of entropy for initialization
  7855. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  7856. return std::mt19937(seed_sequence);
  7857. }());
  7858. std::string result;
  7859. for (size_t i = 0; i < length; i++) {
  7860. result += data[engine() % (sizeof(data) - 1)];
  7861. }
  7862. return result;
  7863. }
  7864. inline std::string make_multipart_data_boundary() {
  7865. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  7866. }
  7867. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  7868. auto valid = true;
  7869. for (size_t i = 0; i < boundary.size(); i++) {
  7870. auto c = boundary[i];
  7871. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  7872. valid = false;
  7873. break;
  7874. }
  7875. }
  7876. return valid;
  7877. }
  7878. // Escape a multipart field name/filename following the WHATWG HTML standard
  7879. // ("escape a multipart form-data name"), which is what browsers send:
  7880. // '"' -> %22, CR -> %0D, LF -> %0A
  7881. // With escape_quote = false, only CR and LF are escaped; this is for header
  7882. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  7883. inline std::string escape_multipart_field(const std::string &s,
  7884. bool escape_quote = true) {
  7885. std::string result;
  7886. result.reserve(s.size());
  7887. for (auto c : s) {
  7888. switch (c) {
  7889. case '"':
  7890. if (escape_quote) {
  7891. result += "%22";
  7892. } else {
  7893. result += c;
  7894. }
  7895. break;
  7896. case '\r': result += "%0D"; break;
  7897. case '\n': result += "%0A"; break;
  7898. default: result += c; break;
  7899. }
  7900. }
  7901. return result;
  7902. }
  7903. template <typename T>
  7904. inline std::string
  7905. serialize_multipart_formdata_item_begin(const T &item,
  7906. const std::string &boundary) {
  7907. std::string body = "--" + boundary + "\r\n";
  7908. body += "Content-Disposition: form-data; name=\"" +
  7909. escape_multipart_field(item.name) + "\"";
  7910. if (!item.filename.empty()) {
  7911. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  7912. }
  7913. body += "\r\n";
  7914. if (!item.content_type.empty()) {
  7915. body +=
  7916. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  7917. "\r\n";
  7918. }
  7919. body += "\r\n";
  7920. return body;
  7921. }
  7922. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  7923. inline std::string
  7924. serialize_multipart_formdata_finish(const std::string &boundary) {
  7925. return "--" + boundary + "--\r\n";
  7926. }
  7927. inline std::string
  7928. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  7929. return "multipart/form-data; boundary=" + boundary;
  7930. }
  7931. inline std::string
  7932. serialize_multipart_formdata(const UploadFormDataItems &items,
  7933. const std::string &boundary, bool finish = true) {
  7934. std::string body;
  7935. for (const auto &item : items) {
  7936. body += serialize_multipart_formdata_item_begin(item, boundary);
  7937. body += item.content + serialize_multipart_formdata_item_end();
  7938. }
  7939. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  7940. return body;
  7941. }
  7942. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  7943. const std::string &boundary) {
  7944. size_t total = 0;
  7945. for (const auto &item : items) {
  7946. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  7947. total += item.content.size();
  7948. total += serialize_multipart_formdata_item_end().size();
  7949. }
  7950. total += serialize_multipart_formdata_finish(boundary).size();
  7951. return total;
  7952. }
  7953. struct MultipartSegment {
  7954. const char *data;
  7955. size_t size;
  7956. };
  7957. // NOTE: items must outlive the returned ContentProvider
  7958. // (safe for synchronous use inside Post/Put/Patch)
  7959. inline ContentProvider
  7960. make_multipart_content_provider(const UploadFormDataItems &items,
  7961. const std::string &boundary) {
  7962. // Own the per-item header strings and the finish string
  7963. std::vector<std::string> owned;
  7964. owned.reserve(items.size() + 1);
  7965. for (const auto &item : items)
  7966. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  7967. owned.push_back(serialize_multipart_formdata_finish(boundary));
  7968. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  7969. std::vector<MultipartSegment> segs;
  7970. segs.reserve(items.size() * 3 + 1);
  7971. static const char crlf[] = "\r\n";
  7972. for (size_t i = 0; i < items.size(); i++) {
  7973. segs.push_back({owned[i].data(), owned[i].size()});
  7974. segs.push_back({items[i].content.data(), items[i].content.size()});
  7975. segs.push_back({crlf, 2});
  7976. }
  7977. segs.push_back({owned.back().data(), owned.back().size()});
  7978. struct MultipartState {
  7979. std::vector<std::string> owned;
  7980. std::vector<MultipartSegment> segs;
  7981. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  7982. };
  7983. auto state = std::make_shared<MultipartState>();
  7984. state->owned = std::move(owned);
  7985. // `segs` holds raw pointers into owned strings; std::string move preserves
  7986. // the data pointer, so these pointers remain valid after the move above.
  7987. state->segs = std::move(segs);
  7988. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  7989. // Buffer multiple small segments into fewer, larger writes to avoid
  7990. // excessive TCP packets when there are many form data items (#2410)
  7991. auto &buf = state->buf;
  7992. auto buf_size = buf.size();
  7993. size_t buf_len = 0;
  7994. size_t remaining = length;
  7995. // Find the first segment containing 'offset'
  7996. size_t pos = 0;
  7997. size_t seg_idx = 0;
  7998. for (; seg_idx < state->segs.size(); seg_idx++) {
  7999. const auto &seg = state->segs[seg_idx];
  8000. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8001. pos += seg.size;
  8002. }
  8003. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8004. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8005. const auto &seg = state->segs[seg_idx];
  8006. size_t available = seg.size - seg_offset;
  8007. size_t to_copy = (std::min)(available, remaining);
  8008. const char *src = seg.data + seg_offset;
  8009. seg_offset = 0; // only the first segment has a non-zero offset
  8010. while (to_copy > 0) {
  8011. size_t space = buf_size - buf_len;
  8012. size_t chunk = (std::min)(to_copy, space);
  8013. std::memcpy(buf.data() + buf_len, src, chunk);
  8014. buf_len += chunk;
  8015. src += chunk;
  8016. to_copy -= chunk;
  8017. remaining -= chunk;
  8018. if (buf_len == buf_size) {
  8019. if (!sink.write(buf.data(), buf_len)) { return false; }
  8020. buf_len = 0;
  8021. }
  8022. }
  8023. }
  8024. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8025. return true;
  8026. };
  8027. }
  8028. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8029. if (ranges.size() <= 1) return;
  8030. // Sort ranges by start position
  8031. std::sort(ranges.begin(), ranges.end(),
  8032. [](const Range &a, const Range &b) { return a.first < b.first; });
  8033. Ranges coalesced;
  8034. coalesced.reserve(ranges.size());
  8035. for (auto &r : ranges) {
  8036. auto first_pos = r.first;
  8037. auto last_pos = r.second;
  8038. // Handle special cases like in range_error
  8039. if (first_pos == -1 && last_pos == -1) {
  8040. first_pos = 0;
  8041. last_pos = static_cast<ssize_t>(content_length);
  8042. }
  8043. if (first_pos == -1) {
  8044. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8045. last_pos = static_cast<ssize_t>(content_length) - 1;
  8046. }
  8047. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8048. last_pos = static_cast<ssize_t>(content_length) - 1;
  8049. }
  8050. // Skip invalid ranges
  8051. if (!(0 <= first_pos && first_pos <= last_pos &&
  8052. last_pos < static_cast<ssize_t>(content_length))) {
  8053. continue;
  8054. }
  8055. // Coalesce with previous range if overlapping or adjacent (but not
  8056. // identical)
  8057. if (!coalesced.empty()) {
  8058. auto &prev = coalesced.back();
  8059. // Check if current range overlaps or is adjacent to previous range
  8060. // but don't coalesce identical ranges (allow duplicates)
  8061. if (first_pos <= prev.second + 1 &&
  8062. !(first_pos == prev.first && last_pos == prev.second)) {
  8063. // Extend the previous range
  8064. prev.second = (std::max)(prev.second, last_pos);
  8065. continue;
  8066. }
  8067. }
  8068. // Add new range
  8069. coalesced.emplace_back(first_pos, last_pos);
  8070. }
  8071. ranges = std::move(coalesced);
  8072. }
  8073. inline bool range_error(Request &req, Response &res) {
  8074. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8075. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8076. req.ranges.clear();
  8077. if (res.status == StatusCode::PartialContent_206) {
  8078. res.status = StatusCode::OK_200;
  8079. }
  8080. return false;
  8081. }
  8082. ssize_t content_len = static_cast<ssize_t>(
  8083. res.content_length_ ? res.content_length_ : res.body.size());
  8084. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8085. size_t overwrapping_count = 0;
  8086. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8087. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8088. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8089. // Too many ranges
  8090. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8091. for (auto &r : req.ranges) {
  8092. auto &first_pos = r.first;
  8093. auto &last_pos = r.second;
  8094. if (first_pos == -1 && last_pos == -1) {
  8095. first_pos = 0;
  8096. last_pos = content_len;
  8097. }
  8098. if (first_pos == -1) {
  8099. first_pos = content_len - last_pos;
  8100. last_pos = content_len - 1;
  8101. }
  8102. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8103. // A client can limit the number of bytes requested without knowing the
  8104. // size of the selected representation. If the last-pos value is absent,
  8105. // or if the value is greater than or equal to the current length of the
  8106. // representation data, the byte range is interpreted as the remainder of
  8107. // the representation (i.e., the server replaces the value of last-pos
  8108. // with a value that is one less than the current length of the selected
  8109. // representation).
  8110. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8111. if (last_pos == -1 || last_pos >= content_len) {
  8112. last_pos = content_len - 1;
  8113. }
  8114. // Range must be within content length
  8115. if (!(0 <= first_pos && first_pos <= last_pos &&
  8116. last_pos <= content_len - 1)) {
  8117. return true;
  8118. }
  8119. // Request must not have more than two overlapping ranges
  8120. for (const auto &processed_range : processed_ranges) {
  8121. if (!(last_pos < processed_range.first ||
  8122. first_pos > processed_range.second)) {
  8123. overwrapping_count++;
  8124. if (overwrapping_count > 2) { return true; }
  8125. break; // Only count once per range
  8126. }
  8127. }
  8128. processed_ranges.emplace_back(first_pos, last_pos);
  8129. }
  8130. // After validation, coalesce overlapping ranges as per RFC 9110
  8131. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8132. }
  8133. return false;
  8134. }
  8135. inline std::pair<size_t, size_t>
  8136. get_range_offset_and_length(Range r, size_t content_length) {
  8137. assert(r.first != -1 && r.second != -1);
  8138. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8139. assert(r.first <= r.second &&
  8140. r.second < static_cast<ssize_t>(content_length));
  8141. (void)(content_length);
  8142. return std::make_pair(static_cast<size_t>(r.first),
  8143. static_cast<size_t>(r.second - r.first) + 1);
  8144. }
  8145. inline std::string make_content_range_header_field(
  8146. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8147. auto st = offset_and_length.first;
  8148. auto ed = st + offset_and_length.second - 1;
  8149. std::string field = "bytes ";
  8150. field += std::to_string(st);
  8151. field += '-';
  8152. field += std::to_string(ed);
  8153. field += '/';
  8154. field += std::to_string(content_length);
  8155. return field;
  8156. }
  8157. template <typename SToken, typename CToken, typename Content>
  8158. bool process_multipart_ranges_data(const Request &req,
  8159. const std::string &boundary,
  8160. const std::string &content_type,
  8161. size_t content_length, SToken stoken,
  8162. CToken ctoken, Content content) {
  8163. for (size_t i = 0; i < req.ranges.size(); i++) {
  8164. ctoken("--");
  8165. stoken(boundary);
  8166. ctoken("\r\n");
  8167. if (!content_type.empty()) {
  8168. ctoken("Content-Type: ");
  8169. stoken(content_type);
  8170. ctoken("\r\n");
  8171. }
  8172. auto offset_and_length =
  8173. get_range_offset_and_length(req.ranges[i], content_length);
  8174. ctoken("Content-Range: ");
  8175. stoken(make_content_range_header_field(offset_and_length, content_length));
  8176. ctoken("\r\n");
  8177. ctoken("\r\n");
  8178. if (!content(offset_and_length.first, offset_and_length.second)) {
  8179. return false;
  8180. }
  8181. ctoken("\r\n");
  8182. }
  8183. ctoken("--");
  8184. stoken(boundary);
  8185. ctoken("--");
  8186. return true;
  8187. }
  8188. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8189. const std::string &boundary,
  8190. const std::string &content_type,
  8191. size_t content_length,
  8192. std::string &data) {
  8193. process_multipart_ranges_data(
  8194. req, boundary, content_type, content_length,
  8195. [&](const std::string &token) { data += token; },
  8196. [&](const std::string &token) { data += token; },
  8197. [&](size_t offset, size_t length) {
  8198. assert(offset + length <= content_length);
  8199. data += res.body.substr(offset, length);
  8200. return true;
  8201. });
  8202. }
  8203. inline size_t get_multipart_ranges_data_length(const Request &req,
  8204. const std::string &boundary,
  8205. const std::string &content_type,
  8206. size_t content_length) {
  8207. size_t data_length = 0;
  8208. process_multipart_ranges_data(
  8209. req, boundary, content_type, content_length,
  8210. [&](const std::string &token) { data_length += token.size(); },
  8211. [&](const std::string &token) { data_length += token.size(); },
  8212. [&](size_t /*offset*/, size_t length) {
  8213. data_length += length;
  8214. return true;
  8215. });
  8216. return data_length;
  8217. }
  8218. template <typename T>
  8219. inline bool
  8220. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8221. const std::string &boundary,
  8222. const std::string &content_type,
  8223. size_t content_length, const T &is_shutting_down) {
  8224. return process_multipart_ranges_data(
  8225. req, boundary, content_type, content_length,
  8226. [&](const std::string &token) { strm.write(token); },
  8227. [&](const std::string &token) { strm.write(token); },
  8228. [&](size_t offset, size_t length) {
  8229. return write_content(strm, res.content_provider_, offset, length,
  8230. is_shutting_down);
  8231. });
  8232. }
  8233. inline bool has_framed_body(const Request &req) {
  8234. return is_chunked_transfer_encoding(req.headers) ||
  8235. req.get_header_value_u64("Content-Length") > 0;
  8236. }
  8237. inline bool is_connection_persistent(const Request &req) {
  8238. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8239. if (req.version == "HTTP/1.0" &&
  8240. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8241. return false;
  8242. }
  8243. return true;
  8244. }
  8245. inline bool expect_content(const Request &req) {
  8246. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8247. req.method == "DELETE") {
  8248. return true;
  8249. }
  8250. return has_framed_body(req);
  8251. }
  8252. #ifdef _WIN32
  8253. class WSInit {
  8254. public:
  8255. WSInit() {
  8256. WSADATA wsaData;
  8257. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8258. }
  8259. ~WSInit() {
  8260. if (is_valid_) WSACleanup();
  8261. }
  8262. bool is_valid_ = false;
  8263. };
  8264. static WSInit wsinit_;
  8265. #endif
  8266. // RFC 9110 Section 11.6.1 defines a challenge list as
  8267. // WWW-Authenticate = #challenge
  8268. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8269. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8270. // so a server may offer several schemes, each with its own comma-separated
  8271. // auth-param list, in either order and either as separate field lines or
  8272. // packed into one. Splitting on every comma would break apart a challenge's
  8273. // own param list; splitting only on the first space would miss a Digest
  8274. // challenge that isn't first. Split on commas that aren't inside a
  8275. // quoted-string instead, then track which scheme each resulting segment
  8276. // belongs to: a segment whose text before "=" contains whitespace (or that
  8277. // has no "=" at all) starts a new challenge named by its leading token.
  8278. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8279. std::vector<std::string> segments;
  8280. size_t start = 0;
  8281. auto in_quotes = false;
  8282. for (size_t i = 0; i < s.size(); i++) {
  8283. auto c = s[i];
  8284. if (in_quotes) {
  8285. if (c == '\\' && i + 1 < s.size()) {
  8286. i++;
  8287. } else if (c == '"') {
  8288. in_quotes = false;
  8289. }
  8290. } else if (c == '"') {
  8291. in_quotes = true;
  8292. } else if (c == ',') {
  8293. segments.push_back(s.substr(start, i - start));
  8294. start = i + 1;
  8295. }
  8296. }
  8297. segments.push_back(s.substr(start));
  8298. return segments;
  8299. }
  8300. inline std::string unescape_quoted_pairs(const std::string &s) {
  8301. std::string out;
  8302. out.reserve(s.size());
  8303. for (size_t i = 0; i < s.size(); i++) {
  8304. if (s[i] == '\\' && i + 1 < s.size()) {
  8305. out += s[++i];
  8306. } else {
  8307. out += s[i];
  8308. }
  8309. }
  8310. return out;
  8311. }
  8312. inline bool parse_www_authenticate(const Response &res,
  8313. std::map<std::string, std::string> &auth,
  8314. bool is_proxy) {
  8315. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8316. auto combined = get_combined_header_value(res.headers, auth_key);
  8317. if (combined.empty()) { return false; }
  8318. auto found_digest = false;
  8319. auto in_digest_challenge = false;
  8320. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8321. auto segment = trim_copy(raw_segment);
  8322. if (segment.empty()) { continue; }
  8323. auto eq_pos = segment.find('=');
  8324. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8325. // for the first segment of a challenge, "<scheme> <key>") must be
  8326. // trimmed before its boundaries are inspected.
  8327. auto key_part = trim_copy(
  8328. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8329. auto space_pos = key_part.find_last_of(" \t");
  8330. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8331. // "<scheme>[ <key>]" starts a new challenge.
  8332. auto scheme_end =
  8333. space_pos == std::string::npos ? key_part.size() : space_pos;
  8334. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8335. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8336. // from one challenge is never paired with another's algorithm.
  8337. in_digest_challenge =
  8338. !found_digest &&
  8339. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8340. if (in_digest_challenge) { found_digest = true; }
  8341. if (space_pos == std::string::npos) {
  8342. // Bare scheme (or a token68), no auth-param on this segment.
  8343. continue;
  8344. }
  8345. key_part = key_part.substr(space_pos + 1);
  8346. }
  8347. if (!in_digest_challenge) { continue; }
  8348. auto val = trim_copy(segment.substr(eq_pos + 1));
  8349. auto unquoted = trim_double_quotes_copy(val);
  8350. if (unquoted.size() != val.size()) {
  8351. unquoted = unescape_quoted_pairs(unquoted);
  8352. }
  8353. auth[std::move(key_part)] = std::move(unquoted);
  8354. }
  8355. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8356. // make_digest_authentication_header() dereferences both unconditionally, so
  8357. // a challenge missing either can't produce a usable Authorization header.
  8358. // Treat it the same as no Digest challenge at all.
  8359. return found_digest && auth.find("realm") != auth.end() &&
  8360. auth.find("nonce") != auth.end();
  8361. }
  8362. class ContentProviderAdapter {
  8363. public:
  8364. explicit ContentProviderAdapter(
  8365. ContentProviderWithoutLength &&content_provider)
  8366. : content_provider_(std::move(content_provider)) {}
  8367. bool operator()(size_t offset, size_t, DataSink &sink) {
  8368. return content_provider_(offset, sink);
  8369. }
  8370. private:
  8371. ContentProviderWithoutLength content_provider_;
  8372. };
  8373. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8374. namespace fields {
  8375. inline bool is_token_char(char c) {
  8376. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8377. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8378. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8379. }
  8380. inline bool is_token(const std::string &s) {
  8381. if (s.empty()) { return false; }
  8382. for (auto c : s) {
  8383. if (!is_token_char(c)) { return false; }
  8384. }
  8385. return true;
  8386. }
  8387. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8388. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8389. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8390. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8391. inline bool is_field_content(const std::string &s) {
  8392. if (s.empty()) { return true; }
  8393. if (s.size() == 1) {
  8394. return is_field_vchar(s[0]);
  8395. } else if (s.size() == 2) {
  8396. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8397. } else {
  8398. size_t i = 0;
  8399. if (!is_field_vchar(s[i])) { return false; }
  8400. i++;
  8401. while (i < s.size() - 1) {
  8402. auto c = s[i++];
  8403. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8404. } else {
  8405. return false;
  8406. }
  8407. }
  8408. return is_field_vchar(s[i]);
  8409. }
  8410. }
  8411. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8412. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8413. return is_field_name(name) && is_field_value(value);
  8414. }
  8415. } // namespace fields
  8416. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8417. WebSocketUpgradeResponse &upgrade) {
  8418. // Generate random Sec-WebSocket-Key
  8419. thread_local std::mt19937 rng(std::random_device{}());
  8420. std::string key_bytes(16, '\0');
  8421. for (size_t i = 0; i < 16; i += 4) {
  8422. auto r = rng();
  8423. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8424. }
  8425. auto client_key = base64_encode(key_bytes);
  8426. req.headers.erase("Upgrade");
  8427. req.headers.erase("Connection");
  8428. req.headers.erase("Sec-WebSocket-Key");
  8429. req.headers.erase("Sec-WebSocket-Version");
  8430. req.headers.emplace("Upgrade", "websocket");
  8431. req.headers.emplace("Connection", "Upgrade");
  8432. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8433. req.headers.emplace("Sec-WebSocket-Version", "13");
  8434. // Build the request in memory first, like ClientImpl::write_request does.
  8435. // Writing straight to the socket would leak a request line onto the wire
  8436. // before check_and_write_headers gets a chance to reject an invalid header,
  8437. // and would emit one small write per header.
  8438. BufferStream bstrm;
  8439. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8440. upgrade.error = Error::Write;
  8441. return false;
  8442. }
  8443. auto error = Error::Success;
  8444. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8445. upgrade.error = error;
  8446. return false;
  8447. }
  8448. const auto &data = bstrm.get_buffer();
  8449. if (!write_data(strm, data.data(), data.size())) {
  8450. upgrade.error = Error::Write;
  8451. return false;
  8452. }
  8453. // Verify 101 response and Sec-WebSocket-Accept header
  8454. auto expected_accept = websocket_accept_key(client_key);
  8455. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8456. }
  8457. inline bool is_ip_address(const std::string &host) {
  8458. struct in_addr addr4;
  8459. struct in6_addr addr6;
  8460. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8461. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8462. }
  8463. // Resolve where a client should connect for `host`, honoring a user-supplied
  8464. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8465. // supplying the Host header and SNI; only the connection target changes.
  8466. //
  8467. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8468. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8469. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8470. // absent or empty mapping leaves `host` as the connection target; without the
  8471. // empty check the value would reach getaddrinfo as a null node and silently
  8472. // resolve to loopback.
  8473. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8474. const std::string &host, std::string &connect_host,
  8475. std::string &ip) {
  8476. connect_host = host;
  8477. ip.clear();
  8478. auto it = addr_map.find(host);
  8479. if (it == addr_map.end() || it->second.empty()) { return; }
  8480. if (is_ip_address(it->second)) {
  8481. ip = it->second;
  8482. } else {
  8483. connect_host = it->second;
  8484. }
  8485. }
  8486. } // namespace detail
  8487. /*
  8488. * Group 2: detail namespace - SSL common utilities
  8489. */
  8490. #ifdef CPPHTTPLIB_SSL_ENABLED
  8491. namespace detail {
  8492. class SSLSocketStream final : public Stream {
  8493. public:
  8494. SSLSocketStream(
  8495. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8496. time_t read_timeout_usec, time_t write_timeout_sec,
  8497. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8498. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8499. (std::chrono::steady_clock::time_point::min)());
  8500. ~SSLSocketStream() override;
  8501. bool is_readable() const override;
  8502. bool wait_readable() const override;
  8503. bool wait_writable() const override;
  8504. bool is_peer_alive() const override;
  8505. ssize_t read(char *ptr, size_t size) override;
  8506. ssize_t write(const char *ptr, size_t size) override;
  8507. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8508. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8509. socket_t socket() const override;
  8510. time_t duration() const override;
  8511. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8512. // See SocketStream::set_readable_hint().
  8513. void set_readable_hint() { readable_hint_ = true; }
  8514. private:
  8515. bool ensure_readable();
  8516. socket_t sock_;
  8517. tls::session_t session_;
  8518. time_t read_timeout_sec_;
  8519. time_t read_timeout_usec_;
  8520. time_t write_timeout_sec_;
  8521. time_t write_timeout_usec_;
  8522. time_t max_timeout_msec_;
  8523. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8524. bool readable_hint_ = false;
  8525. };
  8526. // A TLS stream for WebSocket connections, where the receive path and the
  8527. // send path (application send() plus the heartbeat ping thread) run on
  8528. // different threads. A single TLS session must never be entered
  8529. // concurrently, so every call into the session is serialized by one mutex.
  8530. //
  8531. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8532. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8533. // call under the lock, then waits for readiness with select() outside the
  8534. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8535. // blocked waiting for data never stalls a concurrent sender.
  8536. //
  8537. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8538. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8539. class WebSocketSSLStream final : public Stream {
  8540. public:
  8541. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8542. time_t read_timeout_sec, time_t read_timeout_usec,
  8543. time_t write_timeout_sec, time_t write_timeout_usec);
  8544. ~WebSocketSSLStream() override;
  8545. bool is_readable() const override;
  8546. bool wait_readable() const override;
  8547. bool wait_writable() const override;
  8548. ssize_t read(char *ptr, size_t size) override;
  8549. ssize_t write(const char *ptr, size_t size) override;
  8550. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8551. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8552. socket_t socket() const override;
  8553. time_t duration() const override;
  8554. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8555. private:
  8556. mutable std::mutex session_mutex_;
  8557. socket_t sock_;
  8558. tls::session_t session_;
  8559. // WebSocket::close() shortens the read timeout from the closing thread
  8560. // while the receive thread is inside wait_readable(), so these two are read
  8561. // and written concurrently. The write timeouts are never mutated.
  8562. std::atomic<time_t> read_timeout_sec_;
  8563. std::atomic<time_t> read_timeout_usec_;
  8564. time_t write_timeout_sec_;
  8565. time_t write_timeout_usec_;
  8566. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8567. };
  8568. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8569. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8570. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8571. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8572. unsigned int hash_length = 0;
  8573. unsigned char hash[EVP_MAX_MD_SIZE];
  8574. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8575. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8576. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8577. std::stringstream ss;
  8578. for (auto i = 0u; i < hash_length; ++i) {
  8579. ss << std::hex << std::setw(2) << std::setfill('0')
  8580. << static_cast<unsigned int>(hash[i]);
  8581. }
  8582. return ss.str();
  8583. }
  8584. inline std::string MD5(const std::string &s) {
  8585. return message_digest(s, EVP_md5());
  8586. }
  8587. inline std::string SHA_256(const std::string &s) {
  8588. return message_digest(s, EVP_sha256());
  8589. }
  8590. inline std::string SHA_512(const std::string &s) {
  8591. return message_digest(s, EVP_sha512());
  8592. }
  8593. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8594. namespace {
  8595. template <size_t N>
  8596. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8597. std::stringstream ss;
  8598. for (size_t i = 0; i < N; ++i) {
  8599. ss << std::hex << std::setw(2) << std::setfill('0')
  8600. << static_cast<unsigned int>(hash[i]);
  8601. }
  8602. return ss.str();
  8603. }
  8604. } // namespace
  8605. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8606. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8607. // initialized once. PSA state is process-global; do not free it.
  8608. inline bool ensure_mbedtls_psa_crypto() {
  8609. static std::once_flag once;
  8610. static bool ok = false;
  8611. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8612. return ok;
  8613. }
  8614. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8615. unsigned char *out, size_t out_size) {
  8616. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8617. size_t olen = 0;
  8618. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8619. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8620. olen == out_size;
  8621. }
  8622. #endif
  8623. inline std::string MD5(const std::string &s) {
  8624. unsigned char hash[16];
  8625. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8626. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8627. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8628. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8629. hash);
  8630. #else
  8631. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8632. hash);
  8633. #endif
  8634. return hash_to_hex(hash);
  8635. }
  8636. inline std::string SHA_256(const std::string &s) {
  8637. unsigned char hash[32];
  8638. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8639. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8640. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8641. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8642. hash, 0);
  8643. #else
  8644. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8645. s.size(), hash, 0);
  8646. #endif
  8647. return hash_to_hex(hash);
  8648. }
  8649. inline std::string SHA_512(const std::string &s) {
  8650. unsigned char hash[64];
  8651. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8652. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8653. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8654. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8655. hash, 0);
  8656. #else
  8657. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8658. s.size(), hash, 0);
  8659. #endif
  8660. return hash_to_hex(hash);
  8661. }
  8662. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8663. namespace {
  8664. template <size_t N>
  8665. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8666. std::stringstream ss;
  8667. for (size_t i = 0; i < N; ++i) {
  8668. ss << std::hex << std::setw(2) << std::setfill('0')
  8669. << static_cast<unsigned int>(hash[i]);
  8670. }
  8671. return ss.str();
  8672. }
  8673. } // namespace
  8674. inline std::string MD5(const std::string &s) {
  8675. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8676. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8677. static_cast<word32>(s.size()), hash);
  8678. return hash_to_hex(hash);
  8679. }
  8680. inline std::string SHA_256(const std::string &s) {
  8681. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8682. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8683. static_cast<word32>(s.size()), hash);
  8684. return hash_to_hex(hash);
  8685. }
  8686. inline std::string SHA_512(const std::string &s) {
  8687. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8688. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8689. static_cast<word32>(s.size()), hash);
  8690. return hash_to_hex(hash);
  8691. }
  8692. #endif
  8693. template <typename T>
  8694. inline bool process_server_socket_ssl(
  8695. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8696. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8697. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8698. time_t write_timeout_usec, T callback) {
  8699. return process_server_socket_core(
  8700. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8701. [&](bool close_connection, bool &connection_closed) {
  8702. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8703. write_timeout_sec, write_timeout_usec);
  8704. // See the non-TLS path in process_server_socket().
  8705. strm.set_readable_hint();
  8706. return callback(strm, close_connection, connection_closed);
  8707. });
  8708. }
  8709. template <typename T>
  8710. inline bool process_client_socket_ssl(
  8711. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8712. time_t read_timeout_usec, time_t write_timeout_sec,
  8713. time_t write_timeout_usec, time_t max_timeout_msec,
  8714. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8715. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8716. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8717. start_time);
  8718. return callback(strm);
  8719. }
  8720. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8721. const Request &req, const std::map<std::string, std::string> &auth,
  8722. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8723. const std::string &password, bool is_proxy = false) {
  8724. std::string nc;
  8725. {
  8726. std::stringstream ss;
  8727. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8728. nc = ss.str();
  8729. }
  8730. std::string qop;
  8731. if (auth.find("qop") != auth.end()) {
  8732. qop = auth.at("qop");
  8733. if (qop.find("auth-int") != std::string::npos) {
  8734. qop = "auth-int";
  8735. } else if (qop.find("auth") != std::string::npos) {
  8736. qop = "auth";
  8737. } else {
  8738. qop.clear();
  8739. }
  8740. }
  8741. std::string algo = "MD5";
  8742. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8743. std::string response;
  8744. {
  8745. auto H = algo == "SHA-256" ? detail::SHA_256
  8746. : algo == "SHA-512" ? detail::SHA_512
  8747. : detail::MD5;
  8748. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8749. auto A2 = req.method + ":" + req.path;
  8750. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8751. if (qop.empty()) {
  8752. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8753. } else {
  8754. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8755. ":" + qop + ":" + H(A2));
  8756. }
  8757. }
  8758. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8759. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8760. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8761. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8762. (qop.empty() ? ", response=\""
  8763. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8764. cnonce + "\", response=\"") +
  8765. response + "\"" +
  8766. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8767. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8768. return std::make_pair(key, field);
  8769. }
  8770. inline bool match_hostname(const std::string &pattern,
  8771. const std::string &hostname) {
  8772. // Exact match (case-insensitive)
  8773. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8774. // Split both pattern and hostname into components by '.'
  8775. std::vector<std::string> pattern_components;
  8776. if (!pattern.empty()) {
  8777. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8778. [&](const char *b, const char *e) {
  8779. pattern_components.emplace_back(b, e);
  8780. });
  8781. }
  8782. std::vector<std::string> host_components;
  8783. if (!hostname.empty()) {
  8784. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8785. [&](const char *b, const char *e) {
  8786. host_components.emplace_back(b, e);
  8787. });
  8788. }
  8789. // Component count must match
  8790. if (host_components.size() != pattern_components.size()) { return false; }
  8791. // Compare each component with wildcard support
  8792. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8793. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8794. auto itr = pattern_components.begin();
  8795. for (const auto &h : host_components) {
  8796. auto &p = *itr;
  8797. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8798. bool partial_match = false;
  8799. if (!p.empty() && p[p.size() - 1] == '*') {
  8800. const auto prefix_length = p.size() - 1;
  8801. if (prefix_length == 0) {
  8802. partial_match = true;
  8803. } else if (h.size() >= prefix_length) {
  8804. partial_match =
  8805. std::equal(p.begin(),
  8806. p.begin() + static_cast<std::string::difference_type>(
  8807. prefix_length),
  8808. h.begin(), [](const char ca, const char cb) {
  8809. return detail::case_ignore::to_lower(ca) ==
  8810. detail::case_ignore::to_lower(cb);
  8811. });
  8812. }
  8813. }
  8814. if (!partial_match) { return false; }
  8815. }
  8816. ++itr;
  8817. }
  8818. return true;
  8819. }
  8820. #ifdef _WIN32
  8821. // Verify certificate using Windows CertGetCertificateChain API.
  8822. // This provides real-time certificate validation with Windows Update
  8823. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8824. inline bool
  8825. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8826. const std::string &hostname,
  8827. bool verify_hostname, uint64_t &out_error) {
  8828. if (der_cert.empty()) { return false; }
  8829. out_error = 0;
  8830. // Create Windows certificate context from DER data
  8831. auto cert_context = CertCreateCertificateContext(
  8832. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8833. static_cast<DWORD>(der_cert.size()));
  8834. if (!cert_context) {
  8835. out_error = GetLastError();
  8836. return false;
  8837. }
  8838. auto cert_guard =
  8839. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8840. // Setup chain parameters
  8841. CERT_CHAIN_PARA chain_para = {};
  8842. chain_para.cbSize = sizeof(chain_para);
  8843. // Build certificate chain with revocation checking
  8844. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8845. auto chain_result = CertGetCertificateChain(
  8846. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8847. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8848. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8849. nullptr, &chain_context);
  8850. if (!chain_result || !chain_context) {
  8851. out_error = GetLastError();
  8852. return false;
  8853. }
  8854. auto chain_guard =
  8855. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  8856. // Check if chain has errors
  8857. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  8858. out_error = chain_context->TrustStatus.dwErrorStatus;
  8859. return false;
  8860. }
  8861. // Verify SSL policy
  8862. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  8863. extra_policy_para.cbSize = sizeof(extra_policy_para);
  8864. #ifdef AUTHTYPE_SERVER
  8865. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  8866. #endif
  8867. std::wstring whost;
  8868. if (verify_hostname) {
  8869. whost = u8string_to_wstring(hostname.c_str());
  8870. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  8871. }
  8872. CERT_CHAIN_POLICY_PARA policy_para = {};
  8873. policy_para.cbSize = sizeof(policy_para);
  8874. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  8875. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  8876. #else
  8877. policy_para.dwFlags = 0;
  8878. #endif
  8879. policy_para.pvExtraPolicyPara = &extra_policy_para;
  8880. CERT_CHAIN_POLICY_STATUS policy_status = {};
  8881. policy_status.cbSize = sizeof(policy_status);
  8882. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  8883. &policy_para, &policy_status)) {
  8884. out_error = GetLastError();
  8885. return false;
  8886. }
  8887. if (policy_status.dwError != 0) {
  8888. out_error = policy_status.dwError;
  8889. return false;
  8890. }
  8891. return true;
  8892. }
  8893. #endif // _WIN32
  8894. // Loads CA file/dir configuration and applies the system CA policy to a
  8895. // client TLS context. PEM data and native stores are applied to the context
  8896. // directly at set time; has_custom_store reflects them for the Auto policy
  8897. // decision.
  8898. inline bool load_client_ca_config(tls::ctx_t ctx,
  8899. const std::string &ca_cert_file_path,
  8900. const std::string &ca_cert_dir_path,
  8901. bool has_custom_store, SystemCAMode mode,
  8902. uint64_t &backend_error) {
  8903. auto ret = true;
  8904. if (!ca_cert_file_path.empty()) {
  8905. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  8906. backend_error = tls::get_error();
  8907. ret = false;
  8908. }
  8909. } else if (!ca_cert_dir_path.empty()) {
  8910. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  8911. backend_error = tls::get_error();
  8912. ret = false;
  8913. }
  8914. }
  8915. auto has_custom_ca = !ca_cert_file_path.empty() ||
  8916. !ca_cert_dir_path.empty() || has_custom_store;
  8917. if (mode == SystemCAMode::Enabled ||
  8918. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  8919. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  8920. }
  8921. return ret;
  8922. }
  8923. // The parts of session setup that only SSLClient needs, plus the handful
  8924. // WebSocketClient also exposes; everything else takes the defaults, which is
  8925. // what keeps the two clients on one implementation.
  8926. struct ClientTlsSessionOptions {
  8927. // Both SSLClient and WebSocketClient expose this independently of
  8928. // certificate verification.
  8929. bool server_hostname_verification = true;
  8930. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  8931. // When non-null, guards session creation against concurrent use of the
  8932. // context. A WebSocketClient is not safe to use from several threads to
  8933. // begin with, so it passes nothing.
  8934. std::mutex *ctx_mutex = nullptr;
  8935. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  8936. // The caller decides whether Schannel has anything to say about this
  8937. // connection; see SSLClient::initialize_ssl().
  8938. bool windows_cert_verification = false;
  8939. #endif
  8940. };
  8941. // Filled in on failure for callers that report error details.
  8942. struct ClientTlsSessionError {
  8943. Error error = Error::Success;
  8944. int ssl_error = 0;
  8945. uint64_t backend_error = 0;
  8946. };
  8947. // Establishes a client TLS session on an already connected socket. On failure
  8948. // the session is left for the caller to free: SSLClient frees it right away,
  8949. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  8950. inline bool setup_client_tls_session(
  8951. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  8952. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  8953. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  8954. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  8955. using namespace tls;
  8956. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  8957. if (out_error) {
  8958. out_error->error = error;
  8959. out_error->ssl_error = ssl_error;
  8960. out_error->backend_error = backend_error;
  8961. }
  8962. return false;
  8963. };
  8964. if (!ctx) {
  8965. session = nullptr;
  8966. return fail(Error::SSLConnection, 0, 0);
  8967. }
  8968. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8969. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  8970. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  8971. // verification happens during the handshake even for IP hosts; the
  8972. // certificate identity is verified post-handshake via verify_hostname().
  8973. set_verify_client(ctx, server_certificate_verification);
  8974. #endif
  8975. {
  8976. std::unique_lock<std::mutex> guard;
  8977. if (options.ctx_mutex) {
  8978. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  8979. }
  8980. session = create_session(ctx, sock);
  8981. }
  8982. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  8983. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  8984. // their identity is checked post-handshake below instead. On Mbed TLS and
  8985. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  8986. // options.server_hostname_verification is threaded through here.
  8987. if (!is_ip_address(host)) {
  8988. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  8989. return fail(Error::SSLConnection, 0, get_error());
  8990. }
  8991. }
  8992. TlsError tls_err;
  8993. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  8994. &tls_err)) {
  8995. auto error = Error::SSLConnection;
  8996. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  8997. error = Error::SSLServerVerification;
  8998. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  8999. error = Error::SSLServerHostnameVerification;
  9000. }
  9001. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9002. }
  9003. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9004. if (options.session_verifier) {
  9005. verification_status = options.session_verifier(session);
  9006. }
  9007. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9008. return fail(Error::SSLServerVerification, 0, get_error());
  9009. }
  9010. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9011. server_certificate_verification) {
  9012. auto verify_result = get_verify_result(session);
  9013. if (verify_result != 0) {
  9014. return fail(Error::SSLServerVerification, 0,
  9015. static_cast<uint64_t>(verify_result));
  9016. }
  9017. auto server_cert = get_peer_cert(session);
  9018. if (!server_cert) {
  9019. return fail(Error::SSLServerVerification, 0, get_error());
  9020. }
  9021. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9022. // Identity check against the peer certificate, post-handshake for all
  9023. // backends. For IP hosts this is the only identity verification, since no
  9024. // hostname is bound during the handshake.
  9025. if (options.server_hostname_verification) {
  9026. if (!verify_hostname(server_cert, host.c_str())) {
  9027. return fail(Error::SSLServerHostnameVerification, 0,
  9028. hostname_mismatch_code());
  9029. }
  9030. }
  9031. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9032. // Additional Windows Schannel verification.
  9033. // This provides real-time certificate validation with Windows Update
  9034. // integration, working with both OpenSSL and MbedTLS backends.
  9035. if (options.windows_cert_verification) {
  9036. std::vector<unsigned char> der;
  9037. if (get_cert_der(server_cert, der)) {
  9038. uint64_t wincrypt_error = 0;
  9039. if (!verify_cert_with_windows_schannel(
  9040. der, host, options.server_hostname_verification,
  9041. wincrypt_error)) {
  9042. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9043. }
  9044. }
  9045. }
  9046. #endif
  9047. }
  9048. return true;
  9049. }
  9050. } // namespace detail
  9051. #endif // CPPHTTPLIB_SSL_ENABLED
  9052. /*
  9053. * Group 3: httplib namespace - Non-SSL public API implementations
  9054. */
  9055. inline void default_socket_options(socket_t sock) {
  9056. set_socket_opt(sock, SOL_SOCKET,
  9057. #ifdef SO_REUSEPORT
  9058. SO_REUSEPORT,
  9059. #else
  9060. SO_REUSEADDR,
  9061. #endif
  9062. 1);
  9063. }
  9064. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9065. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9066. sizeof(optval));
  9067. }
  9068. inline std::string get_bearer_token_auth(const Request &req) {
  9069. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9070. // than the prefix carries no token.
  9071. constexpr const char bearer_prefix[] = "Bearer ";
  9072. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9073. auto value = req.get_header_value("Authorization");
  9074. if (value.size() >= bearer_prefix_len &&
  9075. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9076. bearer_prefix)) {
  9077. return value.substr(bearer_prefix_len);
  9078. }
  9079. return "";
  9080. }
  9081. inline const char *status_message(int status) {
  9082. switch (status) {
  9083. case StatusCode::Continue_100: return "Continue";
  9084. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9085. case StatusCode::Processing_102: return "Processing";
  9086. case StatusCode::EarlyHints_103: return "Early Hints";
  9087. case StatusCode::OK_200: return "OK";
  9088. case StatusCode::Created_201: return "Created";
  9089. case StatusCode::Accepted_202: return "Accepted";
  9090. case StatusCode::NonAuthoritativeInformation_203:
  9091. return "Non-Authoritative Information";
  9092. case StatusCode::NoContent_204: return "No Content";
  9093. case StatusCode::ResetContent_205: return "Reset Content";
  9094. case StatusCode::PartialContent_206: return "Partial Content";
  9095. case StatusCode::MultiStatus_207: return "Multi-Status";
  9096. case StatusCode::AlreadyReported_208: return "Already Reported";
  9097. case StatusCode::IMUsed_226: return "IM Used";
  9098. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9099. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9100. case StatusCode::Found_302: return "Found";
  9101. case StatusCode::SeeOther_303: return "See Other";
  9102. case StatusCode::NotModified_304: return "Not Modified";
  9103. case StatusCode::UseProxy_305: return "Use Proxy";
  9104. case StatusCode::unused_306: return "unused";
  9105. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9106. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9107. case StatusCode::BadRequest_400: return "Bad Request";
  9108. case StatusCode::Unauthorized_401: return "Unauthorized";
  9109. case StatusCode::PaymentRequired_402: return "Payment Required";
  9110. case StatusCode::Forbidden_403: return "Forbidden";
  9111. case StatusCode::NotFound_404: return "Not Found";
  9112. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9113. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9114. case StatusCode::ProxyAuthenticationRequired_407:
  9115. return "Proxy Authentication Required";
  9116. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9117. case StatusCode::Conflict_409: return "Conflict";
  9118. case StatusCode::Gone_410: return "Gone";
  9119. case StatusCode::LengthRequired_411: return "Length Required";
  9120. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9121. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9122. case StatusCode::UriTooLong_414: return "URI Too Long";
  9123. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9124. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9125. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9126. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9127. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9128. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9129. case StatusCode::Locked_423: return "Locked";
  9130. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9131. case StatusCode::TooEarly_425: return "Too Early";
  9132. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9133. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9134. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9135. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9136. return "Request Header Fields Too Large";
  9137. case StatusCode::UnavailableForLegalReasons_451:
  9138. return "Unavailable For Legal Reasons";
  9139. case StatusCode::NotImplemented_501: return "Not Implemented";
  9140. case StatusCode::BadGateway_502: return "Bad Gateway";
  9141. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9142. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9143. case StatusCode::HttpVersionNotSupported_505:
  9144. return "HTTP Version Not Supported";
  9145. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9146. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9147. case StatusCode::LoopDetected_508: return "Loop Detected";
  9148. case StatusCode::NotExtended_510: return "Not Extended";
  9149. case StatusCode::NetworkAuthenticationRequired_511:
  9150. return "Network Authentication Required";
  9151. default:
  9152. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9153. }
  9154. }
  9155. inline std::string to_string(const Error error) {
  9156. switch (error) {
  9157. case Error::Success: return "Success (no error)";
  9158. case Error::Unknown: return "Unknown";
  9159. case Error::Connection: return "Could not establish connection";
  9160. case Error::BindIPAddress: return "Failed to bind IP address";
  9161. case Error::Read: return "Failed to read connection";
  9162. case Error::Write: return "Failed to write connection";
  9163. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9164. case Error::Canceled: return "Connection handling canceled";
  9165. case Error::SSLConnection: return "SSL connection failed";
  9166. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9167. case Error::SSLServerVerification: return "SSL server verification failed";
  9168. case Error::SSLServerHostnameVerification:
  9169. return "SSL server hostname verification failed";
  9170. case Error::UnsupportedMultipartBoundaryChars:
  9171. return "Unsupported HTTP multipart boundary characters";
  9172. case Error::Compression: return "Compression failed";
  9173. case Error::ConnectionTimeout: return "Connection timed out";
  9174. case Error::ProxyConnection: return "Proxy connection failed";
  9175. case Error::ConnectionClosed: return "Connection closed by server";
  9176. case Error::Timeout: return "Read timeout";
  9177. case Error::ResourceExhaustion: return "Resource exhaustion";
  9178. case Error::TooManyFormDataFiles: return "Too many form data files";
  9179. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9180. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9181. case Error::ExceedMaxSocketDescriptorCount:
  9182. return "Exceeded maximum socket descriptor count";
  9183. case Error::InvalidRequestLine: return "Invalid request line";
  9184. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9185. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9186. case Error::InvalidHeaders: return "Invalid headers";
  9187. case Error::MultipartParsing: return "Multipart parsing failed";
  9188. case Error::OpenFile: return "Failed to open file";
  9189. case Error::Listen: return "Failed to listen on socket";
  9190. case Error::GetSockName: return "Failed to get socket name";
  9191. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9192. case Error::HTTPParsing: return "HTTP parsing failed";
  9193. case Error::InvalidRangeHeader: return "Invalid Range header";
  9194. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9195. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9196. case Error::UserCallbackException: return "User callback threw an exception";
  9197. default: break;
  9198. }
  9199. return "Invalid";
  9200. }
  9201. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9202. os << to_string(obj);
  9203. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9204. return os;
  9205. }
  9206. inline std::string hosted_at(const std::string &hostname) {
  9207. std::vector<std::string> addrs;
  9208. hosted_at(hostname, addrs);
  9209. if (addrs.empty()) { return std::string(); }
  9210. return addrs[0];
  9211. }
  9212. inline void hosted_at(const std::string &hostname,
  9213. std::vector<std::string> &addrs) {
  9214. struct addrinfo hints;
  9215. struct addrinfo *result;
  9216. memset(&hints, 0, sizeof(struct addrinfo));
  9217. hints.ai_family = AF_UNSPEC;
  9218. hints.ai_socktype = SOCK_STREAM;
  9219. hints.ai_protocol = 0;
  9220. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9221. &result, 0)) {
  9222. #if defined __linux__ && !defined __ANDROID__
  9223. res_init();
  9224. #endif
  9225. return;
  9226. }
  9227. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9228. for (auto rp = result; rp; rp = rp->ai_next) {
  9229. const auto &addr =
  9230. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9231. std::string ip;
  9232. auto dummy = -1;
  9233. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9234. dummy)) {
  9235. addrs.emplace_back(std::move(ip));
  9236. }
  9237. }
  9238. }
  9239. inline std::string encode_uri_component(const std::string &value) {
  9240. std::ostringstream escaped;
  9241. escaped.fill('0');
  9242. escaped << std::hex;
  9243. for (auto c : value) {
  9244. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9245. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9246. escaped << c;
  9247. } else {
  9248. escaped << std::uppercase;
  9249. escaped << '%' << std::setw(2)
  9250. << static_cast<int>(static_cast<unsigned char>(c));
  9251. escaped << std::nouppercase;
  9252. }
  9253. }
  9254. return escaped.str();
  9255. }
  9256. inline std::string encode_uri(const std::string &value) {
  9257. std::ostringstream escaped;
  9258. escaped.fill('0');
  9259. escaped << std::hex;
  9260. for (auto c : value) {
  9261. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9262. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9263. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9264. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9265. escaped << c;
  9266. } else {
  9267. escaped << std::uppercase;
  9268. escaped << '%' << std::setw(2)
  9269. << static_cast<int>(static_cast<unsigned char>(c));
  9270. escaped << std::nouppercase;
  9271. }
  9272. }
  9273. return escaped.str();
  9274. }
  9275. inline std::string decode_uri_component(const std::string &value) {
  9276. std::string result;
  9277. for (size_t i = 0; i < value.size(); i++) {
  9278. if (value[i] == '%' && i + 2 < value.size()) {
  9279. auto val = 0;
  9280. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9281. result += static_cast<char>(val);
  9282. i += 2;
  9283. } else {
  9284. result += value[i];
  9285. }
  9286. } else {
  9287. result += value[i];
  9288. }
  9289. }
  9290. return result;
  9291. }
  9292. inline std::string decode_uri(const std::string &value) {
  9293. std::string result;
  9294. for (size_t i = 0; i < value.size(); i++) {
  9295. if (value[i] == '%' && i + 2 < value.size()) {
  9296. auto val = 0;
  9297. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9298. auto c = static_cast<char>(val);
  9299. // Keep escapes of the reserved characters that encode_uri leaves
  9300. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9301. // delimiter is not promoted into a real one (as with JS decodeURI).
  9302. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9303. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9304. c == '#') {
  9305. result += value[i];
  9306. result += value[i + 1];
  9307. result += value[i + 2];
  9308. } else {
  9309. result += c;
  9310. }
  9311. i += 2;
  9312. } else {
  9313. result += value[i];
  9314. }
  9315. } else {
  9316. result += value[i];
  9317. }
  9318. }
  9319. return result;
  9320. }
  9321. inline std::string encode_path_component(const std::string &component) {
  9322. std::string result;
  9323. result.reserve(component.size() * 3);
  9324. for (size_t i = 0; i < component.size(); i++) {
  9325. auto c = static_cast<unsigned char>(component[i]);
  9326. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9327. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9328. c == '_' || c == '~') {
  9329. result += static_cast<char>(c);
  9330. }
  9331. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9332. // "," / ";" / "="
  9333. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9334. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9335. c == '=') {
  9336. result += static_cast<char>(c);
  9337. }
  9338. // Colon is allowed in path segments except first segment
  9339. else if (c == ':') {
  9340. result += static_cast<char>(c);
  9341. }
  9342. // @ is allowed in path
  9343. else if (c == '@') {
  9344. result += static_cast<char>(c);
  9345. } else {
  9346. result += '%';
  9347. char hex[3];
  9348. snprintf(hex, sizeof(hex), "%02X", c);
  9349. result.append(hex, 2);
  9350. }
  9351. }
  9352. return result;
  9353. }
  9354. inline std::string decode_path_component(const std::string &component) {
  9355. std::string result;
  9356. result.reserve(component.size());
  9357. for (size_t i = 0; i < component.size(); i++) {
  9358. if (component[i] == '%' && i + 1 < component.size()) {
  9359. if (component[i + 1] == 'u') {
  9360. // Unicode %uXXXX encoding
  9361. auto val = 0;
  9362. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9363. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9364. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9365. char buff[4];
  9366. size_t len = detail::to_utf8(val, buff);
  9367. if (len > 0) { result.append(buff, len); }
  9368. i += 5; // 'u0000'
  9369. } else {
  9370. result += component[i];
  9371. }
  9372. } else {
  9373. // Standard %XX encoding
  9374. auto val = 0;
  9375. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9376. // 2 digits hex codes
  9377. result += static_cast<char>(val);
  9378. i += 2; // 'XX'
  9379. } else {
  9380. result += component[i];
  9381. }
  9382. }
  9383. } else {
  9384. result += component[i];
  9385. }
  9386. }
  9387. return result;
  9388. }
  9389. inline std::string encode_query_component(const std::string &component,
  9390. bool space_as_plus) {
  9391. std::string result;
  9392. result.reserve(component.size() * 3);
  9393. for (size_t i = 0; i < component.size(); i++) {
  9394. auto c = static_cast<unsigned char>(component[i]);
  9395. // Unreserved characters per RFC 3986
  9396. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9397. c == '_' || c == '~') {
  9398. result += static_cast<char>(c);
  9399. }
  9400. // Space handling
  9401. else if (c == ' ') {
  9402. if (space_as_plus) {
  9403. result += '+';
  9404. } else {
  9405. result += "%20";
  9406. }
  9407. }
  9408. // Plus sign handling
  9409. else if (c == '+') {
  9410. if (space_as_plus) {
  9411. result += "%2B";
  9412. } else {
  9413. result += static_cast<char>(c);
  9414. }
  9415. }
  9416. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9417. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9418. c == '*' || c == ',' || c == ';') {
  9419. result += static_cast<char>(c);
  9420. }
  9421. // Colon and @ are allowed in query
  9422. else if (c == ':' || c == '@') {
  9423. result += static_cast<char>(c);
  9424. }
  9425. // Forward slash is allowed in query values
  9426. else if (c == '/') {
  9427. result += static_cast<char>(c);
  9428. }
  9429. // Question mark is allowed in query values (after first ?)
  9430. else if (c == '?') {
  9431. result += static_cast<char>(c);
  9432. } else {
  9433. result += '%';
  9434. char hex[3];
  9435. snprintf(hex, sizeof(hex), "%02X", c);
  9436. result.append(hex, 2);
  9437. }
  9438. }
  9439. return result;
  9440. }
  9441. inline std::string decode_query_component(const std::string &component,
  9442. bool plus_as_space) {
  9443. std::string result;
  9444. result.reserve(component.size());
  9445. for (size_t i = 0; i < component.size(); i++) {
  9446. if (component[i] == '%' && i + 2 < component.size()) {
  9447. auto val = 0;
  9448. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9449. result += static_cast<char>(val);
  9450. i += 2;
  9451. } else {
  9452. result += component[i];
  9453. }
  9454. } else if (component[i] == '+' && plus_as_space) {
  9455. result += ' '; // + becomes space in form-urlencoded
  9456. } else {
  9457. result += component[i];
  9458. }
  9459. }
  9460. return result;
  9461. }
  9462. inline std::string sanitize_filename(const std::string &filename) {
  9463. // Extract basename: find the last path separator (/ or \)
  9464. auto pos = filename.find_last_of("/\\");
  9465. auto result =
  9466. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9467. // Strip null bytes
  9468. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9469. // Trim whitespace
  9470. {
  9471. auto start = result.find_first_not_of(" \t");
  9472. auto end = result.find_last_not_of(" \t");
  9473. result = (start == std::string::npos)
  9474. ? ""
  9475. : result.substr(start, end - start + 1);
  9476. }
  9477. // Reject . and ..
  9478. if (result == "." || result == "..") { return ""; }
  9479. return result;
  9480. }
  9481. inline std::string append_query_params(const std::string &path,
  9482. const Params &params) {
  9483. std::string path_with_query = path;
  9484. thread_local const std::regex re("[^?]+\\?.*");
  9485. auto delm = std::regex_match(path, re) ? '&' : '?';
  9486. path_with_query += delm + detail::params_to_query_str(params);
  9487. return path_with_query;
  9488. }
  9489. // Header utilities
  9490. inline std::pair<std::string, std::string>
  9491. make_range_header(const Ranges &ranges) {
  9492. std::string field = "bytes=";
  9493. auto i = 0;
  9494. for (const auto &r : ranges) {
  9495. if (i != 0) { field += ", "; }
  9496. if (r.first != -1) { field += std::to_string(r.first); }
  9497. field += '-';
  9498. if (r.second != -1) { field += std::to_string(r.second); }
  9499. i++;
  9500. }
  9501. return std::make_pair("Range", std::move(field));
  9502. }
  9503. inline std::pair<std::string, std::string>
  9504. make_basic_authentication_header(const std::string &username,
  9505. const std::string &password, bool is_proxy) {
  9506. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9507. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9508. return std::make_pair(key, std::move(field));
  9509. }
  9510. inline std::pair<std::string, std::string>
  9511. make_bearer_token_authentication_header(const std::string &token,
  9512. bool is_proxy = false) {
  9513. auto field = "Bearer " + token;
  9514. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9515. return std::make_pair(key, std::move(field));
  9516. }
  9517. // Request implementation
  9518. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9519. size_t id) const {
  9520. return detail::get_header_value_u64(headers, key, def, id);
  9521. }
  9522. inline bool Request::has_header(const std::string &key) const {
  9523. return detail::has_header(headers, key);
  9524. }
  9525. inline std::string Request::get_header_value(const std::string &key,
  9526. const char *def, size_t id) const {
  9527. return detail::get_header_value(headers, key, def, id);
  9528. }
  9529. inline size_t Request::get_header_value_count(const std::string &key) const {
  9530. return detail::get_header_value_count(headers, key);
  9531. }
  9532. inline void Request::set_header(const std::string &key,
  9533. const std::string &val) {
  9534. detail::set_header(headers, key, val);
  9535. }
  9536. inline bool Request::has_trailer(const std::string &key) const {
  9537. return trailers.find(key) != trailers.end();
  9538. }
  9539. inline std::string Request::get_trailer_value(const std::string &key,
  9540. size_t id) const {
  9541. return detail::get_multimap_value(trailers, key, id);
  9542. }
  9543. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9544. return trailers.count(key);
  9545. }
  9546. inline bool Request::has_param(const std::string &key) const {
  9547. return params.find(key) != params.end();
  9548. }
  9549. inline std::string Request::get_param_value(const std::string &key,
  9550. size_t id) const {
  9551. return detail::get_multimap_value(params, key, id);
  9552. }
  9553. inline std::vector<std::string>
  9554. Request::get_param_values(const std::string &key) const {
  9555. auto rng = params.equal_range(key);
  9556. std::vector<std::string> values;
  9557. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9558. for (auto it = rng.first; it != rng.second; ++it) {
  9559. values.push_back(it->second);
  9560. }
  9561. return values;
  9562. }
  9563. inline size_t Request::get_param_value_count(const std::string &key) const {
  9564. return params.count(key);
  9565. }
  9566. inline bool Request::is_multipart_form_data() const {
  9567. const auto &content_type = get_header_value("Content-Type");
  9568. return detail::extract_media_type(content_type) == "multipart/form-data";
  9569. }
  9570. // Multipart FormData implementation
  9571. inline std::string MultipartFormData::get_field(const std::string &key,
  9572. size_t id) const {
  9573. auto rng = fields.equal_range(key);
  9574. auto it = rng.first;
  9575. std::advance(it, static_cast<ssize_t>(id));
  9576. if (it != rng.second) { return it->second.content; }
  9577. return std::string();
  9578. }
  9579. inline std::vector<std::string>
  9580. MultipartFormData::get_fields(const std::string &key) const {
  9581. std::vector<std::string> values;
  9582. auto rng = fields.equal_range(key);
  9583. for (auto it = rng.first; it != rng.second; it++) {
  9584. values.push_back(it->second.content);
  9585. }
  9586. return values;
  9587. }
  9588. inline bool MultipartFormData::has_field(const std::string &key) const {
  9589. return fields.find(key) != fields.end();
  9590. }
  9591. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9592. return fields.count(key);
  9593. }
  9594. inline FormData MultipartFormData::get_file(const std::string &key,
  9595. size_t id) const {
  9596. return detail::get_multimap_value(files, key, id);
  9597. }
  9598. inline std::vector<FormData>
  9599. MultipartFormData::get_files(const std::string &key) const {
  9600. std::vector<FormData> values;
  9601. auto rng = files.equal_range(key);
  9602. for (auto it = rng.first; it != rng.second; it++) {
  9603. values.push_back(it->second);
  9604. }
  9605. return values;
  9606. }
  9607. inline bool MultipartFormData::has_file(const std::string &key) const {
  9608. return files.find(key) != files.end();
  9609. }
  9610. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9611. return files.count(key);
  9612. }
  9613. // Multipart FormData writer implementation
  9614. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9615. return detail::is_multipart_boundary_chars_valid(boundary);
  9616. }
  9617. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9618. : boundary_(detail::make_multipart_data_boundary()) {}
  9619. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9620. : boundary_(std::move(boundary)) {}
  9621. inline const std::string &MultipartFormDataWriter::boundary() const {
  9622. return boundary_;
  9623. }
  9624. inline std::string MultipartFormDataWriter::content_type() const {
  9625. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9626. }
  9627. inline std::string
  9628. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9629. return detail::serialize_multipart_formdata(items, boundary_);
  9630. }
  9631. inline size_t MultipartFormDataWriter::content_length(
  9632. const UploadFormDataItems &items) const {
  9633. return detail::get_multipart_content_length(items, boundary_);
  9634. }
  9635. inline std::string
  9636. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9637. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9638. }
  9639. inline std::string MultipartFormDataWriter::item_end() {
  9640. return detail::serialize_multipart_formdata_item_end();
  9641. }
  9642. inline std::string MultipartFormDataWriter::finish() const {
  9643. return detail::serialize_multipart_formdata_finish(boundary_);
  9644. }
  9645. // Response implementation
  9646. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9647. size_t id) const {
  9648. return detail::get_header_value_u64(headers, key, def, id);
  9649. }
  9650. inline bool Response::has_header(const std::string &key) const {
  9651. return headers.find(key) != headers.end();
  9652. }
  9653. inline std::string Response::get_header_value(const std::string &key,
  9654. const char *def,
  9655. size_t id) const {
  9656. return detail::get_header_value(headers, key, def, id);
  9657. }
  9658. inline size_t Response::get_header_value_count(const std::string &key) const {
  9659. return detail::get_header_value_count(headers, key);
  9660. }
  9661. inline void Response::set_header(const std::string &key,
  9662. const std::string &val) {
  9663. detail::set_header(headers, key, val);
  9664. }
  9665. inline bool Response::has_trailer(const std::string &key) const {
  9666. return trailers.find(key) != trailers.end();
  9667. }
  9668. inline std::string Response::get_trailer_value(const std::string &key,
  9669. size_t id) const {
  9670. return detail::get_multimap_value(trailers, key, id);
  9671. }
  9672. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9673. return trailers.count(key);
  9674. }
  9675. inline void Response::set_redirect(const std::string &url, int stat) {
  9676. if (detail::fields::is_field_value(url)) {
  9677. set_header("Location", url);
  9678. if (300 <= stat && stat < 400) {
  9679. this->status = stat;
  9680. } else {
  9681. this->status = StatusCode::Found_302;
  9682. }
  9683. }
  9684. }
  9685. inline void Response::set_content(const char *s, size_t n,
  9686. const std::string &content_type) {
  9687. body.assign(s, n);
  9688. auto rng = headers.equal_range("Content-Type");
  9689. headers.erase(rng.first, rng.second);
  9690. set_header("Content-Type", content_type);
  9691. content_coding_ = detail::EncodingType::None;
  9692. }
  9693. inline void Response::set_content(const std::string &s,
  9694. const std::string &content_type) {
  9695. set_content(s.data(), s.size(), content_type);
  9696. }
  9697. inline void Response::set_content(std::string &&s,
  9698. const std::string &content_type) {
  9699. body = std::move(s);
  9700. auto rng = headers.equal_range("Content-Type");
  9701. headers.erase(rng.first, rng.second);
  9702. set_header("Content-Type", content_type);
  9703. content_coding_ = detail::EncodingType::None;
  9704. }
  9705. inline void Response::set_content_provider(
  9706. size_t in_length, const std::string &content_type, ContentProvider provider,
  9707. ContentProviderResourceReleaser resource_releaser) {
  9708. set_header("Content-Type", content_type);
  9709. content_length_ = in_length;
  9710. if (in_length > 0) { content_provider_ = std::move(provider); }
  9711. content_provider_resource_releaser_ = std::move(resource_releaser);
  9712. is_chunked_content_provider_ = false;
  9713. content_coding_ = detail::EncodingType::None;
  9714. }
  9715. inline void Response::set_content_provider(
  9716. const std::string &content_type, ContentProviderWithoutLength provider,
  9717. ContentProviderResourceReleaser resource_releaser) {
  9718. set_header("Content-Type", content_type);
  9719. content_length_ = 0;
  9720. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9721. content_provider_resource_releaser_ = std::move(resource_releaser);
  9722. is_chunked_content_provider_ = false;
  9723. content_coding_ = detail::EncodingType::None;
  9724. }
  9725. inline void Response::set_chunked_content_provider(
  9726. const std::string &content_type, ContentProviderWithoutLength provider,
  9727. ContentProviderResourceReleaser resource_releaser) {
  9728. set_header("Content-Type", content_type);
  9729. content_length_ = 0;
  9730. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9731. content_provider_resource_releaser_ = std::move(resource_releaser);
  9732. is_chunked_content_provider_ = true;
  9733. content_coding_ = detail::EncodingType::None;
  9734. }
  9735. inline void Response::set_file_content(const std::string &path,
  9736. const std::string &content_type) {
  9737. file_content_path_ = path;
  9738. file_content_content_type_ = content_type;
  9739. }
  9740. inline void Response::set_file_content(const std::string &path) {
  9741. file_content_path_ = path;
  9742. }
  9743. // Result implementation
  9744. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9745. size_t def,
  9746. size_t id) const {
  9747. return detail::get_header_value_u64(request_headers_, key, def, id);
  9748. }
  9749. inline bool Result::has_request_header(const std::string &key) const {
  9750. return request_headers_.find(key) != request_headers_.end();
  9751. }
  9752. inline std::string Result::get_request_header_value(const std::string &key,
  9753. const char *def,
  9754. size_t id) const {
  9755. return detail::get_header_value(request_headers_, key, def, id);
  9756. }
  9757. inline size_t
  9758. Result::get_request_header_value_count(const std::string &key) const {
  9759. return request_headers_.count(key);
  9760. }
  9761. // Stream implementation
  9762. inline ssize_t Stream::write(const char *ptr) {
  9763. return write(ptr, strlen(ptr));
  9764. }
  9765. inline ssize_t Stream::write(const std::string &s) {
  9766. return write(s.data(), s.size());
  9767. }
  9768. // BodyReader implementation
  9769. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9770. if (!stream) {
  9771. last_error = Error::Connection;
  9772. return -1;
  9773. }
  9774. if (eof) { return 0; }
  9775. if (!chunked) {
  9776. // Content-Length based reading
  9777. if (has_content_length && bytes_read >= content_length) {
  9778. eof = true;
  9779. return 0;
  9780. }
  9781. auto to_read = len;
  9782. if (has_content_length) {
  9783. auto remaining = content_length - bytes_read;
  9784. to_read = (std::min)(len, remaining);
  9785. }
  9786. auto n = stream->read(buf, to_read);
  9787. if (n < 0) {
  9788. last_error = stream->get_error();
  9789. if (last_error == Error::Success) { last_error = Error::Read; }
  9790. eof = true;
  9791. return n;
  9792. }
  9793. if (n == 0) {
  9794. // Unexpected EOF before content_length
  9795. last_error = stream->get_error();
  9796. if (last_error == Error::Success) { last_error = Error::Read; }
  9797. eof = true;
  9798. return 0;
  9799. }
  9800. bytes_read += static_cast<size_t>(n);
  9801. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9802. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9803. last_error = Error::ExceedMaxPayloadSize;
  9804. eof = true;
  9805. return -1;
  9806. }
  9807. return n;
  9808. }
  9809. // Chunked transfer encoding: delegate to shared decoder instance.
  9810. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9811. size_t chunk_offset = 0;
  9812. size_t chunk_total = 0;
  9813. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9814. if (n < 0) {
  9815. last_error = stream->get_error();
  9816. if (last_error == Error::Success) { last_error = Error::Read; }
  9817. eof = true;
  9818. return n;
  9819. }
  9820. if (n == 0) {
  9821. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9822. eof = true;
  9823. return 0;
  9824. }
  9825. bytes_read += static_cast<size_t>(n);
  9826. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9827. last_error = Error::ExceedMaxPayloadSize;
  9828. eof = true;
  9829. return -1;
  9830. }
  9831. return n;
  9832. }
  9833. // ThreadPool implementation
  9834. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9835. time_t idle_timeout_sec)
  9836. : base_thread_count_(n), max_queued_requests_(mqr),
  9837. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9838. shutdown_(false) {
  9839. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9840. if (max_n != 0 && max_n < n) {
  9841. std::string msg = "max_threads must be >= base_threads";
  9842. throw std::invalid_argument(msg);
  9843. }
  9844. #endif
  9845. max_thread_count_ = max_n == 0 ? n : max_n;
  9846. threads_.reserve(base_thread_count_);
  9847. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9848. try {
  9849. #endif
  9850. for (size_t i = 0; i < base_thread_count_; i++) {
  9851. threads_.emplace_back(std::thread([this]() { worker(false); }));
  9852. }
  9853. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9854. } catch (...) {
  9855. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  9856. // signal the workers we already spawned to exit and join them so the
  9857. // vector destructor does not see joinable threads (which would call
  9858. // std::terminate). Then rethrow so the caller learns of the failure.
  9859. {
  9860. std::unique_lock<std::mutex> lock(mutex_);
  9861. shutdown_ = true;
  9862. }
  9863. cond_.notify_all();
  9864. for (auto &t : threads_) {
  9865. if (t.joinable()) { t.join(); }
  9866. }
  9867. throw;
  9868. }
  9869. #endif
  9870. }
  9871. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  9872. {
  9873. std::unique_lock<std::mutex> lock(mutex_);
  9874. if (shutdown_) { return false; }
  9875. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  9876. return false;
  9877. }
  9878. jobs_.push_back(std::move(fn));
  9879. // Spawn a dynamic thread if no idle threads and under max
  9880. if (idle_thread_count_ == 0 &&
  9881. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  9882. cleanup_finished_threads();
  9883. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  9884. }
  9885. }
  9886. cond_.notify_one();
  9887. return true;
  9888. }
  9889. inline void ThreadPool::shutdown() {
  9890. {
  9891. std::unique_lock<std::mutex> lock(mutex_);
  9892. shutdown_ = true;
  9893. }
  9894. cond_.notify_all();
  9895. for (auto &t : threads_) {
  9896. if (t.joinable()) { t.join(); }
  9897. }
  9898. // Move dynamic_threads_ to a local list under the lock to avoid racing
  9899. // with worker threads that call move_to_finished() concurrently.
  9900. std::list<std::thread> remaining_dynamic;
  9901. {
  9902. std::unique_lock<std::mutex> lock(mutex_);
  9903. remaining_dynamic = std::move(dynamic_threads_);
  9904. }
  9905. for (auto &t : remaining_dynamic) {
  9906. if (t.joinable()) { t.join(); }
  9907. }
  9908. std::unique_lock<std::mutex> lock(mutex_);
  9909. cleanup_finished_threads();
  9910. }
  9911. inline void ThreadPool::move_to_finished(std::thread::id id) {
  9912. // Must be called with mutex_ held
  9913. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  9914. if (it->get_id() == id) {
  9915. finished_threads_.push_back(std::move(*it));
  9916. dynamic_threads_.erase(it);
  9917. return;
  9918. }
  9919. }
  9920. }
  9921. inline void ThreadPool::cleanup_finished_threads() {
  9922. // Must be called with mutex_ held
  9923. for (auto &t : finished_threads_) {
  9924. if (t.joinable()) { t.join(); }
  9925. }
  9926. finished_threads_.clear();
  9927. }
  9928. inline void ThreadPool::worker(bool is_dynamic) {
  9929. for (;;) {
  9930. std::function<void()> fn;
  9931. {
  9932. std::unique_lock<std::mutex> lock(mutex_);
  9933. idle_thread_count_++;
  9934. if (is_dynamic) {
  9935. auto has_work =
  9936. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  9937. [&] { return !jobs_.empty() || shutdown_; });
  9938. if (!has_work) {
  9939. // Timed out with no work - exit this dynamic thread
  9940. idle_thread_count_--;
  9941. move_to_finished(std::this_thread::get_id());
  9942. break;
  9943. }
  9944. } else {
  9945. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  9946. }
  9947. idle_thread_count_--;
  9948. if (shutdown_ && jobs_.empty()) { break; }
  9949. fn = std::move(jobs_.front());
  9950. jobs_.pop_front();
  9951. }
  9952. assert(true == static_cast<bool>(fn));
  9953. fn();
  9954. }
  9955. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  9956. !defined(LIBRESSL_VERSION_NUMBER)
  9957. OPENSSL_thread_stop();
  9958. #endif
  9959. }
  9960. /*
  9961. * Group 1 (continued): detail namespace - Stream implementations
  9962. */
  9963. namespace detail {
  9964. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  9965. time_t timeout_sec, time_t timeout_usec,
  9966. time_t &actual_timeout_sec,
  9967. time_t &actual_timeout_usec) {
  9968. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  9969. auto actual_timeout_msec =
  9970. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  9971. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  9972. actual_timeout_sec = actual_timeout_msec / 1000;
  9973. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  9974. }
  9975. // Socket stream implementation
  9976. inline SocketStream::SocketStream(
  9977. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  9978. time_t write_timeout_sec, time_t write_timeout_usec,
  9979. time_t max_timeout_msec,
  9980. std::chrono::time_point<std::chrono::steady_clock> start_time)
  9981. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  9982. read_timeout_usec_(read_timeout_usec),
  9983. write_timeout_sec_(write_timeout_sec),
  9984. write_timeout_usec_(write_timeout_usec),
  9985. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  9986. read_buff_(read_buff_size_, 0) {}
  9987. inline SocketStream::~SocketStream() = default;
  9988. inline bool SocketStream::is_readable() const {
  9989. return read_buff_off_ < read_buff_content_size_;
  9990. }
  9991. inline bool SocketStream::wait_readable() const {
  9992. if (max_timeout_msec_ <= 0) {
  9993. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  9994. }
  9995. time_t read_timeout_sec;
  9996. time_t read_timeout_usec;
  9997. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  9998. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  9999. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10000. }
  10001. inline bool SocketStream::wait_writable() const {
  10002. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10003. }
  10004. inline bool SocketStream::ensure_readable() {
  10005. if (readable_hint_) {
  10006. readable_hint_ = false;
  10007. return true;
  10008. }
  10009. return wait_readable();
  10010. }
  10011. inline const char *SocketStream::buffered_data(size_t &size) const {
  10012. size = read_buff_content_size_ - read_buff_off_;
  10013. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10014. }
  10015. inline void SocketStream::consume_buffered(size_t size) {
  10016. assert(size <= read_buff_content_size_ - read_buff_off_);
  10017. read_buff_off_ += size;
  10018. }
  10019. inline bool SocketStream::is_peer_alive() const {
  10020. return detail::is_socket_alive(sock_);
  10021. }
  10022. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10023. #ifdef _WIN32
  10024. size =
  10025. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10026. #else
  10027. size = (std::min)(size,
  10028. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10029. #endif
  10030. if (read_buff_off_ < read_buff_content_size_) {
  10031. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10032. if (size <= remaining_size) {
  10033. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10034. read_buff_off_ += size;
  10035. return static_cast<ssize_t>(size);
  10036. } else {
  10037. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10038. read_buff_off_ += remaining_size;
  10039. return static_cast<ssize_t>(remaining_size);
  10040. }
  10041. }
  10042. if (!ensure_readable()) {
  10043. error_ = Error::Timeout;
  10044. return -1;
  10045. }
  10046. read_buff_off_ = 0;
  10047. read_buff_content_size_ = 0;
  10048. if (size < read_buff_size_) {
  10049. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10050. CPPHTTPLIB_RECV_FLAGS);
  10051. if (n <= 0) {
  10052. if (n == 0) {
  10053. error_ = Error::ConnectionClosed;
  10054. } else {
  10055. error_ = Error::Read;
  10056. }
  10057. return n;
  10058. } else if (n <= static_cast<ssize_t>(size)) {
  10059. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10060. return n;
  10061. } else {
  10062. memcpy(ptr, read_buff_.data(), size);
  10063. read_buff_off_ = size;
  10064. read_buff_content_size_ = static_cast<size_t>(n);
  10065. return static_cast<ssize_t>(size);
  10066. }
  10067. } else {
  10068. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10069. if (n <= 0) {
  10070. if (n == 0) {
  10071. error_ = Error::ConnectionClosed;
  10072. } else {
  10073. error_ = Error::Read;
  10074. }
  10075. }
  10076. return n;
  10077. }
  10078. }
  10079. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10080. if (!wait_writable()) { return -1; }
  10081. #if defined(_WIN32) && !defined(_WIN64)
  10082. size =
  10083. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10084. #endif
  10085. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10086. }
  10087. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10088. int &port) const {
  10089. return detail::get_remote_ip_and_port(sock_, ip, port);
  10090. }
  10091. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10092. int &port) const {
  10093. return detail::get_local_ip_and_port(sock_, ip, port);
  10094. }
  10095. inline socket_t SocketStream::socket() const { return sock_; }
  10096. inline time_t SocketStream::duration() const {
  10097. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10098. std::chrono::steady_clock::now() - start_time_)
  10099. .count();
  10100. }
  10101. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10102. read_timeout_sec_ = sec;
  10103. read_timeout_usec_ = usec;
  10104. }
  10105. // Buffer stream implementation
  10106. inline bool BufferStream::is_readable() const { return true; }
  10107. inline bool BufferStream::wait_readable() const { return true; }
  10108. inline bool BufferStream::wait_writable() const { return true; }
  10109. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10110. #if defined(_MSC_VER) && _MSC_VER < 1910
  10111. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10112. #else
  10113. auto len_read = buffer.copy(ptr, size, position);
  10114. #endif
  10115. position += static_cast<size_t>(len_read);
  10116. return static_cast<ssize_t>(len_read);
  10117. }
  10118. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10119. buffer.append(ptr, size);
  10120. return static_cast<ssize_t>(size);
  10121. }
  10122. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10123. int & /*port*/) const {}
  10124. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10125. int & /*port*/) const {}
  10126. inline socket_t BufferStream::socket() const { return 0; }
  10127. inline time_t BufferStream::duration() const { return 0; }
  10128. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10129. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10130. : MatcherBase(pattern) {
  10131. constexpr const char marker[] = "/:";
  10132. // One past the last ending position of a path param substring
  10133. std::size_t last_param_end = 0;
  10134. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10135. // Needed to ensure that parameter names are unique during matcher
  10136. // construction
  10137. // If exceptions are disabled, only last duplicate path
  10138. // parameter will be set
  10139. std::unordered_set<std::string> param_name_set;
  10140. #endif
  10141. while (true) {
  10142. const auto marker_pos = pattern.find(
  10143. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10144. if (marker_pos == std::string::npos) { break; }
  10145. static_fragments_.push_back(
  10146. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10147. const auto param_name_start = marker_pos + str_len(marker);
  10148. auto sep_pos = pattern.find(separator, param_name_start);
  10149. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10150. auto param_name =
  10151. pattern.substr(param_name_start, sep_pos - param_name_start);
  10152. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10153. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10154. std::string msg = "Encountered path parameter '" + param_name +
  10155. "' multiple times in route pattern '" + pattern + "'.";
  10156. throw std::invalid_argument(msg);
  10157. }
  10158. #endif
  10159. param_names_.push_back(std::move(param_name));
  10160. last_param_end = sep_pos + 1;
  10161. }
  10162. if (last_param_end < pattern.length()) {
  10163. static_fragments_.push_back(pattern.substr(last_param_end));
  10164. }
  10165. }
  10166. inline bool PathParamsMatcher::match(Request &request) const {
  10167. request.matches = std::smatch();
  10168. request.path_params.clear();
  10169. // A pattern without parameters is just a literal path to compare against
  10170. if (param_names_.empty()) { return request.path == pattern(); }
  10171. request.path_params.reserve(param_names_.size());
  10172. // One past the position at which the path matched the pattern last time
  10173. std::size_t starting_pos = 0;
  10174. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10175. const auto &fragment = static_fragments_[i];
  10176. if (starting_pos + fragment.length() > request.path.length()) {
  10177. return false;
  10178. }
  10179. // Avoid unnecessary allocation by using strncmp instead of substr +
  10180. // comparison
  10181. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10182. fragment.length()) != 0) {
  10183. return false;
  10184. }
  10185. starting_pos += fragment.length();
  10186. // Should only happen when we have a static fragment after a param
  10187. // Example: '/users/:id/subscriptions'
  10188. // The 'subscriptions' fragment here does not have a corresponding param
  10189. if (i >= param_names_.size()) { continue; }
  10190. auto sep_pos = request.path.find(separator, starting_pos);
  10191. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10192. const auto &param_name = param_names_[i];
  10193. request.path_params.emplace(
  10194. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10195. // Mark everything up to '/' as matched
  10196. starting_pos = sep_pos + 1;
  10197. }
  10198. // Returns false if the path is longer than the pattern
  10199. return starting_pos >= request.path.length();
  10200. }
  10201. inline bool RegexMatcher::match(Request &request) const {
  10202. request.path_params.clear();
  10203. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10204. // a non-match rather than risking a stack overflow in std::regex_match.
  10205. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10206. return false;
  10207. }
  10208. return std::regex_match(request.path, request.matches, regex_);
  10209. }
  10210. // Enclose IPv6 address in brackets if needed
  10211. inline std::string prepare_host_string(const std::string &host) {
  10212. // Enclose IPv6 address in brackets (but not if already enclosed)
  10213. if (host.find(':') == std::string::npos ||
  10214. (!host.empty() && host[0] == '[')) {
  10215. // IPv4, hostname, or already bracketed IPv6
  10216. return host;
  10217. } else {
  10218. // IPv6 address without brackets
  10219. return "[" + host + "]";
  10220. }
  10221. }
  10222. inline std::string make_host_and_port_string(const std::string &host, int port,
  10223. bool is_ssl) {
  10224. auto result = prepare_host_string(host);
  10225. // Append port if not default
  10226. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10227. ; // do nothing
  10228. } else {
  10229. result += ":" + std::to_string(port);
  10230. }
  10231. return result;
  10232. }
  10233. // Create "host:port" string always including port number (for CONNECT method)
  10234. inline std::string
  10235. make_host_and_port_string_always_port(const std::string &host, int port) {
  10236. return prepare_host_string(host) + ":" + std::to_string(port);
  10237. }
  10238. // Value for the Host header a client sends when the caller supplied none.
  10239. // Only the value: callers decide where in their header list it goes.
  10240. inline std::string make_default_host_header_value(const std::string &host,
  10241. int port, bool is_ssl,
  10242. int address_family) {
  10243. if (address_family == AF_UNIX) { return "localhost"; }
  10244. return make_host_and_port_string(host, port, is_ssl);
  10245. }
  10246. inline void add_default_user_agent_header(Request &req) {
  10247. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10248. if (!req.has_header("User-Agent")) {
  10249. req.set_header("User-Agent",
  10250. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10251. }
  10252. #else
  10253. (void)req;
  10254. #endif
  10255. }
  10256. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10257. NormalizedTarget normalize_target(const std::string &host);
  10258. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10259. bool host_matches_no_proxy(const NormalizedTarget &target,
  10260. const std::vector<NoProxyEntry> &entries);
  10261. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10262. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10263. if (prefix_bits == 0) { return true; }
  10264. int full_bytes = prefix_bits / 8;
  10265. int rem_bits = prefix_bits % 8;
  10266. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10267. static_cast<size_t>(full_bytes)) != 0) {
  10268. return false;
  10269. }
  10270. if (rem_bits == 0) { return true; }
  10271. auto i = static_cast<size_t>(full_bytes);
  10272. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10273. return (ip[i] & mask) == (net[i] & mask);
  10274. }
  10275. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10276. if (token.empty()) { return false; }
  10277. if (token == "*") {
  10278. out.kind = NoProxyKind::Wildcard;
  10279. return true;
  10280. }
  10281. auto slash = token.find('/');
  10282. std::string addr_part =
  10283. (slash == std::string::npos) ? token : token.substr(0, slash);
  10284. std::string prefix_part =
  10285. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10286. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10287. // don't silently treat it as a /32 (or /128).
  10288. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10289. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10290. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10291. // when brackets are present.
  10292. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10293. addr_part.back() == ']';
  10294. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10295. if (!bracketed) {
  10296. struct in_addr v4;
  10297. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10298. int prefix = 32;
  10299. if (!prefix_part.empty()) {
  10300. auto r = from_chars(prefix_part.data(),
  10301. prefix_part.data() + prefix_part.size(), prefix);
  10302. if (r.ec != std::errc{} ||
  10303. r.ptr != prefix_part.data() + prefix_part.size()) {
  10304. return false;
  10305. }
  10306. if (prefix < 0 || prefix > 32) { return false; }
  10307. }
  10308. out.kind = NoProxyKind::IPv4Cidr;
  10309. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10310. out.prefix_bits = prefix;
  10311. return true;
  10312. }
  10313. }
  10314. struct in6_addr v6;
  10315. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10316. int prefix = 128;
  10317. if (!prefix_part.empty()) {
  10318. auto r = from_chars(prefix_part.data(),
  10319. prefix_part.data() + prefix_part.size(), prefix);
  10320. if (r.ec != std::errc{} ||
  10321. r.ptr != prefix_part.data() + prefix_part.size()) {
  10322. return false;
  10323. }
  10324. if (prefix < 0 || prefix > 128) { return false; }
  10325. }
  10326. out.kind = NoProxyKind::IPv6Cidr;
  10327. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10328. out.prefix_bits = prefix;
  10329. return true;
  10330. }
  10331. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10332. // the entry is malformed — don't fall through to the hostname branch.
  10333. if (bracketed) { return false; }
  10334. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10335. if (slash != std::string::npos) { return false; }
  10336. // Port-specific entries (host:port) are not supported.
  10337. if (token.find(':') != std::string::npos) { return false; }
  10338. std::string hostname = case_ignore::to_lower(token);
  10339. while (!hostname.empty() && hostname.front() == '.') {
  10340. hostname.erase(hostname.begin());
  10341. }
  10342. while (!hostname.empty() && hostname.back() == '.') {
  10343. hostname.pop_back();
  10344. }
  10345. if (hostname.empty()) { return false; }
  10346. out.kind = NoProxyKind::HostnameSuffix;
  10347. out.hostname_pattern = std::move(hostname);
  10348. return true;
  10349. }
  10350. inline NormalizedTarget normalize_target(const std::string &host) {
  10351. NormalizedTarget t;
  10352. std::string h = host;
  10353. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10354. h = h.substr(1, h.size() - 2);
  10355. }
  10356. // Strip a single trailing dot so "example.com." canonicalizes to
  10357. // "example.com".
  10358. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10359. t.hostname = case_ignore::to_lower(h);
  10360. if (!t.hostname.empty()) {
  10361. struct in_addr v4;
  10362. struct in6_addr v6;
  10363. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10364. t.is_ipv4 = true;
  10365. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10366. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10367. t.is_ipv6 = true;
  10368. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10369. }
  10370. }
  10371. return t;
  10372. }
  10373. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10374. const std::vector<NoProxyEntry> &entries) {
  10375. if (target.hostname.empty()) { return false; }
  10376. for (const auto &e : entries) {
  10377. switch (e.kind) {
  10378. case NoProxyKind::Wildcard: return true;
  10379. case NoProxyKind::IPv4Cidr:
  10380. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10381. return true;
  10382. }
  10383. break;
  10384. case NoProxyKind::IPv6Cidr:
  10385. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10386. return true;
  10387. }
  10388. break;
  10389. case NoProxyKind::HostnameSuffix:
  10390. if (target.is_ipv4 || target.is_ipv6) { break; }
  10391. if (target.hostname == e.hostname_pattern) { return true; }
  10392. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10393. // an entry of "example.com".
  10394. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10395. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10396. if (target.hostname[offset - 1] == '.' &&
  10397. target.hostname.compare(offset, e.hostname_pattern.size(),
  10398. e.hostname_pattern) == 0) {
  10399. return true;
  10400. }
  10401. }
  10402. break;
  10403. }
  10404. }
  10405. return false;
  10406. }
  10407. template <typename T>
  10408. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10409. T header_writer, Error &error) {
  10410. for (const auto &h : headers) {
  10411. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10412. error = Error::InvalidHeaders;
  10413. return false;
  10414. }
  10415. }
  10416. if (header_writer(strm, headers) <= 0) {
  10417. error = Error::Write;
  10418. return false;
  10419. }
  10420. return true;
  10421. }
  10422. } // namespace detail
  10423. /*
  10424. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10425. */
  10426. #ifdef CPPHTTPLIB_SSL_ENABLED
  10427. namespace detail {
  10428. // SSL socket stream implementation
  10429. inline SSLSocketStream::SSLSocketStream(
  10430. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10431. time_t read_timeout_usec, time_t write_timeout_sec,
  10432. time_t write_timeout_usec, time_t max_timeout_msec,
  10433. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10434. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10435. read_timeout_usec_(read_timeout_usec),
  10436. write_timeout_sec_(write_timeout_sec),
  10437. write_timeout_usec_(write_timeout_usec),
  10438. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10439. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10440. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10441. // Note: create_session() also clears this, but SSLClient currently
  10442. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10443. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10444. // SSL session was created.
  10445. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10446. #endif
  10447. }
  10448. inline SSLSocketStream::~SSLSocketStream() = default;
  10449. inline bool SSLSocketStream::is_readable() const {
  10450. return tls::pending(session_) > 0;
  10451. }
  10452. inline bool SSLSocketStream::wait_readable() const {
  10453. if (max_timeout_msec_ <= 0) {
  10454. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10455. }
  10456. time_t read_timeout_sec;
  10457. time_t read_timeout_usec;
  10458. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10459. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10460. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10461. }
  10462. inline bool SSLSocketStream::wait_writable() const {
  10463. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10464. !tls::is_peer_closed(session_, sock_);
  10465. }
  10466. inline bool SSLSocketStream::ensure_readable() {
  10467. if (readable_hint_) {
  10468. readable_hint_ = false;
  10469. return true;
  10470. }
  10471. return wait_readable();
  10472. }
  10473. inline bool SSLSocketStream::is_peer_alive() const {
  10474. return !tls::is_peer_closed(session_, sock_);
  10475. }
  10476. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10477. if (tls::pending(session_) > 0) {
  10478. tls::TlsError err;
  10479. auto ret = tls::read(session_, ptr, size, err);
  10480. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10481. error_ = Error::ConnectionClosed;
  10482. }
  10483. return ret;
  10484. } else if (ensure_readable()) {
  10485. tls::TlsError err;
  10486. auto ret = tls::read(session_, ptr, size, err);
  10487. if (ret < 0) {
  10488. auto n = 1000;
  10489. #ifdef _WIN32
  10490. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10491. (err.code == tls::ErrorCode::SyscallError &&
  10492. WSAGetLastError() == WSAETIMEDOUT))) {
  10493. #else
  10494. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10495. #endif
  10496. if (tls::pending(session_) > 0) {
  10497. return tls::read(session_, ptr, size, err);
  10498. } else if (wait_readable()) {
  10499. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10500. ret = tls::read(session_, ptr, size, err);
  10501. if (ret >= 0) { return ret; }
  10502. } else {
  10503. break;
  10504. }
  10505. }
  10506. assert(ret < 0);
  10507. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10508. error_ = Error::ConnectionClosed;
  10509. }
  10510. return ret;
  10511. } else {
  10512. error_ = Error::Timeout;
  10513. return -1;
  10514. }
  10515. }
  10516. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10517. if (wait_writable()) {
  10518. auto handle_size =
  10519. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10520. tls::TlsError err;
  10521. auto ret = tls::write(session_, ptr, handle_size, err);
  10522. if (ret < 0) {
  10523. auto n = 1000;
  10524. #ifdef _WIN32
  10525. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10526. (err.code == tls::ErrorCode::SyscallError &&
  10527. WSAGetLastError() == WSAETIMEDOUT))) {
  10528. #else
  10529. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10530. #endif
  10531. if (wait_writable()) {
  10532. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10533. ret = tls::write(session_, ptr, handle_size, err);
  10534. if (ret >= 0) { return ret; }
  10535. } else {
  10536. break;
  10537. }
  10538. }
  10539. assert(ret < 0);
  10540. }
  10541. return ret;
  10542. }
  10543. return -1;
  10544. }
  10545. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10546. int &port) const {
  10547. detail::get_remote_ip_and_port(sock_, ip, port);
  10548. }
  10549. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10550. int &port) const {
  10551. detail::get_local_ip_and_port(sock_, ip, port);
  10552. }
  10553. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10554. inline time_t SSLSocketStream::duration() const {
  10555. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10556. std::chrono::steady_clock::now() - start_time_)
  10557. .count();
  10558. }
  10559. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10560. read_timeout_sec_ = sec;
  10561. read_timeout_usec_ = usec;
  10562. }
  10563. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10564. tls::session_t session,
  10565. time_t read_timeout_sec,
  10566. time_t read_timeout_usec,
  10567. time_t write_timeout_sec,
  10568. time_t write_timeout_usec)
  10569. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10570. read_timeout_usec_(read_timeout_usec),
  10571. write_timeout_sec_(write_timeout_sec),
  10572. write_timeout_usec_(write_timeout_usec),
  10573. start_time_(std::chrono::steady_clock::now()) {
  10574. // The receive and send paths run on different threads, so each TLS call is
  10575. // driven in non-blocking mode and readiness is awaited with select()
  10576. // outside the session lock. Set the socket non-blocking once here; it is
  10577. // never flipped back, so no thread races on the flag.
  10578. detail::set_nonblocking(sock_, true);
  10579. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10580. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10581. #endif
  10582. }
  10583. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10584. inline bool WebSocketSSLStream::is_readable() const {
  10585. std::lock_guard<std::mutex> guard(session_mutex_);
  10586. return tls::pending(session_) > 0;
  10587. }
  10588. inline bool WebSocketSSLStream::wait_readable() const {
  10589. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10590. }
  10591. inline bool WebSocketSSLStream::wait_writable() const {
  10592. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10593. // that probe toggles the socket's blocking flag, which would race with the
  10594. // concurrent reader on a permanently non-blocking socket.
  10595. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10596. }
  10597. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10598. tls::TlsError err;
  10599. auto n = 1000;
  10600. while (--n >= 0) {
  10601. {
  10602. std::lock_guard<std::mutex> guard(session_mutex_);
  10603. auto ret = tls::read(session_, ptr, size, err);
  10604. if (ret > 0) { return ret; }
  10605. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10606. error_ = Error::ConnectionClosed;
  10607. return ret;
  10608. }
  10609. }
  10610. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10611. // direction: the send path shares this session, so output it left pending
  10612. // has to be flushed before more input can be decrypted. Anything else is
  10613. // a hard error.
  10614. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10615. #ifdef _WIN32
  10616. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10617. needs_readable =
  10618. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10619. WSAGetLastError() == WSAETIMEDOUT);
  10620. #endif
  10621. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) { return -1; }
  10622. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10623. error_ = Error::Timeout;
  10624. return -1;
  10625. }
  10626. }
  10627. return -1;
  10628. }
  10629. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10630. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10631. tls::TlsError err;
  10632. auto n = 1000;
  10633. while (--n >= 0) {
  10634. {
  10635. std::lock_guard<std::mutex> guard(session_mutex_);
  10636. auto ret = tls::write(session_, ptr, handle_size, err);
  10637. if (ret >= 0) { return ret; }
  10638. }
  10639. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10640. // or a post-handshake message must be consumed before the record goes
  10641. // out. Anything else is a hard error.
  10642. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10643. #ifdef _WIN32
  10644. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10645. needs_writable =
  10646. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10647. WSAGetLastError() == WSAETIMEDOUT);
  10648. #endif
  10649. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10650. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10651. }
  10652. return -1;
  10653. }
  10654. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10655. int &port) const {
  10656. detail::get_remote_ip_and_port(sock_, ip, port);
  10657. }
  10658. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10659. int &port) const {
  10660. detail::get_local_ip_and_port(sock_, ip, port);
  10661. }
  10662. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10663. inline time_t WebSocketSSLStream::duration() const {
  10664. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10665. std::chrono::steady_clock::now() - start_time_)
  10666. .count();
  10667. }
  10668. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10669. read_timeout_sec_ = sec;
  10670. read_timeout_usec_ = usec;
  10671. }
  10672. } // namespace detail
  10673. #endif // CPPHTTPLIB_SSL_ENABLED
  10674. /*
  10675. * Group 4: Server implementation
  10676. */
  10677. // HTTP server implementation
  10678. inline Server::Server()
  10679. : new_task_queue([] {
  10680. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10681. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10682. }) {
  10683. #ifndef _WIN32
  10684. signal(SIGPIPE, SIG_IGN);
  10685. #endif
  10686. }
  10687. inline Server::~Server() = default;
  10688. inline std::unique_ptr<detail::MatcherBase>
  10689. Server::make_matcher(const std::string &pattern) {
  10690. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10691. // a path params pattern
  10692. if (pattern.find("/:") != std::string::npos) {
  10693. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10694. }
  10695. // A pattern with no regex metacharacter only has to be compared literally,
  10696. // which is what PathParamsMatcher already does when it captures no
  10697. // parameter, so std::regex is only worth building for the patterns that
  10698. // actually need it
  10699. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10700. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10701. }
  10702. return detail::make_unique<detail::RegexMatcher>(pattern);
  10703. }
  10704. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10705. return add_handler(get_handlers_, pattern, std::move(handler));
  10706. }
  10707. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10708. return add_handler(post_handlers_, pattern, std::move(handler));
  10709. }
  10710. inline Server &Server::Post(const std::string &pattern,
  10711. HandlerWithContentReader handler) {
  10712. return add_handler(post_handlers_for_content_reader_, pattern,
  10713. std::move(handler));
  10714. }
  10715. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10716. return add_handler(put_handlers_, pattern, std::move(handler));
  10717. }
  10718. inline Server &Server::Put(const std::string &pattern,
  10719. HandlerWithContentReader handler) {
  10720. return add_handler(put_handlers_for_content_reader_, pattern,
  10721. std::move(handler));
  10722. }
  10723. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10724. return add_handler(patch_handlers_, pattern, std::move(handler));
  10725. }
  10726. inline Server &Server::Patch(const std::string &pattern,
  10727. HandlerWithContentReader handler) {
  10728. return add_handler(patch_handlers_for_content_reader_, pattern,
  10729. std::move(handler));
  10730. }
  10731. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10732. return add_handler(delete_handlers_, pattern, std::move(handler));
  10733. }
  10734. inline Server &Server::Delete(const std::string &pattern,
  10735. HandlerWithContentReader handler) {
  10736. return add_handler(delete_handlers_for_content_reader_, pattern,
  10737. std::move(handler));
  10738. }
  10739. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10740. return add_handler(options_handlers_, pattern, std::move(handler));
  10741. }
  10742. inline const std::set<std::string> &Server::builtin_methods() {
  10743. thread_local const std::set<std::string> methods{
  10744. "GET", "HEAD", "POST", "PUT", "DELETE",
  10745. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10746. return methods;
  10747. }
  10748. inline Server::CustomHandlerEntry *
  10749. Server::custom_entry_for_registration(const std::string &method) {
  10750. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10751. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10752. // routing() before the custom tables are consulted, so a route registered
  10753. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10754. // there and would be reachable, but they carry protocol-level meaning
  10755. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10756. // library does not route.
  10757. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10758. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10759. has_invalid_registration_ = true;
  10760. return nullptr;
  10761. }
  10762. return &custom_handlers_[method];
  10763. }
  10764. inline Server &Server::CustomRoute(const std::string &method,
  10765. const std::string &pattern,
  10766. Handler handler) {
  10767. auto *entry = custom_entry_for_registration(method);
  10768. if (!entry) { return *this; }
  10769. return add_handler(entry->handlers, pattern, std::move(handler));
  10770. }
  10771. inline Server &Server::CustomRoute(const std::string &method,
  10772. const std::string &pattern,
  10773. HandlerWithContentReader handler) {
  10774. auto *entry = custom_entry_for_registration(method);
  10775. if (!entry) { return *this; }
  10776. return add_handler(entry->handlers_for_content_reader, pattern,
  10777. std::move(handler));
  10778. }
  10779. inline const Server::CustomHandlerEntry *
  10780. Server::find_custom_entry(const std::string &method) const {
  10781. // find() alone would be correct here. The empty() check is what keeps the
  10782. // per-request cost off servers that never call CustomRoute(), which is the
  10783. // overwhelmingly common case; keep it rather than walking into the tree.
  10784. if (custom_handlers_.empty()) { return nullptr; }
  10785. auto it = custom_handlers_.find(method);
  10786. return it == custom_handlers_.end() ? nullptr : &it->second;
  10787. }
  10788. inline Server &Server::WebSocket(const std::string &pattern,
  10789. WebSocketHandler handler) {
  10790. websocket_handlers_.push_back(
  10791. {make_matcher(pattern), std::move(handler), nullptr});
  10792. return *this;
  10793. }
  10794. inline Server &Server::WebSocket(const std::string &pattern,
  10795. WebSocketHandler handler,
  10796. SubProtocolSelector sub_protocol_selector) {
  10797. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10798. std::move(sub_protocol_selector)});
  10799. return *this;
  10800. }
  10801. inline bool Server::set_base_dir(const std::string &dir,
  10802. const std::string &mount_point) {
  10803. return set_mount_point(mount_point, dir);
  10804. }
  10805. inline bool Server::set_mount_point(const std::string &mount_point,
  10806. const std::string &dir, Headers headers) {
  10807. detail::FileStat stat(dir);
  10808. if (stat.is_dir()) {
  10809. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10810. if (!mnt.empty() && mnt[0] == '/') {
  10811. std::string resolved_base;
  10812. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10813. #if defined(_WIN32)
  10814. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10815. resolved_base += '\\';
  10816. }
  10817. #else
  10818. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10819. #endif
  10820. }
  10821. base_dirs_.push_back(
  10822. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10823. return true;
  10824. }
  10825. }
  10826. return false;
  10827. }
  10828. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10829. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10830. if (it->mount_point == mount_point) {
  10831. base_dirs_.erase(it);
  10832. return true;
  10833. }
  10834. }
  10835. return false;
  10836. }
  10837. inline Server &
  10838. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10839. const std::string &mime) {
  10840. file_extension_and_mimetype_map_[ext] = mime;
  10841. return *this;
  10842. }
  10843. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  10844. default_file_mimetype_ = mime;
  10845. return *this;
  10846. }
  10847. inline Server &Server::set_file_request_handler(Handler handler) {
  10848. file_request_handler_ = std::move(handler);
  10849. return *this;
  10850. }
  10851. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  10852. std::true_type) {
  10853. error_handler_ = std::move(handler);
  10854. return *this;
  10855. }
  10856. inline Server &Server::set_error_handler_core(Handler handler,
  10857. std::false_type) {
  10858. error_handler_ = [handler](const Request &req, Response &res) {
  10859. handler(req, res);
  10860. return HandlerResponse::Handled;
  10861. };
  10862. return *this;
  10863. }
  10864. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  10865. exception_handler_ = std::move(handler);
  10866. return *this;
  10867. }
  10868. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  10869. pre_routing_handler_ = std::move(handler);
  10870. return *this;
  10871. }
  10872. inline Server &Server::set_post_routing_handler(Handler handler) {
  10873. post_routing_handler_ = std::move(handler);
  10874. return *this;
  10875. }
  10876. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  10877. pre_request_handler_ = std::move(handler);
  10878. return *this;
  10879. }
  10880. inline Server &Server::set_logger(Logger logger) {
  10881. logger_ = std::move(logger);
  10882. return *this;
  10883. }
  10884. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  10885. error_logger_ = std::move(error_logger);
  10886. return *this;
  10887. }
  10888. inline Server &Server::set_pre_compression_logger(Logger logger) {
  10889. pre_compression_logger_ = std::move(logger);
  10890. return *this;
  10891. }
  10892. inline Server &
  10893. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  10894. expect_100_continue_handler_ = std::move(handler);
  10895. return *this;
  10896. }
  10897. inline Server &Server::set_start_handler(StartHandler handler) {
  10898. start_handler_ = std::move(handler);
  10899. return *this;
  10900. }
  10901. inline Server &Server::set_address_family(int family) {
  10902. address_family_ = family;
  10903. return *this;
  10904. }
  10905. inline Server &Server::set_tcp_nodelay(bool on) {
  10906. tcp_nodelay_ = on;
  10907. return *this;
  10908. }
  10909. inline Server &Server::set_ipv6_v6only(bool on) {
  10910. ipv6_v6only_ = on;
  10911. return *this;
  10912. }
  10913. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  10914. socket_options_ = std::move(socket_options);
  10915. return *this;
  10916. }
  10917. inline Server &Server::set_default_headers(Headers headers) {
  10918. default_headers_ = std::move(headers);
  10919. return *this;
  10920. }
  10921. inline Server &Server::set_header_writer(
  10922. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  10923. header_writer_ = writer;
  10924. return *this;
  10925. }
  10926. inline Server &
  10927. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  10928. trusted_proxies_ = proxies;
  10929. return *this;
  10930. }
  10931. inline Server &Server::set_keep_alive_max_count(size_t count) {
  10932. keep_alive_max_count_ = count;
  10933. return *this;
  10934. }
  10935. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  10936. keep_alive_timeout_sec_ = sec;
  10937. return *this;
  10938. }
  10939. template <class Rep, class Period>
  10940. inline Server &Server::set_keep_alive_timeout(
  10941. const std::chrono::duration<Rep, Period> &duration) {
  10942. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  10943. set_keep_alive_timeout(sec);
  10944. });
  10945. return *this;
  10946. }
  10947. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  10948. read_timeout_sec_ = sec;
  10949. read_timeout_usec_ = usec;
  10950. return *this;
  10951. }
  10952. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  10953. write_timeout_sec_ = sec;
  10954. write_timeout_usec_ = usec;
  10955. return *this;
  10956. }
  10957. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  10958. idle_interval_sec_ = sec;
  10959. idle_interval_usec_ = usec;
  10960. return *this;
  10961. }
  10962. inline Server &Server::set_payload_max_length(size_t length) {
  10963. payload_max_length_ = length;
  10964. return *this;
  10965. }
  10966. inline Server &Server::set_static_file_compression(bool on) {
  10967. static_file_compression_ = on;
  10968. return *this;
  10969. }
  10970. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  10971. static_file_compression_min_length_ = length;
  10972. return *this;
  10973. }
  10974. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  10975. static_file_compression_max_length_ = length;
  10976. return *this;
  10977. }
  10978. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  10979. websocket_max_missed_pongs_ = count;
  10980. return *this;
  10981. }
  10982. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  10983. websocket_ping_interval_sec_ = sec;
  10984. return *this;
  10985. }
  10986. template <class Rep, class Period>
  10987. inline Server &Server::set_websocket_ping_interval(
  10988. const std::chrono::duration<Rep, Period> &duration) {
  10989. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  10990. set_websocket_ping_interval(sec);
  10991. });
  10992. return *this;
  10993. }
  10994. inline bool Server::bind_to_port(const std::string &host, int port,
  10995. int socket_flags) {
  10996. auto ret = bind_internal(host, port, socket_flags);
  10997. if (ret == -1) { is_decommissioned = true; }
  10998. return ret >= 0;
  10999. }
  11000. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11001. auto ret = bind_internal(host, 0, socket_flags);
  11002. if (ret == -1) { is_decommissioned = true; }
  11003. return ret;
  11004. }
  11005. inline bool Server::listen_after_bind() { return listen_internal(); }
  11006. inline bool Server::listen(const std::string &host, int port,
  11007. int socket_flags) {
  11008. return bind_to_port(host, port, socket_flags) && listen_internal();
  11009. }
  11010. inline bool Server::is_running() const { return is_running_; }
  11011. inline void Server::wait_until_ready() const {
  11012. while (!is_running_ && !is_decommissioned) {
  11013. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11014. }
  11015. }
  11016. inline void Server::stop() noexcept {
  11017. // Release the listening socket whether or not the accept loop is running:
  11018. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11019. // exchange is what makes this safe to call concurrently with the accept loop.
  11020. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11021. if (sock != INVALID_SOCKET) {
  11022. detail::shutdown_socket(sock);
  11023. detail::close_socket(sock);
  11024. }
  11025. is_decommissioned = false;
  11026. }
  11027. inline void Server::decommission() { is_decommissioned = true; }
  11028. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11029. auto len = strlen(s);
  11030. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11031. len -= 2;
  11032. {
  11033. size_t count = 0;
  11034. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11035. switch (count) {
  11036. case 0: req.method = std::string(b, e); break;
  11037. case 1: req.target = std::string(b, e); break;
  11038. case 2: req.version = std::string(b, e); break;
  11039. default: break;
  11040. }
  11041. count++;
  11042. });
  11043. if (count != 3) { return false; }
  11044. }
  11045. // A method outside the built-in set is accepted only when a handler has been
  11046. // registered for it with CustomRoute().
  11047. const auto &methods = builtin_methods();
  11048. if (methods.find(req.method) == methods.end() &&
  11049. !find_custom_entry(req.method)) {
  11050. output_error_log(Error::InvalidHTTPMethod, &req);
  11051. return false;
  11052. }
  11053. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11054. output_error_log(Error::InvalidHTTPVersion, &req);
  11055. return false;
  11056. }
  11057. {
  11058. // Skip URL fragment
  11059. for (size_t i = 0; i < req.target.size(); i++) {
  11060. if (req.target[i] == '#') {
  11061. req.target.erase(i);
  11062. break;
  11063. }
  11064. }
  11065. detail::divide(req.target, '?',
  11066. [&](const char *lhs_data, std::size_t lhs_size,
  11067. const char *rhs_data, std::size_t rhs_size) {
  11068. req.path =
  11069. decode_path_component(std::string(lhs_data, lhs_size));
  11070. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11071. });
  11072. }
  11073. return true;
  11074. }
  11075. inline bool Server::write_response(Stream &strm, bool close_connection,
  11076. Request &req, Response &res) {
  11077. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11078. // incorrectly to the error content.
  11079. req.ranges.clear();
  11080. return write_response_core(strm, close_connection, req, res, false);
  11081. }
  11082. inline bool Server::write_response_with_content(Stream &strm,
  11083. bool close_connection,
  11084. const Request &req,
  11085. Response &res) {
  11086. return write_response_core(strm, close_connection, req, res, true);
  11087. }
  11088. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11089. const Request &req, Response &res,
  11090. bool need_apply_ranges) {
  11091. assert(res.status != -1);
  11092. if (400 <= res.status && error_handler_ &&
  11093. error_handler_(req, res) == HandlerResponse::Handled) {
  11094. need_apply_ranges = true;
  11095. }
  11096. std::string content_type;
  11097. std::string boundary;
  11098. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11099. // Prepare additional headers
  11100. if (close_connection ||
  11101. detail::has_header_token(req.headers, "Connection", "close") ||
  11102. 400 <= res.status) { // Don't leave connections open after errors
  11103. res.set_header("Connection", "close");
  11104. } else {
  11105. std::string s = "timeout=";
  11106. s += std::to_string(keep_alive_timeout_sec_);
  11107. s += ", max=";
  11108. s += std::to_string(keep_alive_max_count_);
  11109. res.set_header("Keep-Alive", s);
  11110. }
  11111. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11112. !res.has_header("Content-Type")) {
  11113. res.set_header("Content-Type", "text/plain");
  11114. }
  11115. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11116. !res.has_header("Content-Length")) {
  11117. res.set_header("Content-Length", "0");
  11118. }
  11119. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11120. res.set_header("Accept-Ranges", "bytes");
  11121. }
  11122. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11123. // Response line and headers
  11124. detail::BufferStream bstrm;
  11125. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11126. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11127. // Combine small body with headers to reduce write syscalls
  11128. if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
  11129. bstrm.write(res.body.data(), res.body.size());
  11130. }
  11131. // Log before writing to avoid race condition with client-side code that
  11132. // accesses logger-captured data immediately after receiving the response.
  11133. output_log(req, res);
  11134. // Flush buffer
  11135. auto &data = bstrm.get_buffer();
  11136. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11137. // Streaming body
  11138. auto ret = true;
  11139. if (req.method != "HEAD" && res.content_provider_) {
  11140. if (write_content_with_provider(strm, req, res, boundary, content_type)) {
  11141. res.content_provider_success_ = true;
  11142. } else {
  11143. ret = false;
  11144. }
  11145. }
  11146. return ret;
  11147. }
  11148. inline bool
  11149. Server::write_content_with_provider(Stream &strm, const Request &req,
  11150. Response &res, const std::string &boundary,
  11151. const std::string &content_type) {
  11152. auto is_shutting_down = [this]() {
  11153. return this->svr_sock_ == INVALID_SOCKET;
  11154. };
  11155. if (res.content_length_ > 0) {
  11156. // Only a 206 response is served as a partial representation, matching the
  11157. // condition `apply_ranges()` used to decide the Content-Length and the
  11158. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11159. // only for a 2xx status, slicing under any other status would write a body
  11160. // that disagrees with the header already sent, from an unchecked offset.
  11161. auto is_partial =
  11162. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11163. if (!is_partial) {
  11164. return detail::write_content(strm, res.content_provider_, 0,
  11165. res.content_length_, is_shutting_down);
  11166. } else if (req.ranges.size() == 1) {
  11167. auto offset_and_length = detail::get_range_offset_and_length(
  11168. req.ranges[0], res.content_length_);
  11169. return detail::write_content(strm, res.content_provider_,
  11170. offset_and_length.first,
  11171. offset_and_length.second, is_shutting_down);
  11172. } else {
  11173. return detail::write_multipart_ranges_data(
  11174. strm, req, res, boundary, content_type, res.content_length_,
  11175. is_shutting_down);
  11176. }
  11177. } else {
  11178. if (res.is_chunked_content_provider_) {
  11179. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11180. // re-negotiating here would disagree with them, e.g. once a handler's
  11181. // own Content-Encoding header suppresses the negotiation.
  11182. auto compressor = detail::make_compressor(res.content_coding_);
  11183. if (!compressor) {
  11184. compressor = detail::make_unique<detail::nocompressor>();
  11185. }
  11186. return detail::write_content_chunked(strm, res.content_provider_,
  11187. is_shutting_down, *compressor);
  11188. } else {
  11189. return detail::write_content_without_length(strm, res.content_provider_,
  11190. is_shutting_down);
  11191. }
  11192. }
  11193. }
  11194. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11195. FormFields::iterator cur_field;
  11196. FormFiles::iterator cur_file;
  11197. auto is_text_field = false;
  11198. size_t count = 0;
  11199. if (read_content_core(
  11200. strm, req, res,
  11201. // Regular
  11202. [&](const char *buf, size_t n) {
  11203. // Prevent arithmetic overflow when checking sizes.
  11204. // Avoid computing (req.body.size() + n) directly because
  11205. // adding two unsigned `size_t` values can wrap around and
  11206. // produce a small result instead of indicating overflow.
  11207. // Instead, check using subtraction: ensure `n` does not
  11208. // exceed the remaining capacity `max_size() - size()`.
  11209. if (req.body.size() >= req.body.max_size() ||
  11210. n > req.body.max_size() - req.body.size()) {
  11211. return false;
  11212. }
  11213. // Limit decompressed body size to payload_max_length_ to protect
  11214. // against "zip bomb" attacks where a small compressed payload
  11215. // decompresses to a massive size.
  11216. if (payload_max_length_ > 0 &&
  11217. (req.body.size() >= payload_max_length_ ||
  11218. n > payload_max_length_ - req.body.size())) {
  11219. return false;
  11220. }
  11221. req.body.append(buf, n);
  11222. return true;
  11223. },
  11224. // Multipart FormData
  11225. [&](const FormData &file) {
  11226. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11227. output_error_log(Error::TooManyFormDataFiles, &req);
  11228. return false;
  11229. }
  11230. if (file.filename.empty()) {
  11231. cur_field = req.form.fields.emplace(
  11232. file.name, FormField{file.name, file.content, file.headers});
  11233. is_text_field = true;
  11234. } else {
  11235. cur_file = req.form.files.emplace(file.name, file);
  11236. is_text_field = false;
  11237. }
  11238. return true;
  11239. },
  11240. [&](const char *buf, size_t n) {
  11241. if (is_text_field) {
  11242. auto &content = cur_field->second.content;
  11243. if (content.size() + n > content.max_size()) { return false; }
  11244. content.append(buf, n);
  11245. } else {
  11246. auto &content = cur_file->second.content;
  11247. if (content.size() + n > content.max_size()) { return false; }
  11248. content.append(buf, n);
  11249. }
  11250. return true;
  11251. })) {
  11252. const auto &content_type = req.get_header_value("Content-Type");
  11253. if (detail::extract_media_type(content_type) ==
  11254. "application/x-www-form-urlencoded") {
  11255. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11256. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11257. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11258. return false;
  11259. }
  11260. detail::parse_query_text(req.body, req.params);
  11261. }
  11262. return true;
  11263. }
  11264. return false;
  11265. }
  11266. inline bool Server::read_content_with_content_receiver(
  11267. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11268. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11269. return read_content_core(strm, req, res, std::move(receiver),
  11270. std::move(multipart_header),
  11271. std::move(multipart_receiver));
  11272. }
  11273. inline bool Server::read_content_core(
  11274. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11275. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11276. detail::FormDataParser multipart_form_data_parser;
  11277. ContentReceiverWithProgress out;
  11278. if (req.is_multipart_form_data()) {
  11279. const auto &content_type = req.get_header_value("Content-Type");
  11280. std::string boundary;
  11281. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11282. res.status = StatusCode::BadRequest_400;
  11283. output_error_log(Error::MultipartParsing, &req);
  11284. return false;
  11285. }
  11286. multipart_form_data_parser.set_boundary(std::move(boundary));
  11287. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11288. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11289. multipart_receiver);
  11290. };
  11291. } else {
  11292. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11293. size_t /*len*/) { return receiver(buf, n); };
  11294. }
  11295. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11296. // For non-SSL builds we still scan non-persistent connections for stray
  11297. // body bytes so the payload limit is enforced (413). On keep-alive,
  11298. // pending bytes may be the next request (issue #2450), so skip.
  11299. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11300. if (!req.has_header("Content-Length") &&
  11301. !detail::is_chunked_transfer_encoding(req.headers)) {
  11302. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11303. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11304. auto has_data = strm.is_readable();
  11305. if (!has_data) {
  11306. auto s = strm.socket();
  11307. if (s != INVALID_SOCKET) {
  11308. has_data = detail::select_read(s, 0, 0) > 0;
  11309. }
  11310. }
  11311. if (has_data) {
  11312. // Route through the same decompressing reader used by the
  11313. // length-framed and chunked paths below, so payload_max_length_ is
  11314. // enforced on the decompressed size here too instead of only on the
  11315. // compressed wire bytes.
  11316. return detail::read_content(strm, req, payload_max_length_, res.status,
  11317. nullptr, out, true);
  11318. }
  11319. }
  11320. return true;
  11321. }
  11322. #else
  11323. if (!req.has_header("Content-Length") &&
  11324. !detail::is_chunked_transfer_encoding(req.headers)) {
  11325. return true;
  11326. }
  11327. #endif
  11328. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11329. out, true)) {
  11330. return false;
  11331. }
  11332. req.body_consumed_ = true;
  11333. if (req.is_multipart_form_data()) {
  11334. if (!multipart_form_data_parser.is_valid()) {
  11335. res.status = StatusCode::BadRequest_400;
  11336. output_error_log(Error::MultipartParsing, &req);
  11337. return false;
  11338. }
  11339. }
  11340. return true;
  11341. }
  11342. inline bool Server::handle_file_request(Request &req, Response &res) {
  11343. for (const auto &entry : base_dirs_) {
  11344. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11345. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11346. // One that already ends in '/' (the root mount among them) carries its own
  11347. // boundary; set_mount_point() guarantees the mount point is not empty.
  11348. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11349. (entry.mount_point.back() == '/' ||
  11350. req.path.size() == entry.mount_point.size() ||
  11351. req.path[entry.mount_point.size()] == '/')) {
  11352. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11353. if (detail::is_valid_path(sub_path)) {
  11354. auto path = entry.base_dir + sub_path;
  11355. if (path.back() == '/') { path += "index.html"; }
  11356. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11357. // but symlinks/junctions can still escape the base directory.
  11358. if (!entry.resolved_base_dir.empty()) {
  11359. std::string resolved_path;
  11360. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11361. !detail::is_path_within_base(resolved_path,
  11362. entry.resolved_base_dir)) {
  11363. res.status = StatusCode::Forbidden_403;
  11364. return true;
  11365. }
  11366. }
  11367. detail::FileStat stat(path);
  11368. if (stat.is_dir()) {
  11369. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11370. return true;
  11371. }
  11372. if (stat.is_file()) {
  11373. for (const auto &kv : entry.headers) {
  11374. res.set_header(kv.first, kv.second);
  11375. }
  11376. auto content_type_of = [&]() {
  11377. return detail::find_content_type(
  11378. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11379. };
  11380. // Only the ETag needs the content type this early, and only to name
  11381. // the coding. Deciding it here would otherwise put a regex in front
  11382. // of the 304 below, which serving a file never used to pay for.
  11383. std::string content_type;
  11384. auto encoding = detail::EncodingType::None;
  11385. if (static_file_compression_) {
  11386. content_type = content_type_of();
  11387. encoding =
  11388. static_file_encoding(req, res, content_type, stat.size());
  11389. }
  11390. // The ETag names the representation actually sent, so a client that
  11391. // cached the compressed form revalidates against the compressed ETag
  11392. // and still gets a 304, while one that took identity keeps the plain
  11393. // ETag.
  11394. auto etag = detail::compute_etag(
  11395. stat, encoding == detail::EncodingType::None
  11396. ? std::string()
  11397. : std::string("-") + detail::encoding_name(encoding));
  11398. if (!etag.empty()) { res.set_header("ETag", etag); }
  11399. auto mtime = stat.mtime();
  11400. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11401. if (!last_modified.empty()) {
  11402. res.set_header("Last-Modified", last_modified);
  11403. }
  11404. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11405. check_if_range(req, etag, mtime);
  11406. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11407. if (!mm->is_open()) {
  11408. output_error_log(Error::OpenFile, &req);
  11409. return false;
  11410. }
  11411. if (!static_file_compression_) { content_type = content_type_of(); }
  11412. detail::set_file_content_provider(res, mm, content_type, encoding);
  11413. if (req.method != "HEAD" && file_request_handler_) {
  11414. file_request_handler_(req, res);
  11415. }
  11416. return true;
  11417. } else {
  11418. output_error_log(Error::OpenFile, &req);
  11419. }
  11420. }
  11421. }
  11422. }
  11423. return false;
  11424. }
  11425. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11426. const std::string &etag,
  11427. time_t mtime) const {
  11428. // Handle conditional GET:
  11429. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11430. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11431. if (req.has_header("If-None-Match")) {
  11432. if (!etag.empty()) {
  11433. auto val =
  11434. detail::get_combined_header_value(req.headers, "If-None-Match");
  11435. // NOTE: We use exact string matching here. This works correctly
  11436. // because our server always generates weak ETags (W/"..."), and
  11437. // clients typically send back the same ETag they received.
  11438. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11439. // If-None-Match, where W/"x" and "x" would match, but this
  11440. // simplified implementation requires exact matches.
  11441. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11442. [&](const char *b, const char *e) {
  11443. auto seg_len = static_cast<size_t>(e - b);
  11444. return (seg_len == 1 && *b == '*') ||
  11445. (seg_len == etag.size() &&
  11446. std::equal(b, e, etag.begin()));
  11447. });
  11448. if (ret) {
  11449. res.status = StatusCode::NotModified_304;
  11450. return true;
  11451. }
  11452. }
  11453. } else if (req.has_header("If-Modified-Since")) {
  11454. auto val = req.get_header_value("If-Modified-Since");
  11455. auto t = detail::parse_http_date(val);
  11456. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11457. res.status = StatusCode::NotModified_304;
  11458. return true;
  11459. }
  11460. }
  11461. return false;
  11462. }
  11463. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11464. time_t mtime) const {
  11465. // Handle If-Range for partial content requests (RFC 9110
  11466. // Section 13.1.5). If-Range is only evaluated when Range header is
  11467. // present. If the validator matches, serve partial content; otherwise
  11468. // serve full content.
  11469. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11470. auto val = req.get_header_value("If-Range");
  11471. auto is_valid_range = [&]() {
  11472. if (detail::is_strong_etag(val)) {
  11473. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11474. // comparison.
  11475. return (!etag.empty() && val == etag);
  11476. } else if (detail::is_weak_etag(val)) {
  11477. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11478. return false;
  11479. } else {
  11480. // HTTP-date comparison
  11481. auto t = detail::parse_http_date(val);
  11482. return (t != static_cast<time_t>(-1) && mtime <= t);
  11483. }
  11484. };
  11485. if (!is_valid_range()) {
  11486. // Validator doesn't match: ignore Range and serve full content
  11487. req.ranges.clear();
  11488. return false;
  11489. }
  11490. }
  11491. return true;
  11492. }
  11493. inline socket_t
  11494. Server::create_server_socket(const std::string &host, int port,
  11495. int socket_flags,
  11496. SocketOptions socket_options) const {
  11497. return detail::create_socket(
  11498. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11499. ipv6_v6only_, std::move(socket_options),
  11500. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11501. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11502. output_error_log(Error::BindIPAddress, nullptr);
  11503. return false;
  11504. }
  11505. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11506. output_error_log(Error::Listen, nullptr);
  11507. return false;
  11508. }
  11509. return true;
  11510. });
  11511. }
  11512. inline int Server::bind_internal(const std::string &host, int port,
  11513. int socket_flags) {
  11514. if (is_decommissioned) { return -1; }
  11515. if (!is_valid()) { return -1; }
  11516. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11517. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11518. if (port == 0) {
  11519. struct sockaddr_storage addr;
  11520. socklen_t addr_len = sizeof(addr);
  11521. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11522. &addr_len) == -1) {
  11523. output_error_log(Error::GetSockName, nullptr);
  11524. return -1;
  11525. }
  11526. if (addr.ss_family == AF_INET) {
  11527. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11528. } else if (addr.ss_family == AF_INET6) {
  11529. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11530. } else {
  11531. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11532. return -1;
  11533. }
  11534. } else {
  11535. return port;
  11536. }
  11537. }
  11538. inline bool Server::listen_internal() {
  11539. // A stop() between bind and listen leaves nothing to accept on. Report
  11540. // failure instead of returning success without ever serving, and mark the
  11541. // server decommissioned the way any failed listen does so that a concurrent
  11542. // wait_until_ready() wakes up instead of spinning forever.
  11543. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11544. is_decommissioned = true;
  11545. return false;
  11546. }
  11547. auto ret = true;
  11548. is_running_ = true;
  11549. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11550. if (start_handler_) { start_handler_(); }
  11551. {
  11552. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11553. while (svr_sock_ != INVALID_SOCKET) {
  11554. #ifndef _WIN32
  11555. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11556. #endif
  11557. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11558. idle_interval_usec_);
  11559. if (val == 0) { // Timeout
  11560. task_queue->on_idle();
  11561. continue;
  11562. }
  11563. #ifndef _WIN32
  11564. }
  11565. #endif
  11566. #if defined _WIN32
  11567. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11568. // OVERLAPPED
  11569. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11570. #elif defined SOCK_CLOEXEC
  11571. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11572. #else
  11573. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11574. #endif
  11575. if (sock == INVALID_SOCKET) {
  11576. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11577. // touches the CRT errno, so the two have to be asked platform by
  11578. // platform rather than by testing errno here.
  11579. if (detail::is_accept_resource_error()) {
  11580. // The per-process descriptor limit or the network stack's buffer
  11581. // space has been reached. Try to accept new connections after a
  11582. // short sleep.
  11583. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11584. continue;
  11585. } else if (detail::is_accept_transient_error()) {
  11586. continue;
  11587. }
  11588. // Take the descriptor out of svr_sock_ before closing it: a later
  11589. // stop() would otherwise shutdown()/close() a value the OS may have
  11590. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11591. // gone. The exchange also settles the race with a concurrent stop(),
  11592. // since whichever side takes the descriptor closes it exactly once.
  11593. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11594. if (listen_sock != INVALID_SOCKET) {
  11595. detail::close_socket(listen_sock);
  11596. ret = false;
  11597. output_error_log(Error::Connection, nullptr);
  11598. } else {
  11599. ; // The server socket was closed by user.
  11600. }
  11601. break;
  11602. }
  11603. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11604. read_timeout_sec_, read_timeout_usec_);
  11605. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11606. write_timeout_sec_, write_timeout_usec_);
  11607. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11608. if (!task_queue->enqueue(
  11609. [this, sock]() { process_and_close_socket(sock); })) {
  11610. output_error_log(Error::ResourceExhaustion, nullptr);
  11611. detail::shutdown_socket(sock);
  11612. detail::close_socket(sock);
  11613. }
  11614. }
  11615. task_queue->shutdown();
  11616. }
  11617. is_decommissioned = !ret;
  11618. return ret;
  11619. }
  11620. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11621. if (pre_routing_handler_ &&
  11622. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11623. return true;
  11624. }
  11625. // File handler
  11626. if ((req.method == "GET" || req.method == "HEAD") &&
  11627. handle_file_request(req, res)) {
  11628. return true;
  11629. }
  11630. const auto *custom = find_custom_entry(req.method);
  11631. // The second clause mirrors what expect_content() does unconditionally for
  11632. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11633. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11634. // `allprop`) would skip its handler and fall through to 404.
  11635. if (detail::expect_content(req) ||
  11636. (custom && !custom->handlers_for_content_reader.empty())) {
  11637. // Content reader handler
  11638. {
  11639. // Track whether the ContentReader was aborted due to the decompressed
  11640. // payload exceeding `payload_max_length_`.
  11641. // The user handler runs after the lambda returns, so we must restore the
  11642. // 413 status if the handler overwrites it.
  11643. bool content_reader_payload_too_large = false;
  11644. ContentReader reader(
  11645. [&](ContentReceiver receiver) {
  11646. auto result = read_content_with_content_receiver(
  11647. strm, req, res, std::move(receiver), nullptr, nullptr);
  11648. if (!result) {
  11649. output_error_log(Error::Read, &req);
  11650. if (res.status == StatusCode::PayloadTooLarge_413) {
  11651. content_reader_payload_too_large = true;
  11652. }
  11653. }
  11654. return result;
  11655. },
  11656. [&](FormDataHeader header, ContentReceiver receiver) {
  11657. auto result = read_content_with_content_receiver(
  11658. strm, req, res, nullptr, std::move(header),
  11659. std::move(receiver));
  11660. if (!result) {
  11661. output_error_log(Error::Read, &req);
  11662. if (res.status == StatusCode::PayloadTooLarge_413) {
  11663. content_reader_payload_too_large = true;
  11664. }
  11665. }
  11666. return result;
  11667. });
  11668. bool dispatched = false;
  11669. if (req.method == "POST") {
  11670. dispatched = dispatch_request_for_content_reader(
  11671. req, res, std::move(reader), post_handlers_for_content_reader_);
  11672. } else if (req.method == "PUT") {
  11673. dispatched = dispatch_request_for_content_reader(
  11674. req, res, std::move(reader), put_handlers_for_content_reader_);
  11675. } else if (req.method == "PATCH") {
  11676. dispatched = dispatch_request_for_content_reader(
  11677. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11678. } else if (req.method == "DELETE") {
  11679. dispatched = dispatch_request_for_content_reader(
  11680. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11681. } else if (custom) {
  11682. dispatched = dispatch_request_for_content_reader(
  11683. req, res, std::move(reader), custom->handlers_for_content_reader);
  11684. }
  11685. if (dispatched) {
  11686. if (content_reader_payload_too_large) {
  11687. // Enforce the limit: override any status the handler may have set
  11688. // and return false so the error path sends a plain 413 response.
  11689. res.status = StatusCode::PayloadTooLarge_413;
  11690. res.body.clear();
  11691. res.content_length_ = 0;
  11692. res.content_provider_ = nullptr;
  11693. return false;
  11694. }
  11695. return true;
  11696. }
  11697. }
  11698. // NOTE: `req.body` is not read here. For a regular handler the body is
  11699. // read inside dispatch_request(), after the route has matched and the
  11700. // pre-request handler has approved the request, so that a rejected
  11701. // request (e.g. failed authentication) never forces us to buffer a
  11702. // potentially large body.
  11703. }
  11704. // Regular handler
  11705. if (req.method == "GET" || req.method == "HEAD") {
  11706. return dispatch_request(req, res, get_handlers_, strm);
  11707. } else if (req.method == "POST") {
  11708. return dispatch_request(req, res, post_handlers_, strm);
  11709. } else if (req.method == "PUT") {
  11710. return dispatch_request(req, res, put_handlers_, strm);
  11711. } else if (req.method == "DELETE") {
  11712. return dispatch_request(req, res, delete_handlers_, strm);
  11713. } else if (req.method == "OPTIONS") {
  11714. return dispatch_request(req, res, options_handlers_, strm);
  11715. } else if (req.method == "PATCH") {
  11716. return dispatch_request(req, res, patch_handlers_, strm);
  11717. } else if (custom) {
  11718. return dispatch_request(req, res, custom->handlers, strm);
  11719. }
  11720. res.status = StatusCode::BadRequest_400;
  11721. return false;
  11722. }
  11723. inline bool Server::dispatch_request(Request &req, Response &res,
  11724. const Handlers &handlers, Stream &strm) {
  11725. for (const auto &x : handlers) {
  11726. const auto &matcher = x.first;
  11727. const auto &handler = x.second;
  11728. if (matcher->match(req)) {
  11729. req.matched_route = matcher->pattern();
  11730. // Run the pre-request handler before reading the body so a rejected
  11731. // request (e.g. failed authentication) never forces us to buffer a
  11732. // potentially large body. `req.matched_route` is available here.
  11733. if (pre_request_handler_ &&
  11734. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11735. return true;
  11736. }
  11737. // The route matched and the request was approved; read the body now.
  11738. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11739. output_error_log(Error::Read, &req);
  11740. return false;
  11741. }
  11742. handler(req, res);
  11743. return true;
  11744. }
  11745. }
  11746. return false;
  11747. }
  11748. // Decides the content coding for a response served straight from a file. Both
  11749. // the ETag, which has to name the representation actually sent, and
  11750. // `apply_static_file_compression()` go through this, so the two cannot drift
  11751. // apart.
  11752. inline detail::EncodingType
  11753. Server::static_file_encoding(const Request &req, const Response &res,
  11754. const std::string &content_type,
  11755. size_t length) const {
  11756. if (!static_file_compression_) { return detail::EncodingType::None; }
  11757. // Nothing to compress, and an empty file already answers with
  11758. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11759. // turn an empty body into a 20-byte gzip stream.
  11760. if (length == 0) { return detail::EncodingType::None; }
  11761. // A file that already fits in a single packet gains nothing from being made
  11762. // smaller, since it still travels in that one segment, and a file of a few
  11763. // bytes comes out larger than it went in.
  11764. if (length < static_file_compression_min_length_) {
  11765. return detail::EncodingType::None;
  11766. }
  11767. // RFC 9110 applies Range to the representation after content coding, so a
  11768. // compressed 206 would mean compressing the whole file and then slicing it.
  11769. // Serve ranges from the identity representation instead.
  11770. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11771. if (static_file_compression_max_length_ > 0 &&
  11772. length > static_file_compression_max_length_) {
  11773. return detail::EncodingType::None;
  11774. }
  11775. return detail::encoding_type(req, res, content_type);
  11776. }
  11777. // Compresses a file-backed content provider into `res.body` and takes over the
  11778. // framing headers. Returns false when the response is left untouched.
  11779. inline bool Server::apply_static_file_compression(const Request &req,
  11780. Response &res) const {
  11781. auto type = res.content_coding_;
  11782. if (type == detail::EncodingType::None || !res.content_provider_) {
  11783. return false;
  11784. }
  11785. auto compressor = detail::make_compressor(type);
  11786. if (!compressor) { return false; }
  11787. output_pre_compression_log(req, res);
  11788. std::string compressed;
  11789. if (!detail::compress_content_provider(res.content_provider_,
  11790. res.content_length_, *compressor,
  11791. compressed)) {
  11792. return false;
  11793. }
  11794. res.body.swap(compressed);
  11795. // The provider was consumed in full, so a resource releaser registered with
  11796. // it should hear about a success when the response goes away.
  11797. res.content_provider_success_ = true;
  11798. res.content_provider_ = nullptr;
  11799. res.content_length_ = 0;
  11800. res.content_coding_ = detail::EncodingType::None;
  11801. res.set_header("Content-Encoding", detail::encoding_name(type));
  11802. res.set_header("Vary", "Accept-Encoding");
  11803. res.set_header("Content-Length", std::to_string(res.body.size()));
  11804. return true;
  11805. }
  11806. inline void Server::apply_ranges(const Request &req, Response &res,
  11807. std::string &content_type,
  11808. std::string &boundary) const {
  11809. // A known-length content provider leaves `res.body` empty, so the compressor
  11810. // at the end of this function never runs for one (issue #2545). A file-backed
  11811. // provider is fully readable right here, so compress it and answer with an
  11812. // ordinary body: `Content-Length` and HEAD keep working, and the response
  11813. // takes the same path as `set_content()` from here on. Range requests never
  11814. // get a content coding, so `Content-Range` still names identity bytes and
  11815. // none of the framing below applies.
  11816. if (apply_static_file_compression(req, res)) { return; }
  11817. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  11818. auto it = res.headers.find("Content-Type");
  11819. if (it != res.headers.end()) {
  11820. content_type = it->second;
  11821. res.headers.erase(it);
  11822. }
  11823. boundary = detail::make_multipart_data_boundary();
  11824. res.set_header("Content-Type",
  11825. "multipart/byteranges; boundary=" + boundary);
  11826. }
  11827. auto type = detail::encoding_type(req, res);
  11828. if (res.body.empty()) {
  11829. if (res.content_length_ > 0) {
  11830. size_t length = 0;
  11831. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11832. length = res.content_length_;
  11833. } else if (req.ranges.size() == 1) {
  11834. auto offset_and_length = detail::get_range_offset_and_length(
  11835. req.ranges[0], res.content_length_);
  11836. length = offset_and_length.second;
  11837. auto content_range = detail::make_content_range_header_field(
  11838. offset_and_length, res.content_length_);
  11839. res.set_header("Content-Range", content_range);
  11840. } else {
  11841. length = detail::get_multipart_ranges_data_length(
  11842. req, boundary, content_type, res.content_length_);
  11843. }
  11844. res.set_header("Content-Length", std::to_string(length));
  11845. } else {
  11846. if (res.content_provider_) {
  11847. if (res.is_chunked_content_provider_) {
  11848. res.set_header("Transfer-Encoding", "chunked");
  11849. res.content_coding_ = type;
  11850. if (type != detail::EncodingType::None) {
  11851. res.set_header("Content-Encoding", detail::encoding_name(type));
  11852. res.set_header("Vary", "Accept-Encoding");
  11853. }
  11854. }
  11855. }
  11856. }
  11857. } else {
  11858. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11859. ;
  11860. } else if (req.ranges.size() == 1) {
  11861. auto offset_and_length =
  11862. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  11863. auto offset = offset_and_length.first;
  11864. auto length = offset_and_length.second;
  11865. auto content_range = detail::make_content_range_header_field(
  11866. offset_and_length, res.body.size());
  11867. res.set_header("Content-Range", content_range);
  11868. assert(offset + length <= res.body.size());
  11869. res.body = res.body.substr(offset, length);
  11870. } else {
  11871. std::string data;
  11872. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  11873. res.body.size(), data);
  11874. res.body.swap(data);
  11875. }
  11876. if (type != detail::EncodingType::None) {
  11877. output_pre_compression_log(req, res);
  11878. if (auto compressor = detail::make_compressor(type)) {
  11879. std::string compressed;
  11880. if (compressor->compress(res.body.data(), res.body.size(), true,
  11881. [&](const char *data, size_t data_len) {
  11882. compressed.append(data, data_len);
  11883. return true;
  11884. })) {
  11885. res.body.swap(compressed);
  11886. res.set_header("Content-Encoding", detail::encoding_name(type));
  11887. res.set_header("Vary", "Accept-Encoding");
  11888. }
  11889. }
  11890. }
  11891. res.content_length_ = res.body.size();
  11892. res.set_header("Content-Length", std::to_string(res.content_length_));
  11893. }
  11894. }
  11895. inline bool Server::dispatch_request_for_content_reader(
  11896. Request &req, Response &res, ContentReader content_reader,
  11897. const HandlersForContentReader &handlers) const {
  11898. for (const auto &x : handlers) {
  11899. const auto &matcher = x.first;
  11900. const auto &handler = x.second;
  11901. if (matcher->match(req)) {
  11902. req.matched_route = matcher->pattern();
  11903. if (!pre_request_handler_ ||
  11904. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  11905. handler(req, res, content_reader);
  11906. }
  11907. return true;
  11908. }
  11909. }
  11910. return false;
  11911. }
  11912. inline std::string
  11913. get_client_ip(const std::string &x_forwarded_for,
  11914. const std::vector<std::string> &trusted_proxies) {
  11915. // X-Forwarded-For is a comma-separated list per RFC 7239
  11916. std::vector<std::string> ip_list;
  11917. detail::split(x_forwarded_for.data(),
  11918. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  11919. [&](const char *b, const char *e) {
  11920. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  11921. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  11922. });
  11923. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  11924. // no segments. Signal "no client IP derived" with an empty string so the
  11925. // caller can fall back to the connection-level remote address.
  11926. if (ip_list.empty()) { return std::string(); }
  11927. // Each hop appends the address it received the request from, so the rightmost
  11928. // entries are the ones written by our own infrastructure while the leftmost
  11929. // are whatever the original client chose to send. Walk from the right and
  11930. // skip trusted proxies; the first address that is not a trusted proxy is the
  11931. // furthest point still attributable to a real hop, i.e. the client. Scanning
  11932. // from the left instead lets a client forge an arbitrary address by following
  11933. // it with a trusted proxy's address, which the left-to-right scan then
  11934. // returned as the client.
  11935. for (size_t i = ip_list.size(); i-- > 0;) {
  11936. const auto &ip = ip_list[i];
  11937. auto is_trusted_proxy =
  11938. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  11939. [&](const std::string &proxy) { return ip == proxy; });
  11940. if (!is_trusted_proxy) { return ip; }
  11941. }
  11942. // Every hop was a trusted proxy; fall back to the first entry.
  11943. return ip_list.front();
  11944. }
  11945. inline bool
  11946. Server::process_request(Stream &strm, const std::string &remote_addr,
  11947. int remote_port, const std::string &local_addr,
  11948. int local_port, bool close_connection,
  11949. bool &connection_closed,
  11950. const std::function<void(Request &)> &setup_request,
  11951. bool *websocket_upgraded) {
  11952. std::array<char, 2048> buf{};
  11953. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  11954. // Connection has been closed on client
  11955. if (!line_reader.getline()) { return false; }
  11956. Request req;
  11957. req.start_time_ = std::chrono::steady_clock::now();
  11958. req.remote_addr = remote_addr;
  11959. req.remote_port = remote_port;
  11960. req.local_addr = local_addr;
  11961. req.local_port = local_port;
  11962. Response res;
  11963. res.version = "HTTP/1.1";
  11964. res.headers = default_headers_;
  11965. // Request line and headers
  11966. if (!parse_request_line(line_reader.ptr(), req)) {
  11967. res.status = StatusCode::BadRequest_400;
  11968. output_error_log(Error::InvalidRequestLine, &req);
  11969. return write_response(strm, close_connection, req, res);
  11970. }
  11971. // Request headers
  11972. if (!detail::read_headers(strm, req.headers)) {
  11973. res.status = StatusCode::BadRequest_400;
  11974. output_error_log(Error::InvalidHeaders, &req);
  11975. return write_response(strm, close_connection, req, res);
  11976. }
  11977. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  11978. // otherwise let an intermediary and this parser disagree on where the body
  11979. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  11980. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  11981. // compatibility with existing clients), and a Transfer-Encoding whose final
  11982. // coding is not chunked, which leaves the body length undeterminable. The
  11983. // latter must not fall through to the "no body" path, or the body bytes are
  11984. // parsed as the next request on a persistent connection.
  11985. if (req.has_header("Transfer-Encoding") &&
  11986. (req.get_header_value_u64("Content-Length") > 0 ||
  11987. !detail::is_chunked_transfer_encoding(req.headers))) {
  11988. connection_closed = true;
  11989. res.status = StatusCode::BadRequest_400;
  11990. return write_response(strm, close_connection, req, res);
  11991. }
  11992. // Check if the request URI doesn't exceed the limit
  11993. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  11994. connection_closed = true;
  11995. res.status = StatusCode::UriTooLong_414;
  11996. output_error_log(Error::ExceedUriMaxLength, &req);
  11997. return write_response(strm, close_connection, req, res);
  11998. }
  11999. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12000. connection_closed = true;
  12001. }
  12002. if (req.version == "HTTP/1.0" &&
  12003. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12004. connection_closed = true;
  12005. }
  12006. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12007. // itself a trusted proxy. Otherwise any direct client could spoof
  12008. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12009. auto is_trusted_peer = std::any_of(
  12010. trusted_proxies_.begin(), trusted_proxies_.end(),
  12011. [&](const std::string &proxy) { return proxy == remote_addr; });
  12012. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12013. // Some proxies append the address they observed as a separate
  12014. // X-Forwarded-For field line instead of extending the one the client sent
  12015. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12016. // be scanned. Reading only the first occurrence would hand back the
  12017. // client-supplied, and therefore forgeable, value.
  12018. auto x_forwarded_for =
  12019. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12020. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12021. req.remote_addr = derived.empty() ? remote_addr : derived;
  12022. } else {
  12023. req.remote_addr = remote_addr;
  12024. }
  12025. req.remote_port = remote_port;
  12026. req.local_addr = local_addr;
  12027. req.local_port = local_port;
  12028. if (req.has_header("Accept")) {
  12029. auto accept_header =
  12030. detail::get_combined_header_value(req.headers, "Accept");
  12031. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12032. connection_closed = true;
  12033. res.status = StatusCode::BadRequest_400;
  12034. output_error_log(Error::HTTPParsing, &req);
  12035. return write_response(strm, close_connection, req, res);
  12036. }
  12037. }
  12038. if (req.has_header("Range")) {
  12039. const auto &range_header_value = req.get_header_value("Range");
  12040. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12041. connection_closed = true;
  12042. res.status = StatusCode::RangeNotSatisfiable_416;
  12043. output_error_log(Error::InvalidRangeHeader, &req);
  12044. return write_response(strm, close_connection, req, res);
  12045. }
  12046. }
  12047. if (setup_request) { setup_request(req); }
  12048. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12049. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12050. // must be ignored. An expectation we do not recognize is left alone; the
  12051. // 417 the section allows for one is a MAY, not a requirement.
  12052. if (req.version != "HTTP/1.0" &&
  12053. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12054. int status = StatusCode::Continue_100;
  12055. if (expect_100_continue_handler_) {
  12056. status = expect_100_continue_handler_(req, res);
  12057. }
  12058. switch (status) {
  12059. case StatusCode::Continue_100:
  12060. case StatusCode::ExpectationFailed_417:
  12061. detail::write_response_line(strm, status);
  12062. strm.write("\r\n");
  12063. break;
  12064. default:
  12065. connection_closed = true;
  12066. return write_response(strm, true, req, res);
  12067. }
  12068. }
  12069. // Setup `is_connection_closed` method
  12070. auto sock = strm.socket();
  12071. req.is_connection_closed = [sock]() {
  12072. return !detail::is_socket_alive(sock);
  12073. };
  12074. // WebSocket upgrade
  12075. // Check pre_routing_handler_ before upgrading so that authentication
  12076. // and other middleware can reject the request with an HTTP response
  12077. // (e.g., 401) before the protocol switches.
  12078. if (detail::is_websocket_upgrade(req)) {
  12079. if (pre_routing_handler_ &&
  12080. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12081. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12082. return write_response(strm, close_connection, req, res);
  12083. }
  12084. // Find matching WebSocket handler
  12085. for (const auto &entry : websocket_handlers_) {
  12086. if (entry.matcher->match(req)) {
  12087. // Compute accept key
  12088. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12089. auto accept_key = detail::websocket_accept_key(client_key);
  12090. // Negotiate subprotocol
  12091. std::string selected_subprotocol;
  12092. if (entry.sub_protocol_selector) {
  12093. auto protocol_header = detail::get_combined_header_value(
  12094. req.headers, "Sec-WebSocket-Protocol");
  12095. if (!protocol_header.empty()) {
  12096. std::vector<std::string> protocols;
  12097. detail::split(protocol_header.data(),
  12098. protocol_header.data() + protocol_header.size(), ',',
  12099. [&](const char *b, const char *e) {
  12100. protocols.emplace_back(b, e);
  12101. });
  12102. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12103. }
  12104. }
  12105. // Send 101 Switching Protocols
  12106. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12107. "Upgrade: websocket\r\n"
  12108. "Connection: Upgrade\r\n"
  12109. "Sec-WebSocket-Accept: " +
  12110. accept_key + "\r\n";
  12111. if (!selected_subprotocol.empty()) {
  12112. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12113. return false;
  12114. }
  12115. handshake_response +=
  12116. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12117. }
  12118. handshake_response += "\r\n";
  12119. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12120. 0) {
  12121. return false;
  12122. }
  12123. connection_closed = true;
  12124. if (websocket_upgraded) { *websocket_upgraded = true; }
  12125. {
  12126. #ifdef CPPHTTPLIB_SSL_ENABLED
  12127. if (req.ssl) {
  12128. // wss: the heartbeat ping thread and the read path enter the same
  12129. // TLS session from different threads. Hand the WebSocket a stream
  12130. // that serializes every TLS call, so the shared SSLSocketStream on
  12131. // the plain HTTP/HTTPS paths stays untouched.
  12132. auto ws_strm =
  12133. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12134. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12135. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND, 0,
  12136. write_timeout_sec_, write_timeout_usec_));
  12137. ws::WebSocket ws(std::move(ws_strm), req, true,
  12138. websocket_ping_interval_sec_,
  12139. websocket_max_missed_pongs_);
  12140. entry.handler(req, ws);
  12141. return true;
  12142. }
  12143. #endif
  12144. // Use WebSocket-specific read timeout instead of HTTP timeout
  12145. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND, 0);
  12146. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12147. websocket_max_missed_pongs_);
  12148. entry.handler(req, ws);
  12149. }
  12150. return true;
  12151. }
  12152. }
  12153. // No matching handler - fall through to 404
  12154. }
  12155. // Routing
  12156. auto routed = false;
  12157. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12158. routed = routing(req, res, strm);
  12159. #else
  12160. try {
  12161. routed = routing(req, res, strm);
  12162. } catch (std::exception &) {
  12163. if (exception_handler_) {
  12164. auto ep = std::current_exception();
  12165. exception_handler_(req, res, ep);
  12166. routed = true;
  12167. } else {
  12168. res.status = StatusCode::InternalServerError_500;
  12169. }
  12170. } catch (...) {
  12171. if (exception_handler_) {
  12172. auto ep = std::current_exception();
  12173. exception_handler_(req, res, ep);
  12174. routed = true;
  12175. } else {
  12176. res.status = StatusCode::InternalServerError_500;
  12177. }
  12178. }
  12179. #endif
  12180. auto ret = false;
  12181. if (routed) {
  12182. if (res.status == -1) {
  12183. res.status = req.ranges.empty() ? StatusCode::OK_200
  12184. : StatusCode::PartialContent_206;
  12185. }
  12186. // Serve file content by using a content provider
  12187. auto file_open_error = false;
  12188. if (!res.file_content_path_.empty()) {
  12189. const auto &path = res.file_content_path_;
  12190. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12191. if (!mm->is_open()) {
  12192. res.body.clear();
  12193. res.content_length_ = 0;
  12194. res.content_provider_ = nullptr;
  12195. res.status = StatusCode::NotFound_404;
  12196. output_error_log(Error::OpenFile, &req);
  12197. file_open_error = true;
  12198. } else {
  12199. auto content_type = res.file_content_content_type_;
  12200. if (content_type.empty()) {
  12201. content_type = detail::find_content_type(
  12202. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12203. }
  12204. detail::set_file_content_provider(
  12205. res, mm, content_type,
  12206. static_file_encoding(req, res, content_type, mm->size()));
  12207. }
  12208. }
  12209. if (file_open_error) {
  12210. ret = write_response(strm, close_connection, req, res);
  12211. } else if (detail::range_error(req, res)) {
  12212. res.body.clear();
  12213. res.content_length_ = 0;
  12214. res.content_provider_ = nullptr;
  12215. res.status = StatusCode::RangeNotSatisfiable_416;
  12216. ret = write_response(strm, close_connection, req, res);
  12217. } else {
  12218. ret = write_response_with_content(strm, close_connection, req, res);
  12219. }
  12220. } else {
  12221. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12222. ret = write_response(strm, close_connection, req, res);
  12223. }
  12224. // Drain any unconsumed framed body to prevent request smuggling on
  12225. // keep-alive. Without framing there is no body to drain — reading would
  12226. // consume the next request (issue #2450). If the response has committed the
  12227. // connection to close, there is no next request to protect.
  12228. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12229. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12230. connection_closed = true;
  12231. } else {
  12232. int dummy_status;
  12233. if (!detail::read_content(
  12234. strm, req, payload_max_length_, dummy_status, nullptr,
  12235. [](const char *, size_t, size_t, size_t) { return true; },
  12236. false)) {
  12237. connection_closed = true;
  12238. }
  12239. }
  12240. }
  12241. return ret;
  12242. }
  12243. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12244. inline bool Server::process_and_close_socket(socket_t sock) {
  12245. std::string remote_addr;
  12246. int remote_port = 0;
  12247. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12248. std::string local_addr;
  12249. int local_port = 0;
  12250. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12251. bool websocket_upgraded = false;
  12252. auto ret = serve_guarded([&]() {
  12253. return detail::process_server_socket(
  12254. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12255. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12256. write_timeout_usec_,
  12257. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12258. return process_request(strm, remote_addr, remote_port, local_addr,
  12259. local_port, close_connection,
  12260. connection_closed, nullptr,
  12261. &websocket_upgraded);
  12262. });
  12263. });
  12264. detail::drain_and_close_socket(sock);
  12265. return ret;
  12266. }
  12267. inline void Server::output_log(const Request &req, const Response &res) const {
  12268. if (logger_) {
  12269. std::lock_guard<std::mutex> guard(logger_mutex_);
  12270. logger_(req, res);
  12271. }
  12272. }
  12273. inline void Server::output_pre_compression_log(const Request &req,
  12274. const Response &res) const {
  12275. if (pre_compression_logger_) {
  12276. std::lock_guard<std::mutex> guard(logger_mutex_);
  12277. pre_compression_logger_(req, res);
  12278. }
  12279. }
  12280. inline void Server::output_error_log(const Error &err,
  12281. const Request *req) const {
  12282. if (error_logger_) {
  12283. std::lock_guard<std::mutex> guard(logger_mutex_);
  12284. error_logger_(err, req);
  12285. }
  12286. }
  12287. /*
  12288. * Group 5: ClientImpl and Client (Universal) implementation
  12289. */
  12290. // HTTP client implementation
  12291. inline ClientImpl::ClientImpl(const std::string &host)
  12292. : ClientImpl(host, 80, std::string(), std::string()) {}
  12293. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12294. : ClientImpl(host, port, std::string(), std::string()) {}
  12295. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12296. const std::string &client_cert_path,
  12297. const std::string &client_key_path)
  12298. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12299. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12300. inline ClientImpl::~ClientImpl() {
  12301. // Wait until all the requests in flight are handled.
  12302. size_t retry_count = 10;
  12303. while (retry_count-- > 0) {
  12304. {
  12305. std::lock_guard<std::mutex> guard(socket_mutex_);
  12306. if (socket_requests_in_flight_ == 0) { break; }
  12307. }
  12308. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12309. }
  12310. std::lock_guard<std::mutex> guard(socket_mutex_);
  12311. shutdown_socket(socket_);
  12312. close_socket(socket_);
  12313. }
  12314. inline bool ClientImpl::is_valid() const { return true; }
  12315. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12316. client_cert_path_ = rhs.client_cert_path_;
  12317. client_key_path_ = rhs.client_key_path_;
  12318. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12319. read_timeout_sec_ = rhs.read_timeout_sec_;
  12320. read_timeout_usec_ = rhs.read_timeout_usec_;
  12321. write_timeout_sec_ = rhs.write_timeout_sec_;
  12322. write_timeout_usec_ = rhs.write_timeout_usec_;
  12323. max_timeout_msec_ = rhs.max_timeout_msec_;
  12324. basic_auth_username_ = rhs.basic_auth_username_;
  12325. basic_auth_password_ = rhs.basic_auth_password_;
  12326. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12327. keep_alive_ = rhs.keep_alive_;
  12328. follow_location_ = rhs.follow_location_;
  12329. path_encode_ = rhs.path_encode_;
  12330. address_family_ = rhs.address_family_;
  12331. tcp_nodelay_ = rhs.tcp_nodelay_;
  12332. ipv6_v6only_ = rhs.ipv6_v6only_;
  12333. socket_options_ = rhs.socket_options_;
  12334. compress_ = rhs.compress_;
  12335. decompress_ = rhs.decompress_;
  12336. payload_max_length_ = rhs.payload_max_length_;
  12337. has_payload_max_length_ = rhs.has_payload_max_length_;
  12338. interface_ = rhs.interface_;
  12339. proxy_host_ = rhs.proxy_host_;
  12340. proxy_port_ = rhs.proxy_port_;
  12341. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12342. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12343. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12344. no_proxy_entries_ = rhs.no_proxy_entries_;
  12345. logger_ = rhs.logger_;
  12346. error_logger_ = rhs.error_logger_;
  12347. #ifdef CPPHTTPLIB_SSL_ENABLED
  12348. digest_auth_username_ = rhs.digest_auth_username_;
  12349. digest_auth_password_ = rhs.digest_auth_password_;
  12350. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12351. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12352. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12353. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12354. server_certificate_verification_ = rhs.server_certificate_verification_;
  12355. server_hostname_verification_ = rhs.server_hostname_verification_;
  12356. system_ca_mode_ = rhs.system_ca_mode_;
  12357. #endif
  12358. }
  12359. inline bool
  12360. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12361. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12362. if (no_proxy_entries_.empty()) { return true; }
  12363. // host_ is const so its normalized form is invariant; cache it. The
  12364. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12365. if (host == host_) {
  12366. if (!host_normalized_valid_) {
  12367. host_normalized_ = detail::normalize_target(host_);
  12368. host_normalized_valid_ = true;
  12369. }
  12370. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12371. }
  12372. auto target = detail::normalize_target(host);
  12373. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12374. }
  12375. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12376. if (is_proxy_enabled_for_host(host_)) {
  12377. return detail::create_client_socket(
  12378. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12379. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12380. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12381. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12382. }
  12383. // Check is custom IP or hostname specified for host_
  12384. std::string connect_host;
  12385. std::string ip;
  12386. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12387. return detail::create_client_socket(
  12388. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12389. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12390. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12391. write_timeout_usec_, interface_, error);
  12392. }
  12393. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12394. Error &error) {
  12395. auto sock = create_client_socket(error);
  12396. if (sock == INVALID_SOCKET) { return false; }
  12397. socket.sock = sock;
  12398. return true;
  12399. }
  12400. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12401. return create_and_connect_socket(socket, error);
  12402. }
  12403. inline bool ClientImpl::setup_proxy_connection(
  12404. Socket & /*socket*/,
  12405. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12406. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12407. return true;
  12408. }
  12409. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12410. bool /*shutdown_gracefully*/) {
  12411. // If there are any requests in flight from threads other than us, then it's
  12412. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12413. assert(socket_requests_in_flight_ == 0 ||
  12414. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12415. }
  12416. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12417. if (socket.sock == INVALID_SOCKET) { return; }
  12418. detail::shutdown_socket(socket.sock);
  12419. }
  12420. inline void ClientImpl::close_socket(Socket &socket) {
  12421. // If there are requests in flight in another thread, usually closing
  12422. // the socket will be fine and they will simply receive an error when
  12423. // using the closed socket, but it is still a bug since rarely the OS
  12424. // may reassign the socket id to be used for a new socket, and then
  12425. // suddenly they will be operating on a live socket that is different
  12426. // than the one they intended!
  12427. assert(socket_requests_in_flight_ == 0 ||
  12428. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12429. // It is also a bug if this happens while SSL is still active
  12430. #ifdef CPPHTTPLIB_SSL_ENABLED
  12431. assert(socket.ssl == nullptr);
  12432. #endif
  12433. if (socket.sock == INVALID_SOCKET) { return; }
  12434. detail::close_socket(socket.sock);
  12435. socket.sock = INVALID_SOCKET;
  12436. }
  12437. inline void ClientImpl::disconnect(bool gracefully) {
  12438. shutdown_ssl(socket_, gracefully);
  12439. shutdown_socket(socket_);
  12440. close_socket(socket_);
  12441. }
  12442. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12443. Response &res,
  12444. bool skip_100_continue) const {
  12445. std::array<char, 2048> buf{};
  12446. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12447. if (!line_reader.getline()) { return false; }
  12448. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12449. res.reason)) {
  12450. return req.method == "CONNECT";
  12451. }
  12452. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12453. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12454. if (!line_reader.getline()) { return false; } // CRLF
  12455. if (!line_reader.getline()) { return false; } // next response line
  12456. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12457. res.reason)) {
  12458. return false;
  12459. }
  12460. }
  12461. return true;
  12462. }
  12463. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12464. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12465. auto ret = send_(req, res, error);
  12466. if (error == Error::SSLPeerCouldBeClosed_) {
  12467. assert(!ret);
  12468. ret = send_(req, res, error);
  12469. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12470. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12471. }
  12472. return ret;
  12473. }
  12474. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12475. {
  12476. std::lock_guard<std::mutex> guard(socket_mutex_);
  12477. // Set this to false immediately - if it ever gets set to true by the end
  12478. // of the request, we know another thread instructed us to close the
  12479. // socket.
  12480. socket_should_be_closed_when_request_is_done_ = false;
  12481. auto is_alive = false;
  12482. if (socket_.is_open()) {
  12483. is_alive = detail::is_socket_alive(socket_.sock);
  12484. #ifdef CPPHTTPLIB_SSL_ENABLED
  12485. if (is_alive && is_ssl()) {
  12486. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12487. is_alive = false;
  12488. }
  12489. }
  12490. #endif
  12491. if (!is_alive) {
  12492. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12493. disconnect(/*gracefully=*/false);
  12494. }
  12495. }
  12496. if (!is_alive) {
  12497. if (!ensure_socket_connection(socket_, error)) {
  12498. output_error_log(error, &req);
  12499. return false;
  12500. }
  12501. {
  12502. auto success = true;
  12503. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12504. error)) {
  12505. if (!success) { output_error_log(error, &req); }
  12506. return success;
  12507. }
  12508. }
  12509. }
  12510. // Mark the current socket as being in use so that it cannot be closed by
  12511. // anyone else while this request is ongoing, even though we will be
  12512. // releasing the mutex.
  12513. if (socket_requests_in_flight_ > 1) {
  12514. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12515. }
  12516. socket_requests_in_flight_ += 1;
  12517. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12518. }
  12519. for (const auto &header : default_headers_) {
  12520. if (req.headers.find(header.first) == req.headers.end()) {
  12521. req.headers.insert(header);
  12522. }
  12523. }
  12524. auto ret = false;
  12525. auto close_connection = !keep_alive_;
  12526. auto se = detail::scope_exit([&]() {
  12527. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12528. std::lock_guard<std::mutex> guard(socket_mutex_);
  12529. socket_requests_in_flight_ -= 1;
  12530. if (socket_requests_in_flight_ <= 0) {
  12531. assert(socket_requests_in_flight_ == 0);
  12532. socket_requests_are_from_thread_ = std::thread::id();
  12533. }
  12534. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12535. !ret) {
  12536. disconnect(/*gracefully=*/true);
  12537. }
  12538. });
  12539. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12540. return handle_request(strm, req, res, close_connection, error);
  12541. });
  12542. if (!ret) {
  12543. if (error == Error::Success) {
  12544. error = Error::Unknown;
  12545. output_error_log(error, &req);
  12546. }
  12547. }
  12548. return ret;
  12549. }
  12550. inline Result ClientImpl::send(const Request &req) {
  12551. auto req2 = req;
  12552. return send_(std::move(req2));
  12553. }
  12554. inline Result ClientImpl::send_(Request &&req) {
  12555. auto res = detail::make_unique<Response>();
  12556. auto error = Error::Success;
  12557. auto ret = send(req, *res, error);
  12558. #ifdef CPPHTTPLIB_SSL_ENABLED
  12559. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12560. last_ssl_error_, last_backend_error_};
  12561. #else
  12562. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12563. #endif
  12564. }
  12565. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12566. const std::string &ct) {
  12567. (void)for_stream;
  12568. for (const auto &header : default_headers_) {
  12569. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12570. }
  12571. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12572. // prepend it rather than appending it after the caller's own fields.
  12573. if (!r.has_header("Host")) {
  12574. r.headers.emplace_front(
  12575. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12576. address_family_));
  12577. }
  12578. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12579. if (!r.content_receiver) {
  12580. if (!r.has_header("Accept-Encoding")) {
  12581. std::string accept_encoding;
  12582. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12583. accept_encoding = "br";
  12584. #endif
  12585. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12586. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12587. accept_encoding += "gzip, deflate";
  12588. #endif
  12589. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12590. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12591. accept_encoding += "zstd";
  12592. #endif
  12593. r.set_header("Accept-Encoding", accept_encoding);
  12594. }
  12595. detail::add_default_user_agent_header(r);
  12596. }
  12597. if (!r.body.empty()) {
  12598. if (!ct.empty() && !r.has_header("Content-Type")) {
  12599. r.headers.emplace("Content-Type", ct);
  12600. }
  12601. if (!r.has_header("Content-Length")) {
  12602. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12603. }
  12604. }
  12605. }
  12606. inline ClientImpl::StreamHandle
  12607. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12608. const Params &params, const Headers &headers,
  12609. const std::string &body,
  12610. const std::string &content_type) {
  12611. StreamHandle handle;
  12612. handle.response = detail::make_unique<Response>();
  12613. handle.error = Error::Success;
  12614. // Encode the target exactly like the buffered send path does, so that the
  12615. // same `path` produces the same request line through either API.
  12616. auto raw_query_path =
  12617. params.empty() ? path : append_query_params(path, params);
  12618. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12619. handle.connection_ = detail::make_unique<ClientConnection>();
  12620. {
  12621. std::lock_guard<std::mutex> guard(socket_mutex_);
  12622. auto is_alive = false;
  12623. if (socket_.is_open()) {
  12624. is_alive = detail::is_socket_alive(socket_.sock);
  12625. #ifdef CPPHTTPLIB_SSL_ENABLED
  12626. if (is_alive && is_ssl()) {
  12627. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12628. is_alive = false;
  12629. }
  12630. }
  12631. #endif
  12632. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12633. }
  12634. if (!is_alive) {
  12635. if (!ensure_socket_connection(socket_, handle.error)) {
  12636. handle.response.reset();
  12637. return handle;
  12638. }
  12639. {
  12640. auto success = true;
  12641. auto start_time = std::chrono::steady_clock::now();
  12642. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12643. success, handle.error)) {
  12644. if (!success) { handle.response.reset(); }
  12645. return handle;
  12646. }
  12647. }
  12648. }
  12649. transfer_socket_ownership_to_handle(handle);
  12650. }
  12651. #ifdef CPPHTTPLIB_SSL_ENABLED
  12652. if (is_ssl() && handle.connection_->session) {
  12653. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12654. handle.connection_->sock, handle.connection_->session,
  12655. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12656. write_timeout_usec_);
  12657. } else {
  12658. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12659. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12660. write_timeout_sec_, write_timeout_usec_);
  12661. }
  12662. #else
  12663. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12664. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12665. write_timeout_sec_, write_timeout_usec_);
  12666. #endif
  12667. handle.stream_ = handle.socket_stream_.get();
  12668. Request req;
  12669. req.method = method;
  12670. req.path = query_path;
  12671. req.headers = headers;
  12672. req.body = body;
  12673. prepare_default_headers(req, true, content_type);
  12674. auto &strm = *handle.stream_;
  12675. if (detail::write_request_line(strm, req.method, req.path) < 0) {
  12676. handle.error = Error::Write;
  12677. handle.response.reset();
  12678. return handle;
  12679. }
  12680. if (!detail::check_and_write_headers(strm, req.headers, header_writer_,
  12681. handle.error)) {
  12682. handle.response.reset();
  12683. return handle;
  12684. }
  12685. if (!body.empty()) {
  12686. if (strm.write(body.data(), body.size()) < 0) {
  12687. handle.error = Error::Write;
  12688. handle.response.reset();
  12689. return handle;
  12690. }
  12691. }
  12692. if (!read_response_line(strm, req, *handle.response) ||
  12693. !detail::read_headers(strm, handle.response->headers)) {
  12694. handle.error = Error::Read;
  12695. handle.response.reset();
  12696. return handle;
  12697. }
  12698. handle.body_reader_.stream = handle.stream_;
  12699. handle.body_reader_.payload_max_length = payload_max_length_;
  12700. if (handle.response->has_header("Content-Length")) {
  12701. bool is_invalid = false;
  12702. auto content_length = detail::get_header_value_u64(
  12703. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12704. if (is_invalid) {
  12705. handle.error = Error::Read;
  12706. handle.response.reset();
  12707. return handle;
  12708. }
  12709. handle.body_reader_.has_content_length = true;
  12710. handle.body_reader_.content_length = content_length;
  12711. }
  12712. handle.body_reader_.chunked =
  12713. detail::is_chunked_transfer_encoding(handle.response->headers);
  12714. auto content_encoding = detail::get_combined_header_value(
  12715. handle.response->headers, "Content-Encoding");
  12716. if (!content_encoding.empty()) {
  12717. // Same policy as prepare_content_receiver(): reject a coding we know about
  12718. // but were not built with, pass an unrecognized one through as-is.
  12719. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12720. if (!handle.decompressor_) {
  12721. if (detail::is_known_content_encoding(content_encoding)) {
  12722. handle.error = Error::UnsupportedContentEncoding;
  12723. handle.response.reset();
  12724. return handle;
  12725. }
  12726. } else if (!handle.decompressor_->is_valid()) {
  12727. handle.error = Error::Compression;
  12728. handle.response.reset();
  12729. return handle;
  12730. }
  12731. }
  12732. return handle;
  12733. }
  12734. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12735. if (!is_valid() || !response) { return -1; }
  12736. if (decompressor_) { return read_with_decompression(buf, len); }
  12737. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12738. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12739. trailers_parsed_ = true;
  12740. if (body_reader_.chunked_decoder) {
  12741. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12742. response->trailers, response->headers)) {
  12743. return n;
  12744. }
  12745. } else {
  12746. detail::ChunkedDecoder dec(*stream_);
  12747. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12748. return n;
  12749. }
  12750. }
  12751. }
  12752. return n;
  12753. }
  12754. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12755. size_t len) {
  12756. if (decompress_offset_ < decompress_buffer_.size()) {
  12757. auto available = decompress_buffer_.size() - decompress_offset_;
  12758. auto to_copy = (std::min)(len, available);
  12759. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12760. decompress_offset_ += to_copy;
  12761. decompressed_bytes_read_ += to_copy;
  12762. return static_cast<ssize_t>(to_copy);
  12763. }
  12764. decompress_buffer_.clear();
  12765. decompress_offset_ = 0;
  12766. constexpr size_t kDecompressionBufferSize = 8192;
  12767. char compressed_buf[kDecompressionBufferSize];
  12768. while (true) {
  12769. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12770. sizeof(compressed_buf));
  12771. if (n <= 0) { return n; }
  12772. bool decompress_ok = decompressor_->decompress(
  12773. compressed_buf, static_cast<size_t>(n),
  12774. [this](const char *data, size_t data_len) {
  12775. decompress_buffer_.append(data, data_len);
  12776. auto limit = body_reader_.payload_max_length;
  12777. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12778. return false;
  12779. }
  12780. return true;
  12781. });
  12782. if (!decompress_ok) {
  12783. body_reader_.last_error = Error::Read;
  12784. return -1;
  12785. }
  12786. if (!decompress_buffer_.empty()) { break; }
  12787. }
  12788. auto to_copy = (std::min)(len, decompress_buffer_.size());
  12789. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  12790. decompress_offset_ = to_copy;
  12791. decompressed_bytes_read_ += to_copy;
  12792. return static_cast<ssize_t>(to_copy);
  12793. }
  12794. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  12795. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  12796. return;
  12797. }
  12798. trailers_parsed_ = true;
  12799. const auto bufsiz = 128;
  12800. char line_buf[bufsiz];
  12801. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  12802. if (!line_reader.getline()) { return; }
  12803. if (!detail::parse_trailers(line_reader, response->trailers,
  12804. response->headers)) {
  12805. return;
  12806. }
  12807. }
  12808. namespace detail {
  12809. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  12810. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  12811. size_t &out_chunk_offset,
  12812. size_t &out_chunk_total) {
  12813. if (finished) { return 0; }
  12814. if (chunk_remaining == 0) {
  12815. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12816. if (!lr.getline()) { return -1; }
  12817. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  12818. const char *p = lr.ptr();
  12819. int v = 0;
  12820. if (!is_hex(*p, v)) { return -1; }
  12821. size_t chunk_len = 0;
  12822. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  12823. for (; is_hex(*p, v); ++p) {
  12824. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  12825. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  12826. }
  12827. while (is_space_or_tab(*p)) {
  12828. ++p;
  12829. }
  12830. if (*p != '\0' && *p != ';' && *p != '\r' && *p != '\n') { return -1; }
  12831. if (chunk_len == 0) {
  12832. chunk_remaining = 0;
  12833. finished = true;
  12834. out_chunk_offset = 0;
  12835. out_chunk_total = 0;
  12836. return 0;
  12837. }
  12838. chunk_remaining = chunk_len;
  12839. last_chunk_total = chunk_remaining;
  12840. last_chunk_offset = 0;
  12841. }
  12842. auto to_read = (std::min)(chunk_remaining, len);
  12843. auto n = strm.read(buf, to_read);
  12844. if (n <= 0) { return -1; }
  12845. auto offset_before = last_chunk_offset;
  12846. last_chunk_offset += static_cast<size_t>(n);
  12847. chunk_remaining -= static_cast<size_t>(n);
  12848. out_chunk_offset = offset_before;
  12849. out_chunk_total = last_chunk_total;
  12850. if (chunk_remaining == 0) {
  12851. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12852. if (!lr.getline()) { return -1; }
  12853. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  12854. }
  12855. return n;
  12856. }
  12857. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  12858. const Headers &src_headers) {
  12859. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12860. if (!lr.getline()) { return false; }
  12861. return parse_trailers(lr, dest, src_headers);
  12862. }
  12863. } // namespace detail
  12864. inline void
  12865. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  12866. handle.connection_->sock = socket_.sock;
  12867. #ifdef CPPHTTPLIB_SSL_ENABLED
  12868. handle.connection_->session = socket_.ssl;
  12869. socket_.ssl = nullptr;
  12870. #endif
  12871. socket_.sock = INVALID_SOCKET;
  12872. }
  12873. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  12874. Response &res, bool close_connection,
  12875. Error &error) {
  12876. if (req.path.empty()) {
  12877. error = Error::Connection;
  12878. output_error_log(error, &req);
  12879. return false;
  12880. }
  12881. auto req_save = req;
  12882. bool ret;
  12883. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  12884. auto req2 = req;
  12885. req2.path = "http://" +
  12886. detail::make_host_and_port_string(host_, port_, false) +
  12887. req.path;
  12888. ret = process_request(strm, req2, res, close_connection, error);
  12889. req = std::move(req2);
  12890. req.path = req_save.path;
  12891. } else {
  12892. ret = process_request(strm, req, res, close_connection, error);
  12893. }
  12894. if (!ret) { return false; }
  12895. if (detail::has_header_token(res.headers, "Connection", "close") ||
  12896. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  12897. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  12898. // for this to be safe.
  12899. // This is safe to call because handle_request is only called by send_
  12900. // which locks the request mutex during the process. It would be a bug
  12901. // to call it from a different thread since it's a thread-safety issue
  12902. // to do these things to the socket if another thread is using the socket.
  12903. std::lock_guard<std::mutex> guard(socket_mutex_);
  12904. disconnect(/*gracefully=*/true);
  12905. }
  12906. if (300 < res.status && res.status < 400 && follow_location_) {
  12907. req = std::move(req_save);
  12908. ret = redirect(req, res, error);
  12909. }
  12910. #ifdef CPPHTTPLIB_SSL_ENABLED
  12911. if ((res.status == StatusCode::Unauthorized_401 ||
  12912. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  12913. req.authorization_count_ < 5) {
  12914. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  12915. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  12916. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  12917. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  12918. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  12919. return ret;
  12920. }
  12921. const auto &username =
  12922. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  12923. const auto &password =
  12924. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  12925. if (!username.empty() && !password.empty()) {
  12926. std::map<std::string, std::string> auth;
  12927. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  12928. Request new_req = req;
  12929. new_req.authorization_count_ += 1;
  12930. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  12931. : "Authorization");
  12932. new_req.headers.insert(detail::make_digest_authentication_header(
  12933. req, auth, new_req.authorization_count_, detail::random_string(10),
  12934. username, password, is_proxy));
  12935. Response new_res;
  12936. ret = send(new_req, new_res, error);
  12937. if (ret) { res = std::move(new_res); }
  12938. }
  12939. }
  12940. }
  12941. #endif
  12942. return ret;
  12943. }
  12944. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  12945. if (req.redirect_count_ == 0) {
  12946. error = Error::ExceedRedirectCount;
  12947. output_error_log(error, &req);
  12948. return false;
  12949. }
  12950. auto location = res.get_header_value("location");
  12951. if (location.empty()) { return false; }
  12952. detail::UrlComponents uc;
  12953. if (!detail::parse_url(location, uc)) { return false; }
  12954. // Only follow http/https redirects
  12955. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  12956. return false;
  12957. }
  12958. auto scheme = is_ssl() ? "https" : "http";
  12959. auto next_scheme = std::move(uc.scheme);
  12960. auto next_host = std::move(uc.host);
  12961. auto port_str = std::move(uc.port);
  12962. auto next_path = std::move(uc.path);
  12963. auto next_query = std::move(uc.query);
  12964. auto next_port = port_;
  12965. if (!port_str.empty()) {
  12966. if (!detail::parse_port(port_str, next_port)) { return false; }
  12967. } else if (!next_scheme.empty()) {
  12968. next_port = next_scheme == "https" ? 443 : 80;
  12969. }
  12970. if (next_scheme.empty()) { next_scheme = scheme; }
  12971. if (next_host.empty()) { next_host = host_; }
  12972. if (next_path.empty()) { next_path = "/"; }
  12973. auto path = decode_path_component(next_path) + next_query;
  12974. // Same host redirect - use current client
  12975. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  12976. return detail::redirect(*this, req, res, path, location, error);
  12977. }
  12978. // Cross-host/scheme redirect - create new client with robust setup
  12979. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  12980. path, location, error);
  12981. }
  12982. // New method for robust redirect client creation
  12983. inline bool ClientImpl::create_redirect_client(
  12984. const std::string &scheme, const std::string &host, int port, Request &req,
  12985. Response &res, const std::string &path, const std::string &location,
  12986. Error &error) {
  12987. // Determine if we need SSL
  12988. auto need_ssl = (scheme == "https");
  12989. // Clean up request headers that are host/client specific
  12990. // Remove headers that should not be carried over to new host
  12991. auto headers_to_remove = std::vector<std::string>{
  12992. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  12993. for (const auto &header_name : headers_to_remove) {
  12994. auto it = req.headers.find(header_name);
  12995. while (it != req.headers.end()) {
  12996. it = req.headers.erase(it);
  12997. it = req.headers.find(header_name);
  12998. }
  12999. }
  13000. // Create appropriate client type and handle redirect
  13001. if (need_ssl) {
  13002. #ifdef CPPHTTPLIB_SSL_ENABLED
  13003. // Create SSL client for HTTPS redirect
  13004. SSLClient redirect_client(host, port);
  13005. // Setup basic client configuration first
  13006. setup_redirect_client(redirect_client);
  13007. redirect_client.enable_server_certificate_verification(
  13008. server_certificate_verification_);
  13009. redirect_client.enable_server_hostname_verification(
  13010. server_hostname_verification_);
  13011. redirect_client.system_ca_mode_ = system_ca_mode_;
  13012. // Transfer CA certificate to redirect client
  13013. if (!ca_cert_pem_.empty()) {
  13014. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13015. ca_cert_pem_.size());
  13016. }
  13017. if (!ca_cert_file_path_.empty()) {
  13018. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13019. }
  13020. // Client certificates are set through constructor for SSLClient
  13021. // NOTE: SSLClient constructor already takes client_cert_path and
  13022. // client_key_path so we need to create it properly if client certs are
  13023. // needed
  13024. // Execute the redirect
  13025. return detail::redirect(redirect_client, req, res, path, location, error);
  13026. #else
  13027. // SSL not supported - set appropriate error
  13028. error = Error::SSLConnection;
  13029. output_error_log(error, &req);
  13030. return false;
  13031. #endif
  13032. } else {
  13033. // HTTP redirect
  13034. ClientImpl redirect_client(host, port);
  13035. // Setup client with robust configuration
  13036. setup_redirect_client(redirect_client);
  13037. // Execute the redirect
  13038. return detail::redirect(redirect_client, req, res, path, location, error);
  13039. }
  13040. }
  13041. // New method for robust client setup (based on basic_manual_redirect.cpp
  13042. // logic)
  13043. template <typename ClientType>
  13044. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13045. // Copy basic settings first
  13046. client.set_connection_timeout(connection_timeout_sec_);
  13047. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13048. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13049. client.set_keep_alive(keep_alive_);
  13050. client.set_follow_location(
  13051. true); // Enable redirects to handle multi-step redirects
  13052. client.set_path_encode(path_encode_);
  13053. client.set_compress(compress_);
  13054. client.set_decompress(decompress_);
  13055. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13056. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13057. // 15.4, credentials must not be forwarded when redirecting to a different
  13058. // host. This function is only called for cross-host redirects; same-host
  13059. // redirects are handled directly in ClientImpl::redirect().
  13060. // Copy the proxy configuration unconditionally; the per-target bypass is
  13061. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13062. // still use the proxy.
  13063. client.no_proxy_entries_ = no_proxy_entries_;
  13064. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13065. client.set_proxy(proxy_host_, proxy_port_);
  13066. if (!proxy_basic_auth_username_.empty()) {
  13067. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13068. proxy_basic_auth_password_);
  13069. }
  13070. if (!proxy_bearer_token_auth_token_.empty()) {
  13071. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13072. }
  13073. #ifdef CPPHTTPLIB_SSL_ENABLED
  13074. if (!proxy_digest_auth_username_.empty()) {
  13075. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13076. proxy_digest_auth_password_);
  13077. }
  13078. #endif
  13079. }
  13080. // Copy network and socket settings
  13081. client.set_address_family(address_family_);
  13082. client.set_tcp_nodelay(tcp_nodelay_);
  13083. client.set_ipv6_v6only(ipv6_v6only_);
  13084. if (socket_options_) { client.set_socket_options(socket_options_); }
  13085. if (!interface_.empty()) { client.set_interface(interface_); }
  13086. // Copy logging and headers
  13087. if (logger_) { client.set_logger(logger_); }
  13088. if (error_logger_) { client.set_error_logger(error_logger_); }
  13089. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13090. // Each new client should generate its own headers based on its target host
  13091. }
  13092. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13093. const Request &req,
  13094. Error &error) const {
  13095. auto is_shutting_down = []() { return false; };
  13096. if (req.is_chunked_content_provider_) {
  13097. auto compressor = compress_ ? detail::create_compressor().first
  13098. : std::unique_ptr<detail::compressor>();
  13099. if (!compressor) {
  13100. compressor = detail::make_unique<detail::nocompressor>();
  13101. }
  13102. return detail::write_content_chunked(strm, req.content_provider_,
  13103. is_shutting_down, *compressor, error);
  13104. } else {
  13105. return detail::write_content_with_progress(
  13106. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13107. req.upload_progress, error);
  13108. }
  13109. }
  13110. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13111. bool close_connection, Error &error,
  13112. bool skip_body) {
  13113. // Prepare additional headers
  13114. if (close_connection) {
  13115. if (!req.has_header("Connection")) {
  13116. req.set_header("Connection", "close");
  13117. }
  13118. }
  13119. std::string ct_for_defaults;
  13120. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13121. ct_for_defaults = "text/plain";
  13122. }
  13123. prepare_default_headers(req, false, ct_for_defaults);
  13124. if (req.body.empty()) {
  13125. if (req.content_provider_) {
  13126. if (!req.is_chunked_content_provider_) {
  13127. if (!req.has_header("Content-Length")) {
  13128. auto length = std::to_string(req.content_length_);
  13129. req.set_header("Content-Length", length);
  13130. }
  13131. }
  13132. } else {
  13133. if (req.method == "POST" || req.method == "PUT" ||
  13134. req.method == "PATCH") {
  13135. req.set_header("Content-Length", "0");
  13136. }
  13137. }
  13138. }
  13139. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13140. if (!req.has_header("Authorization")) {
  13141. req.headers.insert(make_basic_authentication_header(
  13142. basic_auth_username_, basic_auth_password_, false));
  13143. }
  13144. }
  13145. if (!bearer_token_auth_token_.empty()) {
  13146. if (!req.has_header("Authorization")) {
  13147. req.headers.insert(make_bearer_token_authentication_header(
  13148. bearer_token_auth_token_, false));
  13149. }
  13150. }
  13151. // Proxy-Authorization is only sent when the proxy is actually used for
  13152. // this target — otherwise NO_PROXY-matched requests would leak proxy
  13153. // credentials directly to the destination server.
  13154. if (is_proxy_enabled_for_host(host_)) {
  13155. if (!proxy_basic_auth_username_.empty() &&
  13156. !proxy_basic_auth_password_.empty() &&
  13157. !req.has_header("Proxy-Authorization")) {
  13158. req.headers.insert(make_basic_authentication_header(
  13159. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13160. }
  13161. if (!proxy_bearer_token_auth_token_.empty() &&
  13162. !req.has_header("Proxy-Authorization")) {
  13163. req.headers.insert(make_bearer_token_authentication_header(
  13164. proxy_bearer_token_auth_token_, true));
  13165. }
  13166. }
  13167. // Request line and headers
  13168. {
  13169. detail::BufferStream bstrm;
  13170. // Extract the query from req.path. The encoding itself is delegated to
  13171. // `encode_request_target`; the raw query is still needed here to decide
  13172. // between populating `req.params` from it and falling back to building a
  13173. // query out of caller-supplied `req.params`.
  13174. auto query_pos = req.path.find('?');
  13175. auto query_part = query_pos == std::string::npos
  13176. ? std::string()
  13177. : req.path.substr(query_pos + 1);
  13178. auto path_with_query =
  13179. detail::encode_request_target(req.path, path_encode_);
  13180. if (!query_part.empty()) {
  13181. // The query already came in through `req.path`; still populate
  13182. // `req.params` for handlers/users who read them.
  13183. detail::parse_query_text(query_part, req.params);
  13184. } else if (!req.params.empty()) {
  13185. // No query in `req.path`; build one from `req.params` so existing
  13186. // callers that pass `Params` separately continue to work.
  13187. path_with_query = append_query_params(path_with_query, req.params);
  13188. }
  13189. // Write request line and headers
  13190. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13191. // A rejected target (e.g. CR/LF smuggled in via a decoded redirect
  13192. // Location under set_path_encode(false)) must fail the request cleanly
  13193. // instead of emitting a request-line-less, header-injecting request.
  13194. error = Error::Write;
  13195. output_error_log(error, &req);
  13196. return false;
  13197. }
  13198. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13199. error)) {
  13200. output_error_log(error, &req);
  13201. return false;
  13202. }
  13203. // Flush buffer
  13204. auto &data = bstrm.get_buffer();
  13205. if (!detail::write_data(strm, data.data(), data.size())) {
  13206. error = Error::Write;
  13207. output_error_log(error, &req);
  13208. return false;
  13209. }
  13210. }
  13211. // After sending request line and headers, wait briefly for an early server
  13212. // response (e.g. 4xx) and avoid sending a potentially large request body
  13213. // unnecessarily. This workaround is only enabled on Windows because Unix
  13214. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13215. // buffering can accept large writes even when the peer already responded.
  13216. // Check the stream first (which covers SSL via `is_readable()`), then
  13217. // fall back to select on the socket. Only perform the wait for very large
  13218. // request bodies to avoid interfering with normal small requests and
  13219. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13220. // response. Skip this check when using Expect: 100-continue, as the protocol
  13221. // handles early responses properly.
  13222. #if defined(_WIN32)
  13223. if (!skip_body &&
  13224. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13225. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13226. auto start = std::chrono::high_resolution_clock::now();
  13227. for (;;) {
  13228. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13229. // from SSL internals. If the underlying socket is readable, assume an
  13230. // early response may be present.
  13231. auto sock = strm.socket();
  13232. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13233. return false;
  13234. }
  13235. // Fallback to stream-level check for non-socket streams or when the
  13236. // socket isn't reporting readable. Avoid using `is_readable()` for
  13237. // SSL, since `SSL_pending()` may report buffered records that do not
  13238. // indicate a complete application-level response yet.
  13239. if (!is_ssl() && strm.is_readable()) { return false; }
  13240. auto now = std::chrono::high_resolution_clock::now();
  13241. auto elapsed =
  13242. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13243. .count();
  13244. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13245. break;
  13246. }
  13247. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13248. }
  13249. }
  13250. #endif
  13251. // Body
  13252. if (skip_body) { return true; }
  13253. return write_request_body(strm, req, error);
  13254. }
  13255. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13256. Error &error) {
  13257. if (req.body.empty()) {
  13258. return write_content_with_provider(strm, req, error);
  13259. }
  13260. if (req.upload_progress) {
  13261. auto body_size = req.body.size();
  13262. size_t written = 0;
  13263. auto data = req.body.data();
  13264. while (written < body_size) {
  13265. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13266. if (!detail::write_data(strm, data + written, to_write)) {
  13267. error = Error::Write;
  13268. output_error_log(error, &req);
  13269. return false;
  13270. }
  13271. written += to_write;
  13272. if (!req.upload_progress(written, body_size)) {
  13273. error = Error::Canceled;
  13274. output_error_log(error, &req);
  13275. return false;
  13276. }
  13277. }
  13278. } else {
  13279. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13280. error = Error::Write;
  13281. output_error_log(error, &req);
  13282. return false;
  13283. }
  13284. }
  13285. return true;
  13286. }
  13287. inline std::unique_ptr<Response>
  13288. ClientImpl::send_with_content_provider_and_receiver(
  13289. Request &req, const char *body, size_t content_length,
  13290. ContentProvider content_provider,
  13291. ContentProviderWithoutLength content_provider_without_length,
  13292. const std::string &content_type, ContentReceiver content_receiver,
  13293. Error &error) {
  13294. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13295. auto enc = compress_
  13296. ? detail::create_compressor()
  13297. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13298. nullptr, nullptr);
  13299. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13300. if (enc.first && !content_provider_without_length) {
  13301. auto &compressor = enc.first;
  13302. if (content_provider) {
  13303. auto ok = true;
  13304. auto finished = false;
  13305. size_t offset = 0;
  13306. DataSink data_sink;
  13307. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13308. if (ok) {
  13309. auto last = offset + data_len == content_length;
  13310. auto ret = compressor->compress(
  13311. data, data_len, last,
  13312. [&](const char *compressed_data, size_t compressed_data_len) {
  13313. req.body.append(compressed_data, compressed_data_len);
  13314. return true;
  13315. });
  13316. if (ret) {
  13317. offset += data_len;
  13318. } else {
  13319. ok = false;
  13320. }
  13321. }
  13322. return ok;
  13323. };
  13324. // As in detail::write_content_with_progress(): the body is framed by
  13325. // content_length, so a provider that finishes early has truncated it.
  13326. // Stop and report that instead of calling the provider forever.
  13327. data_sink.done = [&]() { finished = true; };
  13328. while (ok && !finished && offset < content_length) {
  13329. if (!content_provider(offset, content_length - offset, data_sink)) {
  13330. error = Error::Canceled;
  13331. output_error_log(error, &req);
  13332. return nullptr;
  13333. }
  13334. }
  13335. // A short body here means either the provider stopped early or the
  13336. // compressor gave up. The branch below reports a failing compressor as
  13337. // Error::Compression, so keep the two distinguishable.
  13338. if (offset < content_length) {
  13339. error = ok ? Error::Write : Error::Compression;
  13340. output_error_log(error, &req);
  13341. return nullptr;
  13342. }
  13343. } else {
  13344. if (!compressor->compress(body, content_length, true,
  13345. [&](const char *data, size_t data_len) {
  13346. req.body.append(data, data_len);
  13347. return true;
  13348. })) {
  13349. error = Error::Compression;
  13350. output_error_log(error, &req);
  13351. return nullptr;
  13352. }
  13353. }
  13354. } else {
  13355. if (content_provider) {
  13356. req.content_length_ = content_length;
  13357. req.content_provider_ = std::move(content_provider);
  13358. req.is_chunked_content_provider_ = false;
  13359. } else if (content_provider_without_length) {
  13360. req.content_length_ = 0;
  13361. req.content_provider_ = detail::ContentProviderAdapter(
  13362. std::move(content_provider_without_length));
  13363. req.is_chunked_content_provider_ = true;
  13364. req.set_header("Transfer-Encoding", "chunked");
  13365. } else {
  13366. req.body.assign(body, content_length);
  13367. }
  13368. }
  13369. if (content_receiver) {
  13370. req.content_receiver =
  13371. [content_receiver](const char *data, size_t data_length,
  13372. size_t /*offset*/, size_t /*total_length*/) {
  13373. return content_receiver(data, data_length);
  13374. };
  13375. }
  13376. auto res = detail::make_unique<Response>();
  13377. return send(req, *res, error) ? std::move(res) : nullptr;
  13378. }
  13379. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13380. const std::string &method, const std::string &path, const Headers &headers,
  13381. const char *body, size_t content_length, ContentProvider content_provider,
  13382. ContentProviderWithoutLength content_provider_without_length,
  13383. const std::string &content_type, ContentReceiver content_receiver,
  13384. UploadProgress progress) {
  13385. Request req;
  13386. req.method = method;
  13387. req.headers = headers;
  13388. req.path = path;
  13389. req.upload_progress = std::move(progress);
  13390. if (max_timeout_msec_ > 0) {
  13391. req.start_time_ = std::chrono::steady_clock::now();
  13392. }
  13393. auto error = Error::Success;
  13394. auto res = send_with_content_provider_and_receiver(
  13395. req, body, content_length, std::move(content_provider),
  13396. std::move(content_provider_without_length), content_type,
  13397. std::move(content_receiver), error);
  13398. #ifdef CPPHTTPLIB_SSL_ENABLED
  13399. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13400. last_backend_error_};
  13401. #else
  13402. return Result{std::move(res), error, std::move(req.headers)};
  13403. #endif
  13404. }
  13405. inline void ClientImpl::output_log(const Request &req,
  13406. const Response &res) const {
  13407. if (logger_) {
  13408. std::lock_guard<std::mutex> guard(logger_mutex_);
  13409. logger_(req, res);
  13410. }
  13411. }
  13412. inline void ClientImpl::output_error_log(const Error &err,
  13413. const Request *req) const {
  13414. if (error_logger_) {
  13415. std::lock_guard<std::mutex> guard(logger_mutex_);
  13416. error_logger_(err, req);
  13417. }
  13418. }
  13419. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13420. Response &res, bool close_connection,
  13421. Error &error) {
  13422. // Auto-add Expect: 100-continue for large bodies
  13423. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13424. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13425. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13426. req.set_header("Expect", "100-continue");
  13427. }
  13428. }
  13429. // Check for Expect: 100-continue
  13430. auto expect_100_continue =
  13431. detail::has_header_token(req.headers, "Expect", "100-continue");
  13432. // Send request (skip body if using Expect: 100-continue)
  13433. auto write_request_success =
  13434. write_request(strm, req, close_connection, error, expect_100_continue);
  13435. #ifdef CPPHTTPLIB_SSL_ENABLED
  13436. if (is_ssl() && !expect_100_continue) {
  13437. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13438. if (!is_proxy_enabled) {
  13439. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13440. error = Error::SSLPeerCouldBeClosed_;
  13441. output_error_log(error, &req);
  13442. return false;
  13443. }
  13444. }
  13445. }
  13446. #endif
  13447. // Handle Expect: 100-continue.
  13448. //
  13449. // Wait for an interim/early response by attempting to read the status line
  13450. // under a short timeout, instead of trusting raw socket readability. Over
  13451. // TLS, post-handshake records (e.g. session tickets) make the socket
  13452. // readable without any HTTP response being available; relying on
  13453. // `select_read` there caused the body to be withheld forever and the
  13454. // request to fail with `Read` (#2458). If no status line arrives within the
  13455. // timeout, send the body anyway (matching curl's behavior).
  13456. auto status_line_read = false;
  13457. if (expect_100_continue && write_request_success) {
  13458. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13459. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13460. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13461. strm.set_read_timeout(sec, usec);
  13462. status_line_read = read_response_line(strm, req, res, false);
  13463. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13464. }
  13465. if (!status_line_read) {
  13466. // No interim response within the timeout: send the body and handle the
  13467. // response as usual.
  13468. if (!write_request_body(strm, req, error)) { return false; }
  13469. expect_100_continue = false; // Switch to normal response handling
  13470. }
  13471. }
  13472. // Receive response and headers
  13473. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13474. if ((!status_line_read &&
  13475. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13476. !detail::read_headers(strm, res.headers)) {
  13477. if (write_request_success) { error = Error::Read; }
  13478. output_error_log(error, &req);
  13479. return false;
  13480. }
  13481. if (!write_request_success) { return false; }
  13482. // Handle Expect: 100-continue response
  13483. if (expect_100_continue) {
  13484. if (res.status == StatusCode::Continue_100) {
  13485. // Server accepted, send the body
  13486. if (!write_request_body(strm, req, error)) { return false; }
  13487. // Read the actual response
  13488. res.headers.clear();
  13489. res.body.clear();
  13490. if (!read_response_line(strm, req, res) ||
  13491. !detail::read_headers(strm, res.headers)) {
  13492. error = Error::Read;
  13493. output_error_log(error, &req);
  13494. return false;
  13495. }
  13496. }
  13497. // If not 100 Continue, server returned an error; proceed with that response
  13498. }
  13499. // Body
  13500. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13501. req.method != "CONNECT") {
  13502. auto redirect = 300 < res.status && res.status < 400 &&
  13503. res.status != StatusCode::NotModified_304 &&
  13504. follow_location_;
  13505. if (req.response_handler && !redirect) {
  13506. if (!req.response_handler(res)) {
  13507. error = Error::Canceled;
  13508. output_error_log(error, &req);
  13509. return false;
  13510. }
  13511. }
  13512. auto out =
  13513. req.content_receiver
  13514. ? static_cast<ContentReceiverWithProgress>(
  13515. [&](const char *buf, size_t n, size_t off, size_t len) {
  13516. if (redirect) { return true; }
  13517. auto ret = req.content_receiver(buf, n, off, len);
  13518. if (!ret) {
  13519. error = Error::Canceled;
  13520. output_error_log(error, &req);
  13521. }
  13522. return ret;
  13523. })
  13524. : static_cast<ContentReceiverWithProgress>(
  13525. [&](const char *buf, size_t n, size_t /*off*/,
  13526. size_t /*len*/) {
  13527. assert(res.body.size() + n <= res.body.max_size());
  13528. if (payload_max_length_ > 0 &&
  13529. (res.body.size() >= payload_max_length_ ||
  13530. n > payload_max_length_ - res.body.size())) {
  13531. return false;
  13532. }
  13533. res.body.append(buf, n);
  13534. return true;
  13535. });
  13536. auto progress = [&](size_t current, size_t total) {
  13537. if (!req.download_progress || redirect) { return true; }
  13538. auto ret = req.download_progress(current, total);
  13539. if (!ret) {
  13540. error = Error::Canceled;
  13541. output_error_log(error, &req);
  13542. }
  13543. return ret;
  13544. };
  13545. if (res.has_header("Content-Length")) {
  13546. if (!req.content_receiver) {
  13547. auto len = res.get_header_value_u64("Content-Length");
  13548. if (len > res.body.max_size()) {
  13549. error = Error::Read;
  13550. output_error_log(error, &req);
  13551. return false;
  13552. }
  13553. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13554. // hostile or malformed server sends an enormous Content-Length.
  13555. // The actual body read below is bounded by payload_max_length_,
  13556. // so reserving more than that is never useful.
  13557. auto reserve_len = static_cast<size_t>(len);
  13558. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13559. reserve_len = payload_max_length_;
  13560. }
  13561. res.body.reserve(reserve_len);
  13562. }
  13563. }
  13564. if (res.status != StatusCode::NotModified_304) {
  13565. auto content_status = 0;
  13566. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13567. ? (std::numeric_limits<size_t>::max)()
  13568. : payload_max_length_;
  13569. if (!detail::read_content(strm, res, max_length, content_status,
  13570. std::move(progress), std::move(out),
  13571. decompress_)) {
  13572. if (error != Error::Canceled) {
  13573. // Tell the caller apart from a plain read failure when the body could
  13574. // not be decoded because of its Content-Encoding.
  13575. switch (content_status) {
  13576. case StatusCode::UnsupportedMediaType_415:
  13577. error = Error::UnsupportedContentEncoding;
  13578. break;
  13579. case StatusCode::InternalServerError_500:
  13580. error = Error::Compression;
  13581. break;
  13582. default: error = Error::Read; break;
  13583. }
  13584. }
  13585. output_error_log(error, &req);
  13586. return false;
  13587. }
  13588. }
  13589. }
  13590. // Log
  13591. output_log(req, res);
  13592. return true;
  13593. }
  13594. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13595. const std::string &boundary, const UploadFormDataItems &items,
  13596. const FormDataProviderItems &provider_items) const {
  13597. size_t cur_item = 0;
  13598. size_t cur_start = 0;
  13599. // cur_item and cur_start are copied to within the std::function and
  13600. // maintain state between successive calls
  13601. return [&, cur_item, cur_start](size_t offset,
  13602. DataSink &sink) mutable -> bool {
  13603. if (!offset && !items.empty()) {
  13604. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13605. return true;
  13606. } else if (cur_item < provider_items.size()) {
  13607. if (!cur_start) {
  13608. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13609. provider_items[cur_item], boundary);
  13610. offset += begin.size();
  13611. cur_start = offset;
  13612. sink.os << begin;
  13613. }
  13614. DataSink cur_sink;
  13615. auto has_data = true;
  13616. cur_sink.write = sink.write;
  13617. // Forward is_writable so a provider item asking whether it may keep
  13618. // going gets the outer sink's answer rather than the default `true`.
  13619. cur_sink.is_writable = sink.is_writable;
  13620. cur_sink.done = [&]() { has_data = false; };
  13621. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13622. return false;
  13623. }
  13624. if (!has_data) {
  13625. sink.os << detail::serialize_multipart_formdata_item_end();
  13626. cur_item++;
  13627. cur_start = 0;
  13628. }
  13629. return true;
  13630. } else {
  13631. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13632. sink.done();
  13633. return true;
  13634. }
  13635. };
  13636. }
  13637. inline bool ClientImpl::process_socket(
  13638. const Socket &socket,
  13639. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13640. std::function<bool(Stream &strm)> callback) {
  13641. return detail::process_client_socket(
  13642. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13643. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13644. }
  13645. inline bool ClientImpl::is_ssl() const { return false; }
  13646. inline Result ClientImpl::Get(const std::string &path,
  13647. DownloadProgress progress) {
  13648. return Get(path, Headers(), std::move(progress));
  13649. }
  13650. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13651. DownloadProgress progress) {
  13652. return Get(path, params, Headers(), std::move(progress));
  13653. }
  13654. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13655. const Headers &headers,
  13656. DownloadProgress progress) {
  13657. if (params.empty()) { return Get(path, headers); }
  13658. std::string path_with_query = append_query_params(path, params);
  13659. return Get(path_with_query, headers, std::move(progress));
  13660. }
  13661. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13662. DownloadProgress progress) {
  13663. Request req;
  13664. req.method = "GET";
  13665. req.path = path;
  13666. req.headers = headers;
  13667. req.download_progress = std::move(progress);
  13668. if (max_timeout_msec_ > 0) {
  13669. req.start_time_ = std::chrono::steady_clock::now();
  13670. }
  13671. return send_(std::move(req));
  13672. }
  13673. inline Result ClientImpl::Get(const std::string &path,
  13674. ContentReceiver content_receiver,
  13675. DownloadProgress progress) {
  13676. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13677. std::move(progress));
  13678. }
  13679. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13680. ContentReceiver content_receiver,
  13681. DownloadProgress progress) {
  13682. return Get(path, headers, nullptr, std::move(content_receiver),
  13683. std::move(progress));
  13684. }
  13685. inline Result ClientImpl::Get(const std::string &path,
  13686. ResponseHandler response_handler,
  13687. ContentReceiver content_receiver,
  13688. DownloadProgress progress) {
  13689. return Get(path, Headers(), std::move(response_handler),
  13690. std::move(content_receiver), std::move(progress));
  13691. }
  13692. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13693. ResponseHandler response_handler,
  13694. ContentReceiver content_receiver,
  13695. DownloadProgress progress) {
  13696. Request req;
  13697. req.method = "GET";
  13698. req.path = path;
  13699. req.headers = headers;
  13700. req.response_handler = std::move(response_handler);
  13701. req.content_receiver =
  13702. [content_receiver](const char *data, size_t data_length,
  13703. size_t /*offset*/, size_t /*total_length*/) {
  13704. return content_receiver(data, data_length);
  13705. };
  13706. req.download_progress = std::move(progress);
  13707. if (max_timeout_msec_ > 0) {
  13708. req.start_time_ = std::chrono::steady_clock::now();
  13709. }
  13710. return send_(std::move(req));
  13711. }
  13712. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13713. const Headers &headers,
  13714. ContentReceiver content_receiver,
  13715. DownloadProgress progress) {
  13716. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13717. std::move(progress));
  13718. }
  13719. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13720. const Headers &headers,
  13721. ResponseHandler response_handler,
  13722. ContentReceiver content_receiver,
  13723. DownloadProgress progress) {
  13724. if (params.empty()) {
  13725. return Get(path, headers, std::move(response_handler),
  13726. std::move(content_receiver), std::move(progress));
  13727. }
  13728. std::string path_with_query = append_query_params(path, params);
  13729. return Get(path_with_query, headers, std::move(response_handler),
  13730. std::move(content_receiver), std::move(progress));
  13731. }
  13732. inline Result ClientImpl::Head(const std::string &path) {
  13733. return Head(path, Headers());
  13734. }
  13735. inline Result ClientImpl::Head(const std::string &path,
  13736. const Headers &headers) {
  13737. Request req;
  13738. req.method = "HEAD";
  13739. req.headers = headers;
  13740. req.path = path;
  13741. if (max_timeout_msec_ > 0) {
  13742. req.start_time_ = std::chrono::steady_clock::now();
  13743. }
  13744. return send_(std::move(req));
  13745. }
  13746. inline Result ClientImpl::Post(const std::string &path) {
  13747. return Post(path, std::string(), std::string());
  13748. }
  13749. inline Result ClientImpl::Post(const std::string &path,
  13750. const Headers &headers) {
  13751. return Post(path, headers, nullptr, 0, std::string());
  13752. }
  13753. inline Result ClientImpl::Post(const std::string &path, const char *body,
  13754. size_t content_length,
  13755. const std::string &content_type,
  13756. UploadProgress progress) {
  13757. return Post(path, Headers(), body, content_length, content_type, progress);
  13758. }
  13759. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  13760. const std::string &content_type,
  13761. UploadProgress progress) {
  13762. return Post(path, Headers(), body, content_type, progress);
  13763. }
  13764. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  13765. return Post(path, Headers(), params);
  13766. }
  13767. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13768. ContentProvider content_provider,
  13769. const std::string &content_type,
  13770. UploadProgress progress) {
  13771. return Post(path, Headers(), content_length, std::move(content_provider),
  13772. content_type, progress);
  13773. }
  13774. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13775. ContentProvider content_provider,
  13776. const std::string &content_type,
  13777. ContentReceiver content_receiver,
  13778. UploadProgress progress) {
  13779. return Post(path, Headers(), content_length, std::move(content_provider),
  13780. content_type, std::move(content_receiver), progress);
  13781. }
  13782. inline Result ClientImpl::Post(const std::string &path,
  13783. ContentProviderWithoutLength content_provider,
  13784. const std::string &content_type,
  13785. UploadProgress progress) {
  13786. return Post(path, Headers(), std::move(content_provider), content_type,
  13787. progress);
  13788. }
  13789. inline Result ClientImpl::Post(const std::string &path,
  13790. ContentProviderWithoutLength content_provider,
  13791. const std::string &content_type,
  13792. ContentReceiver content_receiver,
  13793. UploadProgress progress) {
  13794. return Post(path, Headers(), std::move(content_provider), content_type,
  13795. std::move(content_receiver), progress);
  13796. }
  13797. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13798. const Params &params) {
  13799. auto query = detail::params_to_query_str(params);
  13800. return Post(path, headers, query, "application/x-www-form-urlencoded");
  13801. }
  13802. inline Result ClientImpl::Post(const std::string &path,
  13803. const UploadFormDataItems &items,
  13804. UploadProgress progress) {
  13805. return Post(path, Headers(), items, progress);
  13806. }
  13807. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13808. const UploadFormDataItems &items,
  13809. UploadProgress progress) {
  13810. const auto &boundary = detail::make_multipart_data_boundary();
  13811. const auto &content_type =
  13812. detail::serialize_multipart_formdata_get_content_type(boundary);
  13813. auto content_length = detail::get_multipart_content_length(items, boundary);
  13814. return Post(path, headers, content_length,
  13815. detail::make_multipart_content_provider(items, boundary),
  13816. content_type, progress);
  13817. }
  13818. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13819. const UploadFormDataItems &items,
  13820. const std::string &boundary,
  13821. UploadProgress progress) {
  13822. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13823. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13824. }
  13825. const auto &content_type =
  13826. detail::serialize_multipart_formdata_get_content_type(boundary);
  13827. auto content_length = detail::get_multipart_content_length(items, boundary);
  13828. return Post(path, headers, content_length,
  13829. detail::make_multipart_content_provider(items, boundary),
  13830. content_type, progress);
  13831. }
  13832. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13833. const char *body, size_t content_length,
  13834. const std::string &content_type,
  13835. UploadProgress progress) {
  13836. return send_with_content_provider_and_receiver(
  13837. "POST", path, headers, body, content_length, nullptr, nullptr,
  13838. content_type, nullptr, progress);
  13839. }
  13840. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13841. const std::string &body,
  13842. const std::string &content_type,
  13843. UploadProgress progress) {
  13844. return send_with_content_provider_and_receiver(
  13845. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  13846. content_type, nullptr, progress);
  13847. }
  13848. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13849. size_t content_length,
  13850. ContentProvider content_provider,
  13851. const std::string &content_type,
  13852. UploadProgress progress) {
  13853. return send_with_content_provider_and_receiver(
  13854. "POST", path, headers, nullptr, content_length,
  13855. std::move(content_provider), nullptr, content_type, nullptr, progress);
  13856. }
  13857. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13858. size_t content_length,
  13859. ContentProvider content_provider,
  13860. const std::string &content_type,
  13861. ContentReceiver content_receiver,
  13862. DownloadProgress progress) {
  13863. return send_with_content_provider_and_receiver(
  13864. "POST", path, headers, nullptr, content_length,
  13865. std::move(content_provider), nullptr, content_type,
  13866. std::move(content_receiver), std::move(progress));
  13867. }
  13868. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13869. ContentProviderWithoutLength content_provider,
  13870. const std::string &content_type,
  13871. UploadProgress progress) {
  13872. return send_with_content_provider_and_receiver(
  13873. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13874. content_type, nullptr, progress);
  13875. }
  13876. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13877. ContentProviderWithoutLength content_provider,
  13878. const std::string &content_type,
  13879. ContentReceiver content_receiver,
  13880. DownloadProgress progress) {
  13881. return send_with_content_provider_and_receiver(
  13882. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  13883. content_type, std::move(content_receiver), std::move(progress));
  13884. }
  13885. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13886. const UploadFormDataItems &items,
  13887. const FormDataProviderItems &provider_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. return send_with_content_provider_and_receiver(
  13893. "POST", path, headers, nullptr, 0, nullptr,
  13894. get_multipart_content_provider(boundary, items, provider_items),
  13895. content_type, nullptr, progress);
  13896. }
  13897. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  13898. const std::string &body,
  13899. const std::string &content_type,
  13900. ContentReceiver content_receiver,
  13901. DownloadProgress progress) {
  13902. Request req;
  13903. req.method = "POST";
  13904. req.path = path;
  13905. req.headers = headers;
  13906. req.body = body;
  13907. req.content_receiver =
  13908. [content_receiver](const char *data, size_t data_length,
  13909. size_t /*offset*/, size_t /*total_length*/) {
  13910. return content_receiver(data, data_length);
  13911. };
  13912. req.download_progress = std::move(progress);
  13913. if (max_timeout_msec_ > 0) {
  13914. req.start_time_ = std::chrono::steady_clock::now();
  13915. }
  13916. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13917. return send_(std::move(req));
  13918. }
  13919. inline Result ClientImpl::Put(const std::string &path) {
  13920. return Put(path, std::string(), std::string());
  13921. }
  13922. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  13923. return Put(path, headers, nullptr, 0, std::string());
  13924. }
  13925. inline Result ClientImpl::Put(const std::string &path, const char *body,
  13926. size_t content_length,
  13927. const std::string &content_type,
  13928. UploadProgress progress) {
  13929. return Put(path, Headers(), body, content_length, content_type, progress);
  13930. }
  13931. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  13932. const std::string &content_type,
  13933. UploadProgress progress) {
  13934. return Put(path, Headers(), body, content_type, progress);
  13935. }
  13936. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  13937. return Put(path, Headers(), params);
  13938. }
  13939. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  13940. ContentProvider content_provider,
  13941. const std::string &content_type,
  13942. UploadProgress progress) {
  13943. return Put(path, Headers(), content_length, std::move(content_provider),
  13944. content_type, progress);
  13945. }
  13946. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  13947. ContentProvider content_provider,
  13948. const std::string &content_type,
  13949. ContentReceiver content_receiver,
  13950. UploadProgress progress) {
  13951. return Put(path, Headers(), content_length, std::move(content_provider),
  13952. content_type, std::move(content_receiver), progress);
  13953. }
  13954. inline Result ClientImpl::Put(const std::string &path,
  13955. ContentProviderWithoutLength content_provider,
  13956. const std::string &content_type,
  13957. UploadProgress progress) {
  13958. return Put(path, Headers(), std::move(content_provider), content_type,
  13959. progress);
  13960. }
  13961. inline Result ClientImpl::Put(const std::string &path,
  13962. ContentProviderWithoutLength content_provider,
  13963. const std::string &content_type,
  13964. ContentReceiver content_receiver,
  13965. UploadProgress progress) {
  13966. return Put(path, Headers(), std::move(content_provider), content_type,
  13967. std::move(content_receiver), progress);
  13968. }
  13969. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13970. const Params &params) {
  13971. auto query = detail::params_to_query_str(params);
  13972. return Put(path, headers, query, "application/x-www-form-urlencoded");
  13973. }
  13974. inline Result ClientImpl::Put(const std::string &path,
  13975. const UploadFormDataItems &items,
  13976. UploadProgress progress) {
  13977. return Put(path, Headers(), items, progress);
  13978. }
  13979. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13980. const UploadFormDataItems &items,
  13981. UploadProgress progress) {
  13982. const auto &boundary = detail::make_multipart_data_boundary();
  13983. const auto &content_type =
  13984. detail::serialize_multipart_formdata_get_content_type(boundary);
  13985. auto content_length = detail::get_multipart_content_length(items, boundary);
  13986. return Put(path, headers, content_length,
  13987. detail::make_multipart_content_provider(items, boundary),
  13988. content_type, progress);
  13989. }
  13990. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  13991. const UploadFormDataItems &items,
  13992. const std::string &boundary,
  13993. UploadProgress progress) {
  13994. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  13995. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  13996. }
  13997. const auto &content_type =
  13998. detail::serialize_multipart_formdata_get_content_type(boundary);
  13999. auto content_length = detail::get_multipart_content_length(items, boundary);
  14000. return Put(path, headers, content_length,
  14001. detail::make_multipart_content_provider(items, boundary),
  14002. content_type, progress);
  14003. }
  14004. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14005. const char *body, size_t content_length,
  14006. const std::string &content_type,
  14007. UploadProgress progress) {
  14008. return send_with_content_provider_and_receiver(
  14009. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14010. content_type, nullptr, progress);
  14011. }
  14012. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14013. const std::string &body,
  14014. const std::string &content_type,
  14015. UploadProgress progress) {
  14016. return send_with_content_provider_and_receiver(
  14017. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14018. content_type, nullptr, progress);
  14019. }
  14020. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14021. size_t content_length,
  14022. ContentProvider content_provider,
  14023. const std::string &content_type,
  14024. UploadProgress progress) {
  14025. return send_with_content_provider_and_receiver(
  14026. "PUT", path, headers, nullptr, content_length,
  14027. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14028. }
  14029. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14030. size_t content_length,
  14031. ContentProvider content_provider,
  14032. const std::string &content_type,
  14033. ContentReceiver content_receiver,
  14034. UploadProgress progress) {
  14035. return send_with_content_provider_and_receiver(
  14036. "PUT", path, headers, nullptr, content_length,
  14037. std::move(content_provider), nullptr, content_type,
  14038. std::move(content_receiver), progress);
  14039. }
  14040. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14041. ContentProviderWithoutLength content_provider,
  14042. const std::string &content_type,
  14043. UploadProgress progress) {
  14044. return send_with_content_provider_and_receiver(
  14045. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14046. content_type, nullptr, progress);
  14047. }
  14048. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14049. ContentProviderWithoutLength content_provider,
  14050. const std::string &content_type,
  14051. ContentReceiver content_receiver,
  14052. UploadProgress progress) {
  14053. return send_with_content_provider_and_receiver(
  14054. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14055. content_type, std::move(content_receiver), progress);
  14056. }
  14057. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14058. const UploadFormDataItems &items,
  14059. const FormDataProviderItems &provider_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. return send_with_content_provider_and_receiver(
  14065. "PUT", path, headers, nullptr, 0, nullptr,
  14066. get_multipart_content_provider(boundary, items, provider_items),
  14067. content_type, nullptr, progress);
  14068. }
  14069. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14070. const std::string &body,
  14071. const std::string &content_type,
  14072. ContentReceiver content_receiver,
  14073. DownloadProgress progress) {
  14074. Request req;
  14075. req.method = "PUT";
  14076. req.path = path;
  14077. req.headers = headers;
  14078. req.body = body;
  14079. req.content_receiver =
  14080. [content_receiver](const char *data, size_t data_length,
  14081. size_t /*offset*/, size_t /*total_length*/) {
  14082. return content_receiver(data, data_length);
  14083. };
  14084. req.download_progress = std::move(progress);
  14085. if (max_timeout_msec_ > 0) {
  14086. req.start_time_ = std::chrono::steady_clock::now();
  14087. }
  14088. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14089. return send_(std::move(req));
  14090. }
  14091. inline Result ClientImpl::Patch(const std::string &path) {
  14092. return Patch(path, std::string(), std::string());
  14093. }
  14094. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14095. UploadProgress progress) {
  14096. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14097. }
  14098. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14099. size_t content_length,
  14100. const std::string &content_type,
  14101. UploadProgress progress) {
  14102. return Patch(path, Headers(), body, content_length, content_type, progress);
  14103. }
  14104. inline Result ClientImpl::Patch(const std::string &path,
  14105. const std::string &body,
  14106. const std::string &content_type,
  14107. UploadProgress progress) {
  14108. return Patch(path, Headers(), body, content_type, progress);
  14109. }
  14110. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14111. return Patch(path, Headers(), params);
  14112. }
  14113. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14114. ContentProvider content_provider,
  14115. const std::string &content_type,
  14116. UploadProgress progress) {
  14117. return Patch(path, Headers(), content_length, std::move(content_provider),
  14118. content_type, progress);
  14119. }
  14120. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14121. ContentProvider content_provider,
  14122. const std::string &content_type,
  14123. ContentReceiver content_receiver,
  14124. UploadProgress progress) {
  14125. return Patch(path, Headers(), content_length, std::move(content_provider),
  14126. content_type, std::move(content_receiver), progress);
  14127. }
  14128. inline Result ClientImpl::Patch(const std::string &path,
  14129. ContentProviderWithoutLength content_provider,
  14130. const std::string &content_type,
  14131. UploadProgress progress) {
  14132. return Patch(path, Headers(), std::move(content_provider), content_type,
  14133. progress);
  14134. }
  14135. inline Result ClientImpl::Patch(const std::string &path,
  14136. ContentProviderWithoutLength content_provider,
  14137. const std::string &content_type,
  14138. ContentReceiver content_receiver,
  14139. UploadProgress progress) {
  14140. return Patch(path, Headers(), std::move(content_provider), content_type,
  14141. std::move(content_receiver), progress);
  14142. }
  14143. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14144. const Params &params) {
  14145. auto query = detail::params_to_query_str(params);
  14146. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14147. }
  14148. inline Result ClientImpl::Patch(const std::string &path,
  14149. const UploadFormDataItems &items,
  14150. UploadProgress progress) {
  14151. return Patch(path, Headers(), items, progress);
  14152. }
  14153. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14154. const UploadFormDataItems &items,
  14155. UploadProgress progress) {
  14156. const auto &boundary = detail::make_multipart_data_boundary();
  14157. const auto &content_type =
  14158. detail::serialize_multipart_formdata_get_content_type(boundary);
  14159. auto content_length = detail::get_multipart_content_length(items, boundary);
  14160. return Patch(path, headers, content_length,
  14161. detail::make_multipart_content_provider(items, boundary),
  14162. content_type, progress);
  14163. }
  14164. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14165. const UploadFormDataItems &items,
  14166. const std::string &boundary,
  14167. UploadProgress progress) {
  14168. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14169. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14170. }
  14171. const auto &content_type =
  14172. detail::serialize_multipart_formdata_get_content_type(boundary);
  14173. auto content_length = detail::get_multipart_content_length(items, boundary);
  14174. return Patch(path, headers, content_length,
  14175. detail::make_multipart_content_provider(items, boundary),
  14176. content_type, progress);
  14177. }
  14178. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14179. const char *body, size_t content_length,
  14180. const std::string &content_type,
  14181. UploadProgress progress) {
  14182. return send_with_content_provider_and_receiver(
  14183. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14184. content_type, nullptr, progress);
  14185. }
  14186. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14187. const std::string &body,
  14188. const std::string &content_type,
  14189. UploadProgress progress) {
  14190. return send_with_content_provider_and_receiver(
  14191. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14192. content_type, nullptr, progress);
  14193. }
  14194. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14195. size_t content_length,
  14196. ContentProvider content_provider,
  14197. const std::string &content_type,
  14198. UploadProgress progress) {
  14199. return send_with_content_provider_and_receiver(
  14200. "PATCH", path, headers, nullptr, content_length,
  14201. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14202. }
  14203. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14204. size_t content_length,
  14205. ContentProvider content_provider,
  14206. const std::string &content_type,
  14207. ContentReceiver content_receiver,
  14208. UploadProgress progress) {
  14209. return send_with_content_provider_and_receiver(
  14210. "PATCH", path, headers, nullptr, content_length,
  14211. std::move(content_provider), nullptr, content_type,
  14212. std::move(content_receiver), progress);
  14213. }
  14214. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14215. ContentProviderWithoutLength content_provider,
  14216. const std::string &content_type,
  14217. UploadProgress progress) {
  14218. return send_with_content_provider_and_receiver(
  14219. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14220. content_type, nullptr, progress);
  14221. }
  14222. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14223. ContentProviderWithoutLength content_provider,
  14224. const std::string &content_type,
  14225. ContentReceiver content_receiver,
  14226. UploadProgress progress) {
  14227. return send_with_content_provider_and_receiver(
  14228. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14229. content_type, std::move(content_receiver), progress);
  14230. }
  14231. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14232. const UploadFormDataItems &items,
  14233. const FormDataProviderItems &provider_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. return send_with_content_provider_and_receiver(
  14239. "PATCH", path, headers, nullptr, 0, nullptr,
  14240. get_multipart_content_provider(boundary, items, provider_items),
  14241. content_type, nullptr, progress);
  14242. }
  14243. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14244. const std::string &body,
  14245. const std::string &content_type,
  14246. ContentReceiver content_receiver,
  14247. DownloadProgress progress) {
  14248. Request req;
  14249. req.method = "PATCH";
  14250. req.path = path;
  14251. req.headers = headers;
  14252. req.body = body;
  14253. req.content_receiver =
  14254. [content_receiver](const char *data, size_t data_length,
  14255. size_t /*offset*/, size_t /*total_length*/) {
  14256. return content_receiver(data, data_length);
  14257. };
  14258. req.download_progress = std::move(progress);
  14259. if (max_timeout_msec_ > 0) {
  14260. req.start_time_ = std::chrono::steady_clock::now();
  14261. }
  14262. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14263. return send_(std::move(req));
  14264. }
  14265. inline Result ClientImpl::Delete(const std::string &path,
  14266. DownloadProgress progress) {
  14267. return Delete(path, Headers(), std::string(), std::string(), progress);
  14268. }
  14269. inline Result ClientImpl::Delete(const std::string &path,
  14270. const Headers &headers,
  14271. DownloadProgress progress) {
  14272. return Delete(path, headers, std::string(), std::string(), progress);
  14273. }
  14274. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14275. size_t content_length,
  14276. const std::string &content_type,
  14277. DownloadProgress progress) {
  14278. return Delete(path, Headers(), body, content_length, content_type, progress);
  14279. }
  14280. inline Result ClientImpl::Delete(const std::string &path,
  14281. const std::string &body,
  14282. const std::string &content_type,
  14283. DownloadProgress progress) {
  14284. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14285. progress);
  14286. }
  14287. inline Result ClientImpl::Delete(const std::string &path,
  14288. const Headers &headers,
  14289. const std::string &body,
  14290. const std::string &content_type,
  14291. DownloadProgress progress) {
  14292. return Delete(path, headers, body.data(), body.size(), content_type,
  14293. progress);
  14294. }
  14295. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14296. DownloadProgress progress) {
  14297. return Delete(path, Headers(), params, progress);
  14298. }
  14299. inline Result ClientImpl::Delete(const std::string &path,
  14300. const Headers &headers, const Params &params,
  14301. DownloadProgress progress) {
  14302. auto query = detail::params_to_query_str(params);
  14303. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14304. progress);
  14305. }
  14306. inline Result ClientImpl::Delete(const std::string &path,
  14307. const Headers &headers, const char *body,
  14308. size_t content_length,
  14309. const std::string &content_type,
  14310. DownloadProgress progress) {
  14311. Request req;
  14312. req.method = "DELETE";
  14313. req.headers = headers;
  14314. req.path = path;
  14315. req.download_progress = std::move(progress);
  14316. if (max_timeout_msec_ > 0) {
  14317. req.start_time_ = std::chrono::steady_clock::now();
  14318. }
  14319. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14320. req.body.assign(body, content_length);
  14321. return send_(std::move(req));
  14322. }
  14323. inline Result ClientImpl::Options(const std::string &path) {
  14324. return Options(path, Headers());
  14325. }
  14326. inline Result ClientImpl::Options(const std::string &path,
  14327. const Headers &headers) {
  14328. Request req;
  14329. req.method = "OPTIONS";
  14330. req.headers = headers;
  14331. req.path = path;
  14332. if (max_timeout_msec_ > 0) {
  14333. req.start_time_ = std::chrono::steady_clock::now();
  14334. }
  14335. return send_(std::move(req));
  14336. }
  14337. inline void ClientImpl::stop() {
  14338. std::lock_guard<std::mutex> guard(socket_mutex_);
  14339. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14340. // do is to shutdown_socket, so that threads using this socket suddenly
  14341. // discover they can't read/write any more and error out. Everything else
  14342. // (closing the socket, shutting ssl down) is unsafe because these actions
  14343. // are not thread-safe.
  14344. if (socket_requests_in_flight_ > 0) {
  14345. shutdown_socket(socket_);
  14346. // Aside from that, we set a flag for the socket to be closed when we're
  14347. // done.
  14348. socket_should_be_closed_when_request_is_done_ = true;
  14349. return;
  14350. }
  14351. disconnect(/*gracefully=*/true);
  14352. }
  14353. inline std::string ClientImpl::host() const { return host_; }
  14354. inline int ClientImpl::port() const { return port_; }
  14355. inline size_t ClientImpl::is_socket_open() const {
  14356. std::lock_guard<std::mutex> guard(socket_mutex_);
  14357. return socket_.is_open();
  14358. }
  14359. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14360. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14361. connection_timeout_sec_ = sec;
  14362. connection_timeout_usec_ = usec;
  14363. }
  14364. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14365. read_timeout_sec_ = sec;
  14366. read_timeout_usec_ = usec;
  14367. }
  14368. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14369. write_timeout_sec_ = sec;
  14370. write_timeout_usec_ = usec;
  14371. }
  14372. inline void ClientImpl::set_max_timeout(time_t msec) {
  14373. max_timeout_msec_ = msec;
  14374. }
  14375. inline void ClientImpl::set_basic_auth(const std::string &username,
  14376. const std::string &password) {
  14377. basic_auth_username_ = username;
  14378. basic_auth_password_ = password;
  14379. }
  14380. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14381. bearer_token_auth_token_ = token;
  14382. }
  14383. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14384. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14385. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14386. inline void
  14387. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14388. addr_map_ = std::move(addr_map);
  14389. }
  14390. inline void ClientImpl::set_default_headers(Headers headers) {
  14391. default_headers_ = std::move(headers);
  14392. }
  14393. inline void ClientImpl::set_header_writer(
  14394. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14395. header_writer_ = writer;
  14396. }
  14397. inline void ClientImpl::set_address_family(int family) {
  14398. address_family_ = family;
  14399. }
  14400. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14401. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14402. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14403. socket_options_ = std::move(socket_options);
  14404. }
  14405. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14406. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14407. inline void ClientImpl::set_payload_max_length(size_t length) {
  14408. payload_max_length_ = length;
  14409. has_payload_max_length_ = true;
  14410. }
  14411. inline void ClientImpl::set_interface(const std::string &intf) {
  14412. interface_ = intf;
  14413. }
  14414. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14415. proxy_host_ = host;
  14416. proxy_port_ = port;
  14417. std::lock_guard<std::mutex> guard(socket_mutex_);
  14418. disconnect(/*gracefully=*/true);
  14419. }
  14420. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14421. const std::string &password) {
  14422. proxy_basic_auth_username_ = username;
  14423. proxy_basic_auth_password_ = password;
  14424. }
  14425. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14426. proxy_bearer_token_auth_token_ = token;
  14427. }
  14428. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14429. std::vector<detail::NoProxyEntry> parsed;
  14430. parsed.reserve(patterns.size());
  14431. for (const auto &p : patterns) {
  14432. auto trimmed = detail::trim_copy(p);
  14433. if (trimmed.empty()) { continue; }
  14434. detail::NoProxyEntry entry;
  14435. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14436. parsed.push_back(std::move(entry));
  14437. }
  14438. }
  14439. no_proxy_entries_ = std::move(parsed);
  14440. std::lock_guard<std::mutex> guard(socket_mutex_);
  14441. disconnect(/*gracefully=*/true);
  14442. }
  14443. #ifdef CPPHTTPLIB_SSL_ENABLED
  14444. inline void ClientImpl::set_digest_auth(const std::string &username,
  14445. const std::string &password) {
  14446. digest_auth_username_ = username;
  14447. digest_auth_password_ = password;
  14448. }
  14449. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14450. const std::string &ca_cert_dir_path) {
  14451. ca_cert_file_path_ = ca_cert_file_path;
  14452. ca_cert_dir_path_ = ca_cert_dir_path;
  14453. }
  14454. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14455. const std::string &password) {
  14456. proxy_digest_auth_username_ = username;
  14457. proxy_digest_auth_password_ = password;
  14458. }
  14459. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14460. server_certificate_verification_ = enabled;
  14461. }
  14462. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14463. server_hostname_verification_ = enabled;
  14464. }
  14465. inline void ClientImpl::enable_system_ca(bool enabled) {
  14466. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14467. }
  14468. #endif
  14469. inline void ClientImpl::set_logger(Logger logger) {
  14470. logger_ = std::move(logger);
  14471. }
  14472. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14473. error_logger_ = std::move(error_logger);
  14474. }
  14475. /*
  14476. * SSL/TLS Common Implementation
  14477. */
  14478. inline ClientConnection::~ClientConnection() {
  14479. #ifdef CPPHTTPLIB_SSL_ENABLED
  14480. if (session) {
  14481. tls::shutdown(session, true);
  14482. tls::free_session(session);
  14483. session = nullptr;
  14484. }
  14485. #endif
  14486. if (sock != INVALID_SOCKET) {
  14487. detail::close_socket(sock);
  14488. sock = INVALID_SOCKET;
  14489. }
  14490. }
  14491. // Universal client implementation
  14492. inline Client::Client(const std::string &scheme_host_port)
  14493. : Client(scheme_host_port, std::string(), std::string()) {}
  14494. inline Client::Client(const std::string &scheme_host_port,
  14495. const std::string &client_cert_path,
  14496. const std::string &client_key_path) {
  14497. detail::UrlComponents uc;
  14498. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14499. auto &scheme = uc.scheme;
  14500. #ifdef CPPHTTPLIB_SSL_ENABLED
  14501. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14502. #else
  14503. if (!scheme.empty() && scheme != "http") {
  14504. #endif
  14505. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14506. std::string msg = "'" + scheme + "' scheme is not supported.";
  14507. throw std::invalid_argument(msg);
  14508. #endif
  14509. return;
  14510. }
  14511. auto is_ssl = scheme == "https";
  14512. auto host = std::move(uc.host);
  14513. auto port = is_ssl ? 443 : 80;
  14514. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14515. if (is_ssl) {
  14516. #ifdef CPPHTTPLIB_SSL_ENABLED
  14517. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14518. client_key_path);
  14519. is_ssl_ = is_ssl;
  14520. #endif
  14521. } else {
  14522. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14523. client_key_path);
  14524. }
  14525. } else {
  14526. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14527. // if port param below changes.
  14528. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14529. client_cert_path, client_key_path);
  14530. }
  14531. }
  14532. inline Client::Client(const std::string &host, int port)
  14533. : Client(host, port, std::string(), std::string()) {}
  14534. inline Client::Client(const std::string &host, int port,
  14535. const std::string &client_cert_path,
  14536. const std::string &client_key_path)
  14537. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14538. client_key_path)) {}
  14539. inline Client::~Client() = default;
  14540. inline bool Client::is_valid() const {
  14541. return cli_ != nullptr && cli_->is_valid();
  14542. }
  14543. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14544. return cli_->Get(path, std::move(progress));
  14545. }
  14546. inline Result Client::Get(const std::string &path, const Headers &headers,
  14547. DownloadProgress progress) {
  14548. return cli_->Get(path, headers, std::move(progress));
  14549. }
  14550. inline Result Client::Get(const std::string &path,
  14551. ContentReceiver content_receiver,
  14552. DownloadProgress progress) {
  14553. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14554. }
  14555. inline Result Client::Get(const std::string &path, const Headers &headers,
  14556. ContentReceiver content_receiver,
  14557. DownloadProgress progress) {
  14558. return cli_->Get(path, headers, std::move(content_receiver),
  14559. std::move(progress));
  14560. }
  14561. inline Result Client::Get(const std::string &path,
  14562. ResponseHandler response_handler,
  14563. ContentReceiver content_receiver,
  14564. DownloadProgress progress) {
  14565. return cli_->Get(path, std::move(response_handler),
  14566. std::move(content_receiver), std::move(progress));
  14567. }
  14568. inline Result Client::Get(const std::string &path, const Headers &headers,
  14569. ResponseHandler response_handler,
  14570. ContentReceiver content_receiver,
  14571. DownloadProgress progress) {
  14572. return cli_->Get(path, headers, std::move(response_handler),
  14573. std::move(content_receiver), std::move(progress));
  14574. }
  14575. inline Result Client::Get(const std::string &path, const Params &params,
  14576. DownloadProgress progress) {
  14577. return cli_->Get(path, params, std::move(progress));
  14578. }
  14579. inline Result Client::Get(const std::string &path, const Params &params,
  14580. const Headers &headers, DownloadProgress progress) {
  14581. return cli_->Get(path, params, headers, std::move(progress));
  14582. }
  14583. inline Result Client::Get(const std::string &path, const Params &params,
  14584. const Headers &headers,
  14585. ContentReceiver content_receiver,
  14586. DownloadProgress progress) {
  14587. return cli_->Get(path, params, headers, std::move(content_receiver),
  14588. std::move(progress));
  14589. }
  14590. inline Result Client::Get(const std::string &path, const Params &params,
  14591. const Headers &headers,
  14592. ResponseHandler response_handler,
  14593. ContentReceiver content_receiver,
  14594. DownloadProgress progress) {
  14595. return cli_->Get(path, params, headers, std::move(response_handler),
  14596. std::move(content_receiver), std::move(progress));
  14597. }
  14598. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14599. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14600. return cli_->Head(path, headers);
  14601. }
  14602. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14603. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14604. return cli_->Post(path, headers);
  14605. }
  14606. inline Result Client::Post(const std::string &path, const char *body,
  14607. size_t content_length,
  14608. const std::string &content_type,
  14609. UploadProgress progress) {
  14610. return cli_->Post(path, body, content_length, content_type, progress);
  14611. }
  14612. inline Result Client::Post(const std::string &path, const Headers &headers,
  14613. const char *body, size_t content_length,
  14614. const std::string &content_type,
  14615. UploadProgress progress) {
  14616. return cli_->Post(path, headers, body, content_length, content_type,
  14617. progress);
  14618. }
  14619. inline Result Client::Post(const std::string &path, const std::string &body,
  14620. const std::string &content_type,
  14621. UploadProgress progress) {
  14622. return cli_->Post(path, body, content_type, progress);
  14623. }
  14624. inline Result Client::Post(const std::string &path, const Headers &headers,
  14625. const std::string &body,
  14626. const std::string &content_type,
  14627. UploadProgress progress) {
  14628. return cli_->Post(path, headers, body, content_type, progress);
  14629. }
  14630. inline Result Client::Post(const std::string &path, size_t content_length,
  14631. ContentProvider content_provider,
  14632. const std::string &content_type,
  14633. UploadProgress progress) {
  14634. return cli_->Post(path, content_length, std::move(content_provider),
  14635. content_type, progress);
  14636. }
  14637. inline Result Client::Post(const std::string &path, size_t content_length,
  14638. ContentProvider content_provider,
  14639. const std::string &content_type,
  14640. ContentReceiver content_receiver,
  14641. UploadProgress progress) {
  14642. return cli_->Post(path, content_length, std::move(content_provider),
  14643. content_type, std::move(content_receiver), progress);
  14644. }
  14645. inline Result Client::Post(const std::string &path,
  14646. ContentProviderWithoutLength content_provider,
  14647. const std::string &content_type,
  14648. UploadProgress progress) {
  14649. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14650. }
  14651. inline Result Client::Post(const std::string &path,
  14652. ContentProviderWithoutLength content_provider,
  14653. const std::string &content_type,
  14654. ContentReceiver content_receiver,
  14655. UploadProgress progress) {
  14656. return cli_->Post(path, std::move(content_provider), content_type,
  14657. std::move(content_receiver), progress);
  14658. }
  14659. inline Result Client::Post(const std::string &path, const Headers &headers,
  14660. size_t content_length,
  14661. ContentProvider content_provider,
  14662. const std::string &content_type,
  14663. UploadProgress progress) {
  14664. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14665. content_type, progress);
  14666. }
  14667. inline Result Client::Post(const std::string &path, const Headers &headers,
  14668. size_t content_length,
  14669. ContentProvider content_provider,
  14670. const std::string &content_type,
  14671. ContentReceiver content_receiver,
  14672. DownloadProgress progress) {
  14673. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14674. content_type, std::move(content_receiver), progress);
  14675. }
  14676. inline Result Client::Post(const std::string &path, const Headers &headers,
  14677. ContentProviderWithoutLength content_provider,
  14678. const std::string &content_type,
  14679. UploadProgress progress) {
  14680. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14681. progress);
  14682. }
  14683. inline Result Client::Post(const std::string &path, const Headers &headers,
  14684. ContentProviderWithoutLength content_provider,
  14685. const std::string &content_type,
  14686. ContentReceiver content_receiver,
  14687. DownloadProgress progress) {
  14688. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14689. std::move(content_receiver), progress);
  14690. }
  14691. inline Result Client::Post(const std::string &path, const Params &params) {
  14692. return cli_->Post(path, params);
  14693. }
  14694. inline Result Client::Post(const std::string &path, const Headers &headers,
  14695. const Params &params) {
  14696. return cli_->Post(path, headers, params);
  14697. }
  14698. inline Result Client::Post(const std::string &path,
  14699. const UploadFormDataItems &items,
  14700. UploadProgress progress) {
  14701. return cli_->Post(path, items, progress);
  14702. }
  14703. inline Result Client::Post(const std::string &path, const Headers &headers,
  14704. const UploadFormDataItems &items,
  14705. UploadProgress progress) {
  14706. return cli_->Post(path, headers, items, progress);
  14707. }
  14708. inline Result Client::Post(const std::string &path, const Headers &headers,
  14709. const UploadFormDataItems &items,
  14710. const std::string &boundary,
  14711. UploadProgress progress) {
  14712. return cli_->Post(path, headers, items, boundary, progress);
  14713. }
  14714. inline Result Client::Post(const std::string &path, const Headers &headers,
  14715. const UploadFormDataItems &items,
  14716. const FormDataProviderItems &provider_items,
  14717. UploadProgress progress) {
  14718. return cli_->Post(path, headers, items, provider_items, progress);
  14719. }
  14720. inline Result Client::Post(const std::string &path, const Headers &headers,
  14721. const std::string &body,
  14722. const std::string &content_type,
  14723. ContentReceiver content_receiver,
  14724. DownloadProgress progress) {
  14725. return cli_->Post(path, headers, body, content_type,
  14726. std::move(content_receiver), progress);
  14727. }
  14728. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14729. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14730. return cli_->Put(path, headers);
  14731. }
  14732. inline Result Client::Put(const std::string &path, const char *body,
  14733. size_t content_length,
  14734. const std::string &content_type,
  14735. UploadProgress progress) {
  14736. return cli_->Put(path, body, content_length, content_type, progress);
  14737. }
  14738. inline Result Client::Put(const std::string &path, const Headers &headers,
  14739. const char *body, size_t content_length,
  14740. const std::string &content_type,
  14741. UploadProgress progress) {
  14742. return cli_->Put(path, headers, body, content_length, content_type, progress);
  14743. }
  14744. inline Result Client::Put(const std::string &path, const std::string &body,
  14745. const std::string &content_type,
  14746. UploadProgress progress) {
  14747. return cli_->Put(path, body, content_type, progress);
  14748. }
  14749. inline Result Client::Put(const std::string &path, const Headers &headers,
  14750. const std::string &body,
  14751. const std::string &content_type,
  14752. UploadProgress progress) {
  14753. return cli_->Put(path, headers, body, content_type, progress);
  14754. }
  14755. inline Result Client::Put(const std::string &path, size_t content_length,
  14756. ContentProvider content_provider,
  14757. const std::string &content_type,
  14758. UploadProgress progress) {
  14759. return cli_->Put(path, content_length, std::move(content_provider),
  14760. content_type, progress);
  14761. }
  14762. inline Result Client::Put(const std::string &path, size_t content_length,
  14763. ContentProvider content_provider,
  14764. const std::string &content_type,
  14765. ContentReceiver content_receiver,
  14766. UploadProgress progress) {
  14767. return cli_->Put(path, content_length, std::move(content_provider),
  14768. content_type, std::move(content_receiver), progress);
  14769. }
  14770. inline Result Client::Put(const std::string &path,
  14771. ContentProviderWithoutLength content_provider,
  14772. const std::string &content_type,
  14773. UploadProgress progress) {
  14774. return cli_->Put(path, std::move(content_provider), content_type, progress);
  14775. }
  14776. inline Result Client::Put(const std::string &path,
  14777. ContentProviderWithoutLength content_provider,
  14778. const std::string &content_type,
  14779. ContentReceiver content_receiver,
  14780. UploadProgress progress) {
  14781. return cli_->Put(path, std::move(content_provider), content_type,
  14782. std::move(content_receiver), progress);
  14783. }
  14784. inline Result Client::Put(const std::string &path, const Headers &headers,
  14785. size_t content_length,
  14786. ContentProvider content_provider,
  14787. const std::string &content_type,
  14788. UploadProgress progress) {
  14789. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14790. content_type, progress);
  14791. }
  14792. inline Result Client::Put(const std::string &path, const Headers &headers,
  14793. size_t content_length,
  14794. ContentProvider content_provider,
  14795. const std::string &content_type,
  14796. ContentReceiver content_receiver,
  14797. UploadProgress progress) {
  14798. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14799. content_type, std::move(content_receiver), progress);
  14800. }
  14801. inline Result Client::Put(const std::string &path, const Headers &headers,
  14802. ContentProviderWithoutLength content_provider,
  14803. const std::string &content_type,
  14804. UploadProgress progress) {
  14805. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14806. progress);
  14807. }
  14808. inline Result Client::Put(const std::string &path, const Headers &headers,
  14809. ContentProviderWithoutLength content_provider,
  14810. const std::string &content_type,
  14811. ContentReceiver content_receiver,
  14812. UploadProgress progress) {
  14813. return cli_->Put(path, headers, std::move(content_provider), content_type,
  14814. std::move(content_receiver), progress);
  14815. }
  14816. inline Result Client::Put(const std::string &path, const Params &params) {
  14817. return cli_->Put(path, params);
  14818. }
  14819. inline Result Client::Put(const std::string &path, const Headers &headers,
  14820. const Params &params) {
  14821. return cli_->Put(path, headers, params);
  14822. }
  14823. inline Result Client::Put(const std::string &path,
  14824. const UploadFormDataItems &items,
  14825. UploadProgress progress) {
  14826. return cli_->Put(path, items, progress);
  14827. }
  14828. inline Result Client::Put(const std::string &path, const Headers &headers,
  14829. const UploadFormDataItems &items,
  14830. UploadProgress progress) {
  14831. return cli_->Put(path, headers, items, progress);
  14832. }
  14833. inline Result Client::Put(const std::string &path, const Headers &headers,
  14834. const UploadFormDataItems &items,
  14835. const std::string &boundary,
  14836. UploadProgress progress) {
  14837. return cli_->Put(path, headers, items, boundary, progress);
  14838. }
  14839. inline Result Client::Put(const std::string &path, const Headers &headers,
  14840. const UploadFormDataItems &items,
  14841. const FormDataProviderItems &provider_items,
  14842. UploadProgress progress) {
  14843. return cli_->Put(path, headers, items, provider_items, progress);
  14844. }
  14845. inline Result Client::Put(const std::string &path, const Headers &headers,
  14846. const std::string &body,
  14847. const std::string &content_type,
  14848. ContentReceiver content_receiver,
  14849. DownloadProgress progress) {
  14850. return cli_->Put(path, headers, body, content_type, content_receiver,
  14851. progress);
  14852. }
  14853. inline Result Client::Patch(const std::string &path) {
  14854. return cli_->Patch(path);
  14855. }
  14856. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  14857. return cli_->Patch(path, headers);
  14858. }
  14859. inline Result Client::Patch(const std::string &path, const char *body,
  14860. size_t content_length,
  14861. const std::string &content_type,
  14862. UploadProgress progress) {
  14863. return cli_->Patch(path, body, content_length, content_type, progress);
  14864. }
  14865. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14866. const char *body, size_t content_length,
  14867. const std::string &content_type,
  14868. UploadProgress progress) {
  14869. return cli_->Patch(path, headers, body, content_length, content_type,
  14870. progress);
  14871. }
  14872. inline Result Client::Patch(const std::string &path, const std::string &body,
  14873. const std::string &content_type,
  14874. UploadProgress progress) {
  14875. return cli_->Patch(path, body, content_type, progress);
  14876. }
  14877. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14878. const std::string &body,
  14879. const std::string &content_type,
  14880. UploadProgress progress) {
  14881. return cli_->Patch(path, headers, body, content_type, progress);
  14882. }
  14883. inline Result Client::Patch(const std::string &path, size_t content_length,
  14884. ContentProvider content_provider,
  14885. const std::string &content_type,
  14886. UploadProgress progress) {
  14887. return cli_->Patch(path, content_length, std::move(content_provider),
  14888. content_type, progress);
  14889. }
  14890. inline Result Client::Patch(const std::string &path, size_t content_length,
  14891. ContentProvider content_provider,
  14892. const std::string &content_type,
  14893. ContentReceiver content_receiver,
  14894. UploadProgress progress) {
  14895. return cli_->Patch(path, content_length, std::move(content_provider),
  14896. content_type, std::move(content_receiver), progress);
  14897. }
  14898. inline Result Client::Patch(const std::string &path,
  14899. ContentProviderWithoutLength content_provider,
  14900. const std::string &content_type,
  14901. UploadProgress progress) {
  14902. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  14903. }
  14904. inline Result Client::Patch(const std::string &path,
  14905. ContentProviderWithoutLength content_provider,
  14906. const std::string &content_type,
  14907. ContentReceiver content_receiver,
  14908. UploadProgress progress) {
  14909. return cli_->Patch(path, std::move(content_provider), content_type,
  14910. std::move(content_receiver), progress);
  14911. }
  14912. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14913. size_t content_length,
  14914. ContentProvider content_provider,
  14915. const std::string &content_type,
  14916. UploadProgress progress) {
  14917. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14918. content_type, progress);
  14919. }
  14920. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14921. size_t content_length,
  14922. ContentProvider content_provider,
  14923. const std::string &content_type,
  14924. ContentReceiver content_receiver,
  14925. UploadProgress progress) {
  14926. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  14927. content_type, std::move(content_receiver), progress);
  14928. }
  14929. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14930. ContentProviderWithoutLength content_provider,
  14931. const std::string &content_type,
  14932. UploadProgress progress) {
  14933. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  14934. progress);
  14935. }
  14936. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14937. ContentProviderWithoutLength content_provider,
  14938. const std::string &content_type,
  14939. ContentReceiver content_receiver,
  14940. UploadProgress progress) {
  14941. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  14942. std::move(content_receiver), progress);
  14943. }
  14944. inline Result Client::Patch(const std::string &path, const Params &params) {
  14945. return cli_->Patch(path, params);
  14946. }
  14947. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14948. const Params &params) {
  14949. return cli_->Patch(path, headers, params);
  14950. }
  14951. inline Result Client::Patch(const std::string &path,
  14952. const UploadFormDataItems &items,
  14953. UploadProgress progress) {
  14954. return cli_->Patch(path, items, progress);
  14955. }
  14956. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14957. const UploadFormDataItems &items,
  14958. UploadProgress progress) {
  14959. return cli_->Patch(path, headers, items, progress);
  14960. }
  14961. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14962. const UploadFormDataItems &items,
  14963. const std::string &boundary,
  14964. UploadProgress progress) {
  14965. return cli_->Patch(path, headers, items, boundary, progress);
  14966. }
  14967. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14968. const UploadFormDataItems &items,
  14969. const FormDataProviderItems &provider_items,
  14970. UploadProgress progress) {
  14971. return cli_->Patch(path, headers, items, provider_items, progress);
  14972. }
  14973. inline Result Client::Patch(const std::string &path, const Headers &headers,
  14974. const std::string &body,
  14975. const std::string &content_type,
  14976. ContentReceiver content_receiver,
  14977. DownloadProgress progress) {
  14978. return cli_->Patch(path, headers, body, content_type, content_receiver,
  14979. progress);
  14980. }
  14981. inline Result Client::Delete(const std::string &path,
  14982. DownloadProgress progress) {
  14983. return cli_->Delete(path, progress);
  14984. }
  14985. inline Result Client::Delete(const std::string &path, const Headers &headers,
  14986. DownloadProgress progress) {
  14987. return cli_->Delete(path, headers, progress);
  14988. }
  14989. inline Result Client::Delete(const std::string &path, const char *body,
  14990. size_t content_length,
  14991. const std::string &content_type,
  14992. DownloadProgress progress) {
  14993. return cli_->Delete(path, body, content_length, content_type, progress);
  14994. }
  14995. inline Result Client::Delete(const std::string &path, const Headers &headers,
  14996. const char *body, size_t content_length,
  14997. const std::string &content_type,
  14998. DownloadProgress progress) {
  14999. return cli_->Delete(path, headers, body, content_length, content_type,
  15000. progress);
  15001. }
  15002. inline Result Client::Delete(const std::string &path, const std::string &body,
  15003. const std::string &content_type,
  15004. DownloadProgress progress) {
  15005. return cli_->Delete(path, body, content_type, progress);
  15006. }
  15007. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15008. const std::string &body,
  15009. const std::string &content_type,
  15010. DownloadProgress progress) {
  15011. return cli_->Delete(path, headers, body, content_type, progress);
  15012. }
  15013. inline Result Client::Delete(const std::string &path, const Params &params,
  15014. DownloadProgress progress) {
  15015. return cli_->Delete(path, params, progress);
  15016. }
  15017. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15018. const Params &params, DownloadProgress progress) {
  15019. return cli_->Delete(path, headers, params, progress);
  15020. }
  15021. inline Result Client::Options(const std::string &path) {
  15022. return cli_->Options(path);
  15023. }
  15024. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15025. return cli_->Options(path, headers);
  15026. }
  15027. inline ClientImpl::StreamHandle
  15028. Client::open_stream(const std::string &method, const std::string &path,
  15029. const Params &params, const Headers &headers,
  15030. const std::string &body, const std::string &content_type) {
  15031. return cli_->open_stream(method, path, params, headers, body, content_type);
  15032. }
  15033. inline bool Client::send(Request &req, Response &res, Error &error) {
  15034. return cli_->send(req, res, error);
  15035. }
  15036. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15037. inline void Client::stop() { cli_->stop(); }
  15038. inline std::string Client::host() const { return cli_->host(); }
  15039. inline int Client::port() const { return cli_->port(); }
  15040. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15041. inline socket_t Client::socket() const { return cli_->socket(); }
  15042. inline void
  15043. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15044. cli_->set_hostname_addr_map(std::move(addr_map));
  15045. }
  15046. inline void Client::set_default_headers(Headers headers) {
  15047. cli_->set_default_headers(std::move(headers));
  15048. }
  15049. inline void Client::set_header_writer(
  15050. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15051. cli_->set_header_writer(writer);
  15052. }
  15053. inline void Client::set_address_family(int family) {
  15054. cli_->set_address_family(family);
  15055. }
  15056. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15057. inline void Client::set_socket_options(SocketOptions socket_options) {
  15058. cli_->set_socket_options(std::move(socket_options));
  15059. }
  15060. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15061. cli_->set_connection_timeout(sec, usec);
  15062. }
  15063. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15064. cli_->set_read_timeout(sec, usec);
  15065. }
  15066. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15067. cli_->set_write_timeout(sec, usec);
  15068. }
  15069. inline void Client::set_basic_auth(const std::string &username,
  15070. const std::string &password) {
  15071. cli_->set_basic_auth(username, password);
  15072. }
  15073. inline void Client::set_bearer_token_auth(const std::string &token) {
  15074. cli_->set_bearer_token_auth(token);
  15075. }
  15076. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15077. inline void Client::set_follow_location(bool on) {
  15078. cli_->set_follow_location(on);
  15079. }
  15080. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15081. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15082. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15083. inline void Client::set_payload_max_length(size_t length) {
  15084. cli_->set_payload_max_length(length);
  15085. }
  15086. inline void Client::set_interface(const std::string &intf) {
  15087. cli_->set_interface(intf);
  15088. }
  15089. inline void Client::set_proxy(const std::string &host, int port) {
  15090. cli_->set_proxy(host, port);
  15091. }
  15092. inline void Client::set_proxy_basic_auth(const std::string &username,
  15093. const std::string &password) {
  15094. cli_->set_proxy_basic_auth(username, password);
  15095. }
  15096. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15097. cli_->set_proxy_bearer_token_auth(token);
  15098. }
  15099. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15100. cli_->set_no_proxy(patterns);
  15101. }
  15102. inline void Client::set_logger(Logger logger) {
  15103. cli_->set_logger(std::move(logger));
  15104. }
  15105. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15106. cli_->set_error_logger(std::move(error_logger));
  15107. }
  15108. /*
  15109. * Group 6: SSL Server and Client implementation
  15110. */
  15111. #ifdef CPPHTTPLIB_SSL_ENABLED
  15112. // SSL HTTP server implementation
  15113. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15114. const char *client_ca_cert_file_path,
  15115. const char *client_ca_cert_dir_path,
  15116. const char *private_key_password) {
  15117. using namespace tls;
  15118. ctx_ = create_server_context();
  15119. if (!ctx_) { return; }
  15120. // Load server certificate and private key
  15121. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15122. private_key_password)) {
  15123. last_ssl_error_ = static_cast<int>(get_error());
  15124. free_context(ctx_);
  15125. ctx_ = nullptr;
  15126. return;
  15127. }
  15128. // Load client CA certificates for client authentication
  15129. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15130. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15131. client_ca_cert_dir_path)) {
  15132. last_ssl_error_ = static_cast<int>(get_error());
  15133. free_context(ctx_);
  15134. ctx_ = nullptr;
  15135. return;
  15136. }
  15137. // Enable client certificate verification
  15138. set_verify_client(ctx_, true);
  15139. }
  15140. }
  15141. inline SSLServer::SSLServer(const PemMemory &pem) {
  15142. using namespace tls;
  15143. ctx_ = create_server_context();
  15144. if (ctx_) {
  15145. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15146. pem.private_key_password)) {
  15147. last_ssl_error_ = static_cast<int>(get_error());
  15148. free_context(ctx_);
  15149. ctx_ = nullptr;
  15150. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15151. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15152. last_ssl_error_ = static_cast<int>(get_error());
  15153. free_context(ctx_);
  15154. ctx_ = nullptr;
  15155. } else {
  15156. set_verify_client(ctx_, true);
  15157. }
  15158. }
  15159. }
  15160. }
  15161. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15162. using namespace tls;
  15163. ctx_ = create_server_context();
  15164. if (ctx_) {
  15165. if (!setup_callback(ctx_)) {
  15166. free_context(ctx_);
  15167. ctx_ = nullptr;
  15168. }
  15169. }
  15170. }
  15171. inline SSLServer::~SSLServer() {
  15172. if (ctx_) { tls::free_context(ctx_); }
  15173. }
  15174. inline bool SSLServer::is_valid() const {
  15175. return ctx_ != nullptr && Server::is_valid();
  15176. }
  15177. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15178. using namespace tls;
  15179. // Create TLS session with mutex protection
  15180. session_t session = nullptr;
  15181. {
  15182. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15183. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15184. }
  15185. if (!session) {
  15186. last_ssl_error_ = static_cast<int>(get_error());
  15187. detail::shutdown_socket(sock);
  15188. detail::close_socket(sock);
  15189. return false;
  15190. }
  15191. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15192. bool handshake_done = false;
  15193. bool ret = false;
  15194. bool websocket_upgraded = false;
  15195. auto cleanup = detail::scope_exit([&] {
  15196. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15197. free_session(session);
  15198. detail::shutdown_socket(sock);
  15199. detail::close_socket(sock);
  15200. });
  15201. // Perform TLS accept handshake with timeout
  15202. TlsError tls_err;
  15203. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15204. &tls_err)) {
  15205. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15206. // Map TlsError to legacy ssl_error for backward compatibility
  15207. if (tls_err.code == ErrorCode::WantRead) {
  15208. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15209. } else if (tls_err.code == ErrorCode::WantWrite) {
  15210. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15211. } else {
  15212. last_ssl_error_ = SSL_ERROR_SSL;
  15213. }
  15214. #else
  15215. last_ssl_error_ = static_cast<int>(get_error());
  15216. #endif
  15217. return false;
  15218. }
  15219. handshake_done = true;
  15220. std::string remote_addr;
  15221. int remote_port = 0;
  15222. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15223. std::string local_addr;
  15224. int local_port = 0;
  15225. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15226. ret = serve_guarded([&]() {
  15227. return detail::process_server_socket_ssl(
  15228. svr_sock_, session, sock, keep_alive_max_count_,
  15229. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15230. write_timeout_sec_, write_timeout_usec_,
  15231. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15232. return process_request(
  15233. strm, remote_addr, remote_port, local_addr, local_port,
  15234. close_connection, connection_closed,
  15235. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15236. });
  15237. });
  15238. return ret;
  15239. }
  15240. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15241. const char *key_pem,
  15242. const char *client_ca_pem,
  15243. const char *password) {
  15244. if (!ctx_) { return false; }
  15245. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15246. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15247. return false;
  15248. }
  15249. if (client_ca_pem) {
  15250. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15251. }
  15252. return true;
  15253. }
  15254. // SSL HTTP client implementation
  15255. inline SSLClient::~SSLClient() {
  15256. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15257. // base function rather than the derived function once we get to the
  15258. // base class destructor, and won't free the SSL (causing a leak).
  15259. // This must happen before the context is freed below: some backends
  15260. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15261. // context, so freeing the context first leaves close_notify reading
  15262. // freed memory.
  15263. shutdown_ssl_impl(socket_, true);
  15264. if (ctx_) {
  15265. tls::free_context(ctx_);
  15266. ctx_ = nullptr;
  15267. }
  15268. }
  15269. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15270. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15271. shutdown_ssl_impl(socket, shutdown_gracefully);
  15272. }
  15273. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15274. bool shutdown_gracefully) {
  15275. if (socket.sock == INVALID_SOCKET) {
  15276. assert(socket.ssl == nullptr);
  15277. return;
  15278. }
  15279. if (socket.ssl) {
  15280. tls::shutdown(socket.ssl, shutdown_gracefully);
  15281. {
  15282. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15283. tls::free_session(socket.ssl);
  15284. }
  15285. socket.ssl = nullptr;
  15286. }
  15287. assert(socket.ssl == nullptr);
  15288. }
  15289. inline bool SSLClient::process_socket(
  15290. const Socket &socket,
  15291. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15292. std::function<bool(Stream &strm)> callback) {
  15293. assert(socket.ssl);
  15294. return detail::process_client_socket_ssl(
  15295. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15296. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15297. std::move(callback));
  15298. }
  15299. inline bool SSLClient::is_ssl() const { return true; }
  15300. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15301. if (!is_valid()) {
  15302. error = Error::SSLConnection;
  15303. return false;
  15304. }
  15305. return ClientImpl::create_and_connect_socket(socket, error);
  15306. }
  15307. inline bool SSLClient::setup_proxy_connection(
  15308. Socket &socket,
  15309. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15310. Response &res, bool &success, Error &error) {
  15311. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15312. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15313. return false;
  15314. }
  15315. if (!initialize_ssl(socket, error)) {
  15316. success = false;
  15317. return false;
  15318. }
  15319. return true;
  15320. }
  15321. // Assumes that socket_mutex_ is locked and that there are no requests in
  15322. // flight
  15323. inline bool SSLClient::connect_with_proxy(
  15324. Socket &socket,
  15325. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15326. Response &res, bool &success, Error &error) {
  15327. success = true;
  15328. Response proxy_res;
  15329. if (!detail::process_client_socket(
  15330. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15331. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15332. start_time, [&](Stream &strm) {
  15333. Request req2;
  15334. req2.method = "CONNECT";
  15335. req2.path =
  15336. detail::make_host_and_port_string_always_port(host_, port_);
  15337. if (max_timeout_msec_ > 0) {
  15338. req2.start_time_ = std::chrono::steady_clock::now();
  15339. }
  15340. return process_request(strm, req2, proxy_res, false, error);
  15341. })) {
  15342. // Thread-safe to close everything because we are assuming there are no
  15343. // requests in flight
  15344. shutdown_ssl(socket, true);
  15345. shutdown_socket(socket);
  15346. close_socket(socket);
  15347. success = false;
  15348. return false;
  15349. }
  15350. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15351. if (!proxy_digest_auth_username_.empty() &&
  15352. !proxy_digest_auth_password_.empty()) {
  15353. std::map<std::string, std::string> auth;
  15354. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15355. // Close the current socket and create a new one for the authenticated
  15356. // request
  15357. shutdown_ssl(socket, true);
  15358. shutdown_socket(socket);
  15359. close_socket(socket);
  15360. // Create a new socket for the authenticated CONNECT request
  15361. if (!ensure_socket_connection(socket, error)) {
  15362. success = false;
  15363. output_error_log(error, nullptr);
  15364. return false;
  15365. }
  15366. proxy_res = Response();
  15367. if (!detail::process_client_socket(
  15368. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15369. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15370. start_time, [&](Stream &strm) {
  15371. Request req3;
  15372. req3.method = "CONNECT";
  15373. req3.path = detail::make_host_and_port_string_always_port(
  15374. host_, port_);
  15375. req3.headers.insert(detail::make_digest_authentication_header(
  15376. req3, auth, 1, detail::random_string(10),
  15377. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15378. true));
  15379. if (max_timeout_msec_ > 0) {
  15380. req3.start_time_ = std::chrono::steady_clock::now();
  15381. }
  15382. return process_request(strm, req3, proxy_res, false, error);
  15383. })) {
  15384. // Thread-safe to close everything because we are assuming there are
  15385. // no requests in flight
  15386. shutdown_ssl(socket, true);
  15387. shutdown_socket(socket);
  15388. close_socket(socket);
  15389. success = false;
  15390. return false;
  15391. }
  15392. }
  15393. }
  15394. }
  15395. // If status code is not 200, proxy request is failed.
  15396. // Set error to ProxyConnection and return proxy response
  15397. // as the response of the request
  15398. if (proxy_res.status != StatusCode::OK_200) {
  15399. error = Error::ProxyConnection;
  15400. output_error_log(error, nullptr);
  15401. res = std::move(proxy_res);
  15402. // Thread-safe to close everything because we are assuming there are
  15403. // no requests in flight
  15404. shutdown_ssl(socket, true);
  15405. shutdown_socket(socket);
  15406. close_socket(socket);
  15407. return false;
  15408. }
  15409. return true;
  15410. }
  15411. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15412. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15413. if (is_proxy_enabled_for_host(host_)) { return true; }
  15414. if (!initialize_ssl(socket, error)) {
  15415. shutdown_socket(socket);
  15416. close_socket(socket);
  15417. return false;
  15418. }
  15419. return true;
  15420. }
  15421. // SSL HTTP client implementation
  15422. inline SSLClient::SSLClient(const std::string &host)
  15423. : SSLClient(host, 443, std::string(), std::string()) {}
  15424. inline SSLClient::SSLClient(const std::string &host, int port)
  15425. : SSLClient(host, port, std::string(), std::string()) {}
  15426. inline void SSLClient::init_ctx() {
  15427. ctx_ = tls::create_client_context();
  15428. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15429. }
  15430. inline void SSLClient::reset_ctx_on_error() {
  15431. last_backend_error_ = tls::get_error();
  15432. tls::free_context(ctx_);
  15433. ctx_ = nullptr;
  15434. }
  15435. inline SSLClient::SSLClient(const std::string &host, int port,
  15436. const std::string &client_cert_path,
  15437. const std::string &client_key_path,
  15438. const std::string &private_key_password)
  15439. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15440. init_ctx();
  15441. if (!ctx_) { return; }
  15442. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15443. const char *password =
  15444. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15445. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15446. client_key_path.c_str(), password)) {
  15447. reset_ctx_on_error();
  15448. }
  15449. }
  15450. }
  15451. inline SSLClient::SSLClient(const std::string &host, int port,
  15452. const PemMemory &pem)
  15453. : ClientImpl(host, port) {
  15454. init_ctx();
  15455. if (!ctx_) { return; }
  15456. if (pem.cert_pem && pem.key_pem) {
  15457. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15458. pem.private_key_password)) {
  15459. reset_ctx_on_error();
  15460. }
  15461. }
  15462. }
  15463. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15464. if (ca_cert_store && ctx_) {
  15465. // set_ca_store takes ownership of ca_cert_store
  15466. tls::set_ca_store(ctx_, ca_cert_store);
  15467. ca_cert_store_set_ = true;
  15468. } else if (ca_cert_store) {
  15469. tls::free_ca_store(ca_cert_store);
  15470. }
  15471. }
  15472. inline void
  15473. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15474. if (!ctx_) { return; }
  15475. tls::set_verify_callback(ctx_, verifier);
  15476. }
  15477. inline void SSLClient::set_session_verifier(
  15478. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15479. session_verifier_ = std::move(verifier);
  15480. }
  15481. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15482. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15483. enable_windows_cert_verification_ = enabled;
  15484. }
  15485. #endif
  15486. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15487. std::size_t size) {
  15488. if (ctx_ && ca_cert && size > 0) {
  15489. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15490. tls::load_ca_pem(ctx_, ca_cert, size);
  15491. }
  15492. }
  15493. inline bool SSLClient::load_certs() {
  15494. auto ret = true;
  15495. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15496. // one client is shared across concurrent requests here.
  15497. std::call_once(initialize_cert_, [&]() {
  15498. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15499. ret = detail::load_client_ca_config(
  15500. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15501. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15502. last_backend_error_);
  15503. });
  15504. return ret;
  15505. }
  15506. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15507. // Load CA certificates if server verification is enabled
  15508. if (server_certificate_verification_) {
  15509. if (!load_certs()) {
  15510. error = Error::SSLLoadingCerts;
  15511. output_error_log(error, nullptr);
  15512. return false;
  15513. }
  15514. }
  15515. detail::ClientTlsSessionOptions options;
  15516. options.server_hostname_verification = server_hostname_verification_;
  15517. options.session_verifier = session_verifier_;
  15518. options.ctx_mutex = &ctx_mutex_;
  15519. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15520. // Skip Schannel when a custom CA cert is specified, as the Windows
  15521. // certificate store would not know about user-provided CA certificates.
  15522. // Also skip when system CA trust is explicitly disabled.
  15523. options.windows_cert_verification =
  15524. enable_windows_cert_verification_ &&
  15525. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15526. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15527. #endif
  15528. tls::session_t session = nullptr;
  15529. // Use scope_exit to ensure session is freed on error paths
  15530. bool success = false;
  15531. auto session_guard = detail::scope_exit([&] {
  15532. if (!success) { tls::free_session(session); }
  15533. });
  15534. detail::ClientTlsSessionError tls_error;
  15535. if (!detail::setup_client_tls_session(
  15536. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15537. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15538. options)) {
  15539. error = tls_error.error;
  15540. last_ssl_error_ = tls_error.ssl_error;
  15541. last_backend_error_ = tls_error.backend_error;
  15542. output_error_log(error, nullptr);
  15543. return false;
  15544. }
  15545. success = true;
  15546. socket.ssl = session;
  15547. return true;
  15548. }
  15549. inline void Client::set_digest_auth(const std::string &username,
  15550. const std::string &password) {
  15551. cli_->set_digest_auth(username, password);
  15552. }
  15553. inline void Client::set_proxy_digest_auth(const std::string &username,
  15554. const std::string &password) {
  15555. cli_->set_proxy_digest_auth(username, password);
  15556. }
  15557. inline void Client::enable_server_certificate_verification(bool enabled) {
  15558. cli_->enable_server_certificate_verification(enabled);
  15559. }
  15560. inline void Client::enable_server_hostname_verification(bool enabled) {
  15561. cli_->enable_server_hostname_verification(enabled);
  15562. }
  15563. inline void Client::enable_system_ca(bool enabled) {
  15564. cli_->enable_system_ca(enabled);
  15565. }
  15566. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15567. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15568. if (is_ssl_) {
  15569. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15570. enabled);
  15571. }
  15572. }
  15573. #endif
  15574. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15575. const std::string &ca_cert_dir_path) {
  15576. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15577. }
  15578. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15579. if (is_ssl_) {
  15580. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15581. } else if (ca_cert_store) {
  15582. tls::free_ca_store(ca_cert_store);
  15583. }
  15584. }
  15585. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15586. if (is_ssl_) {
  15587. // Use the PEM-based path so the CA data is retained for redirect transfer
  15588. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15589. }
  15590. }
  15591. inline void
  15592. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15593. if (is_ssl_) {
  15594. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15595. std::move(verifier));
  15596. }
  15597. }
  15598. inline void Client::set_session_verifier(
  15599. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15600. if (is_ssl_) {
  15601. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15602. }
  15603. }
  15604. inline tls::ctx_t Client::tls_context() const {
  15605. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15606. return nullptr;
  15607. }
  15608. #endif // CPPHTTPLIB_SSL_ENABLED
  15609. /*
  15610. * Group 7: TLS abstraction layer - Common API
  15611. */
  15612. #ifdef CPPHTTPLIB_SSL_ENABLED
  15613. namespace tls {
  15614. // Helper for PeerCert construction
  15615. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15616. return PeerCert(get_peer_cert(session));
  15617. }
  15618. namespace impl {
  15619. inline VerifyCallback &get_verify_callback() {
  15620. static thread_local VerifyCallback callback;
  15621. return callback;
  15622. }
  15623. inline VerifyCallback &get_mbedtls_verify_callback() {
  15624. static thread_local VerifyCallback callback;
  15625. return callback;
  15626. }
  15627. // Check if a string is an IPv4 address
  15628. inline bool is_ipv4_address(const std::string &str) {
  15629. int dots = 0;
  15630. for (char c : str) {
  15631. if (c == '.') {
  15632. dots++;
  15633. } else if (!detail::is_ascii_digit(c)) {
  15634. return false;
  15635. }
  15636. }
  15637. return dots == 3;
  15638. }
  15639. // Parse IPv4 address string to bytes
  15640. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15641. const char *p = str.c_str();
  15642. for (int i = 0; i < 4; i++) {
  15643. if (i > 0) {
  15644. if (*p != '.') { return false; }
  15645. p++;
  15646. }
  15647. int val = 0;
  15648. int digits = 0;
  15649. while (detail::is_ascii_digit(*p)) {
  15650. val = val * 10 + (*p - '0');
  15651. if (val > 255) { return false; }
  15652. p++;
  15653. digits++;
  15654. }
  15655. if (digits == 0) { return false; }
  15656. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15657. if (digits > 1 && *(p - digits) == '0') { return false; }
  15658. out[i] = static_cast<unsigned char>(val);
  15659. }
  15660. return *p == '\0';
  15661. }
  15662. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15663. // `out` must have room for at least 16 bytes. Returns the address length
  15664. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15665. // literal. Used to match a host against iPAddress SANs the same way the
  15666. // OpenSSL backend does via X509_check_ip.
  15667. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15668. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15669. struct in6_addr addr6 = {};
  15670. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15671. memcpy(out, &addr6, 16);
  15672. return 16;
  15673. }
  15674. return 0;
  15675. }
  15676. #ifdef _WIN32
  15677. // Enumerate Windows system certificates and call callback with DER data
  15678. template <typename Callback>
  15679. inline bool enumerate_windows_system_certs(Callback cb) {
  15680. bool loaded = false;
  15681. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15682. for (auto store_name : store_names) {
  15683. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15684. if (hStore) {
  15685. PCCERT_CONTEXT pContext = nullptr;
  15686. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15687. nullptr) {
  15688. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15689. loaded = true;
  15690. }
  15691. }
  15692. CertCloseStore(hStore, 0);
  15693. }
  15694. }
  15695. return loaded;
  15696. }
  15697. #endif
  15698. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15699. // Enumerate macOS Keychain certificates and call callback with DER data
  15700. template <typename Callback>
  15701. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15702. bool loaded = false;
  15703. const SecTrustSettingsDomain domains[] = {
  15704. kSecTrustSettingsDomainSystem,
  15705. kSecTrustSettingsDomainAdmin,
  15706. kSecTrustSettingsDomainUser,
  15707. };
  15708. for (auto domain : domains) {
  15709. CFArrayRef certs = nullptr;
  15710. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15711. if (status != errSecSuccess || !certs) {
  15712. if (certs) CFRelease(certs);
  15713. continue;
  15714. }
  15715. CFIndex count = CFArrayGetCount(certs);
  15716. for (CFIndex i = 0; i < count; i++) {
  15717. SecCertificateRef cert =
  15718. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15719. CFDataRef data = SecCertificateCopyData(cert);
  15720. if (data) {
  15721. if (cb(CFDataGetBytePtr(data),
  15722. static_cast<size_t>(CFDataGetLength(data)))) {
  15723. loaded = true;
  15724. }
  15725. CFRelease(data);
  15726. }
  15727. }
  15728. CFRelease(certs);
  15729. }
  15730. return loaded;
  15731. }
  15732. #endif
  15733. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15734. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  15735. // Common CA certificate file paths on Linux/Unix
  15736. inline const char **system_ca_paths() {
  15737. static const char *paths[] = {
  15738. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  15739. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  15740. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  15741. "/etc/pki/tls/cacert.pem", // OpenELEC
  15742. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  15743. nullptr};
  15744. return paths;
  15745. }
  15746. // Common CA certificate directory paths on Linux/Unix
  15747. inline const char **system_ca_dirs() {
  15748. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  15749. "/etc/pki/tls/certs", // RHEL/CentOS
  15750. "/usr/share/ca-certificates", // Other
  15751. nullptr};
  15752. return dirs;
  15753. }
  15754. #endif
  15755. } // namespace impl
  15756. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  15757. const char *ca_dir) {
  15758. if (!ctx) { return false; }
  15759. bool success = true;
  15760. if (ca_file && *ca_file) {
  15761. if (!load_ca_file(ctx, ca_file)) { success = false; }
  15762. }
  15763. if (ca_dir && *ca_dir) {
  15764. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  15765. }
  15766. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15767. // Set CA list for client certificate request (CertificateRequest message)
  15768. if (ca_file && *ca_file) {
  15769. auto list = SSL_load_client_CA_file(ca_file);
  15770. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  15771. }
  15772. #endif
  15773. return success;
  15774. }
  15775. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15776. const char *password) {
  15777. return set_client_cert_pem(ctx, cert, key, password);
  15778. }
  15779. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  15780. const char *key_path, const char *password) {
  15781. return set_client_cert_file(ctx, cert_path, key_path, password);
  15782. }
  15783. // PeerCert implementation
  15784. inline PeerCert::PeerCert() = default;
  15785. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  15786. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  15787. other.cert_ = nullptr;
  15788. }
  15789. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  15790. if (this != &other) {
  15791. if (cert_) { free_cert(cert_); }
  15792. cert_ = other.cert_;
  15793. other.cert_ = nullptr;
  15794. }
  15795. return *this;
  15796. }
  15797. inline PeerCert::~PeerCert() {
  15798. if (cert_) { free_cert(cert_); }
  15799. }
  15800. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  15801. inline std::string PeerCert::subject_cn() const {
  15802. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  15803. }
  15804. inline std::string PeerCert::issuer_name() const {
  15805. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  15806. }
  15807. inline bool PeerCert::check_hostname(const char *hostname) const {
  15808. return cert_ ? verify_hostname(cert_, hostname) : false;
  15809. }
  15810. inline std::vector<SanEntry> PeerCert::sans() const {
  15811. std::vector<SanEntry> result;
  15812. if (cert_) { get_cert_sans(cert_, result); }
  15813. return result;
  15814. }
  15815. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  15816. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  15817. }
  15818. inline std::string PeerCert::serial() const {
  15819. return cert_ ? get_cert_serial(cert_) : std::string();
  15820. }
  15821. // VerifyContext method implementations
  15822. inline std::string VerifyContext::subject_cn() const {
  15823. return cert ? get_cert_subject_cn(cert) : std::string();
  15824. }
  15825. inline std::string VerifyContext::issuer_name() const {
  15826. return cert ? get_cert_issuer_name(cert) : std::string();
  15827. }
  15828. inline bool VerifyContext::check_hostname(const char *hostname) const {
  15829. return cert ? verify_hostname(cert, hostname) : false;
  15830. }
  15831. inline std::vector<SanEntry> VerifyContext::sans() const {
  15832. std::vector<SanEntry> result;
  15833. if (cert) { get_cert_sans(cert, result); }
  15834. return result;
  15835. }
  15836. inline bool VerifyContext::validity(time_t &not_before,
  15837. time_t &not_after) const {
  15838. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  15839. }
  15840. inline std::string VerifyContext::serial() const {
  15841. return cert ? get_cert_serial(cert) : std::string();
  15842. }
  15843. // TlsError static method implementation
  15844. inline std::string TlsError::verify_error_to_string(long error_code) {
  15845. return verify_error_string(error_code);
  15846. }
  15847. } // namespace tls
  15848. // Request::peer_cert() implementation
  15849. inline tls::PeerCert Request::peer_cert() const {
  15850. return tls::get_peer_cert_from_session(ssl);
  15851. }
  15852. // Request::sni() implementation
  15853. inline std::string Request::sni() const {
  15854. if (!ssl) { return std::string(); }
  15855. const char *s = tls::get_sni(ssl);
  15856. return s ? std::string(s) : std::string();
  15857. }
  15858. #endif // CPPHTTPLIB_SSL_ENABLED
  15859. /*
  15860. * Group 8: TLS abstraction layer - OpenSSL backend
  15861. */
  15862. /*
  15863. * OpenSSL Backend Implementation
  15864. */
  15865. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15866. namespace tls {
  15867. namespace impl {
  15868. // Helper to map OpenSSL SSL_get_error to ErrorCode
  15869. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  15870. switch (ssl_error) {
  15871. case SSL_ERROR_NONE: return ErrorCode::Success;
  15872. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  15873. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  15874. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  15875. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  15876. case SSL_ERROR_SSL:
  15877. default: return ErrorCode::Fatal;
  15878. }
  15879. }
  15880. // Helper: Create client CA list from PEM string
  15881. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  15882. // Caller takes ownership of returned list
  15883. inline STACK_OF(X509_NAME) *
  15884. create_client_ca_list_from_pem(const char *ca_pem) {
  15885. if (!ca_pem) { return nullptr; }
  15886. auto ca_list = sk_X509_NAME_new_null();
  15887. if (!ca_list) { return nullptr; }
  15888. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  15889. if (!bio) {
  15890. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  15891. return nullptr;
  15892. }
  15893. X509 *cert = nullptr;
  15894. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15895. nullptr) {
  15896. const X509_NAME *name = X509_get_subject_name(cert);
  15897. if (name) {
  15898. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  15899. }
  15900. X509_free(cert);
  15901. }
  15902. BIO_free(bio);
  15903. return ca_list;
  15904. }
  15905. // OpenSSL verify callback wrapper
  15906. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  15907. auto &callback = get_verify_callback();
  15908. if (!callback) { return preverify_ok; }
  15909. // Get SSL object from X509_STORE_CTX
  15910. auto ssl = static_cast<SSL *>(
  15911. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  15912. if (!ssl) { return preverify_ok; }
  15913. // Get current certificate and depth
  15914. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  15915. int depth = X509_STORE_CTX_get_error_depth(ctx);
  15916. int error = X509_STORE_CTX_get_error(ctx);
  15917. // Build context
  15918. VerifyContext verify_ctx;
  15919. verify_ctx.session = static_cast<session_t>(ssl);
  15920. verify_ctx.cert = static_cast<cert_t>(cert);
  15921. verify_ctx.depth = depth;
  15922. verify_ctx.preverify_ok = (preverify_ok != 0);
  15923. verify_ctx.error_code = error;
  15924. verify_ctx.error_string =
  15925. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  15926. return callback(verify_ctx) ? 1 : 0;
  15927. }
  15928. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  15929. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  15930. // that must be released with release_store_objects
  15931. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  15932. OPENSSL_VERSION_NUMBER >= 0x30300000L
  15933. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  15934. #endif
  15935. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  15936. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  15937. return X509_STORE_get1_objects(store);
  15938. #else
  15939. return X509_STORE_get0_objects(store);
  15940. #endif
  15941. }
  15942. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  15943. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  15944. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  15945. #else
  15946. (void)objs; // get0 variant returns an internal pointer; nothing to free
  15947. #endif
  15948. }
  15949. } // namespace impl
  15950. inline ctx_t create_client_context() {
  15951. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  15952. if (ctx) {
  15953. // Disable auto-retry to properly handle non-blocking I/O
  15954. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  15955. // Set minimum TLS version
  15956. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  15957. }
  15958. return static_cast<ctx_t>(ctx);
  15959. }
  15960. inline void free_context(ctx_t ctx) {
  15961. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  15962. }
  15963. inline bool set_min_version(ctx_t ctx, Version version) {
  15964. if (!ctx) return false;
  15965. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  15966. static_cast<int>(version)) == 1;
  15967. }
  15968. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  15969. if (!ctx || !pem || len == 0) return false;
  15970. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  15971. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  15972. if (!store) return false;
  15973. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  15974. if (!bio) return false;
  15975. bool ok = true;
  15976. X509 *cert = nullptr;
  15977. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  15978. nullptr) {
  15979. if (X509_STORE_add_cert(store, cert) != 1) {
  15980. // Ignore duplicate errors
  15981. auto err = ERR_peek_last_error();
  15982. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  15983. ok = false;
  15984. }
  15985. }
  15986. X509_free(cert);
  15987. if (!ok) break;
  15988. }
  15989. BIO_free(bio);
  15990. // Clear any "no more certificates" errors
  15991. ERR_clear_error();
  15992. return ok;
  15993. }
  15994. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  15995. if (!ctx || !file_path) return false;
  15996. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  15997. nullptr) == 1;
  15998. }
  15999. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16000. if (!ctx || !dir_path) return false;
  16001. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16002. dir_path) == 1;
  16003. }
  16004. inline bool load_system_certs(ctx_t ctx) {
  16005. if (!ctx) return false;
  16006. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16007. #ifdef _WIN32
  16008. // Windows: Load from system certificate store (ROOT and CA)
  16009. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16010. if (!store) return false;
  16011. bool loaded_any = false;
  16012. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16013. for (auto store_name : store_names) {
  16014. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16015. if (!hStore) continue;
  16016. PCCERT_CONTEXT pContext = nullptr;
  16017. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16018. nullptr) {
  16019. const unsigned char *data = pContext->pbCertEncoded;
  16020. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16021. if (x509) {
  16022. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16023. X509_free(x509);
  16024. }
  16025. }
  16026. CertCloseStore(hStore, 0);
  16027. }
  16028. return loaded_any;
  16029. #elif defined(__APPLE__)
  16030. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16031. // macOS: Load from Keychain
  16032. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16033. if (!store) return false;
  16034. bool loaded_any = false;
  16035. const SecTrustSettingsDomain domains[] = {
  16036. kSecTrustSettingsDomainSystem,
  16037. kSecTrustSettingsDomainAdmin,
  16038. kSecTrustSettingsDomainUser,
  16039. };
  16040. for (auto domain : domains) {
  16041. CFArrayRef certs = nullptr;
  16042. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16043. !certs) {
  16044. if (certs) CFRelease(certs);
  16045. continue;
  16046. }
  16047. auto count = CFArrayGetCount(certs);
  16048. for (CFIndex i = 0; i < count; i++) {
  16049. auto cert = reinterpret_cast<SecCertificateRef>(
  16050. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16051. CFDataRef der = SecCertificateCopyData(cert);
  16052. if (der) {
  16053. const unsigned char *data = CFDataGetBytePtr(der);
  16054. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16055. if (x509) {
  16056. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16057. X509_free(x509);
  16058. }
  16059. CFRelease(der);
  16060. }
  16061. }
  16062. CFRelease(certs);
  16063. }
  16064. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16065. #else
  16066. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16067. #endif
  16068. #else
  16069. // Other Unix: use default verify paths
  16070. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16071. #endif
  16072. }
  16073. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16074. const char *password) {
  16075. if (!ctx || !cert || !key) return false;
  16076. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16077. // Load certificate
  16078. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16079. if (!cert_bio) return false;
  16080. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16081. BIO_free(cert_bio);
  16082. if (!x509) return false;
  16083. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16084. X509_free(x509);
  16085. if (!cert_ok) return false;
  16086. // Load private key
  16087. auto key_bio = BIO_new_mem_buf(key, -1);
  16088. if (!key_bio) return false;
  16089. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16090. password ? const_cast<char *>(password)
  16091. : nullptr);
  16092. BIO_free(key_bio);
  16093. if (!pkey) return false;
  16094. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16095. EVP_PKEY_free(pkey);
  16096. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16097. }
  16098. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16099. const char *key_path, const char *password) {
  16100. if (!ctx || !cert_path || !key_path) return false;
  16101. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16102. if (password && password[0] != '\0') {
  16103. SSL_CTX_set_default_passwd_cb_userdata(
  16104. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16105. }
  16106. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16107. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16108. }
  16109. inline ctx_t create_server_context() {
  16110. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16111. if (ctx) {
  16112. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16113. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16114. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16115. }
  16116. return static_cast<ctx_t>(ctx);
  16117. }
  16118. inline void set_verify_client(ctx_t ctx, bool require) {
  16119. if (!ctx) return;
  16120. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16121. require
  16122. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16123. : SSL_VERIFY_NONE,
  16124. nullptr);
  16125. }
  16126. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16127. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16128. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16129. SSL *ssl = SSL_new(ssl_ctx);
  16130. if (!ssl) return nullptr;
  16131. // Disable auto-retry for proper non-blocking I/O handling
  16132. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16133. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16134. if (!bio) {
  16135. SSL_free(ssl);
  16136. return nullptr;
  16137. }
  16138. SSL_set_bio(ssl, bio, bio);
  16139. return static_cast<session_t>(ssl);
  16140. }
  16141. inline void free_session(session_t session) {
  16142. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16143. }
  16144. inline bool set_sni(session_t session, const char *hostname,
  16145. bool /*verify_hostname*/) {
  16146. if (!session || !hostname) return false;
  16147. auto ssl = static_cast<SSL *>(session);
  16148. // Set SNI (Server Name Indication) only - does not enable verification.
  16149. // OpenSSL never binds identity checking to SNI (that happens post-
  16150. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16151. #if defined(OPENSSL_IS_BORINGSSL)
  16152. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16153. #else
  16154. // Direct call instead of macro to suppress -Wold-style-cast warning
  16155. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16156. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16157. #endif
  16158. }
  16159. inline TlsError connect(session_t session) {
  16160. if (!session) { return TlsError(); }
  16161. auto ssl = static_cast<SSL *>(session);
  16162. auto ret = SSL_connect(ssl);
  16163. TlsError err;
  16164. if (ret == 1) {
  16165. err.code = ErrorCode::Success;
  16166. } else {
  16167. auto ssl_err = SSL_get_error(ssl, ret);
  16168. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16169. err.backend_code = ERR_get_error();
  16170. }
  16171. return err;
  16172. }
  16173. inline TlsError accept(session_t session) {
  16174. if (!session) { return TlsError(); }
  16175. auto ssl = static_cast<SSL *>(session);
  16176. auto ret = SSL_accept(ssl);
  16177. TlsError err;
  16178. if (ret == 1) {
  16179. err.code = ErrorCode::Success;
  16180. } else {
  16181. auto ssl_err = SSL_get_error(ssl, ret);
  16182. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16183. err.backend_code = ERR_get_error();
  16184. }
  16185. return err;
  16186. }
  16187. inline bool connect_nonblocking(session_t session, socket_t sock,
  16188. time_t timeout_sec, time_t timeout_usec,
  16189. TlsError *err) {
  16190. if (!session) {
  16191. if (err) { err->code = ErrorCode::Fatal; }
  16192. return false;
  16193. }
  16194. auto ssl = static_cast<SSL *>(session);
  16195. auto bio = SSL_get_rbio(ssl);
  16196. // Set non-blocking mode for handshake
  16197. detail::set_nonblocking(sock, true);
  16198. if (bio) { BIO_set_nbio(bio, 1); }
  16199. auto cleanup = detail::scope_exit([&]() {
  16200. // Restore blocking mode after handshake
  16201. if (bio) { BIO_set_nbio(bio, 0); }
  16202. detail::set_nonblocking(sock, false);
  16203. });
  16204. auto res = 0;
  16205. while ((res = SSL_connect(ssl)) != 1) {
  16206. auto ssl_err = SSL_get_error(ssl, res);
  16207. switch (ssl_err) {
  16208. case SSL_ERROR_WANT_READ:
  16209. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16210. continue;
  16211. }
  16212. break;
  16213. case SSL_ERROR_WANT_WRITE:
  16214. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16215. continue;
  16216. }
  16217. break;
  16218. default: break;
  16219. }
  16220. if (err) {
  16221. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16222. err->backend_code = ERR_get_error();
  16223. }
  16224. return false;
  16225. }
  16226. if (err) { err->code = ErrorCode::Success; }
  16227. return true;
  16228. }
  16229. inline bool accept_nonblocking(session_t session, socket_t sock,
  16230. time_t timeout_sec, time_t timeout_usec,
  16231. TlsError *err) {
  16232. if (!session) {
  16233. if (err) { err->code = ErrorCode::Fatal; }
  16234. return false;
  16235. }
  16236. auto ssl = static_cast<SSL *>(session);
  16237. auto bio = SSL_get_rbio(ssl);
  16238. // Set non-blocking mode for handshake
  16239. detail::set_nonblocking(sock, true);
  16240. if (bio) { BIO_set_nbio(bio, 1); }
  16241. auto cleanup = detail::scope_exit([&]() {
  16242. // Restore blocking mode after handshake
  16243. if (bio) { BIO_set_nbio(bio, 0); }
  16244. detail::set_nonblocking(sock, false);
  16245. });
  16246. auto res = 0;
  16247. while ((res = SSL_accept(ssl)) != 1) {
  16248. auto ssl_err = SSL_get_error(ssl, res);
  16249. switch (ssl_err) {
  16250. case SSL_ERROR_WANT_READ:
  16251. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16252. continue;
  16253. }
  16254. break;
  16255. case SSL_ERROR_WANT_WRITE:
  16256. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16257. continue;
  16258. }
  16259. break;
  16260. default: break;
  16261. }
  16262. if (err) {
  16263. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16264. err->backend_code = ERR_get_error();
  16265. }
  16266. return false;
  16267. }
  16268. if (err) { err->code = ErrorCode::Success; }
  16269. return true;
  16270. }
  16271. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16272. if (!session || !buf) {
  16273. err.code = ErrorCode::Fatal;
  16274. return -1;
  16275. }
  16276. auto ssl = static_cast<SSL *>(session);
  16277. constexpr auto max_len =
  16278. static_cast<size_t>((std::numeric_limits<int>::max)());
  16279. if (len > max_len) { len = max_len; }
  16280. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16281. if (ret > 0) {
  16282. err.code = ErrorCode::Success;
  16283. return ret;
  16284. }
  16285. auto ssl_err = SSL_get_error(ssl, ret);
  16286. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16287. if (err.code == ErrorCode::PeerClosed) {
  16288. return 0;
  16289. } // Gracefully handle the peer closed state.
  16290. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16291. return -1;
  16292. }
  16293. inline ssize_t write(session_t session, const void *buf, size_t len,
  16294. TlsError &err) {
  16295. if (!session || !buf) {
  16296. err.code = ErrorCode::Fatal;
  16297. return -1;
  16298. }
  16299. auto ssl = static_cast<SSL *>(session);
  16300. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16301. if (ret > 0) {
  16302. err.code = ErrorCode::Success;
  16303. return ret;
  16304. }
  16305. auto ssl_err = SSL_get_error(ssl, ret);
  16306. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16307. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16308. return -1;
  16309. }
  16310. inline int pending(const_session_t session) {
  16311. if (!session) return 0;
  16312. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16313. }
  16314. inline void shutdown(session_t session, bool graceful) {
  16315. if (!session) return;
  16316. auto ssl = static_cast<SSL *>(session);
  16317. if (graceful) {
  16318. // First call sends close_notify
  16319. if (SSL_shutdown(ssl) == 0) {
  16320. // Second call waits for peer's close_notify
  16321. SSL_shutdown(ssl);
  16322. }
  16323. }
  16324. }
  16325. inline bool is_peer_closed(session_t session, socket_t sock) {
  16326. if (!session) return true;
  16327. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16328. detail::set_nonblocking(sock, true);
  16329. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16330. auto ssl = static_cast<SSL *>(session);
  16331. char buf;
  16332. auto ret = SSL_peek(ssl, &buf, 1);
  16333. if (ret > 0) return false;
  16334. auto err = SSL_get_error(ssl, ret);
  16335. return err == SSL_ERROR_ZERO_RETURN;
  16336. }
  16337. inline cert_t get_peer_cert(const_session_t session) {
  16338. if (!session) return nullptr;
  16339. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16340. static_cast<SSL *>(const_cast<void *>(session))));
  16341. }
  16342. inline void free_cert(cert_t cert) {
  16343. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16344. }
  16345. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16346. if (!cert || !hostname) return false;
  16347. auto x509 = static_cast<X509 *>(cert);
  16348. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16349. if (detail::is_ip_address(hostname)) {
  16350. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16351. }
  16352. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16353. }
  16354. inline uint64_t hostname_mismatch_code() {
  16355. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16356. }
  16357. inline long get_verify_result(const_session_t session) {
  16358. if (!session) return X509_V_ERR_UNSPECIFIED;
  16359. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16360. }
  16361. inline std::string get_cert_subject_cn(cert_t cert) {
  16362. if (!cert) return "";
  16363. auto x509 = static_cast<X509 *>(cert);
  16364. auto subject_name = X509_get_subject_name(x509);
  16365. if (!subject_name) return "";
  16366. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16367. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16368. if (idx < 0) return "";
  16369. auto entry = X509_NAME_get_entry(subject_name, idx);
  16370. if (!entry) return "";
  16371. auto data = X509_NAME_ENTRY_get_data(entry);
  16372. if (!data) return "";
  16373. return std::string(
  16374. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16375. static_cast<size_t>(ASN1_STRING_length(data)));
  16376. }
  16377. inline std::string get_cert_issuer_name(cert_t cert) {
  16378. if (!cert) return "";
  16379. auto x509 = static_cast<X509 *>(cert);
  16380. auto issuer_name = X509_get_issuer_name(x509);
  16381. if (!issuer_name) return "";
  16382. char buf[256];
  16383. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16384. return std::string(buf);
  16385. }
  16386. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16387. sans.clear();
  16388. if (!cert) return false;
  16389. auto x509 = static_cast<X509 *>(cert);
  16390. auto names = static_cast<GENERAL_NAMES *>(
  16391. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16392. if (!names) return true; // No SANs is valid
  16393. auto count = sk_GENERAL_NAME_num(names);
  16394. for (decltype(count) i = 0; i < count; i++) {
  16395. auto gen = sk_GENERAL_NAME_value(names, i);
  16396. if (!gen) continue;
  16397. SanEntry entry;
  16398. switch (gen->type) {
  16399. case GEN_DNS:
  16400. entry.type = SanType::DNS;
  16401. if (gen->d.dNSName) {
  16402. entry.value = std::string(
  16403. reinterpret_cast<const char *>(
  16404. ASN1_STRING_get0_data(gen->d.dNSName)),
  16405. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16406. }
  16407. break;
  16408. case GEN_IPADD:
  16409. entry.type = SanType::IP;
  16410. if (gen->d.iPAddress) {
  16411. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16412. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16413. if (len == 4) {
  16414. // IPv4
  16415. char buf[INET_ADDRSTRLEN];
  16416. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16417. entry.value = buf;
  16418. } else if (len == 16) {
  16419. // IPv6
  16420. char buf[INET6_ADDRSTRLEN];
  16421. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16422. entry.value = buf;
  16423. }
  16424. }
  16425. break;
  16426. case GEN_EMAIL:
  16427. entry.type = SanType::EMAIL;
  16428. if (gen->d.rfc822Name) {
  16429. entry.value = std::string(
  16430. reinterpret_cast<const char *>(
  16431. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16432. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16433. }
  16434. break;
  16435. case GEN_URI:
  16436. entry.type = SanType::URI;
  16437. if (gen->d.uniformResourceIdentifier) {
  16438. entry.value = std::string(
  16439. reinterpret_cast<const char *>(
  16440. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16441. static_cast<size_t>(
  16442. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16443. }
  16444. break;
  16445. default: entry.type = SanType::OTHER; break;
  16446. }
  16447. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16448. }
  16449. GENERAL_NAMES_free(names);
  16450. return true;
  16451. }
  16452. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16453. time_t &not_after) {
  16454. if (!cert) return false;
  16455. auto x509 = static_cast<X509 *>(cert);
  16456. auto nb = X509_get0_notBefore(x509);
  16457. auto na = X509_get0_notAfter(x509);
  16458. if (!nb || !na) return false;
  16459. ASN1_TIME *epoch = ASN1_TIME_new();
  16460. if (!epoch) return false;
  16461. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16462. if (!ASN1_TIME_set(epoch, 0)) return false;
  16463. int pday, psec;
  16464. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16465. not_before = 86400 * (time_t)pday + psec;
  16466. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16467. not_after = 86400 * (time_t)pday + psec;
  16468. return true;
  16469. }
  16470. inline std::string get_cert_serial(cert_t cert) {
  16471. if (!cert) return "";
  16472. auto x509 = static_cast<X509 *>(cert);
  16473. auto serial = X509_get_serialNumber(x509);
  16474. if (!serial) return "";
  16475. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16476. if (!bn) return "";
  16477. auto hex = BN_bn2hex(bn);
  16478. BN_free(bn);
  16479. if (!hex) return "";
  16480. std::string result(hex);
  16481. OPENSSL_free(hex);
  16482. return result;
  16483. }
  16484. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16485. if (!cert) return false;
  16486. auto x509 = static_cast<X509 *>(cert);
  16487. auto len = i2d_X509(x509, nullptr);
  16488. if (len < 0) return false;
  16489. der.resize(static_cast<size_t>(len));
  16490. auto p = der.data();
  16491. i2d_X509(x509, &p);
  16492. return true;
  16493. }
  16494. inline const char *get_sni(const_session_t session) {
  16495. if (!session) return nullptr;
  16496. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16497. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16498. }
  16499. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16500. inline uint64_t get_error() { return ERR_get_error(); }
  16501. inline std::string error_string(uint64_t code) {
  16502. char buf[256];
  16503. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16504. return std::string(buf);
  16505. }
  16506. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16507. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16508. if (!mem) { return nullptr; }
  16509. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16510. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16511. if (!inf) { return nullptr; }
  16512. auto store = X509_STORE_new();
  16513. if (store) {
  16514. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16515. auto itmp = sk_X509_INFO_value(inf, i);
  16516. if (!itmp) { continue; }
  16517. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16518. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16519. }
  16520. }
  16521. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16522. return static_cast<ca_store_t>(store);
  16523. }
  16524. inline void free_ca_store(ca_store_t store) {
  16525. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16526. }
  16527. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16528. if (!ctx || !store) { return false; }
  16529. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16530. auto x509_store = static_cast<X509_STORE *>(store);
  16531. // Check if same store is already set
  16532. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16533. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16534. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16535. return true;
  16536. }
  16537. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16538. certs.clear();
  16539. if (!ctx) { return 0; }
  16540. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16541. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16542. if (!store) { return 0; }
  16543. auto objs = impl::get_store_objects(store);
  16544. if (!objs) { return 0; }
  16545. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16546. auto count = sk_X509_OBJECT_num(objs);
  16547. for (decltype(count) i = 0; i < count; i++) {
  16548. auto obj = sk_X509_OBJECT_value(objs, i);
  16549. if (!obj) { continue; }
  16550. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16551. auto x509 = X509_OBJECT_get0_X509(obj);
  16552. if (x509) {
  16553. // Increment reference count so caller can free it
  16554. X509_up_ref(x509);
  16555. certs.push_back(static_cast<cert_t>(x509));
  16556. }
  16557. }
  16558. }
  16559. return certs.size();
  16560. }
  16561. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16562. std::vector<std::string> names;
  16563. if (!ctx) { return names; }
  16564. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16565. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16566. if (!store) { return names; }
  16567. auto objs = impl::get_store_objects(store);
  16568. if (!objs) { return names; }
  16569. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16570. auto count = sk_X509_OBJECT_num(objs);
  16571. for (decltype(count) i = 0; i < count; i++) {
  16572. auto obj = sk_X509_OBJECT_value(objs, i);
  16573. if (!obj) { continue; }
  16574. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16575. auto x509 = X509_OBJECT_get0_X509(obj);
  16576. if (x509) {
  16577. auto subject = X509_get_subject_name(x509);
  16578. if (subject) {
  16579. char buf[512];
  16580. X509_NAME_oneline(subject, buf, sizeof(buf));
  16581. names.push_back(buf);
  16582. }
  16583. }
  16584. }
  16585. }
  16586. return names;
  16587. }
  16588. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16589. const char *key_pem, const char *password) {
  16590. if (!ctx || !cert_pem || !key_pem) { return false; }
  16591. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16592. // Load certificate from PEM
  16593. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16594. if (!cert_bio) { return false; }
  16595. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16596. BIO_free(cert_bio);
  16597. if (!cert) { return false; }
  16598. // Load private key from PEM
  16599. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16600. if (!key_bio) {
  16601. X509_free(cert);
  16602. return false;
  16603. }
  16604. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16605. password ? const_cast<char *>(password)
  16606. : nullptr);
  16607. BIO_free(key_bio);
  16608. if (!key) {
  16609. X509_free(cert);
  16610. return false;
  16611. }
  16612. // Update certificate and key
  16613. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16614. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16615. X509_free(cert);
  16616. EVP_PKEY_free(key);
  16617. return ret;
  16618. }
  16619. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16620. if (!ctx || !ca_pem) { return false; }
  16621. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16622. // Create new X509_STORE from PEM
  16623. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16624. if (!store) { return false; }
  16625. // SSL_CTX_set_cert_store takes ownership
  16626. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16627. // Set client CA list for client certificate request
  16628. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16629. if (ca_list) {
  16630. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16631. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16632. }
  16633. return true;
  16634. }
  16635. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16636. if (!ctx) { return false; }
  16637. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16638. impl::get_verify_callback() = std::move(callback);
  16639. if (impl::get_verify_callback()) {
  16640. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16641. } else {
  16642. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16643. }
  16644. return true;
  16645. }
  16646. inline long get_verify_error(const_session_t session) {
  16647. if (!session) { return -1; }
  16648. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16649. return SSL_get_verify_result(ssl);
  16650. }
  16651. inline std::string verify_error_string(long error_code) {
  16652. if (error_code == X509_V_OK) { return ""; }
  16653. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16654. return str ? str : "unknown error";
  16655. }
  16656. } // namespace tls
  16657. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16658. /*
  16659. * Group 9: TLS abstraction layer - Mbed TLS backend
  16660. */
  16661. /*
  16662. * Mbed TLS Backend Implementation
  16663. */
  16664. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16665. namespace tls {
  16666. namespace impl {
  16667. // Mbed TLS session wrapper
  16668. struct MbedTlsSession {
  16669. mbedtls_ssl_context ssl;
  16670. socket_t sock = INVALID_SOCKET;
  16671. std::string hostname; // For client: set via set_sni
  16672. std::string sni_hostname; // For server: received from client via SNI callback
  16673. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16674. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16675. // (e.g. a response that arrived while this side was still in its post-write
  16676. // check), the byte is pushed back here and served by the next read().
  16677. unsigned char peeked_byte = 0;
  16678. bool has_peeked_byte = false;
  16679. // Set by set_sni() when the caller disabled hostname verification, so the
  16680. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16681. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16682. // OpenSSL and wolfSSL keep them independent).
  16683. bool suppress_hostname_mismatch = false;
  16684. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16685. // decide which verify callback to install when hostname verification is
  16686. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16687. // wired for this context, or a self-contained one otherwise, so a session
  16688. // that never opted into a callback never consults the process-wide
  16689. // set_verify_callback() slot (which some other, unrelated client may have
  16690. // populated).
  16691. bool has_verify_callback = false;
  16692. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16693. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16694. MbedTlsSession(const MbedTlsSession &) = delete;
  16695. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16696. };
  16697. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16698. // queue)
  16699. inline int &mbedtls_last_error() {
  16700. static thread_local int err = 0;
  16701. return err;
  16702. }
  16703. // Helper to map Mbed TLS error to ErrorCode
  16704. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16705. uint32_t verify_flags) {
  16706. if (ret == 0) { return ErrorCode::Success; }
  16707. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16708. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16709. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16710. return ErrorCode::PeerClosed;
  16711. }
  16712. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16713. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16714. out_errno = errno;
  16715. return ErrorCode::SyscallError;
  16716. }
  16717. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16718. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16719. // the handshake's chain verification (see set_sni()); a mismatch there
  16720. // is reported the same way as any other verify_flags bit. Report it as
  16721. // HostnameMismatch, matching the other backends and the post-handshake
  16722. // identity check below, but only when naming is the sole problem -
  16723. // if the chain itself is also untrusted/expired/etc., that takes
  16724. // priority over the naming detail.
  16725. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16726. return ErrorCode::HostnameMismatch;
  16727. }
  16728. return ErrorCode::CertVerifyFailed;
  16729. }
  16730. return ErrorCode::Fatal;
  16731. }
  16732. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16733. // return value, including the verify-flags-dependent HostnameMismatch
  16734. // mapping; shared by connect() and connect_nonblocking() so the
  16735. // backend_code policy for that mapping only lives in one place.
  16736. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  16737. int ret) {
  16738. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  16739. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  16740. err.backend_code = err.code == ErrorCode::HostnameMismatch
  16741. ? static_cast<uint64_t>(verify_flags)
  16742. : static_cast<uint64_t>(-ret);
  16743. }
  16744. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  16745. // non-fatal notification delivered between records, not an error and not
  16746. // application data, so I/O calls that see it should just be retried. Kept in
  16747. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  16748. // splitting the closing brace across an #if.
  16749. inline bool mbedtls_is_session_ticket(int ret) {
  16750. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  16751. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  16752. #else
  16753. (void)ret;
  16754. return false;
  16755. #endif
  16756. }
  16757. // BIO-like send callback for Mbed TLS
  16758. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  16759. size_t len) {
  16760. auto sock = *static_cast<socket_t *>(ctx);
  16761. #ifdef _WIN32
  16762. auto ret =
  16763. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  16764. if (ret == SOCKET_ERROR) {
  16765. int err = WSAGetLastError();
  16766. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  16767. return MBEDTLS_ERR_NET_SEND_FAILED;
  16768. }
  16769. #else
  16770. auto ret = send(sock, buf, len, 0);
  16771. if (ret < 0) {
  16772. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16773. return MBEDTLS_ERR_SSL_WANT_WRITE;
  16774. }
  16775. return MBEDTLS_ERR_NET_SEND_FAILED;
  16776. }
  16777. #endif
  16778. return static_cast<int>(ret);
  16779. }
  16780. // BIO-like recv callback for Mbed TLS
  16781. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  16782. auto sock = *static_cast<socket_t *>(ctx);
  16783. #ifdef _WIN32
  16784. auto ret =
  16785. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  16786. if (ret == SOCKET_ERROR) {
  16787. int err = WSAGetLastError();
  16788. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  16789. return MBEDTLS_ERR_NET_RECV_FAILED;
  16790. }
  16791. #else
  16792. auto ret = recv(sock, buf, len, 0);
  16793. if (ret < 0) {
  16794. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16795. return MBEDTLS_ERR_SSL_WANT_READ;
  16796. }
  16797. return MBEDTLS_ERR_NET_RECV_FAILED;
  16798. }
  16799. #endif
  16800. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  16801. return static_cast<int>(ret);
  16802. }
  16803. // MbedTlsContext constructor/destructor implementations
  16804. inline MbedTlsContext::MbedTlsContext() {
  16805. mbedtls_ssl_config_init(&conf);
  16806. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16807. mbedtls_entropy_init(&entropy);
  16808. mbedtls_ctr_drbg_init(&ctr_drbg);
  16809. #endif
  16810. mbedtls_x509_crt_init(&ca_chain);
  16811. mbedtls_x509_crt_init(&own_cert);
  16812. mbedtls_pk_init(&own_key);
  16813. }
  16814. inline MbedTlsContext::~MbedTlsContext() {
  16815. mbedtls_pk_free(&own_key);
  16816. mbedtls_x509_crt_free(&own_cert);
  16817. mbedtls_x509_crt_free(&ca_chain);
  16818. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16819. mbedtls_ctr_drbg_free(&ctr_drbg);
  16820. mbedtls_entropy_free(&entropy);
  16821. #endif
  16822. mbedtls_ssl_config_free(&conf);
  16823. }
  16824. // Thread-local storage for SNI captured during handshake
  16825. // This is needed because the SNI callback doesn't have a way to pass
  16826. // session-specific data before the session is fully set up
  16827. inline std::string &mbedpending_sni() {
  16828. static thread_local std::string sni;
  16829. return sni;
  16830. }
  16831. // SNI callback for Mbed TLS server to capture client's SNI hostname
  16832. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  16833. const unsigned char *name, size_t name_len) {
  16834. (void)p_ctx;
  16835. (void)ssl;
  16836. // Store SNI name in thread-local storage
  16837. // It will be retrieved and stored in the session after handshake
  16838. if (name && name_len > 0) {
  16839. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  16840. } else {
  16841. mbedpending_sni().clear();
  16842. }
  16843. return 0; // Accept any SNI
  16844. }
  16845. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  16846. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  16847. }
  16848. // Verify callback used when hostname verification is disabled for a session
  16849. // that has no user-supplied verify callback of its own (MbedTlsSession::
  16850. // has_verify_callback is false). Deliberately does not consult
  16851. // get_verify_callback(): that slot is process-wide, so reading it here would
  16852. // pick up whatever another, unrelated client last installed there.
  16853. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  16854. mbedtls_x509_crt *, int,
  16855. uint32_t *flags) {
  16856. (void)data;
  16857. mbedtls_clear_cn_mismatch(flags);
  16858. return 0;
  16859. }
  16860. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16861. int cert_depth, uint32_t *flags);
  16862. // MbedTLS verify callback wrapper
  16863. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  16864. int cert_depth, uint32_t *flags) {
  16865. // data points to the MbedTlsSession
  16866. auto *session = static_cast<MbedTlsSession *>(data);
  16867. // set_sni() disabled hostname verification for this session: drop the
  16868. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  16869. // the OpenSSL/wolfSSL backends where identity checking is independent of
  16870. // SNI. The final pass/fail decision still comes from the remaining flags
  16871. // (or, below, from the user's own verify callback).
  16872. if (session && session->suppress_hostname_mismatch) {
  16873. mbedtls_clear_cn_mismatch(flags);
  16874. }
  16875. auto &callback = get_verify_callback();
  16876. if (!callback) { return 0; } // Continue with default verification
  16877. // Build context
  16878. VerifyContext verify_ctx;
  16879. verify_ctx.session = static_cast<session_t>(session);
  16880. verify_ctx.cert = static_cast<cert_t>(crt);
  16881. verify_ctx.depth = cert_depth;
  16882. verify_ctx.preverify_ok = (*flags == 0);
  16883. verify_ctx.error_code = static_cast<long>(*flags);
  16884. // Convert Mbed TLS flags to error string
  16885. static thread_local char error_buf[256];
  16886. if (*flags != 0) {
  16887. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  16888. verify_ctx.error_string = error_buf;
  16889. } else {
  16890. verify_ctx.error_string = nullptr;
  16891. }
  16892. bool accepted = callback(verify_ctx);
  16893. if (accepted) {
  16894. *flags = 0; // Clear all error flags
  16895. return 0;
  16896. }
  16897. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  16898. }
  16899. } // namespace impl
  16900. inline ctx_t create_client_context() {
  16901. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16902. if (!ctx) { return nullptr; }
  16903. ctx->is_server = false;
  16904. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16905. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16906. if (!detail::ensure_mbedtls_psa_crypto()) {
  16907. delete ctx;
  16908. return nullptr;
  16909. }
  16910. int ret;
  16911. #else
  16912. // Seed the random number generator
  16913. const char *pers = "httplib_client";
  16914. int ret = mbedtls_ctr_drbg_seed(
  16915. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16916. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16917. if (ret != 0) {
  16918. impl::mbedtls_last_error() = ret;
  16919. delete ctx;
  16920. return nullptr;
  16921. }
  16922. #endif
  16923. // Set up SSL config for client
  16924. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  16925. MBEDTLS_SSL_TRANSPORT_STREAM,
  16926. MBEDTLS_SSL_PRESET_DEFAULT);
  16927. if (ret != 0) {
  16928. impl::mbedtls_last_error() = ret;
  16929. delete ctx;
  16930. return nullptr;
  16931. }
  16932. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16933. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  16934. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  16935. #endif
  16936. // Default: verify peer certificate
  16937. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  16938. // Set minimum TLS version to 1.2
  16939. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16940. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  16941. #else
  16942. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  16943. MBEDTLS_SSL_MINOR_VERSION_3);
  16944. #endif
  16945. return static_cast<ctx_t>(ctx);
  16946. }
  16947. inline ctx_t create_server_context() {
  16948. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  16949. if (!ctx) { return nullptr; }
  16950. ctx->is_server = true;
  16951. #ifdef CPPHTTPLIB_MBEDTLS_V4
  16952. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  16953. if (!detail::ensure_mbedtls_psa_crypto()) {
  16954. delete ctx;
  16955. return nullptr;
  16956. }
  16957. int ret;
  16958. #else
  16959. // Seed the random number generator
  16960. const char *pers = "httplib_server";
  16961. int ret = mbedtls_ctr_drbg_seed(
  16962. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  16963. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  16964. if (ret != 0) {
  16965. impl::mbedtls_last_error() = ret;
  16966. delete ctx;
  16967. return nullptr;
  16968. }
  16969. #endif
  16970. // Set up SSL config for server
  16971. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  16972. MBEDTLS_SSL_TRANSPORT_STREAM,
  16973. MBEDTLS_SSL_PRESET_DEFAULT);
  16974. if (ret != 0) {
  16975. impl::mbedtls_last_error() = ret;
  16976. delete ctx;
  16977. return nullptr;
  16978. }
  16979. #ifndef CPPHTTPLIB_MBEDTLS_V4
  16980. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  16981. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  16982. #endif
  16983. // Default: don't verify client
  16984. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  16985. // Set minimum TLS version to 1.2
  16986. #ifdef CPPHTTPLIB_MBEDTLS_V3
  16987. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  16988. #else
  16989. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  16990. MBEDTLS_SSL_MINOR_VERSION_3);
  16991. #endif
  16992. // Set SNI callback to capture client's SNI hostname
  16993. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  16994. return static_cast<ctx_t>(ctx);
  16995. }
  16996. inline void free_context(ctx_t ctx) {
  16997. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  16998. }
  16999. inline bool set_min_version(ctx_t ctx, Version version) {
  17000. if (!ctx) { return false; }
  17001. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17002. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17003. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17004. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17005. if (version >= Version::TLS1_3) {
  17006. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17007. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17008. #endif
  17009. }
  17010. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17011. #else
  17012. // Mbed TLS 2.x uses major/minor version numbers
  17013. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17014. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17015. if (version >= Version::TLS1_3) {
  17016. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17017. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17018. #else
  17019. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17020. #endif
  17021. }
  17022. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17023. #endif
  17024. return true;
  17025. }
  17026. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17027. if (!ctx || !pem) { return false; }
  17028. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17029. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17030. // Add null terminator if not present
  17031. std::string pem_str(pem, len);
  17032. int ret = mbedtls_x509_crt_parse(
  17033. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17034. pem_str.size() + 1);
  17035. if (ret != 0) {
  17036. impl::mbedtls_last_error() = ret;
  17037. return false;
  17038. }
  17039. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17040. return true;
  17041. }
  17042. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17043. if (!ctx || !file_path) { return false; }
  17044. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17045. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17046. if (ret != 0) {
  17047. impl::mbedtls_last_error() = ret;
  17048. return false;
  17049. }
  17050. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17051. return true;
  17052. }
  17053. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17054. if (!ctx || !dir_path) { return false; }
  17055. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17056. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17057. if (ret < 0) { // Returns number of certs on success, negative on error
  17058. impl::mbedtls_last_error() = ret;
  17059. return false;
  17060. }
  17061. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17062. return true;
  17063. }
  17064. inline bool load_system_certs(ctx_t ctx) {
  17065. if (!ctx) { return false; }
  17066. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17067. bool loaded = false;
  17068. #ifdef _WIN32
  17069. loaded = impl::enumerate_windows_system_certs(
  17070. [&](const unsigned char *data, size_t len) {
  17071. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17072. });
  17073. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17074. loaded = impl::enumerate_macos_keychain_certs(
  17075. [&](const unsigned char *data, size_t len) {
  17076. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17077. });
  17078. #else
  17079. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17080. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17081. loaded = true;
  17082. break;
  17083. }
  17084. }
  17085. if (!loaded) {
  17086. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17087. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17088. loaded = true;
  17089. break;
  17090. }
  17091. }
  17092. }
  17093. #endif
  17094. if (loaded) {
  17095. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17096. }
  17097. return loaded;
  17098. }
  17099. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17100. const char *password) {
  17101. if (!ctx || !cert || !key) { return false; }
  17102. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17103. // Parse certificate
  17104. std::string cert_str(cert);
  17105. int ret = mbedtls_x509_crt_parse(
  17106. &mctx->own_cert,
  17107. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17108. cert_str.size() + 1);
  17109. if (ret != 0) {
  17110. impl::mbedtls_last_error() = ret;
  17111. return false;
  17112. }
  17113. // Parse private key
  17114. std::string key_str(key);
  17115. const unsigned char *pwd =
  17116. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17117. size_t pwd_len = password ? strlen(password) : 0;
  17118. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17119. ret = mbedtls_pk_parse_key(
  17120. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17121. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17122. &mctx->ctr_drbg);
  17123. #else
  17124. ret = mbedtls_pk_parse_key(
  17125. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17126. key_str.size() + 1, pwd, pwd_len);
  17127. #endif
  17128. if (ret != 0) {
  17129. impl::mbedtls_last_error() = ret;
  17130. return false;
  17131. }
  17132. // Verify that the certificate and private key match.
  17133. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17134. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17135. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17136. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17137. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17138. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17139. #else
  17140. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17141. #endif
  17142. if (ret != 0) {
  17143. impl::mbedtls_last_error() = ret;
  17144. return false;
  17145. }
  17146. #endif
  17147. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17148. if (ret != 0) {
  17149. impl::mbedtls_last_error() = ret;
  17150. return false;
  17151. }
  17152. return true;
  17153. }
  17154. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17155. const char *key_path, const char *password) {
  17156. if (!ctx || !cert_path || !key_path) { return false; }
  17157. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17158. // Parse certificate file
  17159. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17160. if (ret != 0) {
  17161. impl::mbedtls_last_error() = ret;
  17162. return false;
  17163. }
  17164. // Parse private key file
  17165. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17166. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17167. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17168. #else
  17169. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17170. #endif
  17171. if (ret != 0) {
  17172. impl::mbedtls_last_error() = ret;
  17173. return false;
  17174. }
  17175. // Verify that the certificate and private key match.
  17176. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17177. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17178. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17179. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17180. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17181. #else
  17182. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17183. #endif
  17184. if (ret != 0) {
  17185. impl::mbedtls_last_error() = ret;
  17186. return false;
  17187. }
  17188. #endif
  17189. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17190. if (ret != 0) {
  17191. impl::mbedtls_last_error() = ret;
  17192. return false;
  17193. }
  17194. return true;
  17195. }
  17196. inline void set_verify_client(ctx_t ctx, bool require) {
  17197. if (!ctx) { return; }
  17198. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17199. mctx->verify_client = require;
  17200. if (require) {
  17201. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17202. } else {
  17203. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17204. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17205. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17206. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17207. : MBEDTLS_SSL_VERIFY_NONE);
  17208. }
  17209. }
  17210. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17211. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17212. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17213. auto session = new (std::nothrow) impl::MbedTlsSession();
  17214. if (!session) { return nullptr; }
  17215. session->sock = sock;
  17216. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17217. if (ret != 0) {
  17218. impl::mbedtls_last_error() = ret;
  17219. delete session;
  17220. return nullptr;
  17221. }
  17222. // Explicitly opt out of in-handshake hostname verification by default;
  17223. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17224. // fails outright when no hostname was set. set_sni() installs the real
  17225. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17226. // caller verifies the certificate identity post-handshake via
  17227. // verify_hostname().
  17228. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17229. // Set BIO callbacks
  17230. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17231. impl::mbedtls_net_recv_cb, nullptr);
  17232. // Set per-session verify callback with session pointer if callback is
  17233. // registered
  17234. session->has_verify_callback = mctx->has_verify_callback;
  17235. if (mctx->has_verify_callback) {
  17236. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17237. session);
  17238. }
  17239. return static_cast<session_t>(session);
  17240. }
  17241. inline void free_session(session_t session) {
  17242. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17243. }
  17244. inline bool set_sni(session_t session, const char *hostname,
  17245. bool verify_hostname) {
  17246. if (!session || !hostname) { return false; }
  17247. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17248. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17249. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17250. // independently, so a disabled hostname check is handled below by masking
  17251. // the resulting mismatch flag instead of skipping this call.
  17252. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17253. if (ret != 0) {
  17254. impl::mbedtls_last_error() = ret;
  17255. return false;
  17256. }
  17257. msession->hostname = hostname;
  17258. if (!verify_hostname) {
  17259. msession->suppress_hostname_mismatch = true;
  17260. // If a user verify callback is already wired for this session,
  17261. // mbedtls_verify_callback() masks the mismatch flag itself before
  17262. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17263. // here would be redundant. Otherwise install the self-contained masking
  17264. // callback, which never touches the process-wide callback slot.
  17265. if (!msession->has_verify_callback) {
  17266. mbedtls_ssl_set_verify(&msession->ssl,
  17267. impl::mbedtls_mask_hostname_mismatch_callback,
  17268. msession);
  17269. }
  17270. }
  17271. return true;
  17272. }
  17273. inline TlsError connect(session_t session) {
  17274. TlsError err;
  17275. if (!session) {
  17276. err.code = ErrorCode::Fatal;
  17277. return err;
  17278. }
  17279. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17280. int ret;
  17281. do {
  17282. ret = mbedtls_ssl_handshake(&msession->ssl);
  17283. } while (impl::mbedtls_is_session_ticket(ret));
  17284. if (ret == 0) {
  17285. err.code = ErrorCode::Success;
  17286. } else {
  17287. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17288. impl::mbedtls_last_error() = ret;
  17289. }
  17290. return err;
  17291. }
  17292. inline TlsError accept(session_t session) {
  17293. // Same as connect for Mbed TLS - handshake works for both client and server
  17294. auto result = connect(session);
  17295. // After successful handshake, capture SNI from thread-local storage
  17296. if (result.code == ErrorCode::Success && session) {
  17297. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17298. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17299. impl::mbedpending_sni().clear();
  17300. }
  17301. return result;
  17302. }
  17303. inline bool connect_nonblocking(session_t session, socket_t sock,
  17304. time_t timeout_sec, time_t timeout_usec,
  17305. TlsError *err) {
  17306. if (!session) {
  17307. if (err) { err->code = ErrorCode::Fatal; }
  17308. return false;
  17309. }
  17310. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17311. // Set socket to non-blocking mode
  17312. detail::set_nonblocking(sock, true);
  17313. auto cleanup =
  17314. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17315. int ret;
  17316. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17317. // Non-fatal TLS 1.3 ticket; retry immediately.
  17318. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17319. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17320. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17321. continue;
  17322. }
  17323. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17324. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17325. continue;
  17326. }
  17327. }
  17328. // TlsError or timeout
  17329. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17330. impl::mbedtls_last_error() = ret;
  17331. return false;
  17332. }
  17333. if (err) { err->code = ErrorCode::Success; }
  17334. return true;
  17335. }
  17336. inline bool accept_nonblocking(session_t session, socket_t sock,
  17337. time_t timeout_sec, time_t timeout_usec,
  17338. TlsError *err) {
  17339. // Same implementation as connect for Mbed TLS
  17340. bool result =
  17341. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17342. // After successful handshake, capture SNI from thread-local storage
  17343. if (result && session) {
  17344. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17345. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17346. impl::mbedpending_sni().clear();
  17347. }
  17348. return result;
  17349. }
  17350. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17351. if (!session || !buf) {
  17352. err.code = ErrorCode::Fatal;
  17353. return -1;
  17354. }
  17355. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17356. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17357. if (msession->has_peeked_byte) {
  17358. if (len == 0) { return 0; }
  17359. auto p = static_cast<unsigned char *>(buf);
  17360. p[0] = msession->peeked_byte;
  17361. msession->has_peeked_byte = false;
  17362. size_t n = 1;
  17363. // Top up with any already-decrypted bytes without risking a block.
  17364. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17365. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17366. if (extra > 0) { n += static_cast<size_t>(extra); }
  17367. }
  17368. err.code = ErrorCode::Success;
  17369. return static_cast<ssize_t>(n);
  17370. }
  17371. int ret;
  17372. do {
  17373. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17374. len);
  17375. } while (impl::mbedtls_is_session_ticket(ret));
  17376. if (ret > 0) {
  17377. err.code = ErrorCode::Success;
  17378. return static_cast<ssize_t>(ret);
  17379. }
  17380. if (ret == 0) {
  17381. err.code = ErrorCode::PeerClosed;
  17382. return 0;
  17383. }
  17384. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17385. err.backend_code = static_cast<uint64_t>(-ret);
  17386. impl::mbedtls_last_error() = ret;
  17387. // mbedTLS signals a clean close_notify via a negative error code rather
  17388. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17389. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17390. return -1;
  17391. }
  17392. inline ssize_t write(session_t session, const void *buf, size_t len,
  17393. TlsError &err) {
  17394. if (!session || !buf) {
  17395. err.code = ErrorCode::Fatal;
  17396. return -1;
  17397. }
  17398. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17399. int ret;
  17400. do {
  17401. ret = mbedtls_ssl_write(&msession->ssl,
  17402. static_cast<const unsigned char *>(buf), len);
  17403. } while (impl::mbedtls_is_session_ticket(ret));
  17404. if (ret > 0) {
  17405. err.code = ErrorCode::Success;
  17406. return static_cast<ssize_t>(ret);
  17407. }
  17408. if (ret == 0) {
  17409. err.code = ErrorCode::PeerClosed;
  17410. return 0;
  17411. }
  17412. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17413. err.backend_code = static_cast<uint64_t>(-ret);
  17414. impl::mbedtls_last_error() = ret;
  17415. return -1;
  17416. }
  17417. inline int pending(const_session_t session) {
  17418. if (!session) { return 0; }
  17419. auto msession =
  17420. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17421. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17422. (msession->has_peeked_byte ? 1 : 0);
  17423. }
  17424. inline void shutdown(session_t session, bool graceful) {
  17425. if (!session) { return; }
  17426. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17427. if (graceful) {
  17428. // Try to send close_notify, but don't block forever
  17429. int ret;
  17430. int attempts = 0;
  17431. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17432. attempts < 3) {
  17433. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17434. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17435. break;
  17436. }
  17437. attempts++;
  17438. }
  17439. }
  17440. }
  17441. inline bool is_peer_closed(session_t session, socket_t sock) {
  17442. if (!session || sock == INVALID_SOCKET) { return true; }
  17443. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17444. // Check if there's already decrypted or pushed-back data available.
  17445. // If so, the connection is definitely alive.
  17446. if (msession->has_peeked_byte ||
  17447. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17448. return false;
  17449. }
  17450. // Set socket to non-blocking to avoid blocking on read
  17451. detail::set_nonblocking(sock, true);
  17452. auto cleanup =
  17453. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17454. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17455. // on application data — e.g. a response that already arrived — push the
  17456. // byte back so the next read() delivers it instead of losing it.
  17457. unsigned char buf;
  17458. int ret;
  17459. do {
  17460. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17461. } while (impl::mbedtls_is_session_ticket(ret));
  17462. // If we got data or WANT_READ (would block), connection is alive
  17463. if (ret > 0) {
  17464. msession->peeked_byte = buf;
  17465. msession->has_peeked_byte = true;
  17466. return false;
  17467. }
  17468. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17469. // If we get a peer close notify or a connection reset, the peer is closed
  17470. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17471. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17472. }
  17473. inline cert_t get_peer_cert(const_session_t session) {
  17474. if (!session) { return nullptr; }
  17475. auto msession =
  17476. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17477. // Mbed TLS returns a pointer to the internal peer cert chain.
  17478. // WARNING: This pointer is only valid while the session is active.
  17479. // Do not use the certificate after calling free_session().
  17480. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17481. return const_cast<mbedtls_x509_crt *>(cert);
  17482. }
  17483. inline void free_cert(cert_t cert) {
  17484. // Mbed TLS: peer certificate is owned by the SSL context.
  17485. // No-op here, but callers should still call this for cross-backend
  17486. // portability.
  17487. (void)cert;
  17488. }
  17489. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17490. if (!cert || !hostname) { return false; }
  17491. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17492. std::string host_str(hostname);
  17493. // Check if hostname is an IP address (IPv4 or IPv6)
  17494. unsigned char ip_bytes[16];
  17495. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17496. auto is_ip = ip_len > 0;
  17497. // Check Subject Alternative Names (SAN)
  17498. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17499. // - DNS names: raw string bytes
  17500. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17501. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17502. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17503. const unsigned char *p = san->buf.p;
  17504. size_t len = san->buf.len;
  17505. if (is_ip) {
  17506. // For an IP host, only a matching iPAddress SAN of the same family
  17507. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17508. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17509. } else {
  17510. // Check if this SAN is a DNS name (printable ASCII string)
  17511. bool is_dns = len > 0;
  17512. for (size_t i = 0; i < len && is_dns; i++) {
  17513. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17514. }
  17515. if (is_dns) {
  17516. std::string san_name(reinterpret_cast<const char *>(p), len);
  17517. if (detail::match_hostname(san_name, host_str)) { return true; }
  17518. }
  17519. }
  17520. san = san->next;
  17521. }
  17522. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17523. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17524. // the OpenSSL backend's X509_check_ip behaves the same way).
  17525. if (!is_ip) {
  17526. char cn[256];
  17527. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17528. if (ret > 0) {
  17529. std::string cn_str(cn);
  17530. // Look for "CN=" in the DN string
  17531. size_t cn_pos = cn_str.find("CN=");
  17532. if (cn_pos != std::string::npos) {
  17533. size_t start = cn_pos + 3;
  17534. size_t end = cn_str.find(',', start);
  17535. std::string cn_value =
  17536. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17537. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17538. }
  17539. }
  17540. }
  17541. return false;
  17542. }
  17543. inline uint64_t hostname_mismatch_code() {
  17544. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17545. }
  17546. inline long get_verify_result(const_session_t session) {
  17547. if (!session) { return -1; }
  17548. auto msession =
  17549. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17550. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17551. // Return 0 (X509_V_OK equivalent) if verification passed
  17552. return flags == 0 ? 0 : static_cast<long>(flags);
  17553. }
  17554. inline std::string get_cert_subject_cn(cert_t cert) {
  17555. if (!cert) return "";
  17556. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17557. // Find the CN in the subject
  17558. const mbedtls_x509_name *name = &x509->subject;
  17559. while (name != nullptr) {
  17560. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17561. return std::string(reinterpret_cast<const char *>(name->val.p),
  17562. name->val.len);
  17563. }
  17564. name = name->next;
  17565. }
  17566. return "";
  17567. }
  17568. inline std::string get_cert_issuer_name(cert_t cert) {
  17569. if (!cert) return "";
  17570. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17571. // Build a human-readable issuer name string
  17572. char buf[512];
  17573. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17574. if (ret < 0) return "";
  17575. return std::string(buf);
  17576. }
  17577. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17578. sans.clear();
  17579. if (!cert) return false;
  17580. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17581. // Parse the Subject Alternative Name extension
  17582. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17583. while (cur != nullptr) {
  17584. if (cur->buf.len > 0) {
  17585. // Mbed TLS stores SAN as ASN.1 sequences
  17586. // The tag byte indicates the type
  17587. const unsigned char *p = cur->buf.p;
  17588. size_t len = cur->buf.len;
  17589. // First byte is the tag
  17590. unsigned char tag = *p;
  17591. p++;
  17592. len--;
  17593. // Parse length (simple single-byte length assumed)
  17594. if (len > 0 && *p < 0x80) {
  17595. size_t value_len = *p;
  17596. p++;
  17597. len--;
  17598. if (value_len <= len) {
  17599. SanEntry entry;
  17600. // ASN.1 context tags for GeneralName
  17601. switch (tag & 0x1F) {
  17602. case 2: // dNSName
  17603. entry.type = SanType::DNS;
  17604. entry.value =
  17605. std::string(reinterpret_cast<const char *>(p), value_len);
  17606. break;
  17607. case 7: // iPAddress
  17608. entry.type = SanType::IP;
  17609. if (value_len == 4) {
  17610. // IPv4
  17611. char buf[16];
  17612. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17613. entry.value = buf;
  17614. } else if (value_len == 16) {
  17615. // IPv6
  17616. char buf[64];
  17617. snprintf(buf, sizeof(buf),
  17618. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17619. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17620. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17621. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17622. entry.value = buf;
  17623. }
  17624. break;
  17625. case 1: // rfc822Name (email)
  17626. entry.type = SanType::EMAIL;
  17627. entry.value =
  17628. std::string(reinterpret_cast<const char *>(p), value_len);
  17629. break;
  17630. case 6: // uniformResourceIdentifier
  17631. entry.type = SanType::URI;
  17632. entry.value =
  17633. std::string(reinterpret_cast<const char *>(p), value_len);
  17634. break;
  17635. default: entry.type = SanType::OTHER; break;
  17636. }
  17637. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17638. }
  17639. }
  17640. }
  17641. cur = cur->next;
  17642. }
  17643. return true;
  17644. }
  17645. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17646. time_t &not_after) {
  17647. if (!cert) return false;
  17648. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17649. // Convert mbedtls_x509_time to time_t
  17650. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17651. struct tm tm_time = {};
  17652. tm_time.tm_year = t.year - 1900;
  17653. tm_time.tm_mon = t.mon - 1;
  17654. tm_time.tm_mday = t.day;
  17655. tm_time.tm_hour = t.hour;
  17656. tm_time.tm_min = t.min;
  17657. tm_time.tm_sec = t.sec;
  17658. #ifdef _WIN32
  17659. return _mkgmtime(&tm_time);
  17660. #else
  17661. return timegm(&tm_time);
  17662. #endif
  17663. };
  17664. not_before = to_time_t(x509->valid_from);
  17665. not_after = to_time_t(x509->valid_to);
  17666. return true;
  17667. }
  17668. inline std::string get_cert_serial(cert_t cert) {
  17669. if (!cert) return "";
  17670. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17671. // Convert serial number to hex string
  17672. std::string result;
  17673. result.reserve(x509->serial.len * 2);
  17674. for (size_t i = 0; i < x509->serial.len; i++) {
  17675. char hex[3];
  17676. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17677. result += hex;
  17678. }
  17679. return result;
  17680. }
  17681. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17682. if (!cert) return false;
  17683. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17684. if (!crt->raw.p || crt->raw.len == 0) return false;
  17685. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17686. return true;
  17687. }
  17688. inline const char *get_sni(const_session_t session) {
  17689. if (!session) return nullptr;
  17690. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17691. // For server: return SNI received from client during handshake
  17692. if (!msession->sni_hostname.empty()) {
  17693. return msession->sni_hostname.c_str();
  17694. }
  17695. // For client: return the hostname set via set_sni
  17696. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17697. return nullptr;
  17698. }
  17699. inline uint64_t peek_error() {
  17700. // Mbed TLS doesn't have an error queue, return the last error
  17701. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17702. }
  17703. inline uint64_t get_error() {
  17704. // Mbed TLS doesn't have an error queue, return and clear the last error
  17705. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17706. impl::mbedtls_last_error() = 0;
  17707. return err;
  17708. }
  17709. inline std::string error_string(uint64_t code) {
  17710. char buf[256];
  17711. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17712. return std::string(buf);
  17713. }
  17714. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17715. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17716. if (!ca_chain) { return nullptr; }
  17717. mbedtls_x509_crt_init(ca_chain);
  17718. // mbedtls_x509_crt_parse expects null-terminated PEM
  17719. int ret = mbedtls_x509_crt_parse(ca_chain,
  17720. reinterpret_cast<const unsigned char *>(pem),
  17721. len + 1); // +1 for null terminator
  17722. if (ret != 0) {
  17723. // Try without +1 in case PEM is already null-terminated
  17724. ret = mbedtls_x509_crt_parse(
  17725. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17726. if (ret != 0) {
  17727. mbedtls_x509_crt_free(ca_chain);
  17728. delete ca_chain;
  17729. return nullptr;
  17730. }
  17731. }
  17732. return static_cast<ca_store_t>(ca_chain);
  17733. }
  17734. inline void free_ca_store(ca_store_t store) {
  17735. if (store) {
  17736. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17737. mbedtls_x509_crt_free(ca_chain);
  17738. delete ca_chain;
  17739. }
  17740. }
  17741. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17742. if (!ctx || !store) { return false; }
  17743. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17744. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17745. // Free existing CA chain
  17746. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17747. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17748. // Copy the CA chain (deep copy)
  17749. // Parse from the raw data of the source cert
  17750. mbedtls_x509_crt *src = ca_chain;
  17751. while (src != nullptr) {
  17752. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  17753. src->raw.len);
  17754. if (ret != 0) {
  17755. free_ca_store(store);
  17756. return false;
  17757. }
  17758. src = src->next;
  17759. }
  17760. // This function takes ownership of the store; the chain was deep-copied
  17761. // above, so release the source
  17762. free_ca_store(store);
  17763. // Update the SSL config to use the new CA chain
  17764. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17765. return true;
  17766. }
  17767. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17768. certs.clear();
  17769. if (!ctx) { return 0; }
  17770. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17771. // Iterate through the CA chain
  17772. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17773. while (cert != nullptr && cert->raw.len > 0) {
  17774. // Create a copy of the certificate for the caller
  17775. auto *copy = new mbedtls_x509_crt;
  17776. mbedtls_x509_crt_init(copy);
  17777. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  17778. if (ret == 0) {
  17779. certs.push_back(static_cast<cert_t>(copy));
  17780. } else {
  17781. mbedtls_x509_crt_free(copy);
  17782. delete copy;
  17783. }
  17784. cert = cert->next;
  17785. }
  17786. return certs.size();
  17787. }
  17788. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17789. std::vector<std::string> names;
  17790. if (!ctx) { return names; }
  17791. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17792. // Iterate through the CA chain
  17793. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17794. while (cert != nullptr && cert->raw.len > 0) {
  17795. char buf[512];
  17796. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  17797. if (ret > 0) { names.push_back(buf); }
  17798. cert = cert->next;
  17799. }
  17800. return names;
  17801. }
  17802. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  17803. const char *key_pem, const char *password) {
  17804. if (!ctx || !cert_pem || !key_pem) { return false; }
  17805. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17806. // Free existing certificate and key
  17807. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  17808. mbedtls_pk_free(&mbed_ctx->own_key);
  17809. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  17810. mbedtls_pk_init(&mbed_ctx->own_key);
  17811. // Parse certificate PEM
  17812. int ret = mbedtls_x509_crt_parse(
  17813. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  17814. strlen(cert_pem) + 1);
  17815. if (ret != 0) {
  17816. impl::mbedtls_last_error() = ret;
  17817. return false;
  17818. }
  17819. // Parse private key PEM
  17820. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17821. ret = mbedtls_pk_parse_key(
  17822. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17823. strlen(key_pem) + 1,
  17824. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17825. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  17826. &mbed_ctx->ctr_drbg);
  17827. #else
  17828. ret = mbedtls_pk_parse_key(
  17829. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  17830. strlen(key_pem) + 1,
  17831. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  17832. password ? strlen(password) : 0);
  17833. #endif
  17834. if (ret != 0) {
  17835. impl::mbedtls_last_error() = ret;
  17836. return false;
  17837. }
  17838. // Configure SSL to use the new certificate and key
  17839. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  17840. &mbed_ctx->own_key);
  17841. if (ret != 0) {
  17842. impl::mbedtls_last_error() = ret;
  17843. return false;
  17844. }
  17845. return true;
  17846. }
  17847. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  17848. if (!ctx || !ca_pem) { return false; }
  17849. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17850. // Free existing CA chain
  17851. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17852. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17853. // Parse CA PEM
  17854. int ret = mbedtls_x509_crt_parse(
  17855. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  17856. strlen(ca_pem) + 1);
  17857. if (ret != 0) {
  17858. impl::mbedtls_last_error() = ret;
  17859. return false;
  17860. }
  17861. // Update SSL config to use new CA chain
  17862. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17863. return true;
  17864. }
  17865. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  17866. if (!ctx) { return false; }
  17867. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17868. impl::get_verify_callback() = std::move(callback);
  17869. mbed_ctx->has_verify_callback =
  17870. static_cast<bool>(impl::get_verify_callback());
  17871. if (mbed_ctx->has_verify_callback) {
  17872. // Set OPTIONAL mode to ensure callback is called even when verification
  17873. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  17874. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  17875. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  17876. nullptr);
  17877. } else {
  17878. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  17879. }
  17880. return true;
  17881. }
  17882. inline long get_verify_error(const_session_t session) {
  17883. if (!session) { return -1; }
  17884. auto *msession =
  17885. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17886. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  17887. }
  17888. inline std::string verify_error_string(long error_code) {
  17889. if (error_code == 0) { return ""; }
  17890. char buf[256];
  17891. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  17892. static_cast<uint32_t>(error_code));
  17893. // Remove trailing newline if present
  17894. std::string result(buf);
  17895. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  17896. result.pop_back();
  17897. }
  17898. return result;
  17899. }
  17900. } // namespace tls
  17901. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  17902. /*
  17903. * Group 10: TLS abstraction layer - wolfSSL backend
  17904. */
  17905. /*
  17906. * wolfSSL Backend Implementation
  17907. */
  17908. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  17909. namespace tls {
  17910. namespace impl {
  17911. // wolfSSL session wrapper
  17912. struct WolfSSLSession {
  17913. WOLFSSL *ssl = nullptr;
  17914. socket_t sock = INVALID_SOCKET;
  17915. std::string hostname; // For client: set via set_sni
  17916. std::string sni_hostname; // For server: received from client via SNI callback
  17917. WolfSSLSession() = default;
  17918. ~WolfSSLSession() {
  17919. if (ssl) { wolfSSL_free(ssl); }
  17920. }
  17921. WolfSSLSession(const WolfSSLSession &) = delete;
  17922. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  17923. };
  17924. // Thread-local error code accessor for wolfSSL
  17925. inline uint64_t &wolfssl_last_error() {
  17926. static thread_local uint64_t err = 0;
  17927. return err;
  17928. }
  17929. // Helper to map wolfSSL error to ErrorCode.
  17930. // ssl_error is the value from wolfSSL_get_error().
  17931. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  17932. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  17933. int &out_errno) {
  17934. switch (ssl_error) {
  17935. case SSL_ERROR_NONE: return ErrorCode::Success;
  17936. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  17937. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  17938. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  17939. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  17940. default:
  17941. if (ssl) {
  17942. // wolfSSL stores the low-level error code as a negative value.
  17943. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  17944. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  17945. if (low_err == DOMAIN_NAME_MISMATCH) {
  17946. return ErrorCode::HostnameMismatch;
  17947. }
  17948. // Check verify result to distinguish cert verification from generic SSL
  17949. // errors.
  17950. long vr = wolfSSL_get_verify_result(ssl);
  17951. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  17952. }
  17953. return ErrorCode::Fatal;
  17954. }
  17955. }
  17956. // WolfSSLContext constructor/destructor implementations
  17957. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  17958. inline WolfSSLContext::~WolfSSLContext() {
  17959. if (ctx) { wolfSSL_CTX_free(ctx); }
  17960. }
  17961. // Thread-local storage for SNI captured during handshake
  17962. inline std::string &wolfssl_pending_sni() {
  17963. static thread_local std::string sni;
  17964. return sni;
  17965. }
  17966. // SNI callback for wolfSSL server to capture client's SNI hostname
  17967. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  17968. (void)ret;
  17969. (void)exArg;
  17970. void *name_data = nullptr;
  17971. unsigned short name_len =
  17972. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  17973. if (name_data && name_len > 0) {
  17974. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  17975. name_len);
  17976. } else {
  17977. wolfssl_pending_sni().clear();
  17978. }
  17979. return 0; // Continue regardless
  17980. }
  17981. // wolfSSL verify callback wrapper
  17982. inline int wolfssl_verify_callback(int preverify_ok,
  17983. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  17984. auto &callback = get_verify_callback();
  17985. if (!callback) { return preverify_ok; }
  17986. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  17987. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  17988. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  17989. // Get the WOLFSSL object from the X509_STORE_CTX
  17990. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  17991. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  17992. VerifyContext verify_ctx;
  17993. verify_ctx.session = static_cast<session_t>(ssl);
  17994. verify_ctx.cert = static_cast<cert_t>(cert);
  17995. verify_ctx.depth = depth;
  17996. verify_ctx.preverify_ok = (preverify_ok != 0);
  17997. verify_ctx.error_code = static_cast<long>(err);
  17998. if (err != 0) {
  17999. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18000. } else {
  18001. verify_ctx.error_string = nullptr;
  18002. }
  18003. bool accepted = callback(verify_ctx);
  18004. return accepted ? 1 : 0;
  18005. }
  18006. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18007. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18008. wolfSSL_CTX_set_default_passwd_cb(
  18009. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18010. auto *pwd = static_cast<const char *>(userdata);
  18011. if (!pwd) return 0;
  18012. auto len = static_cast<int>(strlen(pwd));
  18013. if (len > size) len = size;
  18014. memcpy(buf, pwd, static_cast<size_t>(len));
  18015. return len;
  18016. });
  18017. }
  18018. } // namespace impl
  18019. inline ctx_t create_client_context() {
  18020. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18021. if (!ctx) { return nullptr; }
  18022. ctx->is_server = false;
  18023. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18024. if (!method) {
  18025. delete ctx;
  18026. return nullptr;
  18027. }
  18028. ctx->ctx = wolfSSL_CTX_new(method);
  18029. if (!ctx->ctx) {
  18030. delete ctx;
  18031. return nullptr;
  18032. }
  18033. // Default: verify peer certificate
  18034. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18035. return static_cast<ctx_t>(ctx);
  18036. }
  18037. inline ctx_t create_server_context() {
  18038. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18039. if (!ctx) { return nullptr; }
  18040. ctx->is_server = true;
  18041. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18042. if (!method) {
  18043. delete ctx;
  18044. return nullptr;
  18045. }
  18046. ctx->ctx = wolfSSL_CTX_new(method);
  18047. if (!ctx->ctx) {
  18048. delete ctx;
  18049. return nullptr;
  18050. }
  18051. // Default: don't verify client
  18052. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18053. // Enable SNI on server
  18054. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18055. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18056. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18057. return static_cast<ctx_t>(ctx);
  18058. }
  18059. inline void free_context(ctx_t ctx) {
  18060. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18061. }
  18062. inline bool set_min_version(ctx_t ctx, Version version) {
  18063. if (!ctx) { return false; }
  18064. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18065. int min_ver = WOLFSSL_TLSV1_2;
  18066. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18067. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18068. }
  18069. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18070. if (!ctx || !pem) { return false; }
  18071. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18072. int ret = wolfSSL_CTX_load_verify_buffer(
  18073. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18074. static_cast<long>(len), SSL_FILETYPE_PEM);
  18075. if (ret != SSL_SUCCESS) {
  18076. impl::wolfssl_last_error() =
  18077. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18078. return false;
  18079. }
  18080. wctx->ca_pem_data_.append(pem, len);
  18081. return true;
  18082. }
  18083. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18084. if (!ctx || !file_path) { return false; }
  18085. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18086. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18087. if (ret != SSL_SUCCESS) {
  18088. impl::wolfssl_last_error() =
  18089. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18090. return false;
  18091. }
  18092. return true;
  18093. }
  18094. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18095. if (!ctx || !dir_path) { return false; }
  18096. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18097. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18098. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18099. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18100. // immediately. Return true even on failure since the CA file may have
  18101. // already been loaded, matching OpenSSL's lenient behavior.
  18102. (void)ret;
  18103. return true;
  18104. }
  18105. inline bool load_system_certs(ctx_t ctx) {
  18106. if (!ctx) { return false; }
  18107. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18108. bool loaded = false;
  18109. #ifdef _WIN32
  18110. loaded = impl::enumerate_windows_system_certs(
  18111. [&](const unsigned char *data, size_t len) {
  18112. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18113. static_cast<long>(len),
  18114. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18115. });
  18116. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18117. loaded = impl::enumerate_macos_keychain_certs(
  18118. [&](const unsigned char *data, size_t len) {
  18119. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18120. static_cast<long>(len),
  18121. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18122. });
  18123. #else
  18124. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18125. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18126. SSL_SUCCESS) {
  18127. loaded = true;
  18128. break;
  18129. }
  18130. }
  18131. if (!loaded) {
  18132. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18133. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18134. SSL_SUCCESS) {
  18135. loaded = true;
  18136. break;
  18137. }
  18138. }
  18139. }
  18140. #endif
  18141. return loaded;
  18142. }
  18143. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18144. const char *password) {
  18145. if (!ctx || !cert || !key) { return false; }
  18146. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18147. // Load certificate
  18148. int ret = wolfSSL_CTX_use_certificate_buffer(
  18149. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18150. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18151. if (ret != SSL_SUCCESS) {
  18152. impl::wolfssl_last_error() =
  18153. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18154. return false;
  18155. }
  18156. // Set password callback if password is provided
  18157. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18158. // Load private key
  18159. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18160. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18161. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18162. if (ret != SSL_SUCCESS) {
  18163. impl::wolfssl_last_error() =
  18164. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18165. return false;
  18166. }
  18167. // Verify that the certificate and private key match
  18168. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18169. }
  18170. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18171. const char *key_path, const char *password) {
  18172. if (!ctx || !cert_path || !key_path) { return false; }
  18173. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18174. // Load certificate file
  18175. int ret =
  18176. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18177. if (ret != SSL_SUCCESS) {
  18178. impl::wolfssl_last_error() =
  18179. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18180. return false;
  18181. }
  18182. // Set password callback if password is provided
  18183. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18184. // Load private key file
  18185. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18186. if (ret != SSL_SUCCESS) {
  18187. impl::wolfssl_last_error() =
  18188. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18189. return false;
  18190. }
  18191. // Verify that the certificate and private key match
  18192. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18193. }
  18194. inline void set_verify_client(ctx_t ctx, bool require) {
  18195. if (!ctx) { return; }
  18196. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18197. wctx->verify_client = require;
  18198. if (require) {
  18199. wolfSSL_CTX_set_verify(
  18200. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18201. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18202. } else {
  18203. if (wctx->has_verify_callback) {
  18204. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18205. impl::wolfssl_verify_callback);
  18206. } else {
  18207. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18208. }
  18209. }
  18210. }
  18211. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18212. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18213. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18214. auto session = new (std::nothrow) impl::WolfSSLSession();
  18215. if (!session) { return nullptr; }
  18216. session->sock = sock;
  18217. session->ssl = wolfSSL_new(wctx->ctx);
  18218. if (!session->ssl) {
  18219. impl::wolfssl_last_error() =
  18220. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18221. delete session;
  18222. return nullptr;
  18223. }
  18224. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18225. return static_cast<session_t>(session);
  18226. }
  18227. inline void free_session(session_t session) {
  18228. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18229. }
  18230. inline bool set_sni(session_t session, const char *hostname,
  18231. bool verify_hostname) {
  18232. if (!session || !hostname) { return false; }
  18233. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18234. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18235. static_cast<word16>(strlen(hostname)));
  18236. if (ret != WOLFSSL_SUCCESS) {
  18237. impl::wolfssl_last_error() =
  18238. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18239. return false;
  18240. }
  18241. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18242. // separately from the SNI extension sent above; skip it when hostname
  18243. // verification is disabled so only the chain is checked, matching OpenSSL.
  18244. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18245. wsession->hostname = hostname;
  18246. return true;
  18247. }
  18248. inline TlsError connect(session_t session) {
  18249. TlsError err;
  18250. if (!session) {
  18251. err.code = ErrorCode::Fatal;
  18252. return err;
  18253. }
  18254. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18255. int ret = wolfSSL_connect(wsession->ssl);
  18256. if (ret == SSL_SUCCESS) {
  18257. err.code = ErrorCode::Success;
  18258. } else {
  18259. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18260. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18261. err.backend_code = static_cast<uint64_t>(ssl_error);
  18262. impl::wolfssl_last_error() = err.backend_code;
  18263. }
  18264. return err;
  18265. }
  18266. inline TlsError accept(session_t session) {
  18267. TlsError err;
  18268. if (!session) {
  18269. err.code = ErrorCode::Fatal;
  18270. return err;
  18271. }
  18272. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18273. int ret = wolfSSL_accept(wsession->ssl);
  18274. if (ret == SSL_SUCCESS) {
  18275. err.code = ErrorCode::Success;
  18276. // Capture SNI from thread-local storage after successful handshake
  18277. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18278. impl::wolfssl_pending_sni().clear();
  18279. } else {
  18280. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18281. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18282. err.backend_code = static_cast<uint64_t>(ssl_error);
  18283. impl::wolfssl_last_error() = err.backend_code;
  18284. }
  18285. return err;
  18286. }
  18287. inline bool connect_nonblocking(session_t session, socket_t sock,
  18288. time_t timeout_sec, time_t timeout_usec,
  18289. TlsError *err) {
  18290. if (!session) {
  18291. if (err) { err->code = ErrorCode::Fatal; }
  18292. return false;
  18293. }
  18294. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18295. // Set socket to non-blocking mode
  18296. detail::set_nonblocking(sock, true);
  18297. auto cleanup =
  18298. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18299. int ret;
  18300. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18301. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18302. if (ssl_error == SSL_ERROR_WANT_READ) {
  18303. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18304. continue;
  18305. }
  18306. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18307. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18308. continue;
  18309. }
  18310. }
  18311. // Error or timeout
  18312. if (err) {
  18313. err->code =
  18314. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18315. err->backend_code = static_cast<uint64_t>(ssl_error);
  18316. }
  18317. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18318. return false;
  18319. }
  18320. if (err) { err->code = ErrorCode::Success; }
  18321. return true;
  18322. }
  18323. inline bool accept_nonblocking(session_t session, socket_t sock,
  18324. time_t timeout_sec, time_t timeout_usec,
  18325. TlsError *err) {
  18326. if (!session) {
  18327. if (err) { err->code = ErrorCode::Fatal; }
  18328. return false;
  18329. }
  18330. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18331. // Set socket to non-blocking mode
  18332. detail::set_nonblocking(sock, true);
  18333. auto cleanup =
  18334. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18335. int ret;
  18336. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18337. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18338. if (ssl_error == SSL_ERROR_WANT_READ) {
  18339. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18340. continue;
  18341. }
  18342. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18343. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18344. continue;
  18345. }
  18346. }
  18347. // Error or timeout
  18348. if (err) {
  18349. err->code =
  18350. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18351. err->backend_code = static_cast<uint64_t>(ssl_error);
  18352. }
  18353. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18354. return false;
  18355. }
  18356. if (err) { err->code = ErrorCode::Success; }
  18357. // Capture SNI from thread-local storage after successful handshake
  18358. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18359. impl::wolfssl_pending_sni().clear();
  18360. return true;
  18361. }
  18362. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18363. if (!session || !buf) {
  18364. err.code = ErrorCode::Fatal;
  18365. return -1;
  18366. }
  18367. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18368. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18369. if (ret > 0) {
  18370. err.code = ErrorCode::Success;
  18371. return static_cast<ssize_t>(ret);
  18372. }
  18373. if (ret == 0) {
  18374. err.code = ErrorCode::PeerClosed;
  18375. return 0;
  18376. }
  18377. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18378. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18379. err.backend_code = static_cast<uint64_t>(ssl_error);
  18380. impl::wolfssl_last_error() = err.backend_code;
  18381. return -1;
  18382. }
  18383. inline ssize_t write(session_t session, const void *buf, size_t len,
  18384. TlsError &err) {
  18385. if (!session || !buf) {
  18386. err.code = ErrorCode::Fatal;
  18387. return -1;
  18388. }
  18389. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18390. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18391. if (ret > 0) {
  18392. err.code = ErrorCode::Success;
  18393. return static_cast<ssize_t>(ret);
  18394. }
  18395. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18396. // Treat this as an error (return -1) so callers don't spin in a
  18397. // write loop adding zero to the offset.
  18398. if (ret == 0) {
  18399. err.code = ErrorCode::PeerClosed;
  18400. return -1;
  18401. }
  18402. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18403. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18404. err.backend_code = static_cast<uint64_t>(ssl_error);
  18405. impl::wolfssl_last_error() = err.backend_code;
  18406. return -1;
  18407. }
  18408. inline int pending(const_session_t session) {
  18409. if (!session) { return 0; }
  18410. auto wsession =
  18411. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18412. return wolfSSL_pending(wsession->ssl);
  18413. }
  18414. inline void shutdown(session_t session, bool graceful) {
  18415. if (!session) { return; }
  18416. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18417. if (graceful) {
  18418. int ret;
  18419. int attempts = 0;
  18420. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18421. attempts < 3) {
  18422. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18423. if (ssl_error != SSL_ERROR_WANT_READ &&
  18424. ssl_error != SSL_ERROR_WANT_WRITE) {
  18425. break;
  18426. }
  18427. attempts++;
  18428. }
  18429. } else {
  18430. wolfSSL_shutdown(wsession->ssl);
  18431. }
  18432. }
  18433. inline bool is_peer_closed(session_t session, socket_t sock) {
  18434. if (!session || sock == INVALID_SOCKET) { return true; }
  18435. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18436. // Check if there's already decrypted data available
  18437. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18438. // Set socket to non-blocking to avoid blocking on read
  18439. detail::set_nonblocking(sock, true);
  18440. auto cleanup =
  18441. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18442. // Peek 1 byte to check connection status without consuming data
  18443. unsigned char buf;
  18444. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18445. // If we got data or WANT_READ (would block), connection is alive
  18446. if (ret > 0) { return false; }
  18447. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18448. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18449. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18450. ret == 0;
  18451. }
  18452. inline cert_t get_peer_cert(const_session_t session) {
  18453. if (!session) { return nullptr; }
  18454. auto wsession =
  18455. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18456. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18457. return static_cast<cert_t>(cert);
  18458. }
  18459. inline void free_cert(cert_t cert) {
  18460. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18461. }
  18462. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18463. if (!cert || !hostname) { return false; }
  18464. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18465. std::string host_str(hostname);
  18466. // Check if hostname is an IP address (IPv4 or IPv6)
  18467. unsigned char ip_bytes[16];
  18468. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18469. auto is_ip = ip_len > 0;
  18470. // Check Subject Alternative Names
  18471. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18472. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18473. if (san_names) {
  18474. int san_count = wolfSSL_sk_num(san_names);
  18475. for (int i = 0; i < san_count; i++) {
  18476. auto *names =
  18477. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18478. if (!names) continue;
  18479. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18480. // DNS name
  18481. unsigned char *dns_name = nullptr;
  18482. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18483. if (dns_name && dns_len > 0) {
  18484. std::string san_name(reinterpret_cast<char *>(dns_name),
  18485. static_cast<size_t>(dns_len));
  18486. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18487. if (detail::match_hostname(san_name, host_str)) {
  18488. wolfSSL_sk_free(san_names);
  18489. return true;
  18490. }
  18491. }
  18492. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18493. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18494. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18495. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18496. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18497. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18498. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18499. wolfSSL_sk_free(san_names);
  18500. return true;
  18501. }
  18502. }
  18503. }
  18504. wolfSSL_sk_free(san_names);
  18505. }
  18506. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18507. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18508. // the OpenSSL backend's X509_check_ip behaves the same way).
  18509. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18510. if (subject) {
  18511. char cn[256] = {};
  18512. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18513. sizeof(cn));
  18514. if (cn_len > 0) {
  18515. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18516. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18517. }
  18518. }
  18519. return false;
  18520. }
  18521. inline uint64_t hostname_mismatch_code() {
  18522. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18523. }
  18524. inline long get_verify_result(const_session_t session) {
  18525. if (!session) { return -1; }
  18526. auto wsession =
  18527. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18528. long result = wolfSSL_get_verify_result(wsession->ssl);
  18529. return result;
  18530. }
  18531. inline std::string get_cert_subject_cn(cert_t cert) {
  18532. if (!cert) return "";
  18533. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18534. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18535. if (!subject) return "";
  18536. char cn[256] = {};
  18537. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18538. sizeof(cn));
  18539. if (cn_len <= 0) return "";
  18540. return std::string(cn, static_cast<size_t>(cn_len));
  18541. }
  18542. inline std::string get_cert_issuer_name(cert_t cert) {
  18543. if (!cert) return "";
  18544. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18545. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18546. if (!issuer) return "";
  18547. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18548. if (!name_str) return "";
  18549. std::string result(name_str);
  18550. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18551. return result;
  18552. }
  18553. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18554. sans.clear();
  18555. if (!cert) return false;
  18556. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18557. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18558. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18559. if (!san_names) return true; // No SANs is not an error
  18560. int count = wolfSSL_sk_num(san_names);
  18561. for (int i = 0; i < count; i++) {
  18562. auto *name =
  18563. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18564. if (!name) continue;
  18565. SanEntry entry;
  18566. switch (name->type) {
  18567. case WOLFSSL_GEN_DNS: {
  18568. entry.type = SanType::DNS;
  18569. unsigned char *dns_name = nullptr;
  18570. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18571. if (dns_name && dns_len > 0) {
  18572. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18573. static_cast<size_t>(dns_len));
  18574. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18575. }
  18576. break;
  18577. }
  18578. case WOLFSSL_GEN_IPADD: {
  18579. entry.type = SanType::IP;
  18580. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18581. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18582. if (ip_data && ip_len == 4) {
  18583. char buf[16];
  18584. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18585. ip_data[2], ip_data[3]);
  18586. entry.value = buf;
  18587. } else if (ip_data && ip_len == 16) {
  18588. char buf[64];
  18589. snprintf(buf, sizeof(buf),
  18590. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18591. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18592. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18593. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18594. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18595. ip_data[14], ip_data[15]);
  18596. entry.value = buf;
  18597. }
  18598. break;
  18599. }
  18600. case WOLFSSL_GEN_EMAIL:
  18601. entry.type = SanType::EMAIL;
  18602. {
  18603. unsigned char *email = nullptr;
  18604. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18605. if (email && email_len > 0) {
  18606. entry.value = std::string(reinterpret_cast<char *>(email),
  18607. static_cast<size_t>(email_len));
  18608. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18609. }
  18610. }
  18611. break;
  18612. case WOLFSSL_GEN_URI:
  18613. entry.type = SanType::URI;
  18614. {
  18615. unsigned char *uri = nullptr;
  18616. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18617. &uri, name->d.uniformResourceIdentifier);
  18618. if (uri && uri_len > 0) {
  18619. entry.value = std::string(reinterpret_cast<char *>(uri),
  18620. static_cast<size_t>(uri_len));
  18621. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18622. }
  18623. }
  18624. break;
  18625. default: entry.type = SanType::OTHER; break;
  18626. }
  18627. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18628. }
  18629. wolfSSL_sk_free(san_names);
  18630. return true;
  18631. }
  18632. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18633. time_t &not_after) {
  18634. if (!cert) return false;
  18635. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18636. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18637. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18638. if (!nb || !na) return false;
  18639. // wolfSSL_ASN1_TIME_to_tm is available
  18640. struct tm tm_nb = {}, tm_na = {};
  18641. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18642. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18643. #ifdef _WIN32
  18644. not_before = _mkgmtime(&tm_nb);
  18645. not_after = _mkgmtime(&tm_na);
  18646. #else
  18647. not_before = timegm(&tm_nb);
  18648. not_after = timegm(&tm_na);
  18649. #endif
  18650. return true;
  18651. }
  18652. inline std::string get_cert_serial(cert_t cert) {
  18653. if (!cert) return "";
  18654. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18655. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18656. if (!serial_asn1) return "";
  18657. // Get the serial number data
  18658. int len = serial_asn1->length;
  18659. unsigned char *data = serial_asn1->data;
  18660. if (!data || len <= 0) return "";
  18661. std::string result;
  18662. result.reserve(static_cast<size_t>(len) * 2);
  18663. for (int i = 0; i < len; i++) {
  18664. char hex[3];
  18665. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18666. result += hex;
  18667. }
  18668. return result;
  18669. }
  18670. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18671. if (!cert) return false;
  18672. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18673. int der_len = 0;
  18674. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18675. if (!der_data || der_len <= 0) return false;
  18676. der.assign(der_data, der_data + der_len);
  18677. return true;
  18678. }
  18679. inline const char *get_sni(const_session_t session) {
  18680. if (!session) return nullptr;
  18681. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18682. // For server: return SNI received from client during handshake
  18683. if (!wsession->sni_hostname.empty()) {
  18684. return wsession->sni_hostname.c_str();
  18685. }
  18686. // For client: return the hostname set via set_sni
  18687. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18688. return nullptr;
  18689. }
  18690. inline uint64_t peek_error() {
  18691. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18692. }
  18693. inline uint64_t get_error() {
  18694. uint64_t err = impl::wolfssl_last_error();
  18695. impl::wolfssl_last_error() = 0;
  18696. return err;
  18697. }
  18698. inline std::string error_string(uint64_t code) {
  18699. char buf[256];
  18700. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18701. return std::string(buf);
  18702. }
  18703. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18704. if (!pem || len == 0) { return nullptr; }
  18705. // Validate by attempting to load into a temporary ctx
  18706. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18707. if (!tmp_ctx) { return nullptr; }
  18708. int ret = wolfSSL_CTX_load_verify_buffer(
  18709. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18710. static_cast<long>(len), SSL_FILETYPE_PEM);
  18711. wolfSSL_CTX_free(tmp_ctx);
  18712. if (ret != SSL_SUCCESS) { return nullptr; }
  18713. return static_cast<ca_store_t>(
  18714. new impl::WolfSSLCAStore{std::string(pem, len)});
  18715. }
  18716. inline void free_ca_store(ca_store_t store) {
  18717. delete static_cast<impl::WolfSSLCAStore *>(store);
  18718. }
  18719. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18720. if (!ctx || !store) { return false; }
  18721. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18722. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18723. int ret = wolfSSL_CTX_load_verify_buffer(
  18724. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18725. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18726. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18727. // This function takes ownership of the store; the PEM data was copied into
  18728. // the context, so release the source
  18729. free_ca_store(store);
  18730. return ret == SSL_SUCCESS;
  18731. }
  18732. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18733. certs.clear();
  18734. if (!ctx) { return 0; }
  18735. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18736. if (wctx->ca_pem_data_.empty()) { return 0; }
  18737. const std::string &pem = wctx->ca_pem_data_;
  18738. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18739. const std::string end_marker = "-----END CERTIFICATE-----";
  18740. size_t pos = 0;
  18741. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18742. size_t end_pos = pem.find(end_marker, pos);
  18743. if (end_pos == std::string::npos) { break; }
  18744. end_pos += end_marker.size();
  18745. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18746. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18747. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18748. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18749. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18750. pos = end_pos;
  18751. }
  18752. return certs.size();
  18753. }
  18754. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18755. std::vector<std::string> names;
  18756. if (!ctx) { return names; }
  18757. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18758. if (wctx->ca_pem_data_.empty()) { return names; }
  18759. const std::string &pem = wctx->ca_pem_data_;
  18760. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18761. const std::string end_marker = "-----END CERTIFICATE-----";
  18762. size_t pos = 0;
  18763. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18764. size_t end_pos = pem.find(end_marker, pos);
  18765. if (end_pos == std::string::npos) { break; }
  18766. end_pos += end_marker.size();
  18767. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18768. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18769. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18770. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18771. if (x509) {
  18772. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18773. if (subject) {
  18774. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  18775. if (name_str) {
  18776. names.push_back(name_str);
  18777. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18778. }
  18779. }
  18780. wolfSSL_X509_free(x509);
  18781. }
  18782. pos = end_pos;
  18783. }
  18784. return names;
  18785. }
  18786. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18787. const char *key_pem, const char *password) {
  18788. if (!ctx || !cert_pem || !key_pem) { return false; }
  18789. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18790. // Load new certificate
  18791. int ret = wolfSSL_CTX_use_certificate_buffer(
  18792. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  18793. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  18794. if (ret != SSL_SUCCESS) {
  18795. impl::wolfssl_last_error() =
  18796. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18797. return false;
  18798. }
  18799. // Set password if provided
  18800. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18801. // Load new private key
  18802. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18803. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  18804. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  18805. if (ret != SSL_SUCCESS) {
  18806. impl::wolfssl_last_error() =
  18807. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18808. return false;
  18809. }
  18810. return true;
  18811. }
  18812. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18813. if (!ctx || !ca_pem) { return false; }
  18814. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18815. int ret = wolfSSL_CTX_load_verify_buffer(
  18816. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  18817. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  18818. if (ret != SSL_SUCCESS) {
  18819. impl::wolfssl_last_error() =
  18820. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18821. return false;
  18822. }
  18823. return true;
  18824. }
  18825. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18826. if (!ctx) { return false; }
  18827. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18828. impl::get_verify_callback() = std::move(callback);
  18829. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  18830. if (wctx->has_verify_callback) {
  18831. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18832. impl::wolfssl_verify_callback);
  18833. } else {
  18834. wolfSSL_CTX_set_verify(
  18835. wctx->ctx,
  18836. wctx->verify_client
  18837. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  18838. : SSL_VERIFY_NONE,
  18839. nullptr);
  18840. }
  18841. return true;
  18842. }
  18843. inline long get_verify_error(const_session_t session) {
  18844. if (!session) { return -1; }
  18845. auto *wsession =
  18846. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18847. return wolfSSL_get_verify_result(wsession->ssl);
  18848. }
  18849. inline std::string verify_error_string(long error_code) {
  18850. if (error_code == 0) { return ""; }
  18851. const char *str =
  18852. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  18853. return str ? std::string(str) : std::string();
  18854. }
  18855. } // namespace tls
  18856. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  18857. // WebSocket implementation
  18858. namespace ws {
  18859. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  18860. bool fin) {
  18861. std::lock_guard<std::mutex> lock(write_mutex_);
  18862. if (closed_) { return false; }
  18863. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  18864. }
  18865. inline ReadResult WebSocket::read(std::string &msg) {
  18866. std::unique_lock<std::mutex> read_lock(read_mutex_);
  18867. while (!closed_) {
  18868. Opcode opcode;
  18869. std::string payload;
  18870. bool fin;
  18871. if (!impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  18872. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)) {
  18873. closed_ = true;
  18874. return Fail;
  18875. }
  18876. switch (opcode) {
  18877. case Opcode::Ping: {
  18878. std::lock_guard<std::mutex> lock(write_mutex_);
  18879. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  18880. payload.size(), true, !is_server_);
  18881. continue;
  18882. }
  18883. case Opcode::Pong: {
  18884. std::lock_guard<std::mutex> lock(ping_mutex_);
  18885. unacked_pings_ = 0;
  18886. continue;
  18887. }
  18888. case Opcode::Close: {
  18889. if (!closed_.exchange(true)) {
  18890. // Echo close frame back
  18891. std::lock_guard<std::mutex> lock(write_mutex_);
  18892. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18893. payload.size(), true, !is_server_);
  18894. }
  18895. return Fail;
  18896. }
  18897. case Opcode::Text:
  18898. case Opcode::Binary: {
  18899. auto result = opcode == Opcode::Text ? Text : Binary;
  18900. msg = std::move(payload);
  18901. // Handle fragmentation
  18902. if (!fin) {
  18903. while (true) {
  18904. Opcode cont_opcode;
  18905. std::string cont_payload;
  18906. bool cont_fin;
  18907. if (!impl::read_websocket_frame(
  18908. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  18909. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH)) {
  18910. closed_ = true;
  18911. return Fail;
  18912. }
  18913. if (cont_opcode == Opcode::Ping) {
  18914. std::lock_guard<std::mutex> lock(write_mutex_);
  18915. detail::write_websocket_frame(
  18916. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  18917. true, !is_server_);
  18918. continue;
  18919. }
  18920. if (cont_opcode == Opcode::Pong) {
  18921. std::lock_guard<std::mutex> lock(ping_mutex_);
  18922. unacked_pings_ = 0;
  18923. continue;
  18924. }
  18925. if (cont_opcode == Opcode::Close) {
  18926. if (!closed_.exchange(true)) {
  18927. std::lock_guard<std::mutex> lock(write_mutex_);
  18928. detail::write_websocket_frame(
  18929. strm_, Opcode::Close, cont_payload.data(),
  18930. cont_payload.size(), true, !is_server_);
  18931. }
  18932. return Fail;
  18933. }
  18934. // RFC 6455: continuation frames must use opcode 0x0
  18935. if (cont_opcode != Opcode::Continuation) {
  18936. closed_ = true;
  18937. return Fail;
  18938. }
  18939. msg += cont_payload;
  18940. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  18941. closed_ = true;
  18942. return Fail;
  18943. }
  18944. if (cont_fin) { break; }
  18945. }
  18946. }
  18947. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  18948. if (result == Text && !impl::is_valid_utf8(msg)) {
  18949. // close() takes the read lock to wait for the peer's Close reply, so
  18950. // it must not run while this thread still holds it.
  18951. read_lock.unlock();
  18952. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  18953. return Fail;
  18954. }
  18955. return result;
  18956. }
  18957. default: closed_ = true; return Fail;
  18958. }
  18959. }
  18960. return Fail;
  18961. }
  18962. inline bool WebSocket::send(const std::string &data) {
  18963. return send_frame(Opcode::Text, data.data(), data.size());
  18964. }
  18965. inline bool WebSocket::send(const char *data, size_t len) {
  18966. return send_frame(Opcode::Binary, data, len);
  18967. }
  18968. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  18969. if (closed_.exchange(true)) { return; }
  18970. ping_cv_.notify_all();
  18971. std::string payload;
  18972. auto code = static_cast<uint16_t>(status);
  18973. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  18974. payload.push_back(static_cast<char>(code & 0xFF));
  18975. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  18976. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  18977. payload += reason.substr(0, 123);
  18978. {
  18979. std::lock_guard<std::mutex> lock(write_mutex_);
  18980. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  18981. payload.size(), true, !is_server_);
  18982. }
  18983. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  18984. // Close response before closing the TCP connection.
  18985. //
  18986. // Wait only when no other thread is parsing frames. When one is, it is the
  18987. // thread positioned to see the peer's reply, and reading here would take
  18988. // bytes out of the message it is assembling. Bailing out also leaves the
  18989. // stream, including its read timeout, entirely to that thread.
  18990. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  18991. if (!read_lock.owns_lock()) { return; }
  18992. // Use a short timeout to avoid hanging if the peer doesn't respond.
  18993. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  18994. Opcode op;
  18995. std::string resp;
  18996. bool fin;
  18997. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125)) {
  18998. if (op == Opcode::Close) { break; }
  18999. }
  19000. }
  19001. inline WebSocket::~WebSocket() {
  19002. {
  19003. std::lock_guard<std::mutex> lock(ping_mutex_);
  19004. closed_ = true;
  19005. }
  19006. ping_cv_.notify_all();
  19007. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19008. }
  19009. inline void WebSocket::start_heartbeat() {
  19010. if (ping_interval_sec_ == 0) { return; }
  19011. ping_thread_ = std::thread([this]() {
  19012. std::unique_lock<std::mutex> lock(ping_mutex_);
  19013. while (!closed_) {
  19014. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19015. if (closed_) { break; }
  19016. // If the peer has failed to respond to the previous pings, give up.
  19017. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19018. // opt-in liveness check controlled by max_missed_pongs_.
  19019. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19020. lock.unlock();
  19021. close(CloseStatus::GoingAway, "pong timeout");
  19022. return;
  19023. }
  19024. lock.unlock();
  19025. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19026. lock.lock();
  19027. closed_ = true;
  19028. break;
  19029. }
  19030. lock.lock();
  19031. unacked_pings_++;
  19032. }
  19033. });
  19034. }
  19035. inline const Request &WebSocket::request() const { return req_; }
  19036. inline bool WebSocket::is_open() const { return !closed_; }
  19037. // WebSocketClient implementation
  19038. inline WebSocketClient::WebSocketClient(
  19039. const std::string &scheme_host_port_path, const Headers &headers)
  19040. : headers_(headers) {
  19041. detail::UrlComponents uc;
  19042. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19043. !uc.host.empty() && !uc.path.empty()) {
  19044. auto &scheme = uc.scheme;
  19045. #ifdef CPPHTTPLIB_SSL_ENABLED
  19046. if (scheme != "ws" && scheme != "wss") {
  19047. #else
  19048. if (scheme != "ws") {
  19049. #endif
  19050. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19051. std::string msg = "'" + scheme + "' scheme is not supported.";
  19052. throw std::invalid_argument(msg);
  19053. #endif
  19054. return;
  19055. }
  19056. auto is_ssl = scheme == "wss";
  19057. host_ = std::move(uc.host);
  19058. port_ = is_ssl ? 443 : 80;
  19059. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19060. path_ = std::move(uc.path);
  19061. if (!uc.query.empty()) { path_ += uc.query; }
  19062. #ifdef CPPHTTPLIB_SSL_ENABLED
  19063. is_ssl_ = is_ssl;
  19064. if (is_ssl_) {
  19065. // The context lives as long as the client so that CA configuration
  19066. // survives reconnects; sessions are created per connection.
  19067. tls_ctx_ = tls::create_client_context();
  19068. if (!tls_ctx_) { return; }
  19069. }
  19070. #else
  19071. if (is_ssl) { return; }
  19072. #endif
  19073. is_valid_ = true;
  19074. }
  19075. }
  19076. #ifdef CPPHTTPLIB_SSL_ENABLED
  19077. inline WebSocketClient::WebSocketClient(
  19078. const std::string &scheme_host_port_path, const PemMemory &pem,
  19079. const Headers &headers)
  19080. : WebSocketClient(scheme_host_port_path, headers) {
  19081. // For ws:// URLs the client certificate is silently ignored, consistent
  19082. // with the TLS-only setters such as set_ca_cert_path().
  19083. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19084. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19085. pem.private_key_password)) {
  19086. tls::free_context(tls_ctx_);
  19087. tls_ctx_ = nullptr;
  19088. is_valid_ = false;
  19089. }
  19090. }
  19091. }
  19092. #endif
  19093. inline WebSocketClient::~WebSocketClient() {
  19094. shutdown_and_close();
  19095. #ifdef CPPHTTPLIB_SSL_ENABLED
  19096. if (tls_ctx_) {
  19097. tls::free_context(tls_ctx_);
  19098. tls_ctx_ = nullptr;
  19099. }
  19100. #endif
  19101. }
  19102. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19103. inline void WebSocketClient::shutdown_and_close() {
  19104. // Send the close frame while the TLS session is still alive: ws_ holds an
  19105. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19106. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19107. if (ws_ && ws_->is_open()) { ws_->close(); }
  19108. ws_.reset();
  19109. #ifdef CPPHTTPLIB_SSL_ENABLED
  19110. if (is_ssl_) {
  19111. if (tls_session_) {
  19112. tls::shutdown(tls_session_, true);
  19113. tls::free_session(tls_session_);
  19114. tls_session_ = nullptr;
  19115. }
  19116. }
  19117. #endif
  19118. if (sock_ != INVALID_SOCKET) {
  19119. detail::shutdown_socket(sock_);
  19120. detail::close_socket(sock_);
  19121. sock_ = INVALID_SOCKET;
  19122. }
  19123. }
  19124. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19125. Error &error, int &ssl_error,
  19126. uint64_t &ssl_backend_error) {
  19127. #ifdef CPPHTTPLIB_SSL_ENABLED
  19128. if (is_ssl_) {
  19129. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19130. // is not safe to call concurrently on one client to begin with, since
  19131. // nothing else here is guarded either.
  19132. if (server_certificate_verification_ && !certs_loaded_) {
  19133. uint64_t backend_error = 0;
  19134. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19135. ca_cert_dir_path_, custom_ca_loaded_,
  19136. system_ca_mode_, backend_error);
  19137. certs_loaded_ = true;
  19138. }
  19139. detail::ClientTlsSessionOptions options;
  19140. options.server_hostname_verification = server_hostname_verification_;
  19141. detail::ClientTlsSessionError tls_error;
  19142. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19143. server_certificate_verification_,
  19144. read_timeout_sec_, read_timeout_usec_,
  19145. &tls_error, options)) {
  19146. error = tls_error.error;
  19147. ssl_error = tls_error.ssl_error;
  19148. ssl_backend_error = tls_error.backend_error;
  19149. return false;
  19150. }
  19151. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19152. sock_, tls_session_, read_timeout_sec_, read_timeout_usec_,
  19153. write_timeout_sec_, write_timeout_usec_));
  19154. return true;
  19155. }
  19156. #else
  19157. (void)error;
  19158. (void)ssl_error;
  19159. (void)ssl_backend_error;
  19160. #endif
  19161. strm = std::unique_ptr<Stream>(
  19162. new detail::SocketStream(sock_, read_timeout_sec_, read_timeout_usec_,
  19163. write_timeout_sec_, write_timeout_usec_));
  19164. return true;
  19165. }
  19166. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19167. #ifdef CPPHTTPLIB_SSL_ENABLED
  19168. auto is_ssl = is_ssl_;
  19169. #else
  19170. auto is_ssl = false;
  19171. #endif
  19172. if (!req.has_header("Host")) {
  19173. req.headers.emplace("Host", detail::make_default_host_header_value(
  19174. host_, port_, is_ssl, address_family_));
  19175. }
  19176. detail::add_default_user_agent_header(req);
  19177. }
  19178. inline Result WebSocketClient::connect() {
  19179. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19180. shutdown_and_close();
  19181. // Check is custom IP or hostname specified for host_
  19182. std::string connect_host;
  19183. std::string ip;
  19184. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19185. auto error = Error::Success;
  19186. sock_ = detail::create_client_socket(
  19187. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19188. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19189. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19190. write_timeout_usec_, interface_, error);
  19191. if (sock_ == INVALID_SOCKET) {
  19192. if (error == Error::Success) { error = Error::Connection; }
  19193. return Result{error, -1, Headers{}};
  19194. }
  19195. std::unique_ptr<Stream> strm;
  19196. auto stream_error = Error::SSLConnection;
  19197. int ssl_error = 0;
  19198. uint64_t ssl_backend_error = 0;
  19199. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19200. shutdown_and_close();
  19201. #ifdef CPPHTTPLIB_SSL_ENABLED
  19202. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19203. #else
  19204. return Result{stream_error, -1, Headers{}};
  19205. #endif
  19206. }
  19207. Request req;
  19208. req.method = "GET";
  19209. req.path = path_;
  19210. req.headers = headers_;
  19211. prepare_default_headers(req);
  19212. detail::WebSocketUpgradeResponse upgrade;
  19213. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19214. shutdown_and_close();
  19215. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19216. }
  19217. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19218. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19219. websocket_ping_interval_sec_,
  19220. websocket_max_missed_pongs_));
  19221. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19222. }
  19223. inline ReadResult WebSocketClient::read(std::string &msg) {
  19224. if (!ws_) { return Fail; }
  19225. return ws_->read(msg);
  19226. }
  19227. inline bool WebSocketClient::send(const std::string &data) {
  19228. if (!ws_) { return false; }
  19229. return ws_->send(data);
  19230. }
  19231. inline bool WebSocketClient::send(const char *data, size_t len) {
  19232. if (!ws_) { return false; }
  19233. return ws_->send(data, len);
  19234. }
  19235. inline void WebSocketClient::close(CloseStatus status,
  19236. const std::string &reason) {
  19237. if (ws_) { ws_->close(status, reason); }
  19238. }
  19239. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19240. inline const std::string &WebSocketClient::subprotocol() const {
  19241. return subprotocol_;
  19242. }
  19243. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19244. read_timeout_sec_ = sec;
  19245. read_timeout_usec_ = usec;
  19246. }
  19247. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19248. write_timeout_sec_ = sec;
  19249. write_timeout_usec_ = usec;
  19250. }
  19251. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19252. websocket_ping_interval_sec_ = sec;
  19253. }
  19254. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19255. websocket_max_missed_pongs_ = count;
  19256. }
  19257. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19258. inline void WebSocketClient::set_address_family(int family) {
  19259. address_family_ = family;
  19260. }
  19261. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19262. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19263. socket_options_ = std::move(socket_options);
  19264. }
  19265. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19266. connection_timeout_sec_ = sec;
  19267. connection_timeout_usec_ = usec;
  19268. }
  19269. inline void WebSocketClient::set_interface(const std::string &intf) {
  19270. interface_ = intf;
  19271. }
  19272. inline void WebSocketClient::set_hostname_addr_map(
  19273. std::map<std::string, std::string> addr_map) {
  19274. addr_map_ = std::move(addr_map);
  19275. }
  19276. #ifdef CPPHTTPLIB_SSL_ENABLED
  19277. inline void
  19278. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19279. const std::string &ca_cert_dir_path) {
  19280. ca_cert_file_path_ = ca_cert_file_path;
  19281. ca_cert_dir_path_ = ca_cert_dir_path;
  19282. }
  19283. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19284. if (store && tls_ctx_) {
  19285. // set_ca_store takes ownership of store
  19286. tls::set_ca_store(tls_ctx_, store);
  19287. custom_ca_loaded_ = true;
  19288. } else if (store) {
  19289. tls::free_ca_store(store);
  19290. }
  19291. }
  19292. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19293. std::size_t size) {
  19294. if (tls_ctx_ && ca_cert && size > 0) {
  19295. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19296. custom_ca_loaded_ = true;
  19297. }
  19298. }
  19299. inline void
  19300. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19301. server_certificate_verification_ = enabled;
  19302. }
  19303. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19304. server_hostname_verification_ = enabled;
  19305. }
  19306. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19307. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19308. }
  19309. #endif // CPPHTTPLIB_SSL_ENABLED
  19310. } // namespace ws
  19311. // ----------------------------------------------------------------------------
  19312. } // namespace httplib
  19313. #endif // CPPHTTPLIB_HTTPLIB_H