httplib.h 781 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956
  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.57.1"
  10. #define CPPHTTPLIB_VERSION_NUM "0x003901"
  11. #ifdef _WIN32
  12. #if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0A00
  13. #error \
  14. "cpp-httplib doesn't support Windows 8 or lower. Please use Windows 10 or later."
  15. #endif
  16. #endif
  17. /*
  18. * Configuration
  19. */
  20. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND
  21. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND 5
  22. #endif
  23. #ifndef CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND
  24. #define CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND 10000
  25. #endif
  26. #ifndef CPPHTTPLIB_KEEPALIVE_MAX_COUNT
  27. #define CPPHTTPLIB_KEEPALIVE_MAX_COUNT 100
  28. #endif
  29. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND
  30. #define CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND 300
  31. #endif
  32. #ifndef CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND
  33. #define CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND 0
  34. #endif
  35. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND
  36. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND 5
  37. #endif
  38. #ifndef CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND
  39. #define CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND 0
  40. #endif
  41. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND
  42. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND 5
  43. #endif
  44. #ifndef CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND
  45. #define CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND 0
  46. #endif
  47. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND
  48. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND 300
  49. #endif
  50. #ifndef CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND
  51. #define CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND 0
  52. #endif
  53. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND
  54. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND 5
  55. #endif
  56. #ifndef CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND
  57. #define CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND 0
  58. #endif
  59. #ifndef CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND
  60. #define CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND 0
  61. #endif
  62. #ifndef CPPHTTPLIB_EXPECT_100_THRESHOLD
  63. #define CPPHTTPLIB_EXPECT_100_THRESHOLD 1024
  64. #endif
  65. #ifndef CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND
  66. #define CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND 1000
  67. #endif
  68. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD
  69. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD (1024 * 1024)
  70. #endif
  71. #ifndef CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND
  72. #define CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND 50
  73. #endif
  74. #ifndef CPPHTTPLIB_IDLE_INTERVAL_SECOND
  75. #define CPPHTTPLIB_IDLE_INTERVAL_SECOND 0
  76. #endif
  77. #ifndef CPPHTTPLIB_IDLE_INTERVAL_USECOND
  78. #ifdef _WIN32
  79. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 1000
  80. #else
  81. #define CPPHTTPLIB_IDLE_INTERVAL_USECOND 0
  82. #endif
  83. #endif
  84. #ifndef CPPHTTPLIB_REQUEST_URI_MAX_LENGTH
  85. #define CPPHTTPLIB_REQUEST_URI_MAX_LENGTH 8192
  86. #endif
  87. #ifndef CPPHTTPLIB_HEADER_MAX_LENGTH
  88. #define CPPHTTPLIB_HEADER_MAX_LENGTH 8192
  89. #endif
  90. #ifndef CPPHTTPLIB_HEADER_MAX_COUNT
  91. #define CPPHTTPLIB_HEADER_MAX_COUNT 100
  92. #endif
  93. #ifndef CPPHTTPLIB_REDIRECT_MAX_COUNT
  94. #define CPPHTTPLIB_REDIRECT_MAX_COUNT 20
  95. #endif
  96. #ifndef CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT
  97. #define CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT 1024
  98. #endif
  99. #ifndef CPPHTTPLIB_PAYLOAD_MAX_LENGTH
  100. #define CPPHTTPLIB_PAYLOAD_MAX_LENGTH (100 * 1024 * 1024) // 100MB
  101. #endif
  102. #ifndef CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH
  103. #define CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
  104. #endif
  105. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH
  106. // 1400 rather than a round number: a body that already fits in one 1500-byte
  107. // MTU gains nothing from being made smaller.
  108. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH 1400
  109. #endif
  110. #ifndef CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH
  111. #define CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH (4 * 1024 * 1024) // 4MB
  112. #endif
  113. #ifndef CPPHTTPLIB_RANGE_MAX_COUNT
  114. #define CPPHTTPLIB_RANGE_MAX_COUNT 1024
  115. #endif
  116. // std::regex_match's backtracking implementation (most acutely on libstdc++)
  117. // recurses roughly once per matched character for quantified patterns such
  118. // as "(.*)", so a long enough path can exhaust the calling thread's stack; on
  119. // a default ~8MB thread stack that has been observed to take on the order of
  120. // a couple thousand characters for a simple pattern. 256 leaves a wide safety
  121. // margin below that (well under the 8192-byte request URI limit) while still
  122. // fitting any realistic route segment; raise it if a route legitimately needs
  123. // longer paths. Regex routes are never applied to paths longer than this.
  124. #ifndef CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH
  125. #define CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH 256
  126. #endif
  127. #ifndef CPPHTTPLIB_TCP_NODELAY
  128. #define CPPHTTPLIB_TCP_NODELAY false
  129. #endif
  130. #ifndef CPPHTTPLIB_IPV6_V6ONLY
  131. #define CPPHTTPLIB_IPV6_V6ONLY false
  132. #endif
  133. #ifndef CPPHTTPLIB_RECV_BUFSIZ
  134. #define CPPHTTPLIB_RECV_BUFSIZ size_t(16384u)
  135. #endif
  136. #ifndef CPPHTTPLIB_SEND_BUFSIZ
  137. #define CPPHTTPLIB_SEND_BUFSIZ size_t(16384u)
  138. #endif
  139. #ifndef CPPHTTPLIB_COMPRESSION_BUFSIZ
  140. #define CPPHTTPLIB_COMPRESSION_BUFSIZ size_t(16384u)
  141. #endif
  142. #ifndef CPPHTTPLIB_THREAD_POOL_COUNT
  143. #define CPPHTTPLIB_THREAD_POOL_COUNT \
  144. ((std::max)(8u, std::thread::hardware_concurrency() > 0 \
  145. ? std::thread::hardware_concurrency() - 1 \
  146. : 0))
  147. #endif
  148. #ifndef CPPHTTPLIB_THREAD_POOL_MAX_COUNT
  149. #define CPPHTTPLIB_THREAD_POOL_MAX_COUNT (CPPHTTPLIB_THREAD_POOL_COUNT * 4)
  150. #endif
  151. #ifndef CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT
  152. #define CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT 3 // seconds
  153. #endif
  154. #ifndef CPPHTTPLIB_RECV_FLAGS
  155. #define CPPHTTPLIB_RECV_FLAGS 0
  156. #endif
  157. #ifndef CPPHTTPLIB_SEND_FLAGS
  158. #define CPPHTTPLIB_SEND_FLAGS 0
  159. #endif
  160. #ifndef CPPHTTPLIB_LISTEN_BACKLOG
  161. #define CPPHTTPLIB_LISTEN_BACKLOG 128
  162. #endif
  163. #ifndef CPPHTTPLIB_MAX_LINE_LENGTH
  164. #define CPPHTTPLIB_MAX_LINE_LENGTH 32768
  165. #endif
  166. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH
  167. #define CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH 16777216
  168. #endif
  169. // One macro used to set the read timeout for both sides. They want different
  170. // defaults: a client's read timeout is the caller's own tool (it waits forever
  171. // until asked not to), while a server keeps a ceiling that reclaims a worker
  172. // from a peer that has gone quiet. The old name still works and sets both.
  173. #ifdef CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  174. #pragma message( \
  175. "CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND is deprecated; define " \
  176. "CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND and/or " \
  177. "CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND instead")
  178. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  179. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND \
  180. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  181. #endif
  182. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  183. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND \
  184. CPPHTTPLIB_WEBSOCKET_READ_TIMEOUT_SECOND
  185. #endif
  186. #endif
  187. // 0 waits forever. A read timeout is how a caller gets control back to send on
  188. // the same connection; it is not a liveness check (that is ping/pong). Only a
  189. // timeout set at runtime through set_read_timeout() is reported as
  190. // ws::Timeout; when one of these compile-time defaults elapses, read() returns
  191. // ws::Fail and closes the connection.
  192. #ifndef CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND
  193. #define CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND 0
  194. #endif
  195. #ifndef CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND
  196. #define CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND 300
  197. #endif
  198. #ifndef CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND
  199. #define CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND 5
  200. #endif
  201. #ifndef CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND
  202. #define CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND 30
  203. #endif
  204. #ifndef CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS
  205. #define CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS 0
  206. #endif
  207. /*
  208. * Headers
  209. */
  210. #ifdef _WIN32
  211. #ifndef _CRT_SECURE_NO_WARNINGS
  212. #define _CRT_SECURE_NO_WARNINGS
  213. #endif //_CRT_SECURE_NO_WARNINGS
  214. #ifndef _CRT_NONSTDC_NO_DEPRECATE
  215. #define _CRT_NONSTDC_NO_DEPRECATE
  216. #endif //_CRT_NONSTDC_NO_DEPRECATE
  217. #if defined(_MSC_VER)
  218. #if _MSC_VER < 1900
  219. #error Sorry, Visual Studio versions prior to 2015 are not supported
  220. #endif
  221. #pragma comment(lib, "ws2_32.lib")
  222. #ifndef _SSIZE_T_DEFINED
  223. using ssize_t = __int64;
  224. #define _SSIZE_T_DEFINED
  225. #endif
  226. #endif // _MSC_VER
  227. #ifndef S_ISREG
  228. #define S_ISREG(m) (((m) & S_IFREG) == S_IFREG)
  229. #endif // S_ISREG
  230. #ifndef S_ISDIR
  231. #define S_ISDIR(m) (((m) & S_IFDIR) == S_IFDIR)
  232. #endif // S_ISDIR
  233. #ifndef NOMINMAX
  234. #define NOMINMAX
  235. #endif // NOMINMAX
  236. #include <io.h>
  237. #include <winsock2.h>
  238. #include <ws2tcpip.h>
  239. #if defined(__has_include)
  240. #if __has_include(<afunix.h>)
  241. // afunix.h uses types declared in winsock2.h, so has to be included after it.
  242. #include <afunix.h>
  243. #define CPPHTTPLIB_HAVE_AFUNIX_H 1
  244. #endif
  245. #endif
  246. #ifndef WSA_FLAG_NO_HANDLE_INHERIT
  247. #define WSA_FLAG_NO_HANDLE_INHERIT 0x80
  248. #endif
  249. using nfds_t = unsigned long;
  250. using socket_t = SOCKET;
  251. using socklen_t = int;
  252. #else // not _WIN32
  253. #include <arpa/inet.h>
  254. #if !defined(_AIX) && !defined(__MVS__)
  255. #include <ifaddrs.h>
  256. #endif
  257. #ifdef __MVS__
  258. #include <strings.h>
  259. #ifndef NI_MAXHOST
  260. #define NI_MAXHOST 1025
  261. #endif
  262. #endif
  263. #include <net/if.h>
  264. #include <netdb.h>
  265. #include <netinet/in.h>
  266. #ifdef __linux__
  267. #include <resolv.h>
  268. #undef _res // Undefine _res macro to avoid conflicts with user code (#2278)
  269. #endif
  270. #include <csignal>
  271. #include <netinet/tcp.h>
  272. #include <poll.h>
  273. #include <pthread.h>
  274. #include <sys/mman.h>
  275. #include <sys/socket.h>
  276. #include <sys/un.h>
  277. #include <unistd.h>
  278. using socket_t = int;
  279. #ifndef INVALID_SOCKET
  280. #define INVALID_SOCKET (-1)
  281. #endif
  282. #endif //_WIN32
  283. #if defined(__APPLE__)
  284. #include <TargetConditionals.h>
  285. #endif
  286. #include <algorithm>
  287. #include <array>
  288. #include <atomic>
  289. #include <cassert>
  290. #include <chrono>
  291. #include <climits>
  292. #include <condition_variable>
  293. #include <cstdlib>
  294. #include <cstring>
  295. #include <errno.h>
  296. #include <exception>
  297. #include <fcntl.h>
  298. #include <fstream>
  299. #include <functional>
  300. #include <iomanip>
  301. #include <iostream>
  302. #include <iterator>
  303. #include <list>
  304. #include <map>
  305. #include <memory>
  306. #include <mutex>
  307. #include <random>
  308. #include <regex>
  309. #include <set>
  310. #include <sstream>
  311. #include <string>
  312. #include <sys/stat.h>
  313. #include <system_error>
  314. #include <thread>
  315. #include <type_traits>
  316. #include <unordered_map>
  317. #include <unordered_set>
  318. #include <utility>
  319. #include <vector>
  320. // On macOS with a TLS backend, enable Keychain root certificates by default
  321. // unless the user explicitly opts out. Not enabled on iOS/tvOS/watchOS since
  322. // the SecTrustSettings APIs used to enumerate anchor certificates are macOS
  323. // only; on those platforms the user must provide a CA bundle explicitly.
  324. #if defined(__APPLE__) && defined(__clang__) && \
  325. !defined(CPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATES) && \
  326. (defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  327. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || \
  328. defined(CPPHTTPLIB_WOLFSSL_SUPPORT))
  329. #if TARGET_OS_OSX
  330. #ifndef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  331. #define CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  332. #endif
  333. #endif
  334. #endif
  335. #if defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN) && \
  336. defined(__APPLE__) && !TARGET_OS_OSX
  337. #error \
  338. "CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN is only supported on macOS. On iOS/tvOS/watchOS, supply a CA bundle via set_ca_cert_path()."
  339. #endif
  340. // On Windows, enable Schannel certificate verification by default
  341. // unless the user explicitly opts out.
  342. #if defined(_WIN32) && \
  343. !defined(CPPHTTPLIB_DISABLE_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE)
  344. #define CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  345. #endif
  346. #if defined(CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO) || \
  347. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  348. #if TARGET_OS_MAC && defined(__clang__)
  349. #include <CFNetwork/CFHost.h>
  350. #include <CoreFoundation/CoreFoundation.h>
  351. #endif
  352. #endif
  353. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  354. #ifdef _WIN32
  355. #include <wincrypt.h>
  356. // these are defined in wincrypt.h and it breaks compilation if BoringSSL is
  357. // used
  358. #undef X509_NAME
  359. #undef X509_CERT_PAIR
  360. #undef X509_EXTENSIONS
  361. #undef PKCS7_SIGNER_INFO
  362. #ifdef _MSC_VER
  363. #pragma comment(lib, "crypt32.lib")
  364. #endif
  365. #endif // _WIN32
  366. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  367. #if TARGET_OS_OSX
  368. #include <Security/Security.h>
  369. #endif
  370. #endif
  371. #include <openssl/err.h>
  372. #include <openssl/evp.h>
  373. #include <openssl/ssl.h>
  374. #include <openssl/x509v3.h>
  375. #if defined(_WIN32) && defined(OPENSSL_USE_APPLINK)
  376. #include <openssl/applink.c>
  377. #endif
  378. #include <iostream>
  379. #include <sstream>
  380. #if defined(OPENSSL_IS_BORINGSSL) || defined(LIBRESSL_VERSION_NUMBER)
  381. #if OPENSSL_VERSION_NUMBER < 0x1010107f
  382. #error Please use OpenSSL or a current version of BoringSSL
  383. #endif
  384. #define SSL_get1_peer_certificate SSL_get_peer_certificate
  385. #elif OPENSSL_VERSION_NUMBER < 0x30000000L
  386. #error Sorry, OpenSSL versions prior to 3.0.0 are not supported
  387. #endif
  388. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  389. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  390. // version.h defines MBEDTLS_VERSION_MAJOR (on 2.x/3.x/4.x alike); it is pulled
  391. // in with this first include group so the version gating below can use it.
  392. #include <mbedtls/error.h>
  393. #include <mbedtls/net_sockets.h>
  394. #include <mbedtls/oid.h>
  395. #include <mbedtls/pk.h>
  396. #include <mbedtls/ssl.h>
  397. #include <mbedtls/version.h>
  398. #include <mbedtls/x509_crt.h>
  399. #if MBEDTLS_VERSION_MAJOR >= 4
  400. // Mbed TLS 4.x moved hashing/RNG to PSA Crypto and removed these headers.
  401. #include <psa/crypto.h>
  402. #else
  403. #include <mbedtls/ctr_drbg.h>
  404. #include <mbedtls/entropy.h>
  405. #include <mbedtls/md5.h>
  406. #include <mbedtls/sha1.h>
  407. #include <mbedtls/sha256.h>
  408. #include <mbedtls/sha512.h>
  409. #endif
  410. #ifdef _WIN32
  411. #include <wincrypt.h>
  412. #ifdef _MSC_VER
  413. #pragma comment(lib, "crypt32.lib")
  414. #endif
  415. #endif // _WIN32
  416. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  417. #if TARGET_OS_OSX
  418. #include <Security/Security.h>
  419. #endif
  420. #endif
  421. // Mbed TLS version API compatibility. Note: V4 implies V3 (both defined on
  422. // 4.x), so version-specific 3.x-only code must check V3 && !V4.
  423. #if MBEDTLS_VERSION_MAJOR >= 4
  424. #define CPPHTTPLIB_MBEDTLS_V4
  425. #endif
  426. #if MBEDTLS_VERSION_MAJOR >= 3
  427. #define CPPHTTPLIB_MBEDTLS_V3
  428. #endif
  429. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  430. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  431. #include <wolfssl/options.h>
  432. #include <wolfssl/openssl/x509v3.h>
  433. // Fallback definitions for older wolfSSL versions (e.g., 5.6.6)
  434. #ifndef WOLFSSL_GEN_EMAIL
  435. #define WOLFSSL_GEN_EMAIL 1
  436. #endif
  437. #ifndef WOLFSSL_GEN_DNS
  438. #define WOLFSSL_GEN_DNS 2
  439. #endif
  440. #ifndef WOLFSSL_GEN_URI
  441. #define WOLFSSL_GEN_URI 6
  442. #endif
  443. #ifndef WOLFSSL_GEN_IPADD
  444. #define WOLFSSL_GEN_IPADD 7
  445. #endif
  446. #include <wolfssl/ssl.h>
  447. #include <wolfssl/wolfcrypt/hash.h>
  448. #include <wolfssl/wolfcrypt/md5.h>
  449. #include <wolfssl/wolfcrypt/sha256.h>
  450. #include <wolfssl/wolfcrypt/sha512.h>
  451. #ifdef _WIN32
  452. #include <wincrypt.h>
  453. #ifdef _MSC_VER
  454. #pragma comment(lib, "crypt32.lib")
  455. #endif
  456. #endif // _WIN32
  457. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  458. #if TARGET_OS_OSX
  459. #include <Security/Security.h>
  460. #endif
  461. #endif
  462. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  463. // Define CPPHTTPLIB_SSL_ENABLED if any SSL backend is available
  464. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) || \
  465. defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  466. #define CPPHTTPLIB_SSL_ENABLED
  467. #endif
  468. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  469. #include <zlib.h>
  470. #endif
  471. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  472. #include <brotli/decode.h>
  473. #include <brotli/encode.h>
  474. #endif
  475. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  476. #include <zstd.h>
  477. #endif
  478. /*
  479. * Declaration
  480. */
  481. namespace httplib {
  482. namespace ws {
  483. class WebSocket;
  484. } // namespace ws
  485. namespace detail {
  486. /*
  487. * Backport std::make_unique from C++14.
  488. *
  489. * NOTE: This code came up with the following stackoverflow post:
  490. * https://stackoverflow.com/questions/10149840/c-arrays-and-make-unique
  491. *
  492. */
  493. template <class T, class... Args>
  494. typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type
  495. make_unique(Args &&...args) {
  496. return std::unique_ptr<T>(new T(std::forward<Args>(args)...));
  497. }
  498. template <class T>
  499. typename std::enable_if<std::is_array<T>::value, std::unique_ptr<T>>::type
  500. make_unique(std::size_t n) {
  501. typedef typename std::remove_extent<T>::type RT;
  502. return std::unique_ptr<T>(new RT[n]);
  503. }
  504. // Locale-independent ASCII character classification. The <cctype>
  505. // counterparts (std::isalnum, std::isdigit, ...) consult the global C locale,
  506. // so e.g. std::isalnum(0xC5) can return true once an embedder calls
  507. // setlocale(). HTTP grammars are defined over ASCII, so raw bytes must be
  508. // classified without regard to the locale.
  509. inline bool is_ascii_digit(char c) { return '0' <= c && c <= '9'; }
  510. inline bool is_ascii_alpha(char c) {
  511. return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z');
  512. }
  513. inline bool is_ascii_alnum(char c) {
  514. return is_ascii_digit(c) || is_ascii_alpha(c);
  515. }
  516. namespace case_ignore {
  517. inline unsigned char to_lower(int c) {
  518. const static unsigned char table[256] = {
  519. 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14,
  520. 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29,
  521. 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44,
  522. 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59,
  523. 60, 61, 62, 63, 64, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106,
  524. 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121,
  525. 122, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104,
  526. 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119,
  527. 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134,
  528. 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149,
  529. 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164,
  530. 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179,
  531. 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 224, 225, 226,
  532. 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241,
  533. 242, 243, 244, 245, 246, 215, 248, 249, 250, 251, 252, 253, 254, 223, 224,
  534. 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239,
  535. 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254,
  536. 255,
  537. };
  538. return table[(unsigned char)(char)c];
  539. }
  540. inline std::string to_lower(const std::string &s) {
  541. std::string result = s;
  542. std::transform(
  543. result.begin(), result.end(), result.begin(),
  544. [](unsigned char c) { return static_cast<char>(to_lower(c)); });
  545. return result;
  546. }
  547. inline bool equal(const std::string &a, const std::string &b) {
  548. return a.size() == b.size() &&
  549. std::equal(a.begin(), a.end(), b.begin(), [](char ca, char cb) {
  550. return to_lower(ca) == to_lower(cb);
  551. });
  552. }
  553. struct equal_to {
  554. bool operator()(const std::string &a, const std::string &b) const {
  555. return equal(a, b);
  556. }
  557. };
  558. struct hash {
  559. size_t operator()(const std::string &key) const {
  560. return hash_core(key.data(), key.size(), 0);
  561. }
  562. size_t hash_core(const char *s, size_t l, size_t h) const {
  563. return (l == 0) ? h
  564. : hash_core(s + 1, l - 1,
  565. // Unsets the 6 high bits of h, therefore no
  566. // overflow happens
  567. (((std::numeric_limits<size_t>::max)() >> 6) &
  568. h * 33) ^
  569. static_cast<unsigned char>(to_lower(*s)));
  570. }
  571. };
  572. template <typename T>
  573. using unordered_set = std::unordered_set<T, detail::case_ignore::hash,
  574. detail::case_ignore::equal_to>;
  575. } // namespace case_ignore
  576. // This is based on
  577. // "http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4189".
  578. struct scope_exit {
  579. explicit scope_exit(std::function<void(void)> &&f)
  580. : exit_function(std::move(f)), execute_on_destruction{true} {}
  581. scope_exit(scope_exit &&rhs) noexcept
  582. : exit_function(std::move(rhs.exit_function)),
  583. execute_on_destruction{rhs.execute_on_destruction} {
  584. rhs.release();
  585. }
  586. ~scope_exit() {
  587. if (execute_on_destruction) { this->exit_function(); }
  588. }
  589. void release() { this->execute_on_destruction = false; }
  590. private:
  591. scope_exit(const scope_exit &) = delete;
  592. void operator=(const scope_exit &) = delete;
  593. scope_exit &operator=(scope_exit &&) = delete;
  594. std::function<void(void)> exit_function;
  595. bool execute_on_destruction;
  596. };
  597. // Simple from_chars implementation for integer and double types (C++17
  598. // substitute)
  599. template <typename T> struct from_chars_result {
  600. const char *ptr;
  601. std::errc ec;
  602. };
  603. template <typename T>
  604. inline from_chars_result<T> from_chars(const char *first, const char *last,
  605. T &value, int base = 10) {
  606. value = 0;
  607. const char *p = first;
  608. bool negative = false;
  609. if (p != last && *p == '-') {
  610. negative = true;
  611. ++p;
  612. }
  613. if (p == last) { return {first, std::errc::invalid_argument}; }
  614. T result = 0;
  615. for (; p != last; ++p) {
  616. char c = *p;
  617. int digit = -1;
  618. if (is_ascii_digit(c)) {
  619. digit = c - '0';
  620. } else if ('a' <= c && c <= 'z') {
  621. digit = c - 'a' + 10;
  622. } else if ('A' <= c && c <= 'Z') {
  623. digit = c - 'A' + 10;
  624. } else {
  625. break;
  626. }
  627. if (digit < 0 || digit >= base) { break; }
  628. if (result > ((std::numeric_limits<T>::max)() - digit) / base) {
  629. return {p, std::errc::result_out_of_range};
  630. }
  631. result = result * base + digit;
  632. }
  633. if (p == first || (negative && p == first + 1)) {
  634. return {first, std::errc::invalid_argument};
  635. }
  636. value = negative ? T(0) - result : result;
  637. return {p, std::errc{}};
  638. }
  639. // from_chars for double (hand-written, locale-independent)
  640. //
  641. // The only double consumed by this library is the HTTP quality value, whose
  642. // grammar is (RFC 9110 12.4.2):
  643. // qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] )
  644. // i.e. a non-negative decimal with no sign, exponent, "inf"/"nan", or wide
  645. // magnitude. So this parser recognizes exactly 1*DIGIT [ "." *DIGIT ] with
  646. // '.' always the decimal separator (std::strtod would instead read it from the
  647. // global C locale, mis-parsing q-values once an embedder calls
  648. // setlocale(LC_ALL, "") into a comma-decimal locale). The caller range-checks
  649. // the result to [0, 1], so inputs outside that range need not be distinguished
  650. // here. Allocation-free, single pass, and free of the overflow/rounding edge
  651. // cases that exponent and wide-range handling would introduce.
  652. inline from_chars_result<double> from_chars(const char *first, const char *last,
  653. double &value) {
  654. value = 0.0;
  655. const char *p = first;
  656. // Each 1eN is exactly representable, so a single final division by the
  657. // matching entry yields a correctly-rounded result.
  658. static const double powers_of_ten[] = {
  659. 1e0, 1e1, 1e2, 1e3, 1e4, 1e5, 1e6, 1e7, 1e8, 1e9,
  660. 1e10, 1e11, 1e12, 1e13, 1e14, 1e15, 1e16, 1e17, 1e18};
  661. const int max_frac_digits =
  662. static_cast<int>(sizeof(powers_of_ten) / sizeof(powers_of_ten[0])) - 1;
  663. // Accumulate digits into a 64-bit integer and remember how many were
  664. // fractional. Two independent caps keep this bounded and safe:
  665. // * accumulation saturates before mantissa could overflow uint64_t, and
  666. // * frac_digits is capped at max_frac_digits so it is always a valid index
  667. // into powers_of_ten (without this an input like "0.000...0" would never
  668. // grow mantissa, so the saturation cap alone would not bound it).
  669. // Both caps only drop digits far beyond the precision a q-value needs; any
  670. // value they would change is well outside [0, 1] and rejected by the caller.
  671. uint64_t mantissa = 0;
  672. int frac_digits = 0;
  673. bool seen_digit = false;
  674. const uint64_t limit = ((std::numeric_limits<uint64_t>::max)() - 9) / 10;
  675. auto accumulate = [&](char c) {
  676. if (mantissa <= limit) {
  677. mantissa = mantissa * 10 + static_cast<uint64_t>(c - '0');
  678. return true;
  679. }
  680. return false;
  681. };
  682. for (; p != last && is_ascii_digit(*p); ++p) {
  683. seen_digit = true;
  684. accumulate(*p);
  685. }
  686. if (p != last && *p == '.') {
  687. ++p;
  688. for (; p != last && is_ascii_digit(*p); ++p) {
  689. seen_digit = true;
  690. if (frac_digits < max_frac_digits && accumulate(*p)) { ++frac_digits; }
  691. }
  692. }
  693. if (!seen_digit) { return {first, std::errc::invalid_argument}; }
  694. value = static_cast<double>(mantissa) / powers_of_ten[frac_digits];
  695. return {p, std::errc{}};
  696. }
  697. inline bool parse_port(const char *s, size_t len, int &port) {
  698. int val = 0;
  699. auto r = from_chars(s, s + len, val);
  700. if (r.ec != std::errc{} || val < 1 || val > 65535) { return false; }
  701. port = val;
  702. return true;
  703. }
  704. inline bool parse_port(const std::string &s, int &port) {
  705. return parse_port(s.data(), s.size(), port);
  706. }
  707. struct UrlComponents {
  708. std::string scheme;
  709. std::string host;
  710. std::string port;
  711. std::string path;
  712. std::string query;
  713. };
  714. inline bool parse_url(const std::string &url, UrlComponents &uc) {
  715. uc = {};
  716. size_t pos = 0;
  717. auto sep = url.find("://");
  718. if (sep != std::string::npos) {
  719. uc.scheme = url.substr(0, sep);
  720. // Scheme must be [a-z]+ only
  721. if (uc.scheme.empty()) { return false; }
  722. for (auto c : uc.scheme) {
  723. if (c < 'a' || c > 'z') { return false; }
  724. }
  725. pos = sep + 3;
  726. } else if (url.compare(0, 2, "//") == 0) {
  727. pos = 2;
  728. }
  729. auto has_authority_prefix = pos > 0;
  730. auto has_authority = has_authority_prefix || (!url.empty() && url[0] != '/' &&
  731. url[0] != '?' && url[0] != '#');
  732. if (has_authority) {
  733. if (pos < url.size() && url[pos] == '[') {
  734. auto close = url.find(']', pos);
  735. if (close == std::string::npos) { return false; }
  736. uc.host = url.substr(pos + 1, close - pos - 1);
  737. // IPv6 host must be [a-fA-F0-9:]+ only
  738. if (uc.host.empty()) { return false; }
  739. for (auto c : uc.host) {
  740. if (!(is_ascii_digit(c) || (c >= 'a' && c <= 'f') ||
  741. (c >= 'A' && c <= 'F') || c == ':')) {
  742. return false;
  743. }
  744. }
  745. pos = close + 1;
  746. // The IPv6 literal is the whole host, so ']' must be followed by a port,
  747. // path, query or fragment delimiter (or the end of input). Otherwise the
  748. // trailing bytes would be folded into the path while the connection
  749. // still targets the bracketed address.
  750. if (pos < url.size()) {
  751. auto c = url[pos];
  752. if (c != ':' && c != '/' && c != '?' && c != '#') { return false; }
  753. }
  754. } else {
  755. auto end = url.find_first_of(":/?#", pos);
  756. if (end == std::string::npos) { end = url.size(); }
  757. uc.host = url.substr(pos, end - pos);
  758. pos = end;
  759. }
  760. if (pos < url.size() && url[pos] == ':') {
  761. ++pos;
  762. auto end = url.find_first_of("/?#", pos);
  763. if (end == std::string::npos) { end = url.size(); }
  764. uc.port = url.substr(pos, end - pos);
  765. pos = end;
  766. }
  767. // Without :// or //, the entire input must be consumed as host[:port].
  768. // If there is leftover (path, query, etc.), this is not a valid
  769. // host[:port] string — clear and reparse as a plain path.
  770. if (!has_authority_prefix && pos < url.size()) {
  771. uc.host.clear();
  772. uc.port.clear();
  773. pos = 0;
  774. }
  775. }
  776. if (pos < url.size() && url[pos] != '?' && url[pos] != '#') {
  777. auto end = url.find_first_of("?#", pos);
  778. if (end == std::string::npos) { end = url.size(); }
  779. uc.path = url.substr(pos, end - pos);
  780. pos = end;
  781. }
  782. if (pos < url.size() && url[pos] == '?') {
  783. auto end = url.find('#', pos);
  784. if (end == std::string::npos) { end = url.size(); }
  785. uc.query = url.substr(pos, end - pos);
  786. }
  787. return true;
  788. }
  789. } // namespace detail
  790. enum class SSLVerifierResponse {
  791. // no decision has been made, use the built-in certificate verifier
  792. NoDecisionMade,
  793. // connection certificate is verified and accepted
  794. CertificateAccepted,
  795. // connection certificate was processed but is rejected
  796. CertificateRejected
  797. };
  798. // System CA loading policy for SSL clients. Auto (the default) loads system
  799. // CA certs only when no custom CA is configured; enable_system_ca() switches
  800. // to an explicit policy.
  801. enum class SystemCAMode { Auto, Enabled, Disabled };
  802. enum StatusCode {
  803. // Information responses
  804. Continue_100 = 100,
  805. SwitchingProtocol_101 = 101,
  806. Processing_102 = 102,
  807. EarlyHints_103 = 103,
  808. // Successful responses
  809. OK_200 = 200,
  810. Created_201 = 201,
  811. Accepted_202 = 202,
  812. NonAuthoritativeInformation_203 = 203,
  813. NoContent_204 = 204,
  814. ResetContent_205 = 205,
  815. PartialContent_206 = 206,
  816. MultiStatus_207 = 207,
  817. AlreadyReported_208 = 208,
  818. IMUsed_226 = 226,
  819. // Redirection messages
  820. MultipleChoices_300 = 300,
  821. MovedPermanently_301 = 301,
  822. Found_302 = 302,
  823. SeeOther_303 = 303,
  824. NotModified_304 = 304,
  825. UseProxy_305 = 305,
  826. unused_306 = 306,
  827. TemporaryRedirect_307 = 307,
  828. PermanentRedirect_308 = 308,
  829. // Client error responses
  830. BadRequest_400 = 400,
  831. Unauthorized_401 = 401,
  832. PaymentRequired_402 = 402,
  833. Forbidden_403 = 403,
  834. NotFound_404 = 404,
  835. MethodNotAllowed_405 = 405,
  836. NotAcceptable_406 = 406,
  837. ProxyAuthenticationRequired_407 = 407,
  838. RequestTimeout_408 = 408,
  839. Conflict_409 = 409,
  840. Gone_410 = 410,
  841. LengthRequired_411 = 411,
  842. PreconditionFailed_412 = 412,
  843. PayloadTooLarge_413 = 413,
  844. UriTooLong_414 = 414,
  845. UnsupportedMediaType_415 = 415,
  846. RangeNotSatisfiable_416 = 416,
  847. ExpectationFailed_417 = 417,
  848. ImATeapot_418 = 418,
  849. MisdirectedRequest_421 = 421,
  850. UnprocessableContent_422 = 422,
  851. Locked_423 = 423,
  852. FailedDependency_424 = 424,
  853. TooEarly_425 = 425,
  854. UpgradeRequired_426 = 426,
  855. PreconditionRequired_428 = 428,
  856. TooManyRequests_429 = 429,
  857. RequestHeaderFieldsTooLarge_431 = 431,
  858. UnavailableForLegalReasons_451 = 451,
  859. // Server error responses
  860. InternalServerError_500 = 500,
  861. NotImplemented_501 = 501,
  862. BadGateway_502 = 502,
  863. ServiceUnavailable_503 = 503,
  864. GatewayTimeout_504 = 504,
  865. HttpVersionNotSupported_505 = 505,
  866. VariantAlsoNegotiates_506 = 506,
  867. InsufficientStorage_507 = 507,
  868. LoopDetected_508 = 508,
  869. NotExtended_510 = 510,
  870. NetworkAuthenticationRequired_511 = 511,
  871. };
  872. namespace detail {
  873. // A multimap that keeps its entries in the order they were inserted.
  874. //
  875. // HTTP needs that order in two places. RFC 9110 5.3 makes the order of header
  876. // fields sharing a field name significant and forbids a proxy from reordering
  877. // them, and a query string's parameters are meaningful in the order the caller
  878. // wrote them. Neither standard container expresses it: std::unordered_multimap
  879. // gives no ordering guarantee at all for equivalent keys (libstdc++ yields
  880. // reverse insertion order, libc++ insertion order), and std::multimap sorts by
  881. // key, which would drop control data such as Host behind whatever else the
  882. // message carries and alphabetise a query string.
  883. //
  884. // Entries are therefore kept in a flat vector, in order. Lookup is a linear
  885. // scan, which beats hashing for the handful of entries a message carries
  886. // (headers are capped at CPPHTTPLIB_HEADER_MAX_COUNT).
  887. //
  888. // KeyEqual compares keys; it is what makes Headers case-insensitive and
  889. // Params, whose parameter names are case-sensitive, not.
  890. template <typename Mapped, typename KeyEqual> class insertion_ordered_multimap {
  891. public:
  892. using key_type = std::string;
  893. using mapped_type = Mapped;
  894. using value_type = std::pair<std::string, Mapped>;
  895. using size_type = std::size_t;
  896. using difference_type = std::ptrdiff_t;
  897. using reference = value_type &;
  898. using const_reference = const value_type &;
  899. private:
  900. static size_type npos() { return static_cast<size_type>(-1); }
  901. static bool keys_equal(const std::string &a, const std::string &b) {
  902. return KeyEqual()(a, b);
  903. }
  904. // Iterating yields every entry in insertion order, but equal_range() and
  905. // find() have to walk only the entries sharing one key, which are not
  906. // adjacent. Both are the same iterator type: key_idx_ selects between the
  907. // two traversals, and since equality compares only the position, an iterator
  908. // restricted to one key still compares equal to end().
  909. template <typename V> class iterator_t {
  910. public:
  911. using iterator_category = std::bidirectional_iterator_tag;
  912. using value_type = insertion_ordered_multimap::value_type;
  913. using difference_type = insertion_ordered_multimap::difference_type;
  914. using pointer = V *;
  915. using reference = V &;
  916. iterator_t() : data_(nullptr), idx_(0), size_(0), key_idx_(npos()) {}
  917. template <typename U,
  918. typename std::enable_if<std::is_convertible<U *, V *>::value,
  919. int>::type = 0>
  920. iterator_t(const iterator_t<U> &rhs)
  921. : data_(rhs.data_), idx_(rhs.idx_), size_(rhs.size_),
  922. key_idx_(rhs.key_idx_) {}
  923. reference operator*() const { return data_[idx_]; }
  924. pointer operator->() const { return data_ + idx_; }
  925. iterator_t &operator++() {
  926. // Saturating, so that advancing past the last entry of a key (which
  927. // get_multimap_value() does when asked for an out-of-range id) stays at
  928. // end() instead of running off the container.
  929. if (idx_ >= size_) { return *this; }
  930. ++idx_;
  931. if (key_idx_ != npos()) {
  932. while (idx_ < size_ && !matches(idx_)) {
  933. ++idx_;
  934. }
  935. }
  936. return *this;
  937. }
  938. iterator_t operator++(int) {
  939. auto tmp = *this;
  940. ++*this;
  941. return tmp;
  942. }
  943. iterator_t &operator--() {
  944. if (idx_ == 0) { return *this; }
  945. --idx_;
  946. if (key_idx_ != npos()) {
  947. while (idx_ > 0 && !matches(idx_)) {
  948. --idx_;
  949. }
  950. }
  951. return *this;
  952. }
  953. iterator_t operator--(int) {
  954. auto tmp = *this;
  955. --*this;
  956. return tmp;
  957. }
  958. template <typename U> bool operator==(const iterator_t<U> &rhs) const {
  959. return idx_ == rhs.idx_;
  960. }
  961. template <typename U> bool operator!=(const iterator_t<U> &rhs) const {
  962. return idx_ != rhs.idx_;
  963. }
  964. private:
  965. friend class insertion_ordered_multimap;
  966. template <typename> friend class iterator_t;
  967. iterator_t(V *data, size_type idx, size_type size, size_type key_idx)
  968. : data_(data), idx_(idx), size_(size), key_idx_(key_idx) {}
  969. bool matches(size_type i) const {
  970. return keys_equal(data_[i].first, data_[key_idx_].first);
  971. }
  972. V *data_;
  973. size_type idx_;
  974. size_type size_;
  975. size_type key_idx_;
  976. };
  977. public:
  978. using iterator = iterator_t<value_type>;
  979. using const_iterator = iterator_t<const value_type>;
  980. insertion_ordered_multimap() = default;
  981. insertion_ordered_multimap(std::initializer_list<value_type> il)
  982. : entries_(il) {}
  983. template <typename InputIt>
  984. insertion_ordered_multimap(InputIt first, InputIt last)
  985. : entries_(first, last) {}
  986. iterator begin() { return make_iter(0, npos()); }
  987. iterator end() { return make_iter(entries_.size(), npos()); }
  988. const_iterator begin() const { return make_citer(0, npos()); }
  989. const_iterator end() const { return make_citer(entries_.size(), npos()); }
  990. const_iterator cbegin() const { return begin(); }
  991. const_iterator cend() const { return end(); }
  992. bool empty() const { return entries_.empty(); }
  993. size_type size() const { return entries_.size(); }
  994. void clear() { entries_.clear(); }
  995. void swap(insertion_ordered_multimap &rhs) { entries_.swap(rhs.entries_); }
  996. iterator insert(const value_type &val) {
  997. entries_.push_back(val);
  998. return make_iter(entries_.size() - 1, npos());
  999. }
  1000. iterator insert(value_type &&val) {
  1001. entries_.push_back(std::move(val));
  1002. return make_iter(entries_.size() - 1, npos());
  1003. }
  1004. template <typename... Args> iterator emplace(Args &&...args) {
  1005. entries_.emplace_back(std::forward<Args>(args)...);
  1006. return make_iter(entries_.size() - 1, npos());
  1007. }
  1008. // For entries that have to lead the message, such as the Host header field
  1009. // (RFC 9110 5.3 recommends sending control data first).
  1010. template <typename... Args> iterator emplace_front(Args &&...args) {
  1011. entries_.emplace(entries_.begin(), std::forward<Args>(args)...);
  1012. return make_iter(0, npos());
  1013. }
  1014. iterator find(const std::string &key) {
  1015. auto i = index_of(key);
  1016. return i == npos() ? end() : make_iter(i, i);
  1017. }
  1018. const_iterator find(const std::string &key) const {
  1019. auto i = index_of(key);
  1020. return i == npos() ? end() : make_citer(i, i);
  1021. }
  1022. size_type count(const std::string &key) const {
  1023. size_type n = 0;
  1024. for (const auto &entry : entries_) {
  1025. if (keys_equal(entry.first, key)) { n++; }
  1026. }
  1027. return n;
  1028. }
  1029. std::pair<iterator, iterator> equal_range(const std::string &key) {
  1030. auto i = index_of(key);
  1031. return i == npos() ? std::make_pair(end(), end())
  1032. : std::make_pair(make_iter(i, i), end());
  1033. }
  1034. std::pair<const_iterator, const_iterator>
  1035. equal_range(const std::string &key) const {
  1036. auto i = index_of(key);
  1037. return i == npos() ? std::make_pair(end(), end())
  1038. : std::make_pair(make_citer(i, i), end());
  1039. }
  1040. size_type erase(const std::string &key) {
  1041. auto before = entries_.size();
  1042. entries_.erase(std::remove_if(entries_.begin(), entries_.end(),
  1043. [&](const value_type &entry) {
  1044. return keys_equal(entry.first, key);
  1045. }),
  1046. entries_.end());
  1047. return before - entries_.size();
  1048. }
  1049. iterator erase(const_iterator pos) {
  1050. entries_.erase(entries_.begin() + static_cast<difference_type>(pos.idx_));
  1051. return make_iter(pos.idx_, npos());
  1052. }
  1053. // Erases what iterating [first, last) would actually visit, so erasing an
  1054. // equal_range() removes only the entries with that key, not everything
  1055. // positioned between them.
  1056. iterator erase(const_iterator first, const_iterator last) {
  1057. auto from = first.idx_;
  1058. auto to = last.idx_;
  1059. if (from >= to) { return make_iter(from, npos()); }
  1060. auto begin_it = entries_.begin();
  1061. auto from_it = begin_it + static_cast<difference_type>(from);
  1062. auto to_it = begin_it + static_cast<difference_type>(to);
  1063. if (first.key_idx_ == npos()) {
  1064. entries_.erase(from_it, to_it);
  1065. } else {
  1066. auto key = entries_[first.key_idx_].first;
  1067. auto keep = from_it;
  1068. for (auto it = from_it; it != to_it; ++it) {
  1069. if (!keys_equal(it->first, key)) {
  1070. if (keep != it) { *keep = std::move(*it); }
  1071. ++keep;
  1072. }
  1073. }
  1074. if (keep != to_it) {
  1075. keep = std::move(to_it, entries_.end(), keep);
  1076. } else {
  1077. keep = entries_.end();
  1078. }
  1079. entries_.erase(keep, entries_.end());
  1080. }
  1081. return make_iter(from, npos());
  1082. }
  1083. friend bool operator==(const insertion_ordered_multimap &lhs,
  1084. const insertion_ordered_multimap &rhs) {
  1085. return lhs.entries_ == rhs.entries_;
  1086. }
  1087. friend bool operator!=(const insertion_ordered_multimap &lhs,
  1088. const insertion_ordered_multimap &rhs) {
  1089. return !(lhs == rhs);
  1090. }
  1091. private:
  1092. size_type index_of(const std::string &key) const {
  1093. for (size_type i = 0; i < entries_.size(); i++) {
  1094. if (keys_equal(entries_[i].first, key)) { return i; }
  1095. }
  1096. return npos();
  1097. }
  1098. iterator make_iter(size_type idx, size_type key_idx) {
  1099. return iterator(entries_.data(), idx, entries_.size(), key_idx);
  1100. }
  1101. const_iterator make_citer(size_type idx, size_type key_idx) const {
  1102. return const_iterator(entries_.data(), idx, entries_.size(), key_idx);
  1103. }
  1104. std::vector<value_type> entries_;
  1105. };
  1106. } // namespace detail
  1107. using Headers =
  1108. detail::insertion_ordered_multimap<std::string,
  1109. detail::case_ignore::equal_to>;
  1110. // Query parameter names are case-sensitive, unlike header field names.
  1111. using Params =
  1112. detail::insertion_ordered_multimap<std::string, std::equal_to<std::string>>;
  1113. using Match = std::smatch;
  1114. using DownloadProgress = std::function<bool(size_t current, size_t total)>;
  1115. using UploadProgress = std::function<bool(size_t current, size_t total)>;
  1116. /*
  1117. * detail: type-erased storage used by UserData.
  1118. * ABI-stable regardless of C++ standard — always uses this custom
  1119. * implementation instead of std::any.
  1120. */
  1121. namespace detail {
  1122. using any_type_id = const void *;
  1123. template <typename T> any_type_id any_typeid() noexcept {
  1124. static const char id = 0;
  1125. return &id;
  1126. }
  1127. struct any_storage {
  1128. virtual ~any_storage() = default;
  1129. virtual std::unique_ptr<any_storage> clone() const = 0;
  1130. virtual any_type_id type_id() const noexcept = 0;
  1131. };
  1132. template <typename T> struct any_value final : any_storage {
  1133. T value;
  1134. template <typename U> explicit any_value(U &&v) : value(std::forward<U>(v)) {}
  1135. std::unique_ptr<any_storage> clone() const override {
  1136. return std::unique_ptr<any_storage>(new any_value<T>(value));
  1137. }
  1138. any_type_id type_id() const noexcept override { return any_typeid<T>(); }
  1139. };
  1140. } // namespace detail
  1141. class UserData {
  1142. public:
  1143. UserData() = default;
  1144. UserData(UserData &&) noexcept = default;
  1145. UserData &operator=(UserData &&) noexcept = default;
  1146. UserData(const UserData &o) {
  1147. for (const auto &e : o.entries_) {
  1148. if (e.second) { entries_[e.first] = e.second->clone(); }
  1149. }
  1150. }
  1151. UserData &operator=(const UserData &o) {
  1152. if (this != &o) {
  1153. entries_.clear();
  1154. for (const auto &e : o.entries_) {
  1155. if (e.second) { entries_[e.first] = e.second->clone(); }
  1156. }
  1157. }
  1158. return *this;
  1159. }
  1160. template <typename T> void set(const std::string &key, T &&value) {
  1161. using D = typename std::decay<T>::type;
  1162. entries_[key].reset(new detail::any_value<D>(std::forward<T>(value)));
  1163. }
  1164. template <typename T> T *get(const std::string &key) noexcept {
  1165. auto it = entries_.find(key);
  1166. if (it == entries_.end() || !it->second) { return nullptr; }
  1167. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1168. return &static_cast<detail::any_value<T> *>(it->second.get())->value;
  1169. }
  1170. template <typename T> const T *get(const std::string &key) const noexcept {
  1171. auto it = entries_.find(key);
  1172. if (it == entries_.end() || !it->second) { return nullptr; }
  1173. if (it->second->type_id() != detail::any_typeid<T>()) { return nullptr; }
  1174. return &static_cast<const detail::any_value<T> *>(it->second.get())->value;
  1175. }
  1176. bool has(const std::string &key) const noexcept {
  1177. return entries_.find(key) != entries_.end();
  1178. }
  1179. void erase(const std::string &key) { entries_.erase(key); }
  1180. void clear() noexcept { entries_.clear(); }
  1181. private:
  1182. std::unordered_map<std::string, std::unique_ptr<detail::any_storage>>
  1183. entries_;
  1184. };
  1185. struct Response;
  1186. using ResponseHandler = std::function<bool(const Response &response)>;
  1187. struct FormData {
  1188. std::string name;
  1189. std::string content;
  1190. std::string filename;
  1191. std::string content_type;
  1192. Headers headers;
  1193. };
  1194. struct FormField {
  1195. std::string name;
  1196. std::string content;
  1197. Headers headers;
  1198. };
  1199. // RFC 7578 5.2: a form processor "SHOULD send back results in order" and
  1200. // "Intermediaries MUST NOT reorder the results", so a handler walking these
  1201. // should see the parts as they were sent. A std::multimap sorts by field name
  1202. // and loses that. Field names are case-sensitive, hence std::equal_to rather
  1203. // than the case-insensitive predicate Headers uses.
  1204. using FormFields =
  1205. detail::insertion_ordered_multimap<FormField, std::equal_to<std::string>>;
  1206. using FormFiles =
  1207. detail::insertion_ordered_multimap<FormData, std::equal_to<std::string>>;
  1208. struct MultipartFormData {
  1209. FormFields fields; // Text fields from multipart
  1210. FormFiles files; // Files from multipart
  1211. // Text field access
  1212. std::string get_field(const std::string &key, size_t id = 0) const;
  1213. std::vector<std::string> get_fields(const std::string &key) const;
  1214. bool has_field(const std::string &key) const;
  1215. size_t get_field_count(const std::string &key) const;
  1216. // File access
  1217. FormData get_file(const std::string &key, size_t id = 0) const;
  1218. std::vector<FormData> get_files(const std::string &key) const;
  1219. bool has_file(const std::string &key) const;
  1220. size_t get_file_count(const std::string &key) const;
  1221. };
  1222. struct UploadFormData {
  1223. std::string name;
  1224. std::string content;
  1225. std::string filename;
  1226. std::string content_type;
  1227. };
  1228. using UploadFormDataItems = std::vector<UploadFormData>;
  1229. class DataSink {
  1230. public:
  1231. DataSink() : os(&sb_), sb_(*this) {}
  1232. DataSink(const DataSink &) = delete;
  1233. DataSink &operator=(const DataSink &) = delete;
  1234. DataSink(DataSink &&) = delete;
  1235. DataSink &operator=(DataSink &&) = delete;
  1236. std::function<bool(const char *data, size_t data_len)> write;
  1237. // Only `write` is mandatory. The rest are defaulted so that a provider
  1238. // calling one on a writer that does not set it gets sensible behaviour
  1239. // rather than std::bad_function_call thrown from a worker thread. Capturing
  1240. // `this` is safe: DataSink is neither copyable nor movable.
  1241. std::function<bool()> is_writable = []() { return true; };
  1242. std::function<void()> done = []() {};
  1243. std::function<void(const Headers &trailer)> done_with_trailer =
  1244. [this](const Headers & /*trailer*/) { done(); };
  1245. std::ostream os;
  1246. private:
  1247. class data_sink_streambuf final : public std::streambuf {
  1248. public:
  1249. explicit data_sink_streambuf(DataSink &sink) : sink_(sink) {}
  1250. protected:
  1251. std::streamsize xsputn(const char *s, std::streamsize n) override {
  1252. if (sink_.write(s, static_cast<size_t>(n))) { return n; }
  1253. return 0;
  1254. }
  1255. private:
  1256. DataSink &sink_;
  1257. };
  1258. data_sink_streambuf sb_;
  1259. };
  1260. using ContentProvider =
  1261. std::function<bool(size_t offset, size_t length, DataSink &sink)>;
  1262. using ContentProviderWithoutLength =
  1263. std::function<bool(size_t offset, DataSink &sink)>;
  1264. using ContentProviderResourceReleaser = std::function<void(bool success)>;
  1265. struct FormDataProvider {
  1266. std::string name;
  1267. ContentProviderWithoutLength provider;
  1268. std::string filename;
  1269. std::string content_type;
  1270. };
  1271. using FormDataProviderItems = std::vector<FormDataProvider>;
  1272. inline FormDataProvider
  1273. make_file_provider(const std::string &name, const std::string &filepath,
  1274. const std::string &filename = std::string(),
  1275. const std::string &content_type = std::string()) {
  1276. FormDataProvider fdp;
  1277. fdp.name = name;
  1278. fdp.filename = filename.empty() ? filepath : filename;
  1279. fdp.content_type = content_type;
  1280. fdp.provider = [filepath](size_t offset, DataSink &sink) -> bool {
  1281. std::ifstream f(filepath, std::ios::binary);
  1282. if (!f) { return false; }
  1283. if (offset > 0) {
  1284. f.seekg(static_cast<std::streamoff>(offset));
  1285. if (!f.good()) {
  1286. sink.done();
  1287. return true;
  1288. }
  1289. }
  1290. char buf[8192];
  1291. f.read(buf, sizeof(buf));
  1292. auto n = static_cast<size_t>(f.gcount());
  1293. if (n > 0) { return sink.write(buf, n); }
  1294. sink.done(); // EOF
  1295. return true;
  1296. };
  1297. return fdp;
  1298. }
  1299. inline std::pair<size_t, ContentProvider>
  1300. make_file_body(const std::string &filepath) {
  1301. size_t size = 0;
  1302. {
  1303. std::ifstream f(filepath, std::ios::binary | std::ios::ate);
  1304. if (!f) { return {0, ContentProvider{}}; }
  1305. size = static_cast<size_t>(f.tellg());
  1306. }
  1307. ContentProvider provider = [filepath](size_t offset, size_t length,
  1308. DataSink &sink) -> bool {
  1309. std::ifstream f(filepath, std::ios::binary);
  1310. if (!f) { return false; }
  1311. f.seekg(static_cast<std::streamoff>(offset));
  1312. if (!f.good()) { return false; }
  1313. char buf[8192];
  1314. while (length > 0) {
  1315. auto to_read = (std::min)(sizeof(buf), length);
  1316. f.read(buf, static_cast<std::streamsize>(to_read));
  1317. auto n = static_cast<size_t>(f.gcount());
  1318. // The file is shorter than the size make_file_body() measured, which the
  1319. // caller has already committed to as Content-Length. The body cannot be
  1320. // completed, so fail as every other error here does.
  1321. if (n == 0) { return false; }
  1322. if (!sink.write(buf, n)) { return false; }
  1323. length -= n;
  1324. }
  1325. return true;
  1326. };
  1327. return {size, std::move(provider)};
  1328. }
  1329. using ContentReceiverWithProgress = std::function<bool(
  1330. const char *data, size_t data_length, size_t offset, size_t total_length)>;
  1331. using ContentReceiver =
  1332. std::function<bool(const char *data, size_t data_length)>;
  1333. using FormDataHeader = std::function<bool(const FormData &file)>;
  1334. class ContentReader {
  1335. public:
  1336. using Reader = std::function<bool(ContentReceiver receiver)>;
  1337. using FormDataReader =
  1338. std::function<bool(FormDataHeader header, ContentReceiver receiver)>;
  1339. ContentReader(Reader reader, FormDataReader multipart_reader)
  1340. : reader_(std::move(reader)),
  1341. formdata_reader_(std::move(multipart_reader)) {}
  1342. bool operator()(FormDataHeader header, ContentReceiver receiver) const {
  1343. return formdata_reader_(std::move(header), std::move(receiver));
  1344. }
  1345. bool operator()(ContentReceiver receiver) const {
  1346. return reader_(std::move(receiver));
  1347. }
  1348. Reader reader_;
  1349. FormDataReader formdata_reader_;
  1350. };
  1351. using Range = std::pair<ssize_t, ssize_t>;
  1352. using Ranges = std::vector<Range>;
  1353. #ifdef CPPHTTPLIB_SSL_ENABLED
  1354. // TLS abstraction layer - public type definitions and API
  1355. namespace tls {
  1356. // Opaque handles (defined as void* for abstraction)
  1357. using ctx_t = void *;
  1358. using session_t = void *;
  1359. using const_session_t = const void *; // For read-only session access
  1360. using cert_t = void *;
  1361. using ca_store_t = void *;
  1362. // TLS versions
  1363. enum class Version {
  1364. TLS1_2 = 0x0303,
  1365. TLS1_3 = 0x0304,
  1366. };
  1367. // Subject Alternative Names (SAN) entry types
  1368. enum class SanType { DNS, IP, EMAIL, URI, OTHER };
  1369. // SAN entry structure
  1370. struct SanEntry {
  1371. SanType type;
  1372. std::string value;
  1373. };
  1374. // Verification context for certificate verification callback
  1375. struct VerifyContext {
  1376. session_t session; // TLS session handle
  1377. cert_t cert; // Current certificate being verified
  1378. int depth; // Certificate chain depth (0 = leaf)
  1379. bool preverify_ok; // OpenSSL/Mbed TLS pre-verification result
  1380. long error_code; // Backend-specific error code (0 = no error)
  1381. const char *error_string; // Human-readable error description
  1382. // Certificate introspection methods
  1383. std::string subject_cn() const;
  1384. std::string issuer_name() const;
  1385. bool check_hostname(const char *hostname) const;
  1386. std::vector<SanEntry> sans() const;
  1387. bool validity(time_t &not_before, time_t &not_after) const;
  1388. std::string serial() const;
  1389. };
  1390. using VerifyCallback = std::function<bool(const VerifyContext &ctx)>;
  1391. // TlsError codes for TLS operations (backend-independent)
  1392. enum class ErrorCode : int {
  1393. Success = 0,
  1394. WantRead, // Non-blocking: need to wait for read
  1395. WantWrite, // Non-blocking: need to wait for write
  1396. PeerClosed, // Peer closed the connection
  1397. Fatal, // Unrecoverable error
  1398. SyscallError, // System call error (check sys_errno)
  1399. CertVerifyFailed, // Certificate verification failed
  1400. HostnameMismatch, // Hostname verification failed
  1401. };
  1402. // TLS error information
  1403. struct TlsError {
  1404. ErrorCode code = ErrorCode::Fatal;
  1405. uint64_t backend_code = 0; // OpenSSL: ERR_get_error(), mbedTLS: return value
  1406. int sys_errno = 0; // errno when SyscallError
  1407. // Convert verification error code to human-readable string
  1408. static std::string verify_error_to_string(long error_code);
  1409. };
  1410. // RAII wrapper for peer certificate
  1411. class PeerCert {
  1412. public:
  1413. PeerCert();
  1414. PeerCert(PeerCert &&other) noexcept;
  1415. PeerCert &operator=(PeerCert &&other) noexcept;
  1416. ~PeerCert();
  1417. PeerCert(const PeerCert &) = delete;
  1418. PeerCert &operator=(const PeerCert &) = delete;
  1419. explicit operator bool() const;
  1420. std::string subject_cn() const;
  1421. std::string issuer_name() const;
  1422. bool check_hostname(const char *hostname) const;
  1423. std::vector<SanEntry> sans() const;
  1424. bool validity(time_t &not_before, time_t &not_after) const;
  1425. std::string serial() const;
  1426. private:
  1427. explicit PeerCert(cert_t cert);
  1428. cert_t cert_ = nullptr;
  1429. friend PeerCert get_peer_cert_from_session(const_session_t session);
  1430. };
  1431. // Callback for TLS context setup (used by SSLServer constructor)
  1432. using ContextSetupCallback = std::function<bool(ctx_t ctx)>;
  1433. } // namespace tls
  1434. #endif
  1435. struct Request {
  1436. std::string method;
  1437. std::string path;
  1438. std::string matched_route;
  1439. Params params;
  1440. Headers headers;
  1441. Headers trailers;
  1442. std::string body;
  1443. std::string remote_addr;
  1444. int remote_port = -1;
  1445. std::string local_addr;
  1446. int local_port = -1;
  1447. // for server
  1448. std::string version;
  1449. std::string target;
  1450. MultipartFormData form;
  1451. Ranges ranges;
  1452. Match matches;
  1453. std::unordered_map<std::string, std::string> path_params;
  1454. std::function<bool()> is_connection_closed = []() { return true; };
  1455. // for client
  1456. std::vector<std::string> accept_content_types;
  1457. ResponseHandler response_handler;
  1458. ContentReceiverWithProgress content_receiver;
  1459. DownloadProgress download_progress;
  1460. UploadProgress upload_progress;
  1461. bool has_header(const std::string &key) const;
  1462. std::string get_header_value(const std::string &key, const char *def = "",
  1463. size_t id = 0) const;
  1464. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1465. size_t id = 0) const;
  1466. size_t get_header_value_count(const std::string &key) const;
  1467. void set_header(const std::string &key, const std::string &val);
  1468. bool has_trailer(const std::string &key) const;
  1469. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1470. size_t get_trailer_value_count(const std::string &key) const;
  1471. bool has_param(const std::string &key) const;
  1472. std::string get_param_value(const std::string &key, size_t id = 0) const;
  1473. std::vector<std::string> get_param_values(const std::string &key) const;
  1474. size_t get_param_value_count(const std::string &key) const;
  1475. bool is_multipart_form_data() const;
  1476. // private members...
  1477. bool body_consumed_ = false;
  1478. bool expect_100_continue_pending_ = false;
  1479. size_t redirect_count_ = CPPHTTPLIB_REDIRECT_MAX_COUNT;
  1480. size_t content_length_ = 0;
  1481. ContentProvider content_provider_;
  1482. bool is_chunked_content_provider_ = false;
  1483. size_t authorization_count_ = 0;
  1484. std::chrono::time_point<std::chrono::steady_clock> start_time_ =
  1485. (std::chrono::steady_clock::time_point::min)();
  1486. #ifdef CPPHTTPLIB_SSL_ENABLED
  1487. tls::const_session_t ssl = nullptr;
  1488. tls::PeerCert peer_cert() const;
  1489. std::string sni() const;
  1490. #endif
  1491. };
  1492. namespace detail {
  1493. // Declared up here, away from the rest of the compression helpers, because
  1494. // `Response` stores one.
  1495. enum class EncodingType { None = 0, Gzip, Brotli, Zstd };
  1496. } // namespace detail
  1497. struct Response {
  1498. std::string version;
  1499. int status = -1;
  1500. std::string reason;
  1501. Headers headers;
  1502. Headers trailers;
  1503. std::string body;
  1504. std::string location; // Redirect location
  1505. // User-defined context — set by pre-routing/pre-request handlers and read
  1506. // by route handlers to pass arbitrary data (e.g. decoded auth tokens).
  1507. UserData user_data;
  1508. bool has_header(const std::string &key) const;
  1509. std::string get_header_value(const std::string &key, const char *def = "",
  1510. size_t id = 0) const;
  1511. size_t get_header_value_u64(const std::string &key, size_t def = 0,
  1512. size_t id = 0) const;
  1513. size_t get_header_value_count(const std::string &key) const;
  1514. void set_header(const std::string &key, const std::string &val);
  1515. bool has_trailer(const std::string &key) const;
  1516. std::string get_trailer_value(const std::string &key, size_t id = 0) const;
  1517. size_t get_trailer_value_count(const std::string &key) const;
  1518. void set_redirect(const std::string &url, int status = StatusCode::Found_302);
  1519. void set_content(const char *s, size_t n, const std::string &content_type);
  1520. void set_content(const std::string &s, const std::string &content_type);
  1521. void set_content(std::string &&s, const std::string &content_type);
  1522. void set_content_provider(
  1523. size_t length, const std::string &content_type, ContentProvider provider,
  1524. ContentProviderResourceReleaser resource_releaser = nullptr);
  1525. void set_content_provider(
  1526. const std::string &content_type, ContentProviderWithoutLength provider,
  1527. ContentProviderResourceReleaser resource_releaser = nullptr);
  1528. void set_chunked_content_provider(
  1529. const std::string &content_type, ContentProviderWithoutLength provider,
  1530. ContentProviderResourceReleaser resource_releaser = nullptr);
  1531. void set_file_content(const std::string &path,
  1532. const std::string &content_type);
  1533. void set_file_content(const std::string &path);
  1534. Response() = default;
  1535. Response(const Response &) = default;
  1536. Response &operator=(const Response &) = default;
  1537. Response(Response &&) = default;
  1538. Response &operator=(Response &&) = default;
  1539. ~Response() {
  1540. if (content_provider_resource_releaser_) {
  1541. content_provider_resource_releaser_(content_provider_success_);
  1542. }
  1543. }
  1544. // private members...
  1545. size_t content_length_ = 0;
  1546. ContentProvider content_provider_;
  1547. ContentProviderResourceReleaser content_provider_resource_releaser_;
  1548. bool is_chunked_content_provider_ = false;
  1549. bool content_provider_success_ = false;
  1550. std::string file_content_path_;
  1551. std::string file_content_content_type_;
  1552. // Content coding chosen for the response body, decided once so that the
  1553. // headers and the body cannot disagree: where the file is opened for a
  1554. // file-backed content provider (keeping the ETag honest), and in
  1555. // `apply_ranges()` for a chunked content provider. `EncodingType::None`
  1556. // for every other kind of response.
  1557. detail::EncodingType content_coding_ = detail::EncodingType::None;
  1558. };
  1559. enum class Error {
  1560. Success = 0,
  1561. Unknown,
  1562. Connection,
  1563. BindIPAddress,
  1564. Read,
  1565. Write,
  1566. ExceedRedirectCount,
  1567. Canceled,
  1568. SSLConnection,
  1569. SSLLoadingCerts,
  1570. SSLServerVerification,
  1571. SSLServerHostnameVerification,
  1572. UnsupportedMultipartBoundaryChars,
  1573. Compression,
  1574. ConnectionTimeout,
  1575. ProxyConnection,
  1576. ConnectionClosed,
  1577. Timeout,
  1578. ResourceExhaustion,
  1579. TooManyFormDataFiles,
  1580. ExceedMaxPayloadSize,
  1581. ExceedUriMaxLength,
  1582. ExceedMaxSocketDescriptorCount,
  1583. InvalidRequestLine,
  1584. InvalidHTTPMethod,
  1585. InvalidHTTPVersion,
  1586. InvalidHeaders,
  1587. MultipartParsing,
  1588. OpenFile,
  1589. Listen,
  1590. GetSockName,
  1591. UnsupportedAddressFamily,
  1592. HTTPParsing,
  1593. InvalidRangeHeader,
  1594. UnsupportedContentEncoding,
  1595. WebSocketHandshake,
  1596. UserCallbackException,
  1597. // For internal use only
  1598. SSLPeerCouldBeClosed_,
  1599. };
  1600. std::string to_string(Error error);
  1601. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1602. class Stream {
  1603. public:
  1604. virtual ~Stream() = default;
  1605. virtual bool is_readable() const = 0;
  1606. virtual bool wait_readable() const = 0;
  1607. virtual bool wait_writable() const = 0;
  1608. virtual bool is_peer_alive() const { return wait_writable(); }
  1609. virtual ssize_t read(char *ptr, size_t size) = 0;
  1610. virtual ssize_t write(const char *ptr, size_t size) = 0;
  1611. virtual void get_remote_ip_and_port(std::string &ip, int &port) const = 0;
  1612. virtual void get_local_ip_and_port(std::string &ip, int &port) const = 0;
  1613. virtual socket_t socket() const = 0;
  1614. virtual time_t duration() const = 0;
  1615. virtual void set_read_timeout(time_t sec, time_t usec = 0) {
  1616. (void)sec;
  1617. (void)usec;
  1618. }
  1619. // Bytes already pulled off the socket and sitting in this stream's own
  1620. // buffer. Exposing them lets a line reader scan for a terminator in one
  1621. // pass instead of asking for a byte at a time. A stream that does no
  1622. // buffering of its own reports none, and readers fall back to read().
  1623. virtual const char *buffered_data(size_t &size) const {
  1624. size = 0;
  1625. return nullptr;
  1626. }
  1627. // Discards `size` bytes previously returned by buffered_data().
  1628. virtual void consume_buffered(size_t size) { (void)size; }
  1629. ssize_t write(const char *ptr);
  1630. ssize_t write(const std::string &s);
  1631. Error get_error() const { return error_; }
  1632. protected:
  1633. Error error_ = Error::Success;
  1634. };
  1635. class TaskQueue {
  1636. public:
  1637. TaskQueue() = default;
  1638. virtual ~TaskQueue() = default;
  1639. virtual bool enqueue(std::function<void()> fn) = 0;
  1640. virtual void shutdown() = 0;
  1641. virtual void on_idle() {}
  1642. };
  1643. class ThreadPool final : public TaskQueue {
  1644. public:
  1645. explicit ThreadPool(
  1646. size_t n, size_t max_n = 0, size_t mqr = 0,
  1647. time_t idle_timeout_sec = CPPHTTPLIB_THREAD_POOL_IDLE_TIMEOUT);
  1648. ThreadPool(const ThreadPool &) = delete;
  1649. ~ThreadPool() override = default;
  1650. bool enqueue(std::function<void()> fn) override;
  1651. void shutdown() override;
  1652. private:
  1653. void worker(bool is_dynamic);
  1654. void move_to_finished(std::thread::id id);
  1655. void cleanup_finished_threads();
  1656. size_t base_thread_count_;
  1657. size_t max_thread_count_;
  1658. size_t max_queued_requests_;
  1659. time_t idle_timeout_sec_;
  1660. size_t idle_thread_count_;
  1661. bool shutdown_;
  1662. std::list<std::function<void()>> jobs_;
  1663. std::vector<std::thread> threads_; // base threads
  1664. std::list<std::thread> dynamic_threads_; // dynamic threads
  1665. std::vector<std::thread>
  1666. finished_threads_; // exited dynamic threads awaiting join
  1667. std::condition_variable cond_;
  1668. std::mutex mutex_;
  1669. };
  1670. using Logger = std::function<void(const Request &, const Response &)>;
  1671. // Forward declaration for Error type
  1672. enum class Error;
  1673. using ErrorLogger = std::function<void(const Error &, const Request *)>;
  1674. using SocketOptions = std::function<void(socket_t sock)>;
  1675. void default_socket_options(socket_t sock);
  1676. bool set_socket_opt(socket_t sock, int level, int optname, int optval);
  1677. const char *status_message(int status);
  1678. std::string to_string(Error error);
  1679. std::ostream &operator<<(std::ostream &os, const Error &obj);
  1680. std::string get_bearer_token_auth(const Request &req);
  1681. namespace detail {
  1682. class MatcherBase {
  1683. public:
  1684. MatcherBase(std::string pattern) : pattern_(std::move(pattern)) {}
  1685. virtual ~MatcherBase() = default;
  1686. const std::string &pattern() const { return pattern_; }
  1687. // Match request path and populate its matches and
  1688. virtual bool match(Request &request) const = 0;
  1689. private:
  1690. std::string pattern_;
  1691. };
  1692. /**
  1693. * Captures parameters in request path and stores them in Request::path_params
  1694. *
  1695. * Capture name is a substring of a pattern from : to /.
  1696. * The rest of the pattern is matched against the request path directly
  1697. * Parameters are captured starting from the next character after
  1698. * the end of the last matched static pattern fragment until the next /.
  1699. *
  1700. * Example pattern:
  1701. * "/path/fragments/:capture/more/fragments/:second_capture"
  1702. * Static fragments:
  1703. * "/path/fragments/", "more/fragments/"
  1704. *
  1705. * Given the following request path:
  1706. * "/path/fragments/:1/more/fragments/:2"
  1707. * the resulting capture will be
  1708. * {{"capture", "1"}, {"second_capture", "2"}}
  1709. */
  1710. class PathParamsMatcher final : public MatcherBase {
  1711. public:
  1712. PathParamsMatcher(const std::string &pattern);
  1713. bool match(Request &request) const override;
  1714. private:
  1715. // Treat segment separators as the end of path parameter capture
  1716. // Does not need to handle query parameters as they are parsed before path
  1717. // matching
  1718. static constexpr char separator = '/';
  1719. // Contains static path fragments to match against, excluding the '/' after
  1720. // path params
  1721. // Fragments are separated by path params
  1722. std::vector<std::string> static_fragments_;
  1723. // Stores the names of the path parameters to be used as keys in the
  1724. // Request::path_params map
  1725. std::vector<std::string> param_names_;
  1726. };
  1727. /**
  1728. * Performs std::regex_match on request path
  1729. * and stores the result in Request::matches
  1730. *
  1731. * Note that regex match is performed directly on the whole request.
  1732. * This means that wildcard patterns may match multiple path segments with /:
  1733. * "/begin/(.*)/end" will match both "/begin/middle/end" and "/begin/1/2/end".
  1734. */
  1735. class RegexMatcher final : public MatcherBase {
  1736. public:
  1737. RegexMatcher(const std::string &pattern)
  1738. : MatcherBase(pattern), regex_(pattern) {}
  1739. bool match(Request &request) const override;
  1740. private:
  1741. std::regex regex_;
  1742. };
  1743. int close_socket(socket_t sock) noexcept;
  1744. bool is_accept_resource_error();
  1745. bool is_accept_transient_error();
  1746. ssize_t write_headers(Stream &strm, const Headers &headers);
  1747. bool set_socket_opt_time(socket_t sock, int level, int optname, time_t sec,
  1748. time_t usec);
  1749. size_t get_multipart_content_length(const UploadFormDataItems &items,
  1750. const std::string &boundary);
  1751. ContentProvider
  1752. make_multipart_content_provider(const UploadFormDataItems &items,
  1753. const std::string &boundary);
  1754. } // namespace detail
  1755. bool is_valid_multipart_boundary(const std::string &boundary);
  1756. // Serializer for multipart/form-data request bodies. The boundary is owned
  1757. // by the writer so that per-part framing and the final terminator always
  1758. // agree. Field names and filenames are escaped following the WHATWG HTML
  1759. // standard ('"' -> %22, CR -> %0D, LF -> %0A); CR and LF are also escaped
  1760. // in content types.
  1761. class MultipartFormDataWriter {
  1762. public:
  1763. MultipartFormDataWriter();
  1764. // precondition: is_valid_multipart_boundary(boundary)
  1765. explicit MultipartFormDataWriter(std::string boundary);
  1766. const std::string &boundary() const;
  1767. std::string content_type() const;
  1768. // In-memory items -> whole body (known length)
  1769. std::string serialize(const UploadFormDataItems &items) const;
  1770. size_t content_length(const UploadFormDataItems &items) const;
  1771. // Per-part framing for streaming via a content provider
  1772. std::string item_begin(const UploadFormData &item) const;
  1773. static std::string item_end();
  1774. std::string finish() const;
  1775. private:
  1776. std::string boundary_;
  1777. };
  1778. class Server {
  1779. public:
  1780. using Handler = std::function<void(const Request &, Response &)>;
  1781. using ExceptionHandler =
  1782. std::function<void(const Request &, Response &, std::exception_ptr ep)>;
  1783. enum class HandlerResponse {
  1784. Handled,
  1785. Unhandled,
  1786. };
  1787. using HandlerWithResponse =
  1788. std::function<HandlerResponse(const Request &, Response &)>;
  1789. using HandlerWithContentReader = std::function<void(
  1790. const Request &, Response &, const ContentReader &content_reader)>;
  1791. using Expect100ContinueHandler =
  1792. std::function<int(const Request &, Response &)>;
  1793. using StartHandler = std::function<void()>;
  1794. using WebSocketHandler =
  1795. std::function<void(const Request &, ws::WebSocket &)>;
  1796. using SubProtocolSelector =
  1797. std::function<std::string(const std::vector<std::string> &protocols)>;
  1798. Server();
  1799. virtual ~Server();
  1800. virtual bool is_valid() const;
  1801. Server &Get(const std::string &pattern, Handler handler);
  1802. Server &Post(const std::string &pattern, Handler handler);
  1803. Server &Post(const std::string &pattern, HandlerWithContentReader handler);
  1804. Server &Put(const std::string &pattern, Handler handler);
  1805. Server &Put(const std::string &pattern, HandlerWithContentReader handler);
  1806. Server &Patch(const std::string &pattern, Handler handler);
  1807. Server &Patch(const std::string &pattern, HandlerWithContentReader handler);
  1808. Server &Delete(const std::string &pattern, Handler handler);
  1809. Server &Delete(const std::string &pattern, HandlerWithContentReader handler);
  1810. Server &Options(const std::string &pattern, Handler handler);
  1811. // Register a handler for an HTTP method outside the built-in set (e.g. the
  1812. // WebDAV methods from RFC 4918). Registering a method here is what makes the
  1813. // server accept it; an unregistered method is still rejected with 400.
  1814. // `method` must be a valid HTTP method token and must not be one of the
  1815. // built-in methods, which have their own registration functions above. A
  1816. // rejected registration makes is_valid() return false, so listen() fails.
  1817. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1818. Handler handler);
  1819. Server &CustomRoute(const std::string &method, const std::string &pattern,
  1820. HandlerWithContentReader handler);
  1821. Server &WebSocket(const std::string &pattern, WebSocketHandler handler);
  1822. Server &WebSocket(const std::string &pattern, WebSocketHandler handler,
  1823. SubProtocolSelector sub_protocol_selector);
  1824. bool set_base_dir(const std::string &dir,
  1825. const std::string &mount_point = std::string());
  1826. bool set_mount_point(const std::string &mount_point, const std::string &dir,
  1827. Headers headers = Headers());
  1828. bool remove_mount_point(const std::string &mount_point);
  1829. Server &set_file_extension_and_mimetype_mapping(const std::string &ext,
  1830. const std::string &mime);
  1831. Server &set_default_file_mimetype(const std::string &mime);
  1832. Server &set_file_request_handler(Handler handler);
  1833. template <class ErrorHandlerFunc>
  1834. Server &set_error_handler(ErrorHandlerFunc &&handler) {
  1835. return set_error_handler_core(
  1836. std::forward<ErrorHandlerFunc>(handler),
  1837. std::is_convertible<ErrorHandlerFunc, HandlerWithResponse>{});
  1838. }
  1839. Server &set_exception_handler(ExceptionHandler handler);
  1840. Server &set_pre_routing_handler(HandlerWithResponse handler);
  1841. Server &set_post_routing_handler(Handler handler);
  1842. Server &set_pre_request_handler(HandlerWithResponse handler);
  1843. Server &set_expect_100_continue_handler(Expect100ContinueHandler handler);
  1844. Server &set_start_handler(StartHandler handler);
  1845. Server &set_logger(Logger logger);
  1846. Server &set_pre_compression_logger(Logger logger);
  1847. Server &set_error_logger(ErrorLogger error_logger);
  1848. Server &set_address_family(int family);
  1849. Server &set_tcp_nodelay(bool on);
  1850. Server &set_ipv6_v6only(bool on);
  1851. Server &set_socket_options(SocketOptions socket_options);
  1852. Server &set_default_headers(Headers headers);
  1853. Server &
  1854. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  1855. Server &set_trusted_proxies(const std::vector<std::string> &proxies);
  1856. Server &set_keep_alive_max_count(size_t count);
  1857. Server &set_keep_alive_timeout(time_t sec);
  1858. template <class Rep, class Period>
  1859. Server &
  1860. set_keep_alive_timeout(const std::chrono::duration<Rep, Period> &duration);
  1861. Server &set_read_timeout(time_t sec, time_t usec = 0);
  1862. template <class Rep, class Period>
  1863. Server &set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  1864. Server &set_write_timeout(time_t sec, time_t usec = 0);
  1865. template <class Rep, class Period>
  1866. Server &set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  1867. Server &set_idle_interval(time_t sec, time_t usec = 0);
  1868. template <class Rep, class Period>
  1869. Server &set_idle_interval(const std::chrono::duration<Rep, Period> &duration);
  1870. Server &set_payload_max_length(size_t length);
  1871. Server &set_static_file_compression(bool on);
  1872. Server &set_static_file_compression_min_length(size_t length);
  1873. Server &set_static_file_compression_max_length(size_t length);
  1874. Server &set_websocket_ping_interval(time_t sec);
  1875. template <class Rep, class Period>
  1876. Server &set_websocket_ping_interval(
  1877. const std::chrono::duration<Rep, Period> &duration);
  1878. Server &set_websocket_max_missed_pongs(int count);
  1879. bool bind_to_port(const std::string &host, int port, int socket_flags = 0);
  1880. int bind_to_any_port(const std::string &host, int socket_flags = 0);
  1881. bool listen_after_bind();
  1882. bool listen(const std::string &host, int port, int socket_flags = 0);
  1883. bool is_running() const;
  1884. void wait_until_ready() const;
  1885. void stop() noexcept;
  1886. void decommission();
  1887. std::function<TaskQueue *(void)> new_task_queue;
  1888. protected:
  1889. bool process_request(Stream &strm, const std::string &remote_addr,
  1890. int remote_port, const std::string &local_addr,
  1891. int local_port, bool close_connection,
  1892. bool &connection_closed,
  1893. const std::function<void(Request &)> &setup_request,
  1894. bool *websocket_upgraded = nullptr);
  1895. // Runs the per-connection serving loop and stops an exception thrown by a
  1896. // user callback from escaping the worker thread.
  1897. //
  1898. // process_request() wraps only routing() in a try/catch. Content providers,
  1899. // the post-routing, error, logging and expect-100 handlers and WebSocket
  1900. // handlers all run outside it, and the task queue calls the job without a
  1901. // catch, so an exception from any of those would terminate the process.
  1902. //
  1903. // No 500 is possible here: by the time a content provider runs, the status
  1904. // line and headers are already on the wire. Report it through the error
  1905. // logger and drop the connection, which is what the peer observes either
  1906. // way. Other connections are unaffected.
  1907. template <typename Serve> bool serve_guarded(Serve &&serve) const {
  1908. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  1909. return serve();
  1910. #else
  1911. try {
  1912. return serve();
  1913. } catch (...) {
  1914. // The error logger is a user callback too, so it must not be able to
  1915. // throw the guard back open.
  1916. try {
  1917. output_error_log(Error::UserCallbackException, nullptr);
  1918. } catch (...) {}
  1919. return false;
  1920. }
  1921. #endif
  1922. }
  1923. std::atomic<socket_t> svr_sock_{INVALID_SOCKET};
  1924. std::vector<std::string> trusted_proxies_;
  1925. size_t keep_alive_max_count_ = CPPHTTPLIB_KEEPALIVE_MAX_COUNT;
  1926. time_t keep_alive_timeout_sec_ = CPPHTTPLIB_KEEPALIVE_TIMEOUT_SECOND;
  1927. time_t read_timeout_sec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_SECOND;
  1928. time_t read_timeout_usec_ = CPPHTTPLIB_SERVER_READ_TIMEOUT_USECOND;
  1929. time_t write_timeout_sec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_SECOND;
  1930. time_t write_timeout_usec_ = CPPHTTPLIB_SERVER_WRITE_TIMEOUT_USECOND;
  1931. time_t idle_interval_sec_ = CPPHTTPLIB_IDLE_INTERVAL_SECOND;
  1932. time_t idle_interval_usec_ = CPPHTTPLIB_IDLE_INTERVAL_USECOND;
  1933. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  1934. bool static_file_compression_ = false;
  1935. size_t static_file_compression_min_length_ =
  1936. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH;
  1937. size_t static_file_compression_max_length_ =
  1938. CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH;
  1939. time_t websocket_ping_interval_sec_ =
  1940. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  1941. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  1942. private:
  1943. using Handlers =
  1944. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, Handler>>;
  1945. using HandlersForContentReader =
  1946. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>,
  1947. HandlerWithContentReader>>;
  1948. // Both handler tables for one custom method live in a single entry, so that
  1949. // routing() needs only one map lookup per request to reach either of them.
  1950. struct CustomHandlerEntry {
  1951. Handlers handlers;
  1952. HandlersForContentReader handlers_for_content_reader;
  1953. };
  1954. using CustomHandlers = std::map<std::string, CustomHandlerEntry>;
  1955. static std::unique_ptr<detail::MatcherBase>
  1956. make_matcher(const std::string &pattern);
  1957. static const std::set<std::string> &builtin_methods();
  1958. CustomHandlerEntry *custom_entry_for_registration(const std::string &method);
  1959. const CustomHandlerEntry *find_custom_entry(const std::string &method) const;
  1960. template <typename H>
  1961. Server &add_handler(
  1962. std::vector<std::pair<std::unique_ptr<detail::MatcherBase>, H>> &handlers,
  1963. const std::string &pattern, H handler) {
  1964. handlers.emplace_back(make_matcher(pattern), std::move(handler));
  1965. return *this;
  1966. }
  1967. Server &set_error_handler_core(HandlerWithResponse handler, std::true_type);
  1968. Server &set_error_handler_core(Handler handler, std::false_type);
  1969. socket_t create_server_socket(const std::string &host, int port,
  1970. int socket_flags,
  1971. SocketOptions socket_options) const;
  1972. int bind_internal(const std::string &host, int port, int socket_flags);
  1973. bool listen_internal();
  1974. bool routing(Request &req, Response &res, Stream &strm);
  1975. bool handle_file_request(Request &req, Response &res);
  1976. bool check_if_not_modified(const Request &req, Response &res,
  1977. const std::string &etag, time_t mtime) const;
  1978. bool check_if_range(Request &req, const std::string &etag,
  1979. time_t mtime) const;
  1980. bool dispatch_request(Request &req, Response &res, const Handlers &handlers,
  1981. Stream &strm);
  1982. bool dispatch_request_for_content_reader(
  1983. Request &req, Response &res, ContentReader content_reader,
  1984. const HandlersForContentReader &handlers) const;
  1985. bool parse_request_line(const char *s, Request &req) const;
  1986. detail::EncodingType static_file_encoding(const Request &req,
  1987. const Response &res,
  1988. const std::string &content_type,
  1989. size_t length) const;
  1990. bool apply_static_file_compression(const Request &req, Response &res) const;
  1991. void apply_ranges(const Request &req, Response &res,
  1992. std::string &content_type, std::string &boundary) const;
  1993. bool write_response(Stream &strm, bool close_connection, Request &req,
  1994. Response &res);
  1995. bool write_response_with_content(Stream &strm, bool close_connection,
  1996. const Request &req, Response &res);
  1997. bool write_response_core(Stream &strm, bool close_connection,
  1998. const Request &req, Response &res,
  1999. bool need_apply_ranges);
  2000. bool write_content_with_provider(Stream &strm, const Request &req,
  2001. Response &res, const std::string &boundary,
  2002. const std::string &content_type);
  2003. bool read_content(Stream &strm, Request &req, Response &res);
  2004. bool read_content_with_content_receiver(Stream &strm, Request &req,
  2005. Response &res,
  2006. ContentReceiver receiver,
  2007. FormDataHeader multipart_header,
  2008. ContentReceiver multipart_receiver);
  2009. bool read_content_core(Stream &strm, Request &req, Response &res,
  2010. ContentReceiver receiver,
  2011. FormDataHeader multipart_header,
  2012. ContentReceiver multipart_receiver) const;
  2013. virtual bool process_and_close_socket(socket_t sock);
  2014. void output_log(const Request &req, const Response &res) const;
  2015. void output_pre_compression_log(const Request &req,
  2016. const Response &res) const;
  2017. void output_error_log(const Error &err, const Request *req) const;
  2018. std::atomic<bool> is_running_{false};
  2019. std::atomic<bool> is_decommissioned{false};
  2020. // Set when CustomRoute() refuses a registration. Written before listen(),
  2021. // read by is_valid() on the same thread, so it needs no synchronization.
  2022. bool has_invalid_registration_ = false;
  2023. struct MountPointEntry {
  2024. std::string mount_point;
  2025. std::string base_dir;
  2026. std::string resolved_base_dir;
  2027. Headers headers;
  2028. };
  2029. std::vector<MountPointEntry> base_dirs_;
  2030. std::map<std::string, std::string> file_extension_and_mimetype_map_;
  2031. std::string default_file_mimetype_ = "application/octet-stream";
  2032. Handler file_request_handler_;
  2033. Handlers get_handlers_;
  2034. Handlers post_handlers_;
  2035. HandlersForContentReader post_handlers_for_content_reader_;
  2036. Handlers put_handlers_;
  2037. HandlersForContentReader put_handlers_for_content_reader_;
  2038. Handlers patch_handlers_;
  2039. HandlersForContentReader patch_handlers_for_content_reader_;
  2040. Handlers delete_handlers_;
  2041. HandlersForContentReader delete_handlers_for_content_reader_;
  2042. Handlers options_handlers_;
  2043. CustomHandlers custom_handlers_;
  2044. struct WebSocketHandlerEntry {
  2045. std::unique_ptr<detail::MatcherBase> matcher;
  2046. WebSocketHandler handler;
  2047. SubProtocolSelector sub_protocol_selector;
  2048. };
  2049. using WebSocketHandlers = std::vector<WebSocketHandlerEntry>;
  2050. WebSocketHandlers websocket_handlers_;
  2051. HandlerWithResponse error_handler_;
  2052. ExceptionHandler exception_handler_;
  2053. HandlerWithResponse pre_routing_handler_;
  2054. Handler post_routing_handler_;
  2055. HandlerWithResponse pre_request_handler_;
  2056. Expect100ContinueHandler expect_100_continue_handler_;
  2057. StartHandler start_handler_;
  2058. mutable std::mutex logger_mutex_;
  2059. Logger logger_;
  2060. Logger pre_compression_logger_;
  2061. ErrorLogger error_logger_;
  2062. int address_family_ = AF_UNSPEC;
  2063. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2064. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2065. SocketOptions socket_options_ = default_socket_options;
  2066. Headers default_headers_;
  2067. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2068. detail::write_headers;
  2069. };
  2070. class Result {
  2071. public:
  2072. Result() = default;
  2073. Result(std::unique_ptr<Response> &&res, Error err,
  2074. Headers &&request_headers = Headers{})
  2075. : res_(std::move(res)), err_(err),
  2076. request_headers_(std::move(request_headers)) {}
  2077. // Response
  2078. operator bool() const { return res_ != nullptr; }
  2079. bool operator==(std::nullptr_t) const { return res_ == nullptr; }
  2080. bool operator!=(std::nullptr_t) const { return res_ != nullptr; }
  2081. const Response &value() const { return *res_; }
  2082. Response &value() { return *res_; }
  2083. const Response &operator*() const { return *res_; }
  2084. Response &operator*() { return *res_; }
  2085. const Response *operator->() const { return res_.get(); }
  2086. Response *operator->() { return res_.get(); }
  2087. // Error
  2088. Error error() const { return err_; }
  2089. // Request Headers
  2090. bool has_request_header(const std::string &key) const;
  2091. std::string get_request_header_value(const std::string &key,
  2092. const char *def = "",
  2093. size_t id = 0) const;
  2094. size_t get_request_header_value_u64(const std::string &key, size_t def = 0,
  2095. size_t id = 0) const;
  2096. size_t get_request_header_value_count(const std::string &key) const;
  2097. private:
  2098. std::unique_ptr<Response> res_;
  2099. Error err_ = Error::Unknown;
  2100. Headers request_headers_;
  2101. #ifdef CPPHTTPLIB_SSL_ENABLED
  2102. public:
  2103. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2104. int ssl_error)
  2105. : res_(std::move(res)), err_(err),
  2106. request_headers_(std::move(request_headers)), ssl_error_(ssl_error) {}
  2107. Result(std::unique_ptr<Response> &&res, Error err, Headers &&request_headers,
  2108. int ssl_error, uint64_t ssl_backend_error)
  2109. : res_(std::move(res)), err_(err),
  2110. request_headers_(std::move(request_headers)), ssl_error_(ssl_error),
  2111. ssl_backend_error_(ssl_backend_error) {}
  2112. int ssl_error() const { return ssl_error_; }
  2113. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  2114. private:
  2115. int ssl_error_ = 0;
  2116. uint64_t ssl_backend_error_ = 0;
  2117. #endif
  2118. };
  2119. struct ClientConnection {
  2120. socket_t sock = INVALID_SOCKET;
  2121. bool is_open() const { return sock != INVALID_SOCKET; }
  2122. ClientConnection() = default;
  2123. ~ClientConnection();
  2124. ClientConnection(const ClientConnection &) = delete;
  2125. ClientConnection &operator=(const ClientConnection &) = delete;
  2126. ClientConnection(ClientConnection &&other) noexcept
  2127. : sock(other.sock)
  2128. #ifdef CPPHTTPLIB_SSL_ENABLED
  2129. ,
  2130. session(other.session)
  2131. #endif
  2132. {
  2133. other.sock = INVALID_SOCKET;
  2134. #ifdef CPPHTTPLIB_SSL_ENABLED
  2135. other.session = nullptr;
  2136. #endif
  2137. }
  2138. ClientConnection &operator=(ClientConnection &&other) noexcept {
  2139. if (this != &other) {
  2140. sock = other.sock;
  2141. other.sock = INVALID_SOCKET;
  2142. #ifdef CPPHTTPLIB_SSL_ENABLED
  2143. session = other.session;
  2144. other.session = nullptr;
  2145. #endif
  2146. }
  2147. return *this;
  2148. }
  2149. #ifdef CPPHTTPLIB_SSL_ENABLED
  2150. tls::session_t session = nullptr;
  2151. #endif
  2152. };
  2153. namespace detail {
  2154. struct ChunkedDecoder;
  2155. struct BodyReader {
  2156. Stream *stream = nullptr;
  2157. bool has_content_length = false;
  2158. size_t content_length = 0;
  2159. size_t payload_max_length = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2160. size_t bytes_read = 0;
  2161. bool chunked = false;
  2162. bool eof = false;
  2163. std::unique_ptr<ChunkedDecoder> chunked_decoder;
  2164. Error last_error = Error::Success;
  2165. ssize_t read(char *buf, size_t len);
  2166. bool has_error() const { return last_error != Error::Success; }
  2167. };
  2168. inline ssize_t read_body_content(Stream *stream, BodyReader &br, char *buf,
  2169. size_t len) {
  2170. (void)stream;
  2171. return br.read(buf, len);
  2172. }
  2173. class decompressor;
  2174. enum class NoProxyKind {
  2175. Wildcard, // "*"
  2176. HostnameSuffix, // "example.com" or ".example.com"
  2177. IPv4Cidr, // "10.0.0.0/8" (or single IP, treated as /32)
  2178. IPv6Cidr, // "fe80::/10" (or single IP, treated as /128)
  2179. };
  2180. // Unified 16-byte buffer holding either a v4 (first 4 bytes) or v6 address.
  2181. // Lets one CIDR matcher cover both families.
  2182. using IPBytes = std::array<uint8_t, 16>;
  2183. struct NoProxyEntry {
  2184. NoProxyKind kind = NoProxyKind::Wildcard;
  2185. std::string hostname_pattern; // lowercased, leading/trailing dot stripped
  2186. IPBytes net{};
  2187. int prefix_bits = 0;
  2188. };
  2189. struct NormalizedTarget {
  2190. std::string hostname; // lowercase; brackets and trailing dot removed
  2191. bool is_ipv4 = false;
  2192. bool is_ipv6 = false;
  2193. IPBytes ip{};
  2194. };
  2195. } // namespace detail
  2196. class ClientImpl {
  2197. public:
  2198. explicit ClientImpl(const std::string &host);
  2199. explicit ClientImpl(const std::string &host, int port);
  2200. explicit ClientImpl(const std::string &host, int port,
  2201. const std::string &client_cert_path,
  2202. const std::string &client_key_path);
  2203. virtual ~ClientImpl();
  2204. virtual bool is_valid() const;
  2205. struct StreamHandle {
  2206. std::unique_ptr<Response> response;
  2207. Error error = Error::Success;
  2208. StreamHandle() = default;
  2209. StreamHandle(const StreamHandle &) = delete;
  2210. StreamHandle &operator=(const StreamHandle &) = delete;
  2211. StreamHandle(StreamHandle &&) = default;
  2212. StreamHandle &operator=(StreamHandle &&) = default;
  2213. ~StreamHandle() = default;
  2214. bool is_valid() const {
  2215. return response != nullptr && error == Error::Success;
  2216. }
  2217. ssize_t read(char *buf, size_t len);
  2218. void parse_trailers_if_needed();
  2219. Error get_read_error() const { return body_reader_.last_error; }
  2220. bool has_read_error() const { return body_reader_.has_error(); }
  2221. bool trailers_parsed_ = false;
  2222. private:
  2223. friend class ClientImpl;
  2224. ssize_t read_with_decompression(char *buf, size_t len);
  2225. std::unique_ptr<ClientConnection> connection_;
  2226. std::unique_ptr<Stream> socket_stream_;
  2227. Stream *stream_ = nullptr;
  2228. detail::BodyReader body_reader_;
  2229. std::unique_ptr<detail::decompressor> decompressor_;
  2230. std::string decompress_buffer_;
  2231. size_t decompress_offset_ = 0;
  2232. size_t decompressed_bytes_read_ = 0;
  2233. };
  2234. // clang-format off
  2235. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2236. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2237. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2238. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2239. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2240. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2241. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2242. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2243. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2244. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2245. Result Head(const std::string &path);
  2246. Result Head(const std::string &path, const Headers &headers);
  2247. Result Post(const std::string &path);
  2248. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2249. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2250. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2251. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2252. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2253. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2254. Result Post(const std::string &path, const Params &params);
  2255. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2256. Result Post(const std::string &path, const Headers &headers);
  2257. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2258. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2259. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2260. 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);
  2261. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2262. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2263. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2264. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2265. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2266. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2267. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2268. Result Put(const std::string &path);
  2269. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2270. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2271. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2272. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2273. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2274. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2275. Result Put(const std::string &path, const Params &params);
  2276. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2277. Result Put(const std::string &path, const Headers &headers);
  2278. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2279. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2280. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2281. 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);
  2282. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2283. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2284. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2285. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2286. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2287. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2288. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2289. Result Patch(const std::string &path);
  2290. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2291. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2292. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2293. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2294. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2295. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2296. Result Patch(const std::string &path, const Params &params);
  2297. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2298. Result Patch(const std::string &path, const Headers &headers, UploadProgress progress = nullptr);
  2299. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2300. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2301. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2302. 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);
  2303. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2304. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2305. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2306. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2307. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2308. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2309. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2310. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2311. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2312. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2313. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2314. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2315. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2316. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2317. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2318. Result Options(const std::string &path);
  2319. Result Options(const std::string &path, const Headers &headers);
  2320. // clang-format on
  2321. // Streaming API: Open a stream for reading response body incrementally
  2322. // Socket ownership is transferred to StreamHandle for true streaming
  2323. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2324. StreamHandle open_stream(const std::string &method, const std::string &path,
  2325. const Params &params = {},
  2326. const Headers &headers = {},
  2327. const std::string &body = {},
  2328. const std::string &content_type = {});
  2329. bool send(Request &req, Response &res, Error &error);
  2330. Result send(const Request &req);
  2331. void stop();
  2332. std::string host() const;
  2333. int port() const;
  2334. size_t is_socket_open() const;
  2335. socket_t socket() const;
  2336. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2337. void set_default_headers(Headers headers);
  2338. void
  2339. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2340. void set_address_family(int family);
  2341. void set_tcp_nodelay(bool on);
  2342. void set_ipv6_v6only(bool on);
  2343. void set_socket_options(SocketOptions socket_options);
  2344. void set_connection_timeout(time_t sec, time_t usec = 0);
  2345. template <class Rep, class Period>
  2346. void
  2347. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2348. void set_read_timeout(time_t sec, time_t usec = 0);
  2349. template <class Rep, class Period>
  2350. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2351. void set_write_timeout(time_t sec, time_t usec = 0);
  2352. template <class Rep, class Period>
  2353. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2354. void set_max_timeout(time_t msec);
  2355. template <class Rep, class Period>
  2356. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2357. void set_basic_auth(const std::string &username, const std::string &password);
  2358. void set_bearer_token_auth(const std::string &token);
  2359. void set_keep_alive(bool on);
  2360. void set_follow_location(bool on);
  2361. void set_path_encode(bool on);
  2362. void set_compress(bool on);
  2363. void set_decompress(bool on);
  2364. void set_payload_max_length(size_t length);
  2365. void set_interface(const std::string &intf);
  2366. void set_proxy(const std::string &host, int port);
  2367. void set_proxy_basic_auth(const std::string &username,
  2368. const std::string &password);
  2369. void set_proxy_bearer_token_auth(const std::string &token);
  2370. void set_no_proxy(const std::vector<std::string> &patterns);
  2371. void set_logger(Logger logger);
  2372. void set_error_logger(ErrorLogger error_logger);
  2373. protected:
  2374. struct Socket {
  2375. socket_t sock = INVALID_SOCKET;
  2376. // For Mbed TLS compatibility: start_time for request timeout tracking
  2377. std::chrono::time_point<std::chrono::steady_clock> start_time_;
  2378. bool is_open() const { return sock != INVALID_SOCKET; }
  2379. #ifdef CPPHTTPLIB_SSL_ENABLED
  2380. tls::session_t ssl = nullptr;
  2381. #endif
  2382. };
  2383. virtual bool create_and_connect_socket(Socket &socket, Error &error);
  2384. virtual bool ensure_socket_connection(Socket &socket, Error &error);
  2385. virtual bool setup_proxy_connection(
  2386. Socket &socket,
  2387. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2388. Response &res, bool &success, Error &error);
  2389. bool is_proxy_enabled_for_host(const std::string &host) const;
  2390. // All of:
  2391. // shutdown_ssl
  2392. // shutdown_socket
  2393. // close_socket
  2394. // disconnect
  2395. // should ONLY be called when socket_mutex_ is locked, and only when
  2396. // no other thread is using the socket.
  2397. virtual void shutdown_ssl(Socket &socket, bool shutdown_gracefully);
  2398. void shutdown_socket(Socket &socket) const;
  2399. void close_socket(Socket &socket);
  2400. void disconnect(bool gracefully);
  2401. bool process_request(Stream &strm, Request &req, Response &res,
  2402. bool close_connection, Error &error);
  2403. bool write_content_with_provider(Stream &strm, const Request &req,
  2404. Error &error) const;
  2405. void copy_settings(const ClientImpl &rhs);
  2406. void output_log(const Request &req, const Response &res) const;
  2407. void output_error_log(const Error &err, const Request *req) const;
  2408. // Socket endpoint information
  2409. const std::string host_;
  2410. const int port_;
  2411. // Current open socket
  2412. Socket socket_;
  2413. mutable std::mutex socket_mutex_;
  2414. std::recursive_mutex request_mutex_;
  2415. // These are all protected under socket_mutex
  2416. size_t socket_requests_in_flight_ = 0;
  2417. std::thread::id socket_requests_are_from_thread_ = std::thread::id();
  2418. bool socket_should_be_closed_when_request_is_done_ = false;
  2419. // Hostname to connection target map. The value is an IP literal or another
  2420. // hostname; only the connection target changes, never the identity.
  2421. std::map<std::string, std::string> addr_map_;
  2422. // Default headers
  2423. Headers default_headers_;
  2424. // Header writer
  2425. std::function<ssize_t(Stream &, Headers &)> header_writer_ =
  2426. detail::write_headers;
  2427. // Settings
  2428. std::string client_cert_path_;
  2429. std::string client_key_path_;
  2430. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  2431. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  2432. time_t read_timeout_sec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_SECOND;
  2433. time_t read_timeout_usec_ = CPPHTTPLIB_CLIENT_READ_TIMEOUT_USECOND;
  2434. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  2435. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  2436. time_t max_timeout_msec_ = CPPHTTPLIB_CLIENT_MAX_TIMEOUT_MSECOND;
  2437. std::string basic_auth_username_;
  2438. std::string basic_auth_password_;
  2439. std::string bearer_token_auth_token_;
  2440. bool keep_alive_ = false;
  2441. bool follow_location_ = false;
  2442. bool path_encode_ = true;
  2443. int address_family_ = AF_UNSPEC;
  2444. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  2445. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  2446. SocketOptions socket_options_ = nullptr;
  2447. bool compress_ = false;
  2448. bool decompress_ = true;
  2449. size_t payload_max_length_ = CPPHTTPLIB_PAYLOAD_MAX_LENGTH;
  2450. bool has_payload_max_length_ = false;
  2451. std::string interface_;
  2452. std::string proxy_host_;
  2453. int proxy_port_ = -1;
  2454. std::string proxy_basic_auth_username_;
  2455. std::string proxy_basic_auth_password_;
  2456. std::string proxy_bearer_token_auth_token_;
  2457. std::vector<detail::NoProxyEntry> no_proxy_entries_;
  2458. mutable detail::NormalizedTarget host_normalized_;
  2459. mutable bool host_normalized_valid_ = false;
  2460. mutable std::mutex logger_mutex_;
  2461. Logger logger_;
  2462. ErrorLogger error_logger_;
  2463. private:
  2464. bool send_(Request &req, Response &res, Error &error);
  2465. Result send_(Request &&req);
  2466. socket_t create_client_socket(Error &error) const;
  2467. bool read_response_line(Stream &strm, const Request &req, Response &res,
  2468. bool skip_100_continue = true) const;
  2469. bool write_request(Stream &strm, Request &req, bool close_connection,
  2470. Error &error, bool skip_body, bool &rejected_locally);
  2471. bool write_request_body(Stream &strm, Request &req, Error &error);
  2472. void prepare_default_headers(Request &r, bool for_stream,
  2473. const std::string &ct);
  2474. bool redirect(Request &req, Response &res, Error &error);
  2475. bool create_redirect_client(const std::string &scheme,
  2476. const std::string &host, int port, Request &req,
  2477. Response &res, const std::string &path,
  2478. const std::string &location, Error &error);
  2479. template <typename ClientType> void setup_redirect_client(ClientType &client);
  2480. bool handle_request(Stream &strm, Request &req, Response &res,
  2481. bool close_connection, Error &error);
  2482. std::unique_ptr<Response> send_with_content_provider_and_receiver(
  2483. Request &req, const char *body, size_t content_length,
  2484. ContentProvider content_provider,
  2485. ContentProviderWithoutLength content_provider_without_length,
  2486. const std::string &content_type, ContentReceiver content_receiver,
  2487. Error &error);
  2488. Result send_with_content_provider_and_receiver(
  2489. const std::string &method, const std::string &path,
  2490. const Headers &headers, const char *body, size_t content_length,
  2491. ContentProvider content_provider,
  2492. ContentProviderWithoutLength content_provider_without_length,
  2493. const std::string &content_type, ContentReceiver content_receiver,
  2494. UploadProgress progress);
  2495. ContentProviderWithoutLength get_multipart_content_provider(
  2496. const std::string &boundary, const UploadFormDataItems &items,
  2497. const FormDataProviderItems &provider_items) const;
  2498. virtual bool
  2499. process_socket(const Socket &socket,
  2500. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2501. std::function<bool(Stream &strm)> callback);
  2502. virtual bool is_ssl() const;
  2503. void transfer_socket_ownership_to_handle(StreamHandle &handle);
  2504. #ifdef CPPHTTPLIB_SSL_ENABLED
  2505. public:
  2506. void set_digest_auth(const std::string &username,
  2507. const std::string &password);
  2508. void set_proxy_digest_auth(const std::string &username,
  2509. const std::string &password);
  2510. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2511. const std::string &ca_cert_dir_path = std::string());
  2512. void enable_server_certificate_verification(bool enabled);
  2513. void enable_server_hostname_verification(bool enabled);
  2514. void enable_system_ca(bool enabled);
  2515. protected:
  2516. std::string digest_auth_username_;
  2517. std::string digest_auth_password_;
  2518. std::string proxy_digest_auth_username_;
  2519. std::string proxy_digest_auth_password_;
  2520. std::string ca_cert_file_path_;
  2521. std::string ca_cert_dir_path_;
  2522. bool server_certificate_verification_ = true;
  2523. bool server_hostname_verification_ = true;
  2524. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  2525. std::string ca_cert_pem_; // Store CA cert PEM for redirect transfer
  2526. int last_ssl_error_ = 0;
  2527. uint64_t last_backend_error_ = 0;
  2528. #endif
  2529. };
  2530. class Client {
  2531. public:
  2532. // Universal interface
  2533. explicit Client(const std::string &scheme_host_port);
  2534. explicit Client(const std::string &scheme_host_port,
  2535. const std::string &client_cert_path,
  2536. const std::string &client_key_path);
  2537. // HTTP only interface
  2538. explicit Client(const std::string &host, int port);
  2539. explicit Client(const std::string &host, int port,
  2540. const std::string &client_cert_path,
  2541. const std::string &client_key_path);
  2542. Client(Client &&) = default;
  2543. Client &operator=(Client &&) = default;
  2544. ~Client();
  2545. bool is_valid() const;
  2546. // clang-format off
  2547. Result Get(const std::string &path, DownloadProgress progress = nullptr);
  2548. Result Get(const std::string &path, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2549. Result Get(const std::string &path, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2550. Result Get(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2551. Result Get(const std::string &path, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2552. Result Get(const std::string &path, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2553. Result Get(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2554. Result Get(const std::string &path, const Params &params, const Headers &headers, DownloadProgress progress = nullptr);
  2555. Result Get(const std::string &path, const Params &params, const Headers &headers, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2556. Result Get(const std::string &path, const Params &params, const Headers &headers, ResponseHandler response_handler, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2557. Result Head(const std::string &path);
  2558. Result Head(const std::string &path, const Headers &headers);
  2559. Result Post(const std::string &path);
  2560. Result Post(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2561. Result Post(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2562. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2563. Result Post(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2564. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2565. Result Post(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2566. Result Post(const std::string &path, const Params &params);
  2567. Result Post(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2568. Result Post(const std::string &path, const Headers &headers);
  2569. Result Post(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2570. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2571. Result Post(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2572. 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);
  2573. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2574. Result Post(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2575. Result Post(const std::string &path, const Headers &headers, const Params &params);
  2576. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2577. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2578. Result Post(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2579. Result Post(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2580. Result Put(const std::string &path);
  2581. Result Put(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2582. Result Put(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2583. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2584. Result Put(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2585. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2586. Result Put(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2587. Result Put(const std::string &path, const Params &params);
  2588. Result Put(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2589. Result Put(const std::string &path, const Headers &headers);
  2590. Result Put(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2591. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2592. Result Put(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2593. 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);
  2594. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2595. Result Put(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2596. Result Put(const std::string &path, const Headers &headers, const Params &params);
  2597. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2598. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2599. Result Put(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2600. Result Put(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2601. Result Patch(const std::string &path);
  2602. Result Patch(const std::string &path, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2603. Result Patch(const std::string &path, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2604. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2605. Result Patch(const std::string &path, size_t content_length, ContentProvider content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2606. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2607. Result Patch(const std::string &path, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2608. Result Patch(const std::string &path, const Params &params);
  2609. Result Patch(const std::string &path, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2610. Result Patch(const std::string &path, const Headers &headers);
  2611. Result Patch(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, UploadProgress progress = nullptr);
  2612. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, UploadProgress progress = nullptr);
  2613. Result Patch(const std::string &path, const Headers &headers, size_t content_length, ContentProvider content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2614. 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);
  2615. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, UploadProgress progress = nullptr);
  2616. Result Patch(const std::string &path, const Headers &headers, ContentProviderWithoutLength content_provider, const std::string &content_type, ContentReceiver content_receiver, UploadProgress progress = nullptr);
  2617. Result Patch(const std::string &path, const Headers &headers, const Params &params);
  2618. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, UploadProgress progress = nullptr);
  2619. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const std::string &boundary, UploadProgress progress = nullptr);
  2620. Result Patch(const std::string &path, const Headers &headers, const UploadFormDataItems &items, const FormDataProviderItems &provider_items, UploadProgress progress = nullptr);
  2621. Result Patch(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, ContentReceiver content_receiver, DownloadProgress progress = nullptr);
  2622. Result Delete(const std::string &path, DownloadProgress progress = nullptr);
  2623. Result Delete(const std::string &path, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2624. Result Delete(const std::string &path, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2625. Result Delete(const std::string &path, const Params &params, DownloadProgress progress = nullptr);
  2626. Result Delete(const std::string &path, const Headers &headers, DownloadProgress progress = nullptr);
  2627. Result Delete(const std::string &path, const Headers &headers, const char *body, size_t content_length, const std::string &content_type, DownloadProgress progress = nullptr);
  2628. Result Delete(const std::string &path, const Headers &headers, const std::string &body, const std::string &content_type, DownloadProgress progress = nullptr);
  2629. Result Delete(const std::string &path, const Headers &headers, const Params &params, DownloadProgress progress = nullptr);
  2630. Result Options(const std::string &path);
  2631. Result Options(const std::string &path, const Headers &headers);
  2632. // clang-format on
  2633. // Streaming API: Open a stream for reading response body incrementally
  2634. // Socket ownership is transferred to StreamHandle for true streaming
  2635. // Supports all HTTP methods (GET, POST, PUT, PATCH, DELETE, etc.)
  2636. ClientImpl::StreamHandle open_stream(const std::string &method,
  2637. const std::string &path,
  2638. const Params &params = {},
  2639. const Headers &headers = {},
  2640. const std::string &body = {},
  2641. const std::string &content_type = {});
  2642. bool send(Request &req, Response &res, Error &error);
  2643. Result send(const Request &req);
  2644. void stop();
  2645. std::string host() const;
  2646. int port() const;
  2647. size_t is_socket_open() const;
  2648. socket_t socket() const;
  2649. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  2650. void set_default_headers(Headers headers);
  2651. void
  2652. set_header_writer(std::function<ssize_t(Stream &, Headers &)> const &writer);
  2653. void set_address_family(int family);
  2654. void set_tcp_nodelay(bool on);
  2655. void set_socket_options(SocketOptions socket_options);
  2656. void set_connection_timeout(time_t sec, time_t usec = 0);
  2657. template <class Rep, class Period>
  2658. void
  2659. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  2660. void set_read_timeout(time_t sec, time_t usec = 0);
  2661. template <class Rep, class Period>
  2662. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  2663. void set_write_timeout(time_t sec, time_t usec = 0);
  2664. template <class Rep, class Period>
  2665. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  2666. void set_max_timeout(time_t msec);
  2667. template <class Rep, class Period>
  2668. void set_max_timeout(const std::chrono::duration<Rep, Period> &duration);
  2669. void set_basic_auth(const std::string &username, const std::string &password);
  2670. void set_bearer_token_auth(const std::string &token);
  2671. void set_keep_alive(bool on);
  2672. void set_follow_location(bool on);
  2673. void set_path_encode(bool on);
  2674. void set_compress(bool on);
  2675. void set_decompress(bool on);
  2676. void set_payload_max_length(size_t length);
  2677. void set_interface(const std::string &intf);
  2678. void set_proxy(const std::string &host, int port);
  2679. void set_proxy_basic_auth(const std::string &username,
  2680. const std::string &password);
  2681. void set_proxy_bearer_token_auth(const std::string &token);
  2682. void set_no_proxy(const std::vector<std::string> &patterns);
  2683. void set_logger(Logger logger);
  2684. void set_error_logger(ErrorLogger error_logger);
  2685. private:
  2686. std::unique_ptr<ClientImpl> cli_;
  2687. #ifdef CPPHTTPLIB_SSL_ENABLED
  2688. public:
  2689. void set_digest_auth(const std::string &username,
  2690. const std::string &password);
  2691. void set_proxy_digest_auth(const std::string &username,
  2692. const std::string &password);
  2693. void enable_server_certificate_verification(bool enabled);
  2694. void enable_server_hostname_verification(bool enabled);
  2695. void enable_system_ca(bool enabled);
  2696. void set_ca_cert_path(const std::string &ca_cert_file_path,
  2697. const std::string &ca_cert_dir_path = std::string());
  2698. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2699. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2700. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2701. void set_session_verifier(
  2702. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2703. tls::ctx_t tls_context() const;
  2704. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2705. void enable_windows_certificate_verification(bool enabled);
  2706. #endif
  2707. private:
  2708. bool is_ssl_ = false;
  2709. #endif
  2710. };
  2711. #ifdef CPPHTTPLIB_SSL_ENABLED
  2712. class SSLServer : public Server {
  2713. public:
  2714. SSLServer(const char *cert_path, const char *private_key_path,
  2715. const char *client_ca_cert_file_path = nullptr,
  2716. const char *client_ca_cert_dir_path = nullptr,
  2717. const char *private_key_password = nullptr);
  2718. struct PemMemory {
  2719. const char *cert_pem;
  2720. size_t cert_pem_len;
  2721. const char *key_pem;
  2722. size_t key_pem_len;
  2723. const char *client_ca_pem;
  2724. size_t client_ca_pem_len;
  2725. const char *private_key_password;
  2726. };
  2727. explicit SSLServer(const PemMemory &pem);
  2728. // The callback receives the ctx_t handle which can be cast to the
  2729. // appropriate backend type (SSL_CTX* for OpenSSL,
  2730. // tls::impl::MbedTlsContext* for Mbed TLS)
  2731. explicit SSLServer(const tls::ContextSetupCallback &setup_callback);
  2732. ~SSLServer() override;
  2733. bool is_valid() const override;
  2734. bool update_certs_pem(const char *cert_pem, const char *key_pem,
  2735. const char *client_ca_pem = nullptr,
  2736. const char *password = nullptr);
  2737. tls::ctx_t tls_context() const { return ctx_; }
  2738. int ssl_last_error() const { return last_ssl_error_; }
  2739. private:
  2740. bool process_and_close_socket(socket_t sock) override;
  2741. tls::ctx_t ctx_ = nullptr;
  2742. std::mutex ctx_mutex_;
  2743. int last_ssl_error_ = 0;
  2744. };
  2745. class SSLClient final : public ClientImpl {
  2746. public:
  2747. explicit SSLClient(const std::string &host);
  2748. explicit SSLClient(const std::string &host, int port);
  2749. explicit SSLClient(const std::string &host, int port,
  2750. const std::string &client_cert_path,
  2751. const std::string &client_key_path,
  2752. const std::string &private_key_password = std::string());
  2753. struct PemMemory {
  2754. const char *cert_pem;
  2755. size_t cert_pem_len;
  2756. const char *key_pem;
  2757. size_t key_pem_len;
  2758. const char *private_key_password;
  2759. };
  2760. explicit SSLClient(const std::string &host, int port, const PemMemory &pem);
  2761. ~SSLClient() override;
  2762. bool is_valid() const override;
  2763. void set_ca_cert_store(tls::ca_store_t ca_cert_store);
  2764. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  2765. void set_server_certificate_verifier(tls::VerifyCallback verifier);
  2766. // Post-handshake session verifier (backend-independent)
  2767. void set_session_verifier(
  2768. std::function<SSLVerifierResponse(tls::session_t)> verifier);
  2769. tls::ctx_t tls_context() const { return ctx_; }
  2770. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2771. void enable_windows_certificate_verification(bool enabled);
  2772. #endif
  2773. private:
  2774. bool create_and_connect_socket(Socket &socket, Error &error) override;
  2775. bool ensure_socket_connection(Socket &socket, Error &error) override;
  2776. void shutdown_ssl(Socket &socket, bool shutdown_gracefully) override;
  2777. void shutdown_ssl_impl(Socket &socket, bool shutdown_gracefully);
  2778. bool
  2779. process_socket(const Socket &socket,
  2780. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2781. std::function<bool(Stream &strm)> callback) override;
  2782. bool is_ssl() const override;
  2783. bool setup_proxy_connection(
  2784. Socket &socket,
  2785. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2786. Response &res, bool &success, Error &error) override;
  2787. bool connect_with_proxy(
  2788. Socket &sock,
  2789. std::chrono::time_point<std::chrono::steady_clock> start_time,
  2790. Response &res, bool &success, Error &error);
  2791. bool initialize_ssl(Socket &socket, Error &error);
  2792. void init_ctx();
  2793. void reset_ctx_on_error();
  2794. bool load_certs();
  2795. tls::ctx_t ctx_ = nullptr;
  2796. std::mutex ctx_mutex_;
  2797. std::once_flag initialize_cert_;
  2798. // Tracks whether a custom CA store was applied via set_ca_cert_store(),
  2799. // since the store handle itself is owned by ctx_ and leaves no other trace.
  2800. // Used to keep custom CA configuration exclusive with system CA loading.
  2801. bool ca_cert_store_set_ = false;
  2802. std::function<SSLVerifierResponse(tls::session_t)> session_verifier_;
  2803. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  2804. bool enable_windows_cert_verification_ = true;
  2805. #endif
  2806. friend class ClientImpl;
  2807. };
  2808. #endif // CPPHTTPLIB_SSL_ENABLED
  2809. namespace detail {
  2810. template <typename T, typename U>
  2811. inline void duration_to_sec_and_usec(const T &duration, U callback) {
  2812. auto sec = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  2813. auto usec = std::chrono::duration_cast<std::chrono::microseconds>(
  2814. duration - std::chrono::seconds(sec))
  2815. .count();
  2816. callback(static_cast<time_t>(sec), static_cast<time_t>(usec));
  2817. }
  2818. template <size_t N> inline constexpr size_t str_len(const char (&)[N]) {
  2819. return N - 1;
  2820. }
  2821. inline bool is_numeric(const std::string &str) {
  2822. return !str.empty() && std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  2823. }
  2824. inline size_t get_header_value_u64(const Headers &headers,
  2825. const std::string &key, size_t def,
  2826. size_t id, bool &is_invalid_value) {
  2827. is_invalid_value = false;
  2828. auto rng = headers.equal_range(key);
  2829. auto it = rng.first;
  2830. std::advance(it, static_cast<ssize_t>(id));
  2831. if (it != rng.second) {
  2832. if (is_numeric(it->second)) {
  2833. // Parse at size_t width so an out-of-range Content-Length is reported
  2834. // rather than silently saturated/truncated (a value above 2^32 would
  2835. // otherwise wrap to a small framing length on 32-bit builds). Flag it
  2836. // and return SIZE_MAX so the existing oversized-value guards reject it.
  2837. size_t val = 0;
  2838. const auto &s = it->second;
  2839. auto r = from_chars(s.data(), s.data() + s.size(), val);
  2840. if (r.ec == std::errc::result_out_of_range) {
  2841. is_invalid_value = true;
  2842. return (std::numeric_limits<size_t>::max)();
  2843. }
  2844. return val;
  2845. } else {
  2846. is_invalid_value = true;
  2847. }
  2848. }
  2849. return def;
  2850. }
  2851. inline size_t get_header_value_u64(const Headers &headers,
  2852. const std::string &key, size_t def,
  2853. size_t id) {
  2854. auto dummy = false;
  2855. return get_header_value_u64(headers, key, def, id, dummy);
  2856. }
  2857. } // namespace detail
  2858. template <class Rep, class Period>
  2859. inline Server &
  2860. Server::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2861. detail::duration_to_sec_and_usec(
  2862. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2863. return *this;
  2864. }
  2865. template <class Rep, class Period>
  2866. inline Server &
  2867. Server::set_write_timeout(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. return *this;
  2871. }
  2872. template <class Rep, class Period>
  2873. inline Server &
  2874. Server::set_idle_interval(const std::chrono::duration<Rep, Period> &duration) {
  2875. detail::duration_to_sec_and_usec(
  2876. duration, [&](time_t sec, time_t usec) { set_idle_interval(sec, usec); });
  2877. return *this;
  2878. }
  2879. template <class Rep, class Period>
  2880. inline void ClientImpl::set_connection_timeout(
  2881. const std::chrono::duration<Rep, Period> &duration) {
  2882. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  2883. set_connection_timeout(sec, usec);
  2884. });
  2885. }
  2886. template <class Rep, class Period>
  2887. inline void ClientImpl::set_read_timeout(
  2888. const std::chrono::duration<Rep, Period> &duration) {
  2889. detail::duration_to_sec_and_usec(
  2890. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  2891. }
  2892. template <class Rep, class Period>
  2893. inline void ClientImpl::set_write_timeout(
  2894. const std::chrono::duration<Rep, Period> &duration) {
  2895. detail::duration_to_sec_and_usec(
  2896. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  2897. }
  2898. template <class Rep, class Period>
  2899. inline void ClientImpl::set_max_timeout(
  2900. const std::chrono::duration<Rep, Period> &duration) {
  2901. auto msec =
  2902. std::chrono::duration_cast<std::chrono::milliseconds>(duration).count();
  2903. set_max_timeout(msec);
  2904. }
  2905. template <class Rep, class Period>
  2906. inline void Client::set_connection_timeout(
  2907. const std::chrono::duration<Rep, Period> &duration) {
  2908. cli_->set_connection_timeout(duration);
  2909. }
  2910. template <class Rep, class Period>
  2911. inline void
  2912. Client::set_read_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2913. cli_->set_read_timeout(duration);
  2914. }
  2915. template <class Rep, class Period>
  2916. inline void
  2917. Client::set_write_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2918. cli_->set_write_timeout(duration);
  2919. }
  2920. inline void Client::set_max_timeout(time_t msec) {
  2921. cli_->set_max_timeout(msec);
  2922. }
  2923. template <class Rep, class Period>
  2924. inline void
  2925. Client::set_max_timeout(const std::chrono::duration<Rep, Period> &duration) {
  2926. cli_->set_max_timeout(duration);
  2927. }
  2928. /*
  2929. * Forward declarations and types that will be part of the .h file if split into
  2930. * .h + .cc.
  2931. */
  2932. std::string hosted_at(const std::string &hostname);
  2933. void hosted_at(const std::string &hostname, std::vector<std::string> &addrs);
  2934. // JavaScript-style URL encoding/decoding functions
  2935. std::string encode_uri_component(const std::string &value);
  2936. std::string encode_uri(const std::string &value);
  2937. std::string decode_uri_component(const std::string &value);
  2938. std::string decode_uri(const std::string &value);
  2939. // RFC 3986 compliant URL component encoding/decoding functions
  2940. std::string encode_path_component(const std::string &component);
  2941. std::string decode_path_component(const std::string &component);
  2942. std::string encode_query_component(const std::string &component,
  2943. bool space_as_plus = true);
  2944. std::string decode_query_component(const std::string &component,
  2945. bool plus_as_space = true);
  2946. std::string sanitize_filename(const std::string &filename);
  2947. std::string append_query_params(const std::string &path, const Params &params);
  2948. std::pair<std::string, std::string> make_range_header(const Ranges &ranges);
  2949. std::pair<std::string, std::string>
  2950. make_basic_authentication_header(const std::string &username,
  2951. const std::string &password,
  2952. bool is_proxy = false);
  2953. namespace detail {
  2954. #if defined(_WIN32)
  2955. inline std::wstring u8string_to_wstring(const char *s) {
  2956. if (!s) { return std::wstring(); }
  2957. auto len = static_cast<int>(strlen(s));
  2958. if (!len) { return std::wstring(); }
  2959. auto wlen = ::MultiByteToWideChar(CP_UTF8, 0, s, len, nullptr, 0);
  2960. if (!wlen) { return std::wstring(); }
  2961. std::wstring ws;
  2962. ws.resize(wlen);
  2963. wlen = ::MultiByteToWideChar(
  2964. CP_UTF8, 0, s, len,
  2965. const_cast<LPWSTR>(reinterpret_cast<LPCWSTR>(ws.data())), wlen);
  2966. if (wlen != static_cast<int>(ws.size())) { ws.clear(); }
  2967. return ws;
  2968. }
  2969. #endif
  2970. struct FileStat {
  2971. FileStat(const std::string &path);
  2972. bool is_file() const;
  2973. bool is_dir() const;
  2974. time_t mtime() const;
  2975. size_t size() const;
  2976. private:
  2977. #if defined(_WIN32)
  2978. struct _stat st_;
  2979. #else
  2980. struct stat st_;
  2981. #endif
  2982. int ret_ = -1;
  2983. };
  2984. std::string make_host_and_port_string(const std::string &host, int port,
  2985. bool is_ssl);
  2986. template <typename T>
  2987. bool check_and_write_headers(Stream &strm, Headers &headers, T header_writer,
  2988. Error &error);
  2989. std::string trim_copy(const std::string &s);
  2990. void divide(
  2991. const char *data, std::size_t size, char d,
  2992. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2993. fn);
  2994. void divide(
  2995. const std::string &str, char d,
  2996. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  2997. fn);
  2998. void split(const char *b, const char *e, char d,
  2999. std::function<void(const char *, const char *)> fn);
  3000. void split(const char *b, const char *e, char d, size_t m,
  3001. std::function<void(const char *, const char *)> fn);
  3002. bool split_find(const char *b, const char *e, char d,
  3003. std::function<bool(const char *, const char *)> fn);
  3004. bool has_header_token(const Headers &headers, const std::string &key,
  3005. const std::string &token);
  3006. std::string websocket_accept_key(const std::string &client_key);
  3007. bool is_websocket_upgrade(const Request &req);
  3008. bool process_client_socket(
  3009. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  3010. time_t write_timeout_sec, time_t write_timeout_usec,
  3011. time_t max_timeout_msec,
  3012. std::chrono::time_point<std::chrono::steady_clock> start_time,
  3013. std::function<bool(Stream &)> callback);
  3014. socket_t create_client_socket(const std::string &host, const std::string &ip,
  3015. int port, int address_family, bool tcp_nodelay,
  3016. bool ipv6_v6only, SocketOptions socket_options,
  3017. time_t connection_timeout_sec,
  3018. time_t connection_timeout_usec,
  3019. time_t read_timeout_sec, time_t read_timeout_usec,
  3020. time_t write_timeout_sec,
  3021. time_t write_timeout_usec,
  3022. const std::string &intf, Error &error);
  3023. const char *get_header_value(const Headers &headers, const std::string &key,
  3024. const char *def, size_t id);
  3025. std::string get_combined_header_value(const Headers &headers,
  3026. const std::string &key);
  3027. std::string params_to_query_str(const Params &params);
  3028. void parse_query_text(const char *data, std::size_t size, Params &params);
  3029. void parse_query_text(const std::string &s, Params &params);
  3030. bool parse_multipart_boundary(const std::string &content_type,
  3031. std::string &boundary);
  3032. bool parse_range_header(const std::string &s, Ranges &ranges);
  3033. bool parse_accept_header(const std::string &s,
  3034. std::vector<std::string> &content_types);
  3035. void parse_disposition_params(const std::string &s, Params &params);
  3036. ssize_t send_socket(socket_t sock, const void *ptr, size_t size, int flags);
  3037. ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags);
  3038. EncodingType encoding_type(const Request &req, const std::string &content_type);
  3039. EncodingType encoding_type(const Request &req, const Response &res,
  3040. const std::string &content_type);
  3041. EncodingType encoding_type(const Request &req, const Response &res);
  3042. class BufferStream final : public Stream {
  3043. public:
  3044. BufferStream() = default;
  3045. ~BufferStream() override = default;
  3046. bool is_readable() const override;
  3047. bool wait_readable() const override;
  3048. bool wait_writable() const override;
  3049. ssize_t read(char *ptr, size_t size) override;
  3050. ssize_t write(const char *ptr, size_t size) override;
  3051. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  3052. void get_local_ip_and_port(std::string &ip, int &port) const override;
  3053. socket_t socket() const override;
  3054. time_t duration() const override;
  3055. const std::string &get_buffer() const;
  3056. private:
  3057. std::string buffer;
  3058. size_t position = 0;
  3059. };
  3060. class compressor {
  3061. public:
  3062. virtual ~compressor() = default;
  3063. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3064. virtual bool compress(const char *data, size_t data_length, bool last,
  3065. Callback callback) = 0;
  3066. };
  3067. class decompressor {
  3068. public:
  3069. virtual ~decompressor() = default;
  3070. virtual bool is_valid() const = 0;
  3071. typedef std::function<bool(const char *data, size_t data_len)> Callback;
  3072. virtual bool decompress(const char *data, size_t data_length,
  3073. Callback callback) = 0;
  3074. };
  3075. class nocompressor final : public compressor {
  3076. public:
  3077. ~nocompressor() override = default;
  3078. bool compress(const char *data, size_t data_length, bool /*last*/,
  3079. Callback callback) override;
  3080. };
  3081. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  3082. class gzip_compressor final : public compressor {
  3083. public:
  3084. gzip_compressor();
  3085. ~gzip_compressor() override;
  3086. bool compress(const char *data, size_t data_length, bool last,
  3087. Callback callback) override;
  3088. private:
  3089. bool is_valid_ = false;
  3090. z_stream strm_;
  3091. };
  3092. class gzip_decompressor final : public decompressor {
  3093. public:
  3094. gzip_decompressor();
  3095. ~gzip_decompressor() override;
  3096. bool is_valid() const override;
  3097. bool decompress(const char *data, size_t data_length,
  3098. Callback callback) override;
  3099. private:
  3100. bool is_valid_ = false;
  3101. z_stream strm_;
  3102. };
  3103. #endif
  3104. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  3105. class brotli_compressor final : public compressor {
  3106. public:
  3107. brotli_compressor();
  3108. ~brotli_compressor();
  3109. bool compress(const char *data, size_t data_length, bool last,
  3110. Callback callback) override;
  3111. private:
  3112. BrotliEncoderState *state_ = nullptr;
  3113. };
  3114. class brotli_decompressor final : public decompressor {
  3115. public:
  3116. brotli_decompressor();
  3117. ~brotli_decompressor();
  3118. bool is_valid() const override;
  3119. bool decompress(const char *data, size_t data_length,
  3120. Callback callback) override;
  3121. private:
  3122. BrotliDecoderResult decoder_r;
  3123. BrotliDecoderState *decoder_s = nullptr;
  3124. };
  3125. #endif
  3126. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  3127. class zstd_compressor : public compressor {
  3128. public:
  3129. zstd_compressor();
  3130. ~zstd_compressor();
  3131. bool compress(const char *data, size_t data_length, bool last,
  3132. Callback callback) override;
  3133. private:
  3134. ZSTD_CCtx *ctx_ = nullptr;
  3135. };
  3136. class zstd_decompressor : public decompressor {
  3137. public:
  3138. zstd_decompressor();
  3139. ~zstd_decompressor();
  3140. bool is_valid() const override;
  3141. bool decompress(const char *data, size_t data_length,
  3142. Callback callback) override;
  3143. private:
  3144. ZSTD_DCtx *ctx_ = nullptr;
  3145. };
  3146. #endif
  3147. // NOTE: until the read size reaches `fixed_buffer_size`, use `fixed_buffer`
  3148. // to store data. The call can set memory on stack for performance.
  3149. class stream_line_reader {
  3150. public:
  3151. stream_line_reader(Stream &strm, char *fixed_buffer,
  3152. size_t fixed_buffer_size);
  3153. const char *ptr() const;
  3154. size_t size() const;
  3155. bool end_with_crlf() const;
  3156. bool getline();
  3157. private:
  3158. void append(char c);
  3159. void append(const char *data, size_t size);
  3160. Stream &strm_;
  3161. char *fixed_buffer_;
  3162. const size_t fixed_buffer_size_;
  3163. size_t fixed_buffer_used_size_ = 0;
  3164. std::string growable_buffer_;
  3165. };
  3166. bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  3167. const Headers &src_headers);
  3168. struct ChunkedDecoder {
  3169. Stream &strm;
  3170. size_t chunk_remaining = 0;
  3171. bool finished = false;
  3172. char line_buf[64];
  3173. size_t last_chunk_total = 0;
  3174. size_t last_chunk_offset = 0;
  3175. explicit ChunkedDecoder(Stream &s);
  3176. ssize_t read_payload(char *buf, size_t len, size_t &out_chunk_offset,
  3177. size_t &out_chunk_total);
  3178. bool parse_trailers_into(Headers &dest, const Headers &src_headers);
  3179. };
  3180. class mmap {
  3181. public:
  3182. mmap(const char *path);
  3183. ~mmap();
  3184. bool open(const char *path);
  3185. void close();
  3186. bool is_open() const;
  3187. size_t size() const;
  3188. const char *data() const;
  3189. private:
  3190. #if defined(_WIN32)
  3191. HANDLE hFile_ = NULL;
  3192. HANDLE hMapping_ = NULL;
  3193. #else
  3194. int fd_ = -1;
  3195. #endif
  3196. size_t size_ = 0;
  3197. void *addr_ = nullptr;
  3198. bool is_open_empty_file = false;
  3199. };
  3200. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  3201. namespace fields {
  3202. bool is_token_char(char c);
  3203. bool is_token(const std::string &s);
  3204. bool is_field_name(const std::string &s);
  3205. bool is_vchar(char c);
  3206. bool is_obs_text(char c);
  3207. bool is_field_vchar(char c);
  3208. bool is_field_content(const std::string &s);
  3209. bool is_field_value(const std::string &s);
  3210. bool is_field_valid(const std::string &name, const std::string &value);
  3211. } // namespace fields
  3212. } // namespace detail
  3213. /*
  3214. * TLS Abstraction Layer Declarations
  3215. */
  3216. #ifdef CPPHTTPLIB_SSL_ENABLED
  3217. // TLS abstraction layer - backend-specific type declarations
  3218. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  3219. namespace tls {
  3220. namespace impl {
  3221. // Mbed TLS context wrapper (holds config, entropy, DRBG, CA chain, own
  3222. // cert/key). This struct is accessible via tls::impl for use in SSL context
  3223. // setup callbacks (cast ctx_t to tls::impl::MbedTlsContext*).
  3224. struct MbedTlsContext {
  3225. mbedtls_ssl_config conf;
  3226. #ifndef CPPHTTPLIB_MBEDTLS_V4
  3227. // Mbed TLS 4.x uses PSA Crypto's internal RNG; no explicit entropy/DRBG.
  3228. mbedtls_entropy_context entropy;
  3229. mbedtls_ctr_drbg_context ctr_drbg;
  3230. #endif
  3231. mbedtls_x509_crt ca_chain;
  3232. mbedtls_x509_crt own_cert;
  3233. mbedtls_pk_context own_key;
  3234. bool is_server = false;
  3235. bool verify_client = false;
  3236. bool has_verify_callback = false;
  3237. MbedTlsContext();
  3238. ~MbedTlsContext();
  3239. MbedTlsContext(const MbedTlsContext &) = delete;
  3240. MbedTlsContext &operator=(const MbedTlsContext &) = delete;
  3241. };
  3242. } // namespace impl
  3243. } // namespace tls
  3244. #endif
  3245. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  3246. namespace tls {
  3247. namespace impl {
  3248. // wolfSSL context wrapper (holds WOLFSSL_CTX and related state).
  3249. // This struct is accessible via tls::impl for use in SSL context
  3250. // setup callbacks (cast ctx_t to tls::impl::WolfSSLContext*).
  3251. struct WolfSSLContext {
  3252. WOLFSSL_CTX *ctx = nullptr;
  3253. bool is_server = false;
  3254. bool verify_client = false;
  3255. bool has_verify_callback = false;
  3256. std::string ca_pem_data_; // accumulated PEM for get_ca_names/get_ca_certs
  3257. WolfSSLContext();
  3258. ~WolfSSLContext();
  3259. WolfSSLContext(const WolfSSLContext &) = delete;
  3260. WolfSSLContext &operator=(const WolfSSLContext &) = delete;
  3261. };
  3262. // CA store for wolfSSL: holds raw PEM bytes to allow reloading into any ctx
  3263. struct WolfSSLCAStore {
  3264. std::string pem_data;
  3265. };
  3266. } // namespace impl
  3267. } // namespace tls
  3268. #endif
  3269. #endif // CPPHTTPLIB_SSL_ENABLED
  3270. namespace stream {
  3271. class Result {
  3272. public:
  3273. Result();
  3274. explicit Result(ClientImpl::StreamHandle &&handle, size_t chunk_size = 8192);
  3275. Result(Result &&other) noexcept;
  3276. Result &operator=(Result &&other) noexcept;
  3277. Result(const Result &) = delete;
  3278. Result &operator=(const Result &) = delete;
  3279. // Response info
  3280. bool is_valid() const;
  3281. explicit operator bool() const;
  3282. int status() const;
  3283. const Headers &headers() const;
  3284. std::string get_header_value(const std::string &key,
  3285. const char *def = "") const;
  3286. bool has_header(const std::string &key) const;
  3287. Error error() const;
  3288. Error read_error() const;
  3289. bool has_read_error() const;
  3290. // Stream reading
  3291. bool next();
  3292. const char *data() const;
  3293. size_t size() const;
  3294. std::string read_all();
  3295. private:
  3296. ClientImpl::StreamHandle handle_;
  3297. std::string buffer_;
  3298. size_t current_size_ = 0;
  3299. size_t chunk_size_;
  3300. bool finished_ = false;
  3301. };
  3302. // GET
  3303. template <typename ClientType>
  3304. inline Result Get(ClientType &cli, const std::string &path,
  3305. size_t chunk_size = 8192) {
  3306. return Result{cli.open_stream("GET", path), chunk_size};
  3307. }
  3308. template <typename ClientType>
  3309. inline Result Get(ClientType &cli, const std::string &path,
  3310. const Headers &headers, size_t chunk_size = 8192) {
  3311. return Result{cli.open_stream("GET", path, {}, headers), chunk_size};
  3312. }
  3313. template <typename ClientType>
  3314. inline Result Get(ClientType &cli, const std::string &path,
  3315. const Params &params, size_t chunk_size = 8192) {
  3316. return Result{cli.open_stream("GET", path, params), chunk_size};
  3317. }
  3318. template <typename ClientType>
  3319. inline Result Get(ClientType &cli, const std::string &path,
  3320. const Params &params, const Headers &headers,
  3321. size_t chunk_size = 8192) {
  3322. return Result{cli.open_stream("GET", path, params, headers), chunk_size};
  3323. }
  3324. // POST
  3325. template <typename ClientType>
  3326. inline Result Post(ClientType &cli, const std::string &path,
  3327. const std::string &body, const std::string &content_type,
  3328. size_t chunk_size = 8192) {
  3329. return Result{cli.open_stream("POST", path, {}, {}, body, content_type),
  3330. chunk_size};
  3331. }
  3332. template <typename ClientType>
  3333. inline Result Post(ClientType &cli, const std::string &path,
  3334. const Headers &headers, const std::string &body,
  3335. const std::string &content_type, size_t chunk_size = 8192) {
  3336. return Result{cli.open_stream("POST", path, {}, headers, body, content_type),
  3337. chunk_size};
  3338. }
  3339. template <typename ClientType>
  3340. inline Result Post(ClientType &cli, const std::string &path,
  3341. const Params &params, const std::string &body,
  3342. const std::string &content_type, size_t chunk_size = 8192) {
  3343. return Result{cli.open_stream("POST", path, params, {}, body, content_type),
  3344. chunk_size};
  3345. }
  3346. template <typename ClientType>
  3347. inline Result Post(ClientType &cli, const std::string &path,
  3348. const Params &params, const Headers &headers,
  3349. const std::string &body, const std::string &content_type,
  3350. size_t chunk_size = 8192) {
  3351. return Result{
  3352. cli.open_stream("POST", path, params, headers, body, content_type),
  3353. chunk_size};
  3354. }
  3355. // PUT
  3356. template <typename ClientType>
  3357. inline Result Put(ClientType &cli, const std::string &path,
  3358. const std::string &body, const std::string &content_type,
  3359. size_t chunk_size = 8192) {
  3360. return Result{cli.open_stream("PUT", path, {}, {}, body, content_type),
  3361. chunk_size};
  3362. }
  3363. template <typename ClientType>
  3364. inline Result Put(ClientType &cli, const std::string &path,
  3365. const Headers &headers, const std::string &body,
  3366. const std::string &content_type, size_t chunk_size = 8192) {
  3367. return Result{cli.open_stream("PUT", path, {}, headers, body, content_type),
  3368. chunk_size};
  3369. }
  3370. template <typename ClientType>
  3371. inline Result Put(ClientType &cli, const std::string &path,
  3372. const Params &params, const std::string &body,
  3373. const std::string &content_type, size_t chunk_size = 8192) {
  3374. return Result{cli.open_stream("PUT", path, params, {}, body, content_type),
  3375. chunk_size};
  3376. }
  3377. template <typename ClientType>
  3378. inline Result Put(ClientType &cli, const std::string &path,
  3379. const Params &params, const Headers &headers,
  3380. const std::string &body, const std::string &content_type,
  3381. size_t chunk_size = 8192) {
  3382. return Result{
  3383. cli.open_stream("PUT", path, params, headers, body, content_type),
  3384. chunk_size};
  3385. }
  3386. // PATCH
  3387. template <typename ClientType>
  3388. inline Result Patch(ClientType &cli, const std::string &path,
  3389. const std::string &body, const std::string &content_type,
  3390. size_t chunk_size = 8192) {
  3391. return Result{cli.open_stream("PATCH", path, {}, {}, body, content_type),
  3392. chunk_size};
  3393. }
  3394. template <typename ClientType>
  3395. inline Result Patch(ClientType &cli, const std::string &path,
  3396. const Headers &headers, const std::string &body,
  3397. const std::string &content_type, size_t chunk_size = 8192) {
  3398. return Result{cli.open_stream("PATCH", path, {}, headers, body, content_type),
  3399. chunk_size};
  3400. }
  3401. template <typename ClientType>
  3402. inline Result Patch(ClientType &cli, const std::string &path,
  3403. const Params &params, const std::string &body,
  3404. const std::string &content_type, size_t chunk_size = 8192) {
  3405. return Result{cli.open_stream("PATCH", path, params, {}, body, content_type),
  3406. chunk_size};
  3407. }
  3408. template <typename ClientType>
  3409. inline Result Patch(ClientType &cli, const std::string &path,
  3410. const Params &params, const Headers &headers,
  3411. const std::string &body, const std::string &content_type,
  3412. size_t chunk_size = 8192) {
  3413. return Result{
  3414. cli.open_stream("PATCH", path, params, headers, body, content_type),
  3415. chunk_size};
  3416. }
  3417. // DELETE
  3418. template <typename ClientType>
  3419. inline Result Delete(ClientType &cli, const std::string &path,
  3420. size_t chunk_size = 8192) {
  3421. return Result{cli.open_stream("DELETE", path), chunk_size};
  3422. }
  3423. template <typename ClientType>
  3424. inline Result Delete(ClientType &cli, const std::string &path,
  3425. const Headers &headers, size_t chunk_size = 8192) {
  3426. return Result{cli.open_stream("DELETE", path, {}, headers), chunk_size};
  3427. }
  3428. template <typename ClientType>
  3429. inline Result Delete(ClientType &cli, const std::string &path,
  3430. const std::string &body, const std::string &content_type,
  3431. size_t chunk_size = 8192) {
  3432. return Result{cli.open_stream("DELETE", path, {}, {}, body, content_type),
  3433. chunk_size};
  3434. }
  3435. template <typename ClientType>
  3436. inline Result Delete(ClientType &cli, const std::string &path,
  3437. const Headers &headers, const std::string &body,
  3438. const std::string &content_type,
  3439. size_t chunk_size = 8192) {
  3440. return Result{
  3441. cli.open_stream("DELETE", path, {}, headers, body, content_type),
  3442. chunk_size};
  3443. }
  3444. template <typename ClientType>
  3445. inline Result Delete(ClientType &cli, const std::string &path,
  3446. const Params &params, size_t chunk_size = 8192) {
  3447. return Result{cli.open_stream("DELETE", path, params), chunk_size};
  3448. }
  3449. template <typename ClientType>
  3450. inline Result Delete(ClientType &cli, const std::string &path,
  3451. const Params &params, const Headers &headers,
  3452. size_t chunk_size = 8192) {
  3453. return Result{cli.open_stream("DELETE", path, params, headers), chunk_size};
  3454. }
  3455. template <typename ClientType>
  3456. inline Result Delete(ClientType &cli, const std::string &path,
  3457. const Params &params, const std::string &body,
  3458. const std::string &content_type,
  3459. size_t chunk_size = 8192) {
  3460. return Result{cli.open_stream("DELETE", path, params, {}, body, content_type),
  3461. chunk_size};
  3462. }
  3463. template <typename ClientType>
  3464. inline Result Delete(ClientType &cli, const std::string &path,
  3465. const Params &params, const Headers &headers,
  3466. const std::string &body, const std::string &content_type,
  3467. size_t chunk_size = 8192) {
  3468. return Result{
  3469. cli.open_stream("DELETE", path, params, headers, body, content_type),
  3470. chunk_size};
  3471. }
  3472. // HEAD
  3473. template <typename ClientType>
  3474. inline Result Head(ClientType &cli, const std::string &path,
  3475. size_t chunk_size = 8192) {
  3476. return Result{cli.open_stream("HEAD", path), chunk_size};
  3477. }
  3478. template <typename ClientType>
  3479. inline Result Head(ClientType &cli, const std::string &path,
  3480. const Headers &headers, size_t chunk_size = 8192) {
  3481. return Result{cli.open_stream("HEAD", path, {}, headers), chunk_size};
  3482. }
  3483. template <typename ClientType>
  3484. inline Result Head(ClientType &cli, const std::string &path,
  3485. const Params &params, size_t chunk_size = 8192) {
  3486. return Result{cli.open_stream("HEAD", path, params), chunk_size};
  3487. }
  3488. template <typename ClientType>
  3489. inline Result Head(ClientType &cli, const std::string &path,
  3490. const Params &params, const Headers &headers,
  3491. size_t chunk_size = 8192) {
  3492. return Result{cli.open_stream("HEAD", path, params, headers), chunk_size};
  3493. }
  3494. // OPTIONS
  3495. template <typename ClientType>
  3496. inline Result Options(ClientType &cli, const std::string &path,
  3497. size_t chunk_size = 8192) {
  3498. return Result{cli.open_stream("OPTIONS", path), chunk_size};
  3499. }
  3500. template <typename ClientType>
  3501. inline Result Options(ClientType &cli, const std::string &path,
  3502. const Headers &headers, size_t chunk_size = 8192) {
  3503. return Result{cli.open_stream("OPTIONS", path, {}, headers), chunk_size};
  3504. }
  3505. template <typename ClientType>
  3506. inline Result Options(ClientType &cli, const std::string &path,
  3507. const Params &params, size_t chunk_size = 8192) {
  3508. return Result{cli.open_stream("OPTIONS", path, params), chunk_size};
  3509. }
  3510. template <typename ClientType>
  3511. inline Result Options(ClientType &cli, const std::string &path,
  3512. const Params &params, const Headers &headers,
  3513. size_t chunk_size = 8192) {
  3514. return Result{cli.open_stream("OPTIONS", path, params, headers), chunk_size};
  3515. }
  3516. } // namespace stream
  3517. namespace sse {
  3518. struct SSEMessage {
  3519. std::string event; // Event type (default: "message")
  3520. std::string data; // Event payload
  3521. std::string id; // Event ID for Last-Event-ID header
  3522. SSEMessage();
  3523. void clear();
  3524. };
  3525. class SSEClient {
  3526. public:
  3527. using MessageHandler = std::function<void(const SSEMessage &)>;
  3528. using ErrorHandler = std::function<void(Error)>;
  3529. using OpenHandler = std::function<void()>;
  3530. SSEClient(Client &client, const std::string &path);
  3531. SSEClient(Client &client, const std::string &path, const Headers &headers);
  3532. ~SSEClient();
  3533. SSEClient(const SSEClient &) = delete;
  3534. SSEClient &operator=(const SSEClient &) = delete;
  3535. // Event handlers
  3536. SSEClient &on_message(MessageHandler handler);
  3537. SSEClient &on_event(const std::string &type, MessageHandler handler);
  3538. SSEClient &on_open(OpenHandler handler);
  3539. SSEClient &on_error(ErrorHandler handler);
  3540. SSEClient &set_reconnect_interval(int ms);
  3541. SSEClient &set_max_reconnect_attempts(int n);
  3542. // Update headers (thread-safe)
  3543. SSEClient &set_headers(const Headers &headers);
  3544. // State accessors
  3545. bool is_connected() const;
  3546. const std::string &last_event_id() const;
  3547. // Blocking start - runs event loop with auto-reconnect
  3548. void start();
  3549. // Non-blocking start - runs in background thread
  3550. void start_async();
  3551. // Stop the client (thread-safe)
  3552. void stop();
  3553. private:
  3554. bool parse_sse_line(const std::string &line, SSEMessage &msg, int &retry_ms);
  3555. void run_event_loop();
  3556. void dispatch_event(const SSEMessage &msg);
  3557. bool should_reconnect(int count) const;
  3558. void wait_for_reconnect();
  3559. // Client and path
  3560. Client &client_;
  3561. std::string path_;
  3562. Headers headers_;
  3563. mutable std::mutex headers_mutex_;
  3564. // Callbacks
  3565. MessageHandler on_message_;
  3566. std::map<std::string, MessageHandler> event_handlers_;
  3567. OpenHandler on_open_;
  3568. ErrorHandler on_error_;
  3569. // Configuration
  3570. int reconnect_interval_ms_ = 3000;
  3571. int max_reconnect_attempts_ = 0; // 0 = unlimited
  3572. // State
  3573. std::atomic<bool> running_{false};
  3574. std::atomic<bool> connected_{false};
  3575. std::string last_event_id_;
  3576. // Async support
  3577. std::thread async_thread_;
  3578. };
  3579. } // namespace sse
  3580. namespace ws {
  3581. enum class Opcode : uint8_t {
  3582. Continuation = 0x0,
  3583. Text = 0x1,
  3584. Binary = 0x2,
  3585. Close = 0x8,
  3586. Ping = 0x9,
  3587. Pong = 0xA,
  3588. };
  3589. enum class CloseStatus : uint16_t {
  3590. Normal = 1000,
  3591. GoingAway = 1001,
  3592. ProtocolError = 1002,
  3593. UnsupportedData = 1003,
  3594. NoStatus = 1005,
  3595. Abnormal = 1006,
  3596. InvalidPayload = 1007,
  3597. PolicyViolation = 1008,
  3598. MessageTooBig = 1009,
  3599. MandatoryExtension = 1010,
  3600. InternalError = 1011,
  3601. };
  3602. // Timeout is returned only when a read timeout was set and it elapsed before
  3603. // any byte of a frame arrived: nothing was consumed and the connection is
  3604. // still open, so the caller can send on it and read again. `msg` is left
  3605. // untouched, so a `while (ws.read(msg))` loop must not treat it as a message.
  3606. enum ReadResult : int { Fail = 0, Text = 1, Binary = 2, Timeout = 3 };
  3607. // Result of WebSocketClient::connect(). Truthy only when the WebSocket
  3608. // upgrade handshake fully succeeded. On failure error() identifies the
  3609. // failing layer; status()/headers() expose the server's upgrade response
  3610. // when one was received (status() is -1 otherwise).
  3611. class Result {
  3612. public:
  3613. Result() = default;
  3614. Result(Error err, int status, Headers &&headers)
  3615. : err_(err), status_(status), headers_(std::move(headers)) {}
  3616. explicit operator bool() const { return err_ == Error::Success; }
  3617. Error error() const { return err_; }
  3618. // Upgrade response info
  3619. int status() const { return status_; }
  3620. const Headers &headers() const { return headers_; }
  3621. std::string get_header_value(const std::string &key,
  3622. const char *def = "") const {
  3623. return detail::get_header_value(headers_, key, def, 0);
  3624. }
  3625. bool has_header(const std::string &key) const {
  3626. return headers_.find(key) != headers_.end();
  3627. }
  3628. #ifdef CPPHTTPLIB_SSL_ENABLED
  3629. Result(Error err, int status, Headers &&headers, int ssl_error,
  3630. uint64_t ssl_backend_error)
  3631. : err_(err), status_(status), headers_(std::move(headers)),
  3632. ssl_error_(ssl_error), ssl_backend_error_(ssl_backend_error) {}
  3633. int ssl_error() const { return ssl_error_; }
  3634. uint64_t ssl_backend_error() const { return ssl_backend_error_; }
  3635. #endif
  3636. private:
  3637. Error err_ = Error::Unknown; // a default-constructed Result is falsy
  3638. int status_ = -1;
  3639. Headers headers_;
  3640. #ifdef CPPHTTPLIB_SSL_ENABLED
  3641. int ssl_error_ = 0;
  3642. uint64_t ssl_backend_error_ = 0;
  3643. #endif
  3644. };
  3645. class WebSocket {
  3646. public:
  3647. WebSocket(const WebSocket &) = delete;
  3648. WebSocket &operator=(const WebSocket &) = delete;
  3649. ~WebSocket();
  3650. ReadResult read(std::string &msg);
  3651. bool send(const std::string &data);
  3652. bool send(const char *data, size_t len);
  3653. void close(CloseStatus status = CloseStatus::Normal,
  3654. const std::string &reason = "");
  3655. const Request &request() const;
  3656. bool is_open() const;
  3657. // Bound how long read() waits before returning Timeout. 0 waits forever.
  3658. // A server handler owns its connection's timeout this way; a client sets it
  3659. // through WebSocketClient. Safe to call while another thread is in read().
  3660. //
  3661. // Only a timeout set here is reported as Timeout. The compile-time default
  3662. // (CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND) is a backstop rather
  3663. // than a request for control, so when it elapses read() returns Fail and
  3664. // closes the connection, and `while (ws.read(msg))` ends as it always has.
  3665. void set_read_timeout(time_t sec, time_t usec = 0);
  3666. template <class Rep, class Period>
  3667. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3668. private:
  3669. friend class httplib::Server;
  3670. friend class WebSocketClient;
  3671. WebSocket(
  3672. Stream &strm, const Request &req, bool is_server,
  3673. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3674. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3675. : strm_(strm), req_(req), is_server_(is_server),
  3676. ping_interval_sec_(ping_interval_sec),
  3677. max_missed_pongs_(max_missed_pongs) {
  3678. start_heartbeat();
  3679. }
  3680. WebSocket(
  3681. std::unique_ptr<Stream> &&owned_strm, const Request &req, bool is_server,
  3682. time_t ping_interval_sec = CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND,
  3683. int max_missed_pongs = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS)
  3684. : strm_(*owned_strm), owned_strm_(std::move(owned_strm)), req_(req),
  3685. is_server_(is_server), ping_interval_sec_(ping_interval_sec),
  3686. max_missed_pongs_(max_missed_pongs) {
  3687. start_heartbeat();
  3688. }
  3689. void start_heartbeat();
  3690. bool send_frame(Opcode op, const char *data, size_t len, bool fin = true);
  3691. Stream &strm_;
  3692. std::unique_ptr<Stream> owned_strm_;
  3693. Request req_;
  3694. bool is_server_;
  3695. time_t ping_interval_sec_;
  3696. int max_missed_pongs_;
  3697. int unacked_pings_ = 0;
  3698. std::atomic<bool> closed_{false};
  3699. // Set once the caller has bounded read() through set_read_timeout(). Until
  3700. // then the timeout in effect is the compile-time default, and elapsing it
  3701. // is a failure that closes the connection, not a Timeout.
  3702. std::atomic<bool> read_timeout_set_{false};
  3703. std::mutex write_mutex_;
  3704. // Owned by whichever thread is parsing frames off strm_. Only one thread
  3705. // may do so: read_websocket_frame() reads a payload until it has the whole
  3706. // declared length, so a second parser stealing bytes silently corrupts the
  3707. // message the first one is assembling.
  3708. std::mutex read_mutex_;
  3709. std::thread ping_thread_;
  3710. std::mutex ping_mutex_;
  3711. std::condition_variable ping_cv_;
  3712. };
  3713. class WebSocketClient {
  3714. public:
  3715. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3716. const Headers &headers = {});
  3717. ~WebSocketClient();
  3718. WebSocketClient(const WebSocketClient &) = delete;
  3719. WebSocketClient &operator=(const WebSocketClient &) = delete;
  3720. bool is_valid() const;
  3721. Result connect();
  3722. ReadResult read(std::string &msg);
  3723. bool send(const std::string &data);
  3724. bool send(const char *data, size_t len);
  3725. void close(CloseStatus status = CloseStatus::Normal,
  3726. const std::string &reason = "");
  3727. bool is_open() const;
  3728. const std::string &subprotocol() const;
  3729. void set_read_timeout(time_t sec, time_t usec = 0);
  3730. template <class Rep, class Period>
  3731. void set_read_timeout(const std::chrono::duration<Rep, Period> &duration);
  3732. void set_write_timeout(time_t sec, time_t usec = 0);
  3733. template <class Rep, class Period>
  3734. void set_write_timeout(const std::chrono::duration<Rep, Period> &duration);
  3735. void set_websocket_ping_interval(time_t sec);
  3736. void set_websocket_max_missed_pongs(int count);
  3737. void set_tcp_nodelay(bool on);
  3738. void set_address_family(int family);
  3739. void set_ipv6_v6only(bool on);
  3740. void set_socket_options(SocketOptions socket_options);
  3741. void set_connection_timeout(time_t sec, time_t usec = 0);
  3742. template <class Rep, class Period>
  3743. void
  3744. set_connection_timeout(const std::chrono::duration<Rep, Period> &duration);
  3745. void set_interface(const std::string &intf);
  3746. void set_hostname_addr_map(std::map<std::string, std::string> addr_map);
  3747. #ifdef CPPHTTPLIB_SSL_ENABLED
  3748. struct PemMemory {
  3749. const char *cert_pem;
  3750. size_t cert_pem_len;
  3751. const char *key_pem;
  3752. size_t key_pem_len;
  3753. const char *private_key_password;
  3754. };
  3755. explicit WebSocketClient(const std::string &scheme_host_port_path,
  3756. const PemMemory &pem, const Headers &headers = {});
  3757. void set_ca_cert_path(const std::string &ca_cert_file_path,
  3758. const std::string &ca_cert_dir_path = std::string());
  3759. void set_ca_cert_store(tls::ca_store_t store);
  3760. void load_ca_cert_store(const char *ca_cert, std::size_t size);
  3761. void enable_server_certificate_verification(bool enabled);
  3762. void enable_server_hostname_verification(bool enabled);
  3763. void enable_system_ca(bool enabled);
  3764. #endif
  3765. private:
  3766. void shutdown_and_close();
  3767. bool create_stream(std::unique_ptr<Stream> &strm, Error &error,
  3768. int &ssl_error, uint64_t &ssl_backend_error);
  3769. void prepare_default_headers(Request &req);
  3770. std::string host_;
  3771. int port_;
  3772. std::string path_;
  3773. Headers headers_;
  3774. std::string subprotocol_;
  3775. bool is_valid_ = false;
  3776. socket_t sock_ = INVALID_SOCKET;
  3777. std::unique_ptr<WebSocket> ws_;
  3778. time_t read_timeout_sec_ = CPPHTTPLIB_WEBSOCKET_CLIENT_READ_TIMEOUT_SECOND;
  3779. time_t read_timeout_usec_ = 0;
  3780. bool read_timeout_set_ = false; // see WebSocket::read_timeout_set_
  3781. time_t write_timeout_sec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_SECOND;
  3782. time_t write_timeout_usec_ = CPPHTTPLIB_CLIENT_WRITE_TIMEOUT_USECOND;
  3783. time_t websocket_ping_interval_sec_ =
  3784. CPPHTTPLIB_WEBSOCKET_PING_INTERVAL_SECOND;
  3785. int websocket_max_missed_pongs_ = CPPHTTPLIB_WEBSOCKET_MAX_MISSED_PONGS;
  3786. int address_family_ = AF_UNSPEC;
  3787. bool tcp_nodelay_ = CPPHTTPLIB_TCP_NODELAY;
  3788. bool ipv6_v6only_ = CPPHTTPLIB_IPV6_V6ONLY;
  3789. SocketOptions socket_options_ = nullptr;
  3790. time_t connection_timeout_sec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_SECOND;
  3791. time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
  3792. std::string interface_;
  3793. // Hostname to connection target map. The value is an IP literal or another
  3794. // hostname; only the connection target changes, never the identity.
  3795. std::map<std::string, std::string> addr_map_;
  3796. #ifdef CPPHTTPLIB_SSL_ENABLED
  3797. bool is_ssl_ = false;
  3798. tls::ctx_t tls_ctx_ = nullptr;
  3799. tls::session_t tls_session_ = nullptr;
  3800. std::string ca_cert_file_path_;
  3801. std::string ca_cert_dir_path_;
  3802. bool custom_ca_loaded_ = false;
  3803. bool certs_loaded_ = false;
  3804. SystemCAMode system_ca_mode_ = SystemCAMode::Auto;
  3805. bool server_certificate_verification_ = true;
  3806. bool server_hostname_verification_ = true;
  3807. #endif
  3808. };
  3809. template <class Rep, class Period>
  3810. inline void WebSocket::set_read_timeout(
  3811. const std::chrono::duration<Rep, Period> &duration) {
  3812. detail::duration_to_sec_and_usec(
  3813. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3814. }
  3815. template <class Rep, class Period>
  3816. inline void WebSocketClient::set_read_timeout(
  3817. const std::chrono::duration<Rep, Period> &duration) {
  3818. detail::duration_to_sec_and_usec(
  3819. duration, [&](time_t sec, time_t usec) { set_read_timeout(sec, usec); });
  3820. }
  3821. template <class Rep, class Period>
  3822. inline void WebSocketClient::set_write_timeout(
  3823. const std::chrono::duration<Rep, Period> &duration) {
  3824. detail::duration_to_sec_and_usec(
  3825. duration, [&](time_t sec, time_t usec) { set_write_timeout(sec, usec); });
  3826. }
  3827. template <class Rep, class Period>
  3828. inline void WebSocketClient::set_connection_timeout(
  3829. const std::chrono::duration<Rep, Period> &duration) {
  3830. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t usec) {
  3831. set_connection_timeout(sec, usec);
  3832. });
  3833. }
  3834. namespace impl {
  3835. bool is_valid_utf8(const std::string &s);
  3836. // Three states, because a failure that consumed bytes and one that consumed
  3837. // none are not the same thing: the first has left the stream in the middle of
  3838. // a frame and the connection cannot be reused, the second can just be retried.
  3839. enum class FrameRead { Ok, Fail, Timeout };
  3840. FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  3841. std::string &payload, bool &fin,
  3842. bool expect_masked, size_t max_len);
  3843. } // namespace impl
  3844. } // namespace ws
  3845. // ----------------------------------------------------------------------------
  3846. /*
  3847. * Implementation that will be part of the .cc file if split into .h + .cc.
  3848. */
  3849. namespace stream {
  3850. // stream::Result implementations
  3851. inline Result::Result() : chunk_size_(8192) {}
  3852. inline Result::Result(ClientImpl::StreamHandle &&handle, size_t chunk_size)
  3853. : handle_(std::move(handle)), chunk_size_(chunk_size) {}
  3854. inline Result::Result(Result &&other) noexcept
  3855. : handle_(std::move(other.handle_)), buffer_(std::move(other.buffer_)),
  3856. current_size_(other.current_size_), chunk_size_(other.chunk_size_),
  3857. finished_(other.finished_) {
  3858. other.current_size_ = 0;
  3859. other.finished_ = true;
  3860. }
  3861. inline Result &Result::operator=(Result &&other) noexcept {
  3862. if (this != &other) {
  3863. handle_ = std::move(other.handle_);
  3864. buffer_ = std::move(other.buffer_);
  3865. current_size_ = other.current_size_;
  3866. chunk_size_ = other.chunk_size_;
  3867. finished_ = other.finished_;
  3868. other.current_size_ = 0;
  3869. other.finished_ = true;
  3870. }
  3871. return *this;
  3872. }
  3873. inline bool Result::is_valid() const { return handle_.is_valid(); }
  3874. inline Result::operator bool() const { return is_valid(); }
  3875. inline int Result::status() const {
  3876. return handle_.response ? handle_.response->status : -1;
  3877. }
  3878. inline const Headers &Result::headers() const {
  3879. static const Headers empty_headers;
  3880. return handle_.response ? handle_.response->headers : empty_headers;
  3881. }
  3882. inline std::string Result::get_header_value(const std::string &key,
  3883. const char *def) const {
  3884. return handle_.response ? handle_.response->get_header_value(key, def) : def;
  3885. }
  3886. inline bool Result::has_header(const std::string &key) const {
  3887. return handle_.response ? handle_.response->has_header(key) : false;
  3888. }
  3889. inline Error Result::error() const { return handle_.error; }
  3890. inline Error Result::read_error() const { return handle_.get_read_error(); }
  3891. inline bool Result::has_read_error() const { return handle_.has_read_error(); }
  3892. inline bool Result::next() {
  3893. if (!handle_.is_valid() || finished_) { return false; }
  3894. if (buffer_.size() < chunk_size_) { buffer_.resize(chunk_size_); }
  3895. ssize_t n = handle_.read(&buffer_[0], chunk_size_);
  3896. if (n > 0) {
  3897. current_size_ = static_cast<size_t>(n);
  3898. return true;
  3899. }
  3900. current_size_ = 0;
  3901. finished_ = true;
  3902. return false;
  3903. }
  3904. inline const char *Result::data() const { return buffer_.data(); }
  3905. inline size_t Result::size() const { return current_size_; }
  3906. inline std::string Result::read_all() {
  3907. std::string result;
  3908. while (next()) {
  3909. result.append(data(), size());
  3910. }
  3911. return result;
  3912. }
  3913. } // namespace stream
  3914. namespace sse {
  3915. // SSEMessage implementations
  3916. inline SSEMessage::SSEMessage() : event("message") {}
  3917. inline void SSEMessage::clear() {
  3918. event = "message";
  3919. data.clear();
  3920. id.clear();
  3921. }
  3922. // SSEClient implementations
  3923. inline SSEClient::SSEClient(Client &client, const std::string &path)
  3924. : client_(client), path_(path) {}
  3925. inline SSEClient::SSEClient(Client &client, const std::string &path,
  3926. const Headers &headers)
  3927. : client_(client), path_(path), headers_(headers) {}
  3928. inline SSEClient::~SSEClient() { stop(); }
  3929. inline SSEClient &SSEClient::on_message(MessageHandler handler) {
  3930. on_message_ = std::move(handler);
  3931. return *this;
  3932. }
  3933. inline SSEClient &SSEClient::on_event(const std::string &type,
  3934. MessageHandler handler) {
  3935. event_handlers_[type] = std::move(handler);
  3936. return *this;
  3937. }
  3938. inline SSEClient &SSEClient::on_open(OpenHandler handler) {
  3939. on_open_ = std::move(handler);
  3940. return *this;
  3941. }
  3942. inline SSEClient &SSEClient::on_error(ErrorHandler handler) {
  3943. on_error_ = std::move(handler);
  3944. return *this;
  3945. }
  3946. inline SSEClient &SSEClient::set_reconnect_interval(int ms) {
  3947. reconnect_interval_ms_ = ms;
  3948. return *this;
  3949. }
  3950. inline SSEClient &SSEClient::set_max_reconnect_attempts(int n) {
  3951. max_reconnect_attempts_ = n;
  3952. return *this;
  3953. }
  3954. inline SSEClient &SSEClient::set_headers(const Headers &headers) {
  3955. std::lock_guard<std::mutex> lock(headers_mutex_);
  3956. headers_ = headers;
  3957. return *this;
  3958. }
  3959. inline bool SSEClient::is_connected() const { return connected_.load(); }
  3960. inline const std::string &SSEClient::last_event_id() const {
  3961. return last_event_id_;
  3962. }
  3963. inline void SSEClient::start() {
  3964. running_.store(true);
  3965. run_event_loop();
  3966. }
  3967. inline void SSEClient::start_async() {
  3968. running_.store(true);
  3969. async_thread_ = std::thread([this]() { run_event_loop(); });
  3970. }
  3971. inline void SSEClient::stop() {
  3972. running_.store(false);
  3973. client_.stop(); // Cancel any pending operations
  3974. if (async_thread_.joinable()) { async_thread_.join(); }
  3975. }
  3976. inline bool SSEClient::parse_sse_line(const std::string &line, SSEMessage &msg,
  3977. int &retry_ms) {
  3978. // Blank line signals end of event
  3979. if (line.empty() || line == "\r") { return true; }
  3980. // Lines starting with ':' are comments (ignored)
  3981. if (!line.empty() && line[0] == ':') { return false; }
  3982. // Find the colon separator
  3983. auto colon_pos = line.find(':');
  3984. if (colon_pos == std::string::npos) {
  3985. // Line with no colon is treated as field name with empty value
  3986. return false;
  3987. }
  3988. auto field = line.substr(0, colon_pos);
  3989. std::string value;
  3990. // Value starts after colon, skip optional single space
  3991. if (colon_pos + 1 < line.size()) {
  3992. auto value_start = colon_pos + 1;
  3993. if (line[value_start] == ' ') { value_start++; }
  3994. value = line.substr(value_start);
  3995. // Remove trailing \r if present
  3996. if (!value.empty() && value.back() == '\r') { value.pop_back(); }
  3997. }
  3998. // Handle known fields
  3999. if (field == "event") {
  4000. msg.event = value;
  4001. } else if (field == "data") {
  4002. // Multiple data lines are concatenated with newlines
  4003. if (!msg.data.empty()) { msg.data += "\n"; }
  4004. msg.data += value;
  4005. } else if (field == "id") {
  4006. // Empty id is valid (clears the last event ID)
  4007. msg.id = value;
  4008. } else if (field == "retry") {
  4009. // Parse retry interval in milliseconds
  4010. {
  4011. int v = 0;
  4012. auto res =
  4013. detail::from_chars(value.data(), value.data() + value.size(), v);
  4014. if (res.ec == std::errc{}) { retry_ms = v; }
  4015. }
  4016. }
  4017. // Unknown fields are ignored per SSE spec
  4018. return false;
  4019. }
  4020. inline void SSEClient::run_event_loop() {
  4021. auto reconnect_count = 0;
  4022. while (running_.load()) {
  4023. // Build headers, including Last-Event-ID if we have one
  4024. Headers request_headers;
  4025. {
  4026. std::lock_guard<std::mutex> lock(headers_mutex_);
  4027. request_headers = headers_;
  4028. }
  4029. if (!last_event_id_.empty()) {
  4030. request_headers.emplace("Last-Event-ID", last_event_id_);
  4031. }
  4032. // Open streaming connection
  4033. auto result = stream::Get(client_, path_, request_headers);
  4034. // Connection error handling
  4035. if (!result) {
  4036. connected_.store(false);
  4037. if (on_error_) { on_error_(result.error()); }
  4038. if (!should_reconnect(reconnect_count)) { break; }
  4039. wait_for_reconnect();
  4040. reconnect_count++;
  4041. continue;
  4042. }
  4043. if (result.status() != StatusCode::OK_200) {
  4044. connected_.store(false);
  4045. if (on_error_) { on_error_(Error::Connection); }
  4046. // For certain errors, don't reconnect.
  4047. // Note: 401 is intentionally absent so that handlers can refresh
  4048. // credentials via set_headers() and let the client reconnect.
  4049. if (result.status() == StatusCode::NoContent_204 ||
  4050. result.status() == StatusCode::NotFound_404 ||
  4051. result.status() == StatusCode::Forbidden_403) {
  4052. break;
  4053. }
  4054. if (!should_reconnect(reconnect_count)) { break; }
  4055. wait_for_reconnect();
  4056. reconnect_count++;
  4057. continue;
  4058. }
  4059. // Connection successful
  4060. connected_.store(true);
  4061. reconnect_count = 0;
  4062. if (on_open_) { on_open_(); }
  4063. // Event receiving loop
  4064. std::string buffer;
  4065. SSEMessage current_msg;
  4066. while (running_.load() && result.next()) {
  4067. buffer.append(result.data(), result.size());
  4068. // Process complete lines in the buffer
  4069. size_t line_start = 0;
  4070. size_t newline_pos;
  4071. while ((newline_pos = buffer.find('\n', line_start)) !=
  4072. std::string::npos) {
  4073. auto line = buffer.substr(line_start, newline_pos - line_start);
  4074. line_start = newline_pos + 1;
  4075. // Parse the line and check if event is complete
  4076. auto event_complete =
  4077. parse_sse_line(line, current_msg, reconnect_interval_ms_);
  4078. if (event_complete && !current_msg.data.empty()) {
  4079. // Update last_event_id for reconnection
  4080. if (!current_msg.id.empty()) { last_event_id_ = current_msg.id; }
  4081. // Dispatch event to appropriate handler
  4082. dispatch_event(current_msg);
  4083. current_msg.clear();
  4084. }
  4085. }
  4086. // Keep unprocessed data in buffer
  4087. buffer.erase(0, line_start);
  4088. }
  4089. // Connection ended
  4090. connected_.store(false);
  4091. if (!running_.load()) { break; }
  4092. // Check for read errors
  4093. if (result.has_read_error()) {
  4094. if (on_error_) { on_error_(result.read_error()); }
  4095. }
  4096. if (!should_reconnect(reconnect_count)) { break; }
  4097. wait_for_reconnect();
  4098. reconnect_count++;
  4099. }
  4100. connected_.store(false);
  4101. }
  4102. inline void SSEClient::dispatch_event(const SSEMessage &msg) {
  4103. // Check for specific event type handler first
  4104. auto it = event_handlers_.find(msg.event);
  4105. if (it != event_handlers_.end()) {
  4106. it->second(msg);
  4107. return;
  4108. }
  4109. // Fall back to generic message handler
  4110. if (on_message_) { on_message_(msg); }
  4111. }
  4112. inline bool SSEClient::should_reconnect(int count) const {
  4113. if (!running_.load()) { return false; }
  4114. if (max_reconnect_attempts_ == 0) { return true; } // unlimited
  4115. return count < max_reconnect_attempts_;
  4116. }
  4117. inline void SSEClient::wait_for_reconnect() {
  4118. // Use small increments to check running_ flag frequently
  4119. auto waited = 0;
  4120. while (running_.load() && waited < reconnect_interval_ms_) {
  4121. std::this_thread::sleep_for(std::chrono::milliseconds(100));
  4122. waited += 100;
  4123. }
  4124. }
  4125. } // namespace sse
  4126. #ifdef CPPHTTPLIB_SSL_ENABLED
  4127. /*
  4128. * TLS abstraction layer - internal function declarations
  4129. * These are implementation details and not part of the public API.
  4130. */
  4131. namespace tls {
  4132. // Client context
  4133. ctx_t create_client_context();
  4134. void free_context(ctx_t ctx);
  4135. bool set_min_version(ctx_t ctx, Version version);
  4136. bool load_ca_pem(ctx_t ctx, const char *pem, size_t len);
  4137. bool load_ca_file(ctx_t ctx, const char *file_path);
  4138. bool load_ca_dir(ctx_t ctx, const char *dir_path);
  4139. bool load_system_certs(ctx_t ctx);
  4140. bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4141. const char *password);
  4142. bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  4143. const char *key_path, const char *password);
  4144. // Server context
  4145. ctx_t create_server_context();
  4146. bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  4147. const char *password);
  4148. bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  4149. const char *key_path, const char *password);
  4150. bool set_client_ca_file(ctx_t ctx, const char *ca_file, const char *ca_dir);
  4151. void set_verify_client(ctx_t ctx, bool require);
  4152. // Session management
  4153. session_t create_session(ctx_t ctx, socket_t sock);
  4154. void free_session(session_t session);
  4155. bool set_sni(session_t session, const char *hostname, bool verify_hostname);
  4156. // Handshake (non-blocking capable)
  4157. TlsError connect(session_t session);
  4158. TlsError accept(session_t session);
  4159. // Handshake with timeout (blocking until timeout)
  4160. bool connect_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4161. time_t timeout_usec, TlsError *err);
  4162. bool accept_nonblocking(session_t session, socket_t sock, time_t timeout_sec,
  4163. time_t timeout_usec, TlsError *err);
  4164. // I/O (non-blocking capable)
  4165. ssize_t read(session_t session, void *buf, size_t len, TlsError &err);
  4166. ssize_t write(session_t session, const void *buf, size_t len, TlsError &err);
  4167. int pending(const_session_t session);
  4168. void shutdown(session_t session, bool graceful);
  4169. // Connection state
  4170. bool is_peer_closed(session_t session, socket_t sock);
  4171. // Certificate verification
  4172. cert_t get_peer_cert(const_session_t session);
  4173. void free_cert(cert_t cert);
  4174. bool verify_hostname(cert_t cert, const char *hostname);
  4175. uint64_t hostname_mismatch_code();
  4176. long get_verify_result(const_session_t session);
  4177. // Certificate introspection
  4178. std::string get_cert_subject_cn(cert_t cert);
  4179. std::string get_cert_issuer_name(cert_t cert);
  4180. bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans);
  4181. bool get_cert_validity(cert_t cert, time_t &not_before, time_t &not_after);
  4182. std::string get_cert_serial(cert_t cert);
  4183. bool get_cert_der(cert_t cert, std::vector<unsigned char> &der);
  4184. const char *get_sni(const_session_t session);
  4185. // CA store management
  4186. ca_store_t create_ca_store(const char *pem, size_t len);
  4187. void free_ca_store(ca_store_t store);
  4188. bool set_ca_store(ctx_t ctx, ca_store_t store);
  4189. size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs);
  4190. std::vector<std::string> get_ca_names(ctx_t ctx);
  4191. // Dynamic certificate update (for servers)
  4192. bool update_server_cert(ctx_t ctx, const char *cert_pem, const char *key_pem,
  4193. const char *password);
  4194. bool update_server_client_ca(ctx_t ctx, const char *ca_pem);
  4195. // Certificate verification callback
  4196. bool set_verify_callback(ctx_t ctx, VerifyCallback callback);
  4197. long get_verify_error(const_session_t session);
  4198. std::string verify_error_string(long error_code);
  4199. // TlsError information
  4200. uint64_t peek_error();
  4201. uint64_t get_error();
  4202. std::string error_string(uint64_t code);
  4203. } // namespace tls
  4204. #endif // CPPHTTPLIB_SSL_ENABLED
  4205. /*
  4206. * Group 1: detail namespace - Non-SSL utilities
  4207. */
  4208. namespace detail {
  4209. inline bool set_socket_opt_impl(socket_t sock, int level, int optname,
  4210. const void *optval, socklen_t optlen) {
  4211. return setsockopt(sock, level, optname,
  4212. #ifdef _WIN32
  4213. reinterpret_cast<const char *>(optval),
  4214. #else
  4215. optval,
  4216. #endif
  4217. optlen) == 0;
  4218. }
  4219. inline bool set_socket_opt_time(socket_t sock, int level, int optname,
  4220. time_t sec, time_t usec) {
  4221. #ifdef _WIN32
  4222. auto timeout = static_cast<uint32_t>(sec * 1000 + usec / 1000);
  4223. #else
  4224. timeval timeout;
  4225. timeout.tv_sec = static_cast<long>(sec);
  4226. timeout.tv_usec = static_cast<decltype(timeout.tv_usec)>(usec);
  4227. #endif
  4228. return set_socket_opt_impl(sock, level, optname, &timeout, sizeof(timeout));
  4229. }
  4230. inline bool is_hex(char c, int &v) {
  4231. if (is_ascii_digit(c)) {
  4232. v = c - '0';
  4233. return true;
  4234. } else if ('A' <= c && c <= 'F') {
  4235. v = c - 'A' + 10;
  4236. return true;
  4237. } else if ('a' <= c && c <= 'f') {
  4238. v = c - 'a' + 10;
  4239. return true;
  4240. }
  4241. return false;
  4242. }
  4243. inline bool from_hex_to_i(const std::string &s, size_t i, size_t cnt,
  4244. int &val) {
  4245. if (i >= s.size()) { return false; }
  4246. val = 0;
  4247. for (; cnt; i++, cnt--) {
  4248. if (!s[i]) { return false; }
  4249. auto v = 0;
  4250. if (is_hex(s[i], v)) {
  4251. val = val * 16 + v;
  4252. } else {
  4253. return false;
  4254. }
  4255. }
  4256. return true;
  4257. }
  4258. inline std::string from_i_to_hex(size_t n) {
  4259. static const auto charset = "0123456789abcdef";
  4260. std::string ret;
  4261. do {
  4262. ret = charset[n & 15] + ret;
  4263. n >>= 4;
  4264. } while (n > 0);
  4265. return ret;
  4266. }
  4267. inline std::string compute_etag(const FileStat &fs,
  4268. const std::string &suffix = std::string()) {
  4269. if (!fs.is_file()) { return std::string(); }
  4270. // If mtime cannot be determined (negative value indicates an error
  4271. // or sentinel), do not generate an ETag. Returning a neutral / fixed
  4272. // value like 0 could collide with a real file that legitimately has
  4273. // mtime == 0 (epoch) and lead to misleading validators.
  4274. auto mtime_raw = fs.mtime();
  4275. if (mtime_raw < 0) { return std::string(); }
  4276. auto mtime = static_cast<size_t>(mtime_raw);
  4277. auto size = fs.size();
  4278. return std::string("W/\"") + from_i_to_hex(mtime) + "-" +
  4279. from_i_to_hex(size) + suffix + "\"";
  4280. }
  4281. // Format time_t as HTTP-date (RFC 9110 Section 5.6.7): "Sun, 06 Nov 1994
  4282. // 08:49:37 GMT" This implementation is defensive: it validates `mtime`, checks
  4283. // return values from `gmtime_r`/`gmtime_s`, and ensures `strftime` succeeds.
  4284. inline std::string file_mtime_to_http_date(time_t mtime) {
  4285. if (mtime < 0) { return std::string(); }
  4286. struct tm tm_buf;
  4287. #ifdef _WIN32
  4288. if (gmtime_s(&tm_buf, &mtime) != 0) { return std::string(); }
  4289. #else
  4290. if (gmtime_r(&mtime, &tm_buf) == nullptr) { return std::string(); }
  4291. #endif
  4292. char buf[64];
  4293. if (strftime(buf, sizeof(buf), "%a, %d %b %Y %H:%M:%S GMT", &tm_buf) == 0) {
  4294. return std::string();
  4295. }
  4296. return std::string(buf);
  4297. }
  4298. // Parse HTTP-date (RFC 9110 Section 5.6.7) to time_t. Returns -1 on failure.
  4299. inline time_t parse_http_date(const std::string &date_str) {
  4300. struct tm tm_buf;
  4301. // Create a classic locale object once for all parsing attempts
  4302. const std::locale classic_locale = std::locale::classic();
  4303. // Try to parse using std::get_time (C++11, cross-platform)
  4304. auto try_parse = [&](const char *fmt) -> bool {
  4305. std::istringstream ss(date_str);
  4306. ss.imbue(classic_locale);
  4307. memset(&tm_buf, 0, sizeof(tm_buf));
  4308. ss >> std::get_time(&tm_buf, fmt);
  4309. return !ss.fail();
  4310. };
  4311. // RFC 9110 preferred format (HTTP-date): "Sun, 06 Nov 1994 08:49:37 GMT"
  4312. if (!try_parse("%a, %d %b %Y %H:%M:%S")) {
  4313. // RFC 850 format: "Sunday, 06-Nov-94 08:49:37 GMT"
  4314. if (!try_parse("%A, %d-%b-%y %H:%M:%S")) {
  4315. // asctime format: "Sun Nov 6 08:49:37 1994"
  4316. if (!try_parse("%a %b %d %H:%M:%S %Y")) {
  4317. return static_cast<time_t>(-1);
  4318. }
  4319. }
  4320. }
  4321. #ifdef _WIN32
  4322. return _mkgmtime(&tm_buf);
  4323. #elif defined _AIX
  4324. return mktime(&tm_buf);
  4325. #else
  4326. return timegm(&tm_buf);
  4327. #endif
  4328. }
  4329. inline bool is_weak_etag(const std::string &s) {
  4330. // Check if the string is a weak ETag (starts with 'W/"')
  4331. return s.size() > 3 && s[0] == 'W' && s[1] == '/' && s[2] == '"';
  4332. }
  4333. inline bool is_strong_etag(const std::string &s) {
  4334. // Check if the string is a strong ETag (starts and ends with '"', at least 2
  4335. // chars)
  4336. return s.size() >= 2 && s[0] == '"' && s.back() == '"';
  4337. }
  4338. inline size_t to_utf8(int code, char *buff) {
  4339. if (code < 0x0080) {
  4340. buff[0] = static_cast<char>(code & 0x7F);
  4341. return 1;
  4342. } else if (code < 0x0800) {
  4343. buff[0] = static_cast<char>(0xC0 | ((code >> 6) & 0x1F));
  4344. buff[1] = static_cast<char>(0x80 | (code & 0x3F));
  4345. return 2;
  4346. } else if (code < 0xD800) {
  4347. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4348. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4349. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4350. return 3;
  4351. } else if (code < 0xE000) { // D800 - DFFF is invalid...
  4352. return 0;
  4353. } else if (code < 0x10000) {
  4354. buff[0] = static_cast<char>(0xE0 | ((code >> 12) & 0xF));
  4355. buff[1] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4356. buff[2] = static_cast<char>(0x80 | (code & 0x3F));
  4357. return 3;
  4358. } else if (code < 0x110000) {
  4359. buff[0] = static_cast<char>(0xF0 | ((code >> 18) & 0x7));
  4360. buff[1] = static_cast<char>(0x80 | ((code >> 12) & 0x3F));
  4361. buff[2] = static_cast<char>(0x80 | ((code >> 6) & 0x3F));
  4362. buff[3] = static_cast<char>(0x80 | (code & 0x3F));
  4363. return 4;
  4364. }
  4365. // NOTREACHED
  4366. return 0;
  4367. }
  4368. } // namespace detail
  4369. namespace ws {
  4370. namespace impl {
  4371. inline bool is_valid_utf8(const std::string &s) {
  4372. size_t i = 0;
  4373. auto n = s.size();
  4374. while (i < n) {
  4375. auto c = static_cast<unsigned char>(s[i]);
  4376. size_t len;
  4377. uint32_t cp;
  4378. if (c < 0x80) {
  4379. i++;
  4380. continue;
  4381. } else if ((c & 0xE0) == 0xC0) {
  4382. len = 2;
  4383. cp = c & 0x1F;
  4384. } else if ((c & 0xF0) == 0xE0) {
  4385. len = 3;
  4386. cp = c & 0x0F;
  4387. } else if ((c & 0xF8) == 0xF0) {
  4388. len = 4;
  4389. cp = c & 0x07;
  4390. } else {
  4391. return false;
  4392. }
  4393. if (i + len > n) { return false; }
  4394. for (size_t j = 1; j < len; j++) {
  4395. auto b = static_cast<unsigned char>(s[i + j]);
  4396. if ((b & 0xC0) != 0x80) { return false; }
  4397. cp = (cp << 6) | (b & 0x3F);
  4398. }
  4399. // Overlong encoding check
  4400. if (len == 2 && cp < 0x80) { return false; }
  4401. if (len == 3 && cp < 0x800) { return false; }
  4402. if (len == 4 && cp < 0x10000) { return false; }
  4403. // Surrogate halves (U+D800..U+DFFF) and beyond U+10FFFF are invalid
  4404. if (cp >= 0xD800 && cp <= 0xDFFF) { return false; }
  4405. if (cp > 0x10FFFF) { return false; }
  4406. i += len;
  4407. }
  4408. return true;
  4409. }
  4410. } // namespace impl
  4411. } // namespace ws
  4412. namespace detail {
  4413. // NOTE: This code came up with the following stackoverflow post:
  4414. // https://stackoverflow.com/questions/180947/base64-decode-snippet-in-c
  4415. inline std::string base64_encode(const std::string &in) {
  4416. static const auto lookup =
  4417. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4418. std::string out;
  4419. out.reserve(in.size());
  4420. // Unsigned: the accumulator is never masked, so with a signed int the
  4421. // `val << 8` below overflows once enough bytes are folded in (undefined
  4422. // behaviour before C++20). Only the low bits are ever emitted, so the
  4423. // wrap-around of an unsigned accumulator does not affect the output.
  4424. uint32_t val = 0;
  4425. auto valb = -6;
  4426. for (auto c : in) {
  4427. val = (val << 8) + static_cast<uint8_t>(c);
  4428. valb += 8;
  4429. while (valb >= 0) {
  4430. out.push_back(lookup[(val >> valb) & 0x3F]);
  4431. valb -= 6;
  4432. }
  4433. }
  4434. if (valb > -6) { out.push_back(lookup[((val << 8) >> (valb + 8)) & 0x3F]); }
  4435. while (out.size() % 4) {
  4436. out.push_back('=');
  4437. }
  4438. return out;
  4439. }
  4440. inline std::string sha1(const std::string &input) {
  4441. // RFC 3174 SHA-1 implementation
  4442. auto left_rotate = [](uint32_t x, uint32_t n) -> uint32_t {
  4443. return (x << n) | (x >> (32 - n));
  4444. };
  4445. uint32_t h0 = 0x67452301;
  4446. uint32_t h1 = 0xEFCDAB89;
  4447. uint32_t h2 = 0x98BADCFE;
  4448. uint32_t h3 = 0x10325476;
  4449. uint32_t h4 = 0xC3D2E1F0;
  4450. // Pre-processing: adding padding bits
  4451. std::string msg = input;
  4452. uint64_t original_bit_len = static_cast<uint64_t>(msg.size()) * 8;
  4453. msg.push_back(static_cast<char>(0x80u));
  4454. while (msg.size() % 64 != 56) {
  4455. msg.push_back(0);
  4456. }
  4457. // Append original length in bits as 64-bit big-endian
  4458. for (int i = 56; i >= 0; i -= 8) {
  4459. msg.push_back(static_cast<char>((original_bit_len >> i) & 0xFF));
  4460. }
  4461. // Process each 512-bit chunk
  4462. for (size_t offset = 0; offset < msg.size(); offset += 64) {
  4463. uint32_t w[80];
  4464. for (size_t i = 0; i < 16; i++) {
  4465. w[i] =
  4466. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4]))
  4467. << 24) |
  4468. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 1]))
  4469. << 16) |
  4470. (static_cast<uint32_t>(static_cast<uint8_t>(msg[offset + i * 4 + 2]))
  4471. << 8) |
  4472. (static_cast<uint32_t>(
  4473. static_cast<uint8_t>(msg[offset + i * 4 + 3])));
  4474. }
  4475. for (int i = 16; i < 80; i++) {
  4476. w[i] = left_rotate(w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16], 1);
  4477. }
  4478. uint32_t a = h0, b = h1, c = h2, d = h3, e = h4;
  4479. for (int i = 0; i < 80; i++) {
  4480. uint32_t f, k;
  4481. if (i < 20) {
  4482. f = (b & c) | ((~b) & d);
  4483. k = 0x5A827999;
  4484. } else if (i < 40) {
  4485. f = b ^ c ^ d;
  4486. k = 0x6ED9EBA1;
  4487. } else if (i < 60) {
  4488. f = (b & c) | (b & d) | (c & d);
  4489. k = 0x8F1BBCDC;
  4490. } else {
  4491. f = b ^ c ^ d;
  4492. k = 0xCA62C1D6;
  4493. }
  4494. uint32_t temp = left_rotate(a, 5) + f + e + k + w[i];
  4495. e = d;
  4496. d = c;
  4497. c = left_rotate(b, 30);
  4498. b = a;
  4499. a = temp;
  4500. }
  4501. h0 += a;
  4502. h1 += b;
  4503. h2 += c;
  4504. h3 += d;
  4505. h4 += e;
  4506. }
  4507. // Produce the final hash as a 20-byte binary string
  4508. std::string hash(20, '\0');
  4509. for (size_t i = 0; i < 4; i++) {
  4510. hash[i] = static_cast<char>((h0 >> (24 - i * 8)) & 0xFF);
  4511. hash[4 + i] = static_cast<char>((h1 >> (24 - i * 8)) & 0xFF);
  4512. hash[8 + i] = static_cast<char>((h2 >> (24 - i * 8)) & 0xFF);
  4513. hash[12 + i] = static_cast<char>((h3 >> (24 - i * 8)) & 0xFF);
  4514. hash[16 + i] = static_cast<char>((h4 >> (24 - i * 8)) & 0xFF);
  4515. }
  4516. return hash;
  4517. }
  4518. inline std::string websocket_accept_key(const std::string &client_key) {
  4519. const std::string magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
  4520. return base64_encode(sha1(client_key + magic));
  4521. }
  4522. inline bool is_websocket_upgrade(const Request &req) {
  4523. if (req.method != "GET") { return false; }
  4524. // Check Upgrade: websocket. RFC 9110 7.8 defines Upgrade as a comma-separated
  4525. // list of protocols and asks recipients to match each name
  4526. // case-insensitively, so look for the token rather than compare the whole
  4527. // field value.
  4528. if (!has_header_token(req.headers, "Upgrade", "websocket")) { return false; }
  4529. // Check Connection: Upgrade
  4530. if (!has_header_token(req.headers, "Connection", "upgrade")) { return false; }
  4531. // Check Sec-WebSocket-Key is a valid base64-encoded 16-byte value (24 chars)
  4532. // RFC 6455 Section 4.2.1
  4533. auto ws_key = req.get_header_value("Sec-WebSocket-Key");
  4534. if (ws_key.size() != 24 || ws_key[22] != '=' || ws_key[23] != '=') {
  4535. return false;
  4536. }
  4537. static const std::string b64chars =
  4538. "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
  4539. for (size_t i = 0; i < 22; i++) {
  4540. if (b64chars.find(ws_key[i]) == std::string::npos) { return false; }
  4541. }
  4542. // Check Sec-WebSocket-Version: 13
  4543. auto version = req.get_header_value("Sec-WebSocket-Version");
  4544. if (version != "13") { return false; }
  4545. return true;
  4546. }
  4547. inline bool write_websocket_frame(Stream &strm, ws::Opcode opcode,
  4548. const char *data, size_t len, bool fin,
  4549. bool mask) {
  4550. // First byte: FIN + opcode
  4551. uint8_t header[2];
  4552. header[0] = static_cast<uint8_t>((fin ? 0x80 : 0x00) |
  4553. (static_cast<uint8_t>(opcode) & 0x0F));
  4554. // Second byte: MASK + payload length
  4555. if (len < 126) {
  4556. header[1] = static_cast<uint8_t>(len);
  4557. if (mask) { header[1] |= 0x80; }
  4558. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4559. } else if (len <= 0xFFFF) {
  4560. header[1] = 126;
  4561. if (mask) { header[1] |= 0x80; }
  4562. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4563. uint8_t ext[2];
  4564. ext[0] = static_cast<uint8_t>((len >> 8) & 0xFF);
  4565. ext[1] = static_cast<uint8_t>(len & 0xFF);
  4566. if (strm.write(reinterpret_cast<char *>(ext), 2) < 0) { return false; }
  4567. } else {
  4568. header[1] = 127;
  4569. if (mask) { header[1] |= 0x80; }
  4570. if (strm.write(reinterpret_cast<char *>(header), 2) < 0) { return false; }
  4571. uint8_t ext[8];
  4572. for (int i = 7; i >= 0; i--) {
  4573. ext[7 - i] =
  4574. static_cast<uint8_t>((static_cast<uint64_t>(len) >> (i * 8)) & 0xFF);
  4575. }
  4576. if (strm.write(reinterpret_cast<char *>(ext), 8) < 0) { return false; }
  4577. }
  4578. if (mask) {
  4579. // Generate random mask key
  4580. thread_local std::mt19937 rng(std::random_device{}());
  4581. uint8_t mask_key[4];
  4582. auto r = rng();
  4583. std::memcpy(mask_key, &r, 4);
  4584. if (strm.write(reinterpret_cast<char *>(mask_key), 4) < 0) { return false; }
  4585. // Write masked payload in chunks
  4586. const size_t chunk_size = 4096;
  4587. std::vector<char> buf((std::min)(len, chunk_size));
  4588. for (size_t offset = 0; offset < len; offset += chunk_size) {
  4589. size_t n = (std::min)(chunk_size, len - offset);
  4590. for (size_t i = 0; i < n; i++) {
  4591. buf[i] =
  4592. data[offset + i] ^ static_cast<char>(mask_key[(offset + i) % 4]);
  4593. }
  4594. if (strm.write(buf.data(), n) < 0) { return false; }
  4595. }
  4596. } else {
  4597. if (len > 0) {
  4598. if (strm.write(data, len) < 0) { return false; }
  4599. }
  4600. }
  4601. return true;
  4602. }
  4603. } // namespace detail
  4604. namespace ws {
  4605. namespace impl {
  4606. // Read exactly `size` bytes. Stream::read may return less than asked for -- it
  4607. // hands back whatever its buffer already holds -- so every multi-byte field has
  4608. // to loop. Reading a 2-byte header with a single read() fails whenever the
  4609. // header straddles the read buffer's boundary.
  4610. //
  4611. // Timeout is reported only when nothing at all was consumed. Once a byte has
  4612. // been taken the stream sits mid-field and cannot be resumed, so a timeout
  4613. // there is a failure like any other. (When read() fails it always records why,
  4614. // so the error belongs to this call and not to an earlier one.)
  4615. inline FrameRead read_exact(Stream &strm, void *buf, size_t size) {
  4616. auto p = static_cast<char *>(buf);
  4617. size_t total = 0;
  4618. while (total < size) {
  4619. auto n = strm.read(p + total, size - total);
  4620. if (n <= 0) {
  4621. auto timed_out = total == 0 && strm.get_error() == Error::Timeout;
  4622. return timed_out ? FrameRead::Timeout : FrameRead::Fail;
  4623. }
  4624. total += static_cast<size_t>(n);
  4625. }
  4626. return FrameRead::Ok;
  4627. }
  4628. inline FrameRead read_websocket_frame(Stream &strm, Opcode &opcode,
  4629. std::string &payload, bool &fin,
  4630. bool expect_masked, size_t max_len) {
  4631. // Read first 2 bytes. This is the only read that may report a timeout: it
  4632. // sits on a frame boundary, where nothing has been consumed yet.
  4633. uint8_t header[2];
  4634. FrameRead first = read_exact(strm, header, 2);
  4635. if (first != FrameRead::Ok) { return first; }
  4636. fin = (header[0] & 0x80) != 0;
  4637. // RSV1, RSV2, RSV3 must be 0 when no extension is negotiated
  4638. if (header[0] & 0x70) { return FrameRead::Fail; }
  4639. opcode = static_cast<Opcode>(header[0] & 0x0F);
  4640. bool masked = (header[1] & 0x80) != 0;
  4641. uint64_t payload_len = header[1] & 0x7F;
  4642. // RFC 6455 Section 5.5: control frames MUST NOT be fragmented and
  4643. // MUST have a payload length of 125 bytes or less
  4644. bool is_control = (static_cast<uint8_t>(opcode) & 0x08) != 0;
  4645. if (is_control) {
  4646. if (!fin) { return FrameRead::Fail; }
  4647. if (payload_len > 125) { return FrameRead::Fail; }
  4648. }
  4649. if (masked != expect_masked) { return FrameRead::Fail; }
  4650. // Extended payload length
  4651. if (payload_len == 126) {
  4652. uint8_t ext[2];
  4653. if (read_exact(strm, ext, 2) != FrameRead::Ok) { return FrameRead::Fail; }
  4654. payload_len = (static_cast<uint64_t>(ext[0]) << 8) | ext[1];
  4655. } else if (payload_len == 127) {
  4656. uint8_t ext[8];
  4657. if (read_exact(strm, ext, 8) != FrameRead::Ok) { return FrameRead::Fail; }
  4658. // RFC 6455 Section 5.2: the most significant bit MUST be 0
  4659. if (ext[0] & 0x80) { return FrameRead::Fail; }
  4660. payload_len = 0;
  4661. for (int i = 0; i < 8; i++) {
  4662. payload_len = (payload_len << 8) | ext[i];
  4663. }
  4664. }
  4665. if (payload_len > max_len) { return FrameRead::Fail; }
  4666. // Read mask key if present
  4667. uint8_t mask_key[4] = {0};
  4668. if (masked) {
  4669. if (read_exact(strm, mask_key, 4) != FrameRead::Ok) {
  4670. return FrameRead::Fail;
  4671. }
  4672. }
  4673. // Read payload
  4674. payload.resize(static_cast<size_t>(payload_len));
  4675. if (payload_len > 0 &&
  4676. read_exact(strm, &payload[0], static_cast<size_t>(payload_len)) !=
  4677. FrameRead::Ok) {
  4678. return FrameRead::Fail;
  4679. }
  4680. // Unmask if needed
  4681. if (masked) {
  4682. for (size_t i = 0; i < payload.size(); i++) {
  4683. payload[i] ^= static_cast<char>(mask_key[i % 4]);
  4684. }
  4685. }
  4686. return FrameRead::Ok;
  4687. }
  4688. } // namespace impl
  4689. } // namespace ws
  4690. namespace detail {
  4691. inline bool is_valid_path(const std::string &path) {
  4692. size_t level = 0;
  4693. size_t i = 0;
  4694. // Skip slash
  4695. while (i < path.size() && path[i] == '/') {
  4696. i++;
  4697. }
  4698. while (i < path.size()) {
  4699. // Read component
  4700. auto beg = i;
  4701. while (i < path.size() && path[i] != '/') {
  4702. if (path[i] == '\0') {
  4703. return false;
  4704. } else if (path[i] == '\\') {
  4705. return false;
  4706. }
  4707. i++;
  4708. }
  4709. auto len = i - beg;
  4710. assert(len > 0);
  4711. if (!path.compare(beg, len, ".")) {
  4712. ;
  4713. } else if (!path.compare(beg, len, "..")) {
  4714. if (level == 0) { return false; }
  4715. level--;
  4716. } else {
  4717. level++;
  4718. }
  4719. // Skip slash
  4720. while (i < path.size() && path[i] == '/') {
  4721. i++;
  4722. }
  4723. }
  4724. return true;
  4725. }
  4726. inline bool canonicalize_path(const char *path, std::string &resolved) {
  4727. #if defined(_WIN32)
  4728. char buf[_MAX_PATH];
  4729. if (_fullpath(buf, path, _MAX_PATH) == nullptr) { return false; }
  4730. resolved = buf;
  4731. #elif defined(PATH_MAX)
  4732. char buf[PATH_MAX];
  4733. if (realpath(path, buf) == nullptr) { return false; }
  4734. resolved = buf;
  4735. #else
  4736. auto buf = realpath(path, nullptr);
  4737. auto guard = scope_exit([&]() { std::free(buf); });
  4738. if (buf == nullptr) { return false; }
  4739. resolved = buf;
  4740. #endif
  4741. return true;
  4742. }
  4743. inline bool is_path_within_base(const std::string &resolved_path,
  4744. const std::string &resolved_base) {
  4745. #if defined(_WIN32)
  4746. return _strnicmp(resolved_path.c_str(), resolved_base.c_str(),
  4747. resolved_base.size()) == 0;
  4748. #else
  4749. return strncmp(resolved_path.c_str(), resolved_base.c_str(),
  4750. resolved_base.size()) == 0;
  4751. #endif
  4752. }
  4753. inline FileStat::FileStat(const std::string &path) {
  4754. #if defined(_WIN32)
  4755. auto wpath = u8string_to_wstring(path.c_str());
  4756. ret_ = _wstat(wpath.c_str(), &st_);
  4757. #else
  4758. ret_ = stat(path.c_str(), &st_);
  4759. #endif
  4760. }
  4761. inline bool FileStat::is_file() const {
  4762. return ret_ >= 0 && S_ISREG(st_.st_mode);
  4763. }
  4764. inline bool FileStat::is_dir() const {
  4765. return ret_ >= 0 && S_ISDIR(st_.st_mode);
  4766. }
  4767. inline time_t FileStat::mtime() const {
  4768. return ret_ >= 0 ? static_cast<time_t>(st_.st_mtime)
  4769. : static_cast<time_t>(-1);
  4770. }
  4771. inline size_t FileStat::size() const {
  4772. return ret_ >= 0 ? static_cast<size_t>(st_.st_size) : 0;
  4773. }
  4774. inline std::string encode_path(const std::string &s) {
  4775. std::string result;
  4776. result.reserve(s.size());
  4777. for (size_t i = 0; s[i]; i++) {
  4778. switch (s[i]) {
  4779. case ' ': result += "%20"; break;
  4780. case '+': result += "%2B"; break;
  4781. case '\r': result += "%0D"; break;
  4782. case '\n': result += "%0A"; break;
  4783. case '\'': result += "%27"; break;
  4784. case ',': result += "%2C"; break;
  4785. // case ':': result += "%3A"; break; // ok? probably...
  4786. case ';': result += "%3B"; break;
  4787. default:
  4788. auto c = static_cast<uint8_t>(s[i]);
  4789. if (c >= 0x80) {
  4790. result += '%';
  4791. char hex[4];
  4792. auto len = snprintf(hex, sizeof(hex) - 1, "%02X", c);
  4793. assert(len == 2);
  4794. result.append(hex, static_cast<size_t>(len));
  4795. } else {
  4796. result += s[i];
  4797. }
  4798. break;
  4799. }
  4800. }
  4801. return result;
  4802. }
  4803. inline std::string file_extension(const std::string &path) {
  4804. std::smatch m;
  4805. thread_local auto re = std::regex("\\.([a-zA-Z0-9]+)$");
  4806. if (std::regex_search(path, m, re)) { return m[1].str(); }
  4807. return std::string();
  4808. }
  4809. inline bool is_space_or_tab(char c) { return c == ' ' || c == '\t'; }
  4810. template <typename T>
  4811. inline bool parse_header(const char *beg, const char *end, T fn);
  4812. template <typename T>
  4813. inline bool parse_header(const char *beg, const char *end, T fn) {
  4814. // Skip trailing spaces and tabs.
  4815. while (beg < end && is_space_or_tab(end[-1])) {
  4816. end--;
  4817. }
  4818. auto p = beg;
  4819. while (p < end && *p != ':') {
  4820. p++;
  4821. }
  4822. auto name = std::string(beg, p);
  4823. if (!detail::fields::is_field_name(name)) { return false; }
  4824. if (p == end) { return false; }
  4825. auto key_end = p;
  4826. if (*p++ != ':') { return false; }
  4827. while (p < end && is_space_or_tab(*p)) {
  4828. p++;
  4829. }
  4830. if (p <= end) {
  4831. auto key_len = key_end - beg;
  4832. if (!key_len) { return false; }
  4833. auto key = std::string(beg, key_end);
  4834. auto val = std::string(p, end);
  4835. if (!detail::fields::is_field_value(val)) { return false; }
  4836. // RFC 9110 §5.5: header field values are opaque octets and MUST NOT be
  4837. // percent-decoded by the recipient. Applications that need to interpret a
  4838. // value as a URI component should call httplib::decode_uri_component()
  4839. // (or decode_path_component()) explicitly.
  4840. fn(key, val);
  4841. return true;
  4842. }
  4843. return false;
  4844. }
  4845. inline bool parse_trailers(stream_line_reader &line_reader, Headers &dest,
  4846. const Headers &src_headers) {
  4847. // NOTE: In RFC 9112, '7.1 Chunked Transfer Coding' mentions "The chunked
  4848. // transfer coding is complete when a chunk with a chunk-size of zero is
  4849. // received, possibly followed by a trailer section, and finally terminated by
  4850. // an empty line". https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1
  4851. //
  4852. // In '7.1.3. Decoding Chunked', however, the pseudo-code in the section
  4853. // doesn't care for the existence of the final CRLF. In other words, it seems
  4854. // to be ok whether the final CRLF exists or not in the chunked data.
  4855. // https://www.rfc-editor.org/rfc/rfc9112.html#section-7.1.3
  4856. //
  4857. // According to the reference code in RFC 9112, cpp-httplib now allows
  4858. // chunked transfer coding data without the final CRLF.
  4859. // RFC 7230 Section 4.1.2 - Headers prohibited in trailers
  4860. thread_local case_ignore::unordered_set<std::string> prohibited_trailers = {
  4861. "transfer-encoding",
  4862. "content-length",
  4863. "host",
  4864. "authorization",
  4865. "www-authenticate",
  4866. "proxy-authenticate",
  4867. "proxy-authorization",
  4868. "cookie",
  4869. "set-cookie",
  4870. "cache-control",
  4871. "expect",
  4872. "max-forwards",
  4873. "pragma",
  4874. "range",
  4875. "te",
  4876. "age",
  4877. "expires",
  4878. "date",
  4879. "location",
  4880. "retry-after",
  4881. "vary",
  4882. "warning",
  4883. "content-encoding",
  4884. "content-type",
  4885. "content-range",
  4886. "trailer"};
  4887. case_ignore::unordered_set<std::string> declared_trailers;
  4888. auto trailer_header = get_combined_header_value(src_headers, "Trailer");
  4889. if (!trailer_header.empty()) {
  4890. // split() trims each token and skips empty ones, so the name arrives ready
  4891. // to look up.
  4892. split(trailer_header.data(), trailer_header.data() + trailer_header.size(),
  4893. ',', [&](const char *b, const char *e) {
  4894. // A legitimate message declares only a handful of trailers. Cap the
  4895. // set so a peer cannot grow it without bound: an oversized set only
  4896. // arises from an attempt to force many colliding names into
  4897. // quadratic lookups (case_ignore::hash is unkeyed).
  4898. if (declared_trailers.size() >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  4899. return;
  4900. }
  4901. std::string key(b, e);
  4902. if (prohibited_trailers.find(key) == prohibited_trailers.end()) {
  4903. declared_trailers.insert(key);
  4904. }
  4905. });
  4906. }
  4907. size_t trailer_header_count = 0;
  4908. while (strcmp(line_reader.ptr(), "\r\n") != 0) {
  4909. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  4910. // Count every received trailer field, not only the declared ones stored in
  4911. // dest, so undeclared fields cannot keep this loop running past the limit.
  4912. if (trailer_header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  4913. constexpr auto line_terminator_len = 2;
  4914. auto line_beg = line_reader.ptr();
  4915. auto line_end =
  4916. line_reader.ptr() + line_reader.size() - line_terminator_len;
  4917. if (!parse_header(line_beg, line_end,
  4918. [&](const std::string &key, const std::string &val) {
  4919. if (declared_trailers.find(key) !=
  4920. declared_trailers.end()) {
  4921. dest.emplace(key, val);
  4922. }
  4923. })) {
  4924. return false;
  4925. }
  4926. trailer_header_count++;
  4927. if (!line_reader.getline()) { return false; }
  4928. }
  4929. return true;
  4930. }
  4931. inline std::pair<size_t, size_t> trim(const char *b, const char *e, size_t left,
  4932. size_t right) {
  4933. while (b + left < e && is_space_or_tab(b[left])) {
  4934. left++;
  4935. }
  4936. while (right > 0 && is_space_or_tab(b[right - 1])) {
  4937. right--;
  4938. }
  4939. return std::make_pair(left, right);
  4940. }
  4941. inline std::string trim_copy(const std::string &s) {
  4942. auto r = trim(s.data(), s.data() + s.size(), 0, s.size());
  4943. return s.substr(r.first, r.second - r.first);
  4944. }
  4945. inline std::string trim_double_quotes_copy(const std::string &s) {
  4946. if (s.length() >= 2 && s.front() == '"' && s.back() == '"') {
  4947. return s.substr(1, s.size() - 2);
  4948. }
  4949. return s;
  4950. }
  4951. inline void
  4952. divide(const char *data, std::size_t size, char d,
  4953. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4954. fn) {
  4955. const auto it = std::find(data, data + size, d);
  4956. const auto found = static_cast<std::size_t>(it != data + size);
  4957. const auto lhs_data = data;
  4958. const auto lhs_size = static_cast<std::size_t>(it - data);
  4959. const auto rhs_data = it + found;
  4960. const auto rhs_size = size - lhs_size - found;
  4961. fn(lhs_data, lhs_size, rhs_data, rhs_size);
  4962. }
  4963. inline void
  4964. divide(const std::string &str, char d,
  4965. std::function<void(const char *, std::size_t, const char *, std::size_t)>
  4966. fn) {
  4967. divide(str.data(), str.size(), d, std::move(fn));
  4968. }
  4969. inline void split(const char *b, const char *e, char d,
  4970. std::function<void(const char *, const char *)> fn) {
  4971. return split(b, e, d, (std::numeric_limits<size_t>::max)(), std::move(fn));
  4972. }
  4973. inline void split(const char *b, const char *e, char d, size_t m,
  4974. std::function<void(const char *, const char *)> fn) {
  4975. size_t i = 0;
  4976. size_t beg = 0;
  4977. size_t count = 1;
  4978. while (e ? (b + i < e) : (b[i] != '\0')) {
  4979. if (b[i] == d && count < m) {
  4980. auto r = trim(b, e, beg, i);
  4981. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4982. beg = i + 1;
  4983. count++;
  4984. }
  4985. i++;
  4986. }
  4987. if (i) {
  4988. auto r = trim(b, e, beg, i);
  4989. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  4990. }
  4991. }
  4992. // Same contract as split(), except that a delimiter inside a quoted-string is
  4993. // not a delimiter. RFC 9110 Section 5.6.6 lets a parameter value be a
  4994. // quoted-string, and ';' and '=' are legal characters inside one.
  4995. inline void split_unquoted(const char *b, const char *e, char d, size_t m,
  4996. std::function<void(const char *, const char *)> fn) {
  4997. size_t i = 0;
  4998. size_t beg = 0;
  4999. size_t count = 1;
  5000. auto in_quotes = false;
  5001. while (e ? (b + i < e) : (b[i] != '\0')) {
  5002. if (b[i] == '"') {
  5003. in_quotes = !in_quotes;
  5004. } else if (b[i] == d && !in_quotes && count < m) {
  5005. auto r = trim(b, e, beg, i);
  5006. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5007. beg = i + 1;
  5008. count++;
  5009. }
  5010. i++;
  5011. }
  5012. if (i) {
  5013. auto r = trim(b, e, beg, i);
  5014. if (r.first < r.second) { fn(&b[r.first], &b[r.second]); }
  5015. }
  5016. }
  5017. inline void split_unquoted(const char *b, const char *e, char d,
  5018. std::function<void(const char *, const char *)> fn) {
  5019. return split_unquoted(b, e, d, (std::numeric_limits<size_t>::max)(),
  5020. std::move(fn));
  5021. }
  5022. // Divide a header parameter at its first '='. RFC 9110 Section 5.6.6 makes the
  5023. // key a token, so the first '=' is the separator even when the value is a
  5024. // quoted-string carrying more of them.
  5025. inline void divide_param_pair(const char *b, const char *e, std::string &key,
  5026. std::string &val) {
  5027. divide(
  5028. b, static_cast<std::size_t>(e - b), '=',
  5029. [&](const char *kb, std::size_t klen, const char *vb, std::size_t vlen) {
  5030. const auto kr = trim(kb, kb + klen, 0, klen);
  5031. key.assign(kb + kr.first, kb + kr.second);
  5032. const auto vr = trim(vb, vb + vlen, 0, vlen);
  5033. val.assign(vb + vr.first, vb + vr.second);
  5034. });
  5035. }
  5036. inline bool split_find(const char *b, const char *e, char d, size_t m,
  5037. std::function<bool(const char *, const char *)> fn) {
  5038. size_t i = 0;
  5039. size_t beg = 0;
  5040. size_t count = 1;
  5041. while (e ? (b + i < e) : (b[i] != '\0')) {
  5042. if (b[i] == d && count < m) {
  5043. auto r = trim(b, e, beg, i);
  5044. if (r.first < r.second) {
  5045. auto found = fn(&b[r.first], &b[r.second]);
  5046. if (found) { return true; }
  5047. }
  5048. beg = i + 1;
  5049. count++;
  5050. }
  5051. i++;
  5052. }
  5053. if (i) {
  5054. auto r = trim(b, e, beg, i);
  5055. if (r.first < r.second) {
  5056. auto found = fn(&b[r.first], &b[r.second]);
  5057. if (found) { return true; }
  5058. }
  5059. }
  5060. return false;
  5061. }
  5062. inline bool split_find(const char *b, const char *e, char d,
  5063. std::function<bool(const char *, const char *)> fn) {
  5064. return split_find(b, e, d, (std::numeric_limits<size_t>::max)(),
  5065. std::move(fn));
  5066. }
  5067. inline stream_line_reader::stream_line_reader(Stream &strm, char *fixed_buffer,
  5068. size_t fixed_buffer_size)
  5069. : strm_(strm), fixed_buffer_(fixed_buffer),
  5070. fixed_buffer_size_(fixed_buffer_size) {}
  5071. inline const char *stream_line_reader::ptr() const {
  5072. if (growable_buffer_.empty()) {
  5073. return fixed_buffer_;
  5074. } else {
  5075. return growable_buffer_.data();
  5076. }
  5077. }
  5078. inline size_t stream_line_reader::size() const {
  5079. if (growable_buffer_.empty()) {
  5080. return fixed_buffer_used_size_;
  5081. } else {
  5082. return growable_buffer_.size();
  5083. }
  5084. }
  5085. inline bool stream_line_reader::end_with_crlf() const {
  5086. auto end = ptr() + size();
  5087. return size() >= 2 && end[-2] == '\r' && end[-1] == '\n';
  5088. }
  5089. inline bool stream_line_reader::getline() {
  5090. fixed_buffer_used_size_ = 0;
  5091. growable_buffer_.clear();
  5092. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5093. char prev_byte = 0;
  5094. #endif
  5095. for (size_t i = 0;; i++) {
  5096. // Fast path: whatever the stream has already buffered can be scanned for
  5097. // the terminator in one pass. Asking for a byte at a time costs a virtual
  5098. // call, a bounds check and a one-byte copy per character of the request.
  5099. size_t buffered_size = 0;
  5100. if (auto buffered = strm_.buffered_data(buffered_size)) {
  5101. auto take = buffered_size;
  5102. auto terminated = false;
  5103. for (size_t at = 0; at < buffered_size;) {
  5104. auto nl = static_cast<const char *>(
  5105. memchr(buffered + at, '\n', buffered_size - at));
  5106. if (!nl) { break; }
  5107. auto pos = static_cast<size_t>(nl - buffered);
  5108. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5109. take = pos + 1;
  5110. terminated = true;
  5111. break;
  5112. #else
  5113. // A bare LF does not end the line; keep looking for CRLF. The CR may
  5114. // be the last byte of an earlier chunk, hence prev_byte.
  5115. if ((pos > 0 ? buffered[pos - 1] : prev_byte) == '\r') {
  5116. take = pos + 1;
  5117. terminated = true;
  5118. break;
  5119. }
  5120. at = pos + 1;
  5121. #endif
  5122. }
  5123. if (size() + take > CPPHTTPLIB_MAX_LINE_LENGTH) { return false; }
  5124. #ifndef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5125. prev_byte = buffered[take - 1];
  5126. #endif
  5127. append(buffered, take);
  5128. strm_.consume_buffered(take);
  5129. i += take;
  5130. if (terminated) { return true; }
  5131. continue;
  5132. }
  5133. if (size() >= CPPHTTPLIB_MAX_LINE_LENGTH) {
  5134. // Treat exceptionally long lines as an error to
  5135. // prevent infinite loops/memory exhaustion
  5136. return false;
  5137. }
  5138. char byte;
  5139. auto n = strm_.read(&byte, 1);
  5140. if (n < 0) {
  5141. return false;
  5142. } else if (n == 0) {
  5143. if (i == 0) {
  5144. return false;
  5145. } else {
  5146. break;
  5147. }
  5148. }
  5149. append(byte);
  5150. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  5151. if (byte == '\n') { break; }
  5152. #else
  5153. if (prev_byte == '\r' && byte == '\n') { break; }
  5154. prev_byte = byte;
  5155. #endif
  5156. }
  5157. return true;
  5158. }
  5159. inline void stream_line_reader::append(char c) { append(&c, 1); }
  5160. inline void stream_line_reader::append(const char *data, size_t size) {
  5161. // Once the line has outgrown the fixed buffer everything must keep going to
  5162. // the growable one, even if a later chunk would have fit. Without the
  5163. // emptiness check a short append after a long one would land in the fixed
  5164. // buffer, which ptr() and size() no longer look at, and be lost.
  5165. if (growable_buffer_.empty() &&
  5166. fixed_buffer_used_size_ + size < fixed_buffer_size_) {
  5167. memcpy(fixed_buffer_ + fixed_buffer_used_size_, data, size);
  5168. fixed_buffer_used_size_ += size;
  5169. fixed_buffer_[fixed_buffer_used_size_] = '\0';
  5170. } else {
  5171. // Unlike the per-character overload, this can be the very first append of
  5172. // the line, so the fixed buffer may hold nothing and carry no terminator
  5173. // yet. assign() takes an explicit length and does not need one.
  5174. if (growable_buffer_.empty()) {
  5175. growable_buffer_.assign(fixed_buffer_, fixed_buffer_used_size_);
  5176. }
  5177. growable_buffer_.append(data, size);
  5178. }
  5179. }
  5180. inline mmap::mmap(const char *path) { open(path); }
  5181. inline mmap::~mmap() { close(); }
  5182. inline bool mmap::open(const char *path) {
  5183. close();
  5184. #if defined(_WIN32)
  5185. auto wpath = u8string_to_wstring(path);
  5186. if (wpath.empty()) { return false; }
  5187. hFile_ =
  5188. ::CreateFile2(wpath.c_str(), GENERIC_READ,
  5189. FILE_SHARE_READ | FILE_SHARE_WRITE, OPEN_EXISTING, NULL);
  5190. if (hFile_ == INVALID_HANDLE_VALUE) { return false; }
  5191. LARGE_INTEGER size{};
  5192. if (!::GetFileSizeEx(hFile_, &size)) { return false; }
  5193. // If the following line doesn't compile due to QuadPart, update Windows SDK.
  5194. // See:
  5195. // https://github.com/yhirose/cpp-httplib/issues/1903#issuecomment-2316520721
  5196. if (static_cast<ULONGLONG>(size.QuadPart) >
  5197. (std::numeric_limits<decltype(size_)>::max)()) {
  5198. // `size_t` might be 32-bits, on 32-bits Windows.
  5199. return false;
  5200. }
  5201. size_ = static_cast<size_t>(size.QuadPart);
  5202. hMapping_ =
  5203. ::CreateFileMappingFromApp(hFile_, NULL, PAGE_READONLY, size_, NULL);
  5204. // Special treatment for an empty file...
  5205. if (hMapping_ == NULL && size_ == 0) {
  5206. close();
  5207. is_open_empty_file = true;
  5208. return true;
  5209. }
  5210. if (hMapping_ == NULL) {
  5211. close();
  5212. return false;
  5213. }
  5214. addr_ = ::MapViewOfFileFromApp(hMapping_, FILE_MAP_READ, 0, 0);
  5215. if (addr_ == nullptr) {
  5216. close();
  5217. return false;
  5218. }
  5219. #else
  5220. fd_ = ::open(path, O_RDONLY);
  5221. if (fd_ == -1) { return false; }
  5222. struct stat sb;
  5223. if (fstat(fd_, &sb) == -1) {
  5224. close();
  5225. return false;
  5226. }
  5227. size_ = static_cast<size_t>(sb.st_size);
  5228. addr_ = ::mmap(NULL, size_, PROT_READ, MAP_PRIVATE, fd_, 0);
  5229. // Special treatment for an empty file...
  5230. if (addr_ == MAP_FAILED && size_ == 0) {
  5231. close();
  5232. is_open_empty_file = true;
  5233. return false;
  5234. }
  5235. if (addr_ == MAP_FAILED) {
  5236. // Clear the sentinel before `close()`, since `is_open()` only checks
  5237. // `addr_` against nullptr and `munmap()` must not be called with it.
  5238. addr_ = nullptr;
  5239. close();
  5240. return false;
  5241. }
  5242. #endif
  5243. return true;
  5244. }
  5245. inline bool mmap::is_open() const {
  5246. return is_open_empty_file ? true : addr_ != nullptr;
  5247. }
  5248. inline size_t mmap::size() const { return size_; }
  5249. inline const char *mmap::data() const {
  5250. return is_open_empty_file ? "" : static_cast<const char *>(addr_);
  5251. }
  5252. inline void mmap::close() {
  5253. #if defined(_WIN32)
  5254. if (addr_) {
  5255. ::UnmapViewOfFile(addr_);
  5256. addr_ = nullptr;
  5257. }
  5258. if (hMapping_) {
  5259. ::CloseHandle(hMapping_);
  5260. hMapping_ = NULL;
  5261. }
  5262. if (hFile_ != INVALID_HANDLE_VALUE) {
  5263. ::CloseHandle(hFile_);
  5264. hFile_ = INVALID_HANDLE_VALUE;
  5265. }
  5266. is_open_empty_file = false;
  5267. #else
  5268. if (addr_ != nullptr) {
  5269. munmap(addr_, size_);
  5270. addr_ = nullptr;
  5271. }
  5272. if (fd_ != -1) {
  5273. ::close(fd_);
  5274. fd_ = -1;
  5275. }
  5276. #endif
  5277. size_ = 0;
  5278. }
  5279. inline int close_socket(socket_t sock) noexcept {
  5280. #ifdef _WIN32
  5281. return closesocket(sock);
  5282. #else
  5283. return close(sock);
  5284. #endif
  5285. }
  5286. template <typename T> inline ssize_t handle_EINTR(T fn) {
  5287. ssize_t res = 0;
  5288. while (true) {
  5289. res = fn();
  5290. if (res < 0 && errno == EINTR) {
  5291. std::this_thread::sleep_for(std::chrono::microseconds{1});
  5292. continue;
  5293. }
  5294. break;
  5295. }
  5296. return res;
  5297. }
  5298. inline ssize_t read_socket(socket_t sock, void *ptr, size_t size, int flags) {
  5299. return handle_EINTR([&]() {
  5300. return recv(sock,
  5301. #ifdef _WIN32
  5302. static_cast<char *>(ptr), static_cast<int>(size),
  5303. #else
  5304. ptr, size,
  5305. #endif
  5306. flags);
  5307. });
  5308. }
  5309. inline ssize_t send_socket(socket_t sock, const void *ptr, size_t size,
  5310. int flags) {
  5311. return handle_EINTR([&]() {
  5312. return send(sock,
  5313. #ifdef _WIN32
  5314. static_cast<const char *>(ptr), static_cast<int>(size),
  5315. #else
  5316. ptr, size,
  5317. #endif
  5318. flags);
  5319. });
  5320. }
  5321. inline int poll_wrapper(struct pollfd *fds, nfds_t nfds, int timeout) {
  5322. #ifdef _WIN32
  5323. return ::WSAPoll(fds, nfds, timeout);
  5324. #else
  5325. return ::poll(fds, nfds, timeout);
  5326. #endif
  5327. }
  5328. inline ssize_t select_impl(socket_t sock, short events, time_t sec,
  5329. time_t usec) {
  5330. struct pollfd pfd;
  5331. pfd.fd = sock;
  5332. pfd.events = events;
  5333. pfd.revents = 0;
  5334. // A negative timeout waits forever, poll's own convention. 0 keeps meaning
  5335. // "return immediately", which callers here rely on to probe a socket.
  5336. auto timeout = sec < 0 ? -1 : static_cast<int>(sec * 1000 + usec / 1000);
  5337. return handle_EINTR([&]() { return poll_wrapper(&pfd, 1, timeout); });
  5338. }
  5339. inline ssize_t select_read(socket_t sock, time_t sec, time_t usec) {
  5340. return select_impl(sock, POLLIN, sec, usec);
  5341. }
  5342. inline ssize_t select_write(socket_t sock, time_t sec, time_t usec) {
  5343. return select_impl(sock, POLLOUT, sec, usec);
  5344. }
  5345. inline Error wait_until_socket_is_ready(socket_t sock, time_t sec,
  5346. time_t usec) {
  5347. struct pollfd pfd_read;
  5348. pfd_read.fd = sock;
  5349. pfd_read.events = POLLIN | POLLOUT;
  5350. pfd_read.revents = 0;
  5351. auto timeout = static_cast<int>(sec * 1000 + usec / 1000);
  5352. auto poll_res =
  5353. handle_EINTR([&]() { return poll_wrapper(&pfd_read, 1, timeout); });
  5354. if (poll_res == 0) { return Error::ConnectionTimeout; }
  5355. if (poll_res > 0 && pfd_read.revents & (POLLIN | POLLOUT)) {
  5356. auto error = 0;
  5357. socklen_t len = sizeof(error);
  5358. auto res = getsockopt(sock, SOL_SOCKET, SO_ERROR,
  5359. reinterpret_cast<char *>(&error), &len);
  5360. auto successful = res >= 0 && !error;
  5361. return successful ? Error::Success : Error::Connection;
  5362. }
  5363. return Error::Connection;
  5364. }
  5365. inline bool is_socket_alive(socket_t sock) {
  5366. const auto val = detail::select_read(sock, 0, 0);
  5367. if (val == 0) {
  5368. return true;
  5369. } else if (val < 0 && errno == EBADF) {
  5370. return false;
  5371. }
  5372. char buf[1];
  5373. return detail::read_socket(sock, &buf[0], sizeof(buf), MSG_PEEK) > 0;
  5374. }
  5375. class SocketStream final : public Stream {
  5376. public:
  5377. SocketStream(socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5378. time_t write_timeout_sec, time_t write_timeout_usec,
  5379. time_t max_timeout_msec = 0,
  5380. std::chrono::time_point<std::chrono::steady_clock> start_time =
  5381. (std::chrono::steady_clock::time_point::min)());
  5382. ~SocketStream() override;
  5383. bool is_readable() const override;
  5384. bool wait_readable() const override;
  5385. bool wait_writable() const override;
  5386. bool is_peer_alive() const override;
  5387. ssize_t read(char *ptr, size_t size) override;
  5388. ssize_t write(const char *ptr, size_t size) override;
  5389. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  5390. void get_local_ip_and_port(std::string &ip, int &port) const override;
  5391. socket_t socket() const override;
  5392. time_t duration() const override;
  5393. void set_read_timeout(time_t sec, time_t usec = 0) override;
  5394. const char *buffered_data(size_t &size) const override;
  5395. void consume_buffered(size_t size) override;
  5396. // The caller has just seen this socket become readable. Lets the next read
  5397. // skip its own readiness wait, which would otherwise ask the kernel a
  5398. // question that was answered a moment ago. Consumed by that read.
  5399. void set_readable_hint() { readable_hint_ = true; }
  5400. private:
  5401. bool ensure_readable();
  5402. socket_t sock_;
  5403. // Atomic because ws::WebSocket::set_read_timeout() reaches this from another
  5404. // thread while a read is in flight -- that is the point of it, for a caller
  5405. // holding one connection and wanting control back to send on it.
  5406. std::atomic<time_t> read_timeout_sec_;
  5407. std::atomic<time_t> read_timeout_usec_;
  5408. time_t write_timeout_sec_;
  5409. time_t write_timeout_usec_;
  5410. time_t max_timeout_msec_;
  5411. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  5412. std::vector<char> read_buff_;
  5413. size_t read_buff_off_ = 0;
  5414. size_t read_buff_content_size_ = 0;
  5415. bool readable_hint_ = false;
  5416. static const size_t read_buff_size_ = 1024l * 4;
  5417. };
  5418. inline bool keep_alive(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5419. time_t keep_alive_timeout_sec) {
  5420. using namespace std::chrono;
  5421. const auto interval_usec =
  5422. CPPHTTPLIB_KEEPALIVE_TIMEOUT_CHECK_INTERVAL_USECOND;
  5423. // Avoid expensive `steady_clock::now()` call for the first time
  5424. if (select_read(sock, 0, interval_usec) > 0) { return true; }
  5425. const auto start = steady_clock::now() - microseconds{interval_usec};
  5426. const auto timeout = seconds{keep_alive_timeout_sec};
  5427. while (true) {
  5428. if (svr_sock == INVALID_SOCKET) {
  5429. break; // Server socket is closed
  5430. }
  5431. auto val = select_read(sock, 0, interval_usec);
  5432. if (val < 0) {
  5433. break; // Ssocket error
  5434. } else if (val == 0) {
  5435. if (steady_clock::now() - start > timeout) {
  5436. break; // Timeout
  5437. }
  5438. } else {
  5439. return true; // Ready for read
  5440. }
  5441. }
  5442. return false;
  5443. }
  5444. template <typename T>
  5445. inline bool
  5446. process_server_socket_core(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5447. size_t keep_alive_max_count,
  5448. time_t keep_alive_timeout_sec, T callback) {
  5449. assert(keep_alive_max_count > 0);
  5450. auto ret = false;
  5451. auto count = keep_alive_max_count;
  5452. while (count > 0 && keep_alive(svr_sock, sock, keep_alive_timeout_sec)) {
  5453. auto close_connection = count == 1;
  5454. auto connection_closed = false;
  5455. ret = callback(close_connection, connection_closed);
  5456. if (!ret || connection_closed) { break; }
  5457. count--;
  5458. }
  5459. return ret;
  5460. }
  5461. template <typename T>
  5462. inline bool
  5463. process_server_socket(const std::atomic<socket_t> &svr_sock, socket_t sock,
  5464. size_t keep_alive_max_count,
  5465. time_t keep_alive_timeout_sec, time_t read_timeout_sec,
  5466. time_t read_timeout_usec, time_t write_timeout_sec,
  5467. time_t write_timeout_usec, T callback) {
  5468. return process_server_socket_core(
  5469. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  5470. [&](bool close_connection, bool &connection_closed) {
  5471. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5472. write_timeout_sec, write_timeout_usec);
  5473. // process_server_socket_core() only gets here once keep_alive() has
  5474. // seen the socket go readable.
  5475. strm.set_readable_hint();
  5476. return callback(strm, close_connection, connection_closed);
  5477. });
  5478. }
  5479. inline bool process_client_socket(
  5480. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  5481. time_t write_timeout_sec, time_t write_timeout_usec,
  5482. time_t max_timeout_msec,
  5483. std::chrono::time_point<std::chrono::steady_clock> start_time,
  5484. std::function<bool(Stream &)> callback) {
  5485. SocketStream strm(sock, read_timeout_sec, read_timeout_usec,
  5486. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  5487. start_time);
  5488. return callback(strm);
  5489. }
  5490. inline int shutdown_socket(socket_t sock) noexcept {
  5491. #ifdef _WIN32
  5492. return shutdown(sock, SD_BOTH);
  5493. #else
  5494. return shutdown(sock, SHUT_RDWR);
  5495. #endif
  5496. }
  5497. // Half-closes the write side and drains any in-flight/queued bytes before
  5498. // the final shutdown+close. Closing with unread data in the receive queue
  5499. // (or bytes arriving after the receive side is closed) makes the stack send
  5500. // an abortive RST instead of a graceful FIN, which can make the peer see the
  5501. // response as a failed read even though it was fully written.
  5502. inline void drain_and_close_socket(socket_t sock) noexcept {
  5503. #ifdef _WIN32
  5504. shutdown(sock, SD_SEND);
  5505. #else
  5506. shutdown(sock, SHUT_WR);
  5507. #endif
  5508. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  5509. size_t total = 0;
  5510. const auto deadline = std::chrono::steady_clock::now() +
  5511. std::chrono::milliseconds(100); // bound #1
  5512. while (total < size_t(1024u * 1024u)) { // bound #2
  5513. const auto remaining =
  5514. std::chrono::duration_cast<std::chrono::microseconds>(
  5515. deadline - std::chrono::steady_clock::now())
  5516. .count();
  5517. if (remaining <= 0) { break; }
  5518. if (select_read(sock, 0, static_cast<time_t>(remaining)) <= 0) { break; }
  5519. const auto n = read_socket(sock, buf, sizeof(buf), CPPHTTPLIB_RECV_FLAGS);
  5520. if (n <= 0) { break; }
  5521. total += static_cast<size_t>(n);
  5522. }
  5523. shutdown_socket(sock);
  5524. close_socket(sock);
  5525. }
  5526. inline std::string escape_abstract_namespace_unix_domain(const std::string &s) {
  5527. if (s.size() > 1 && s[0] == '\0') {
  5528. auto ret = s;
  5529. ret[0] = '@';
  5530. return ret;
  5531. }
  5532. return s;
  5533. }
  5534. inline std::string
  5535. unescape_abstract_namespace_unix_domain(const std::string &s) {
  5536. if (s.size() > 1 && s[0] == '@') {
  5537. auto ret = s;
  5538. ret[0] = '\0';
  5539. return ret;
  5540. }
  5541. return s;
  5542. }
  5543. inline int getaddrinfo_with_timeout(const char *node, const char *service,
  5544. const struct addrinfo *hints,
  5545. struct addrinfo **res, time_t timeout_sec) {
  5546. #ifdef CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO
  5547. if (timeout_sec <= 0) {
  5548. // No timeout specified, use standard getaddrinfo
  5549. return getaddrinfo(node, service, hints, res);
  5550. }
  5551. #ifdef _WIN32
  5552. // Windows-specific implementation using GetAddrInfoEx with overlapped I/O
  5553. OVERLAPPED overlapped = {};
  5554. HANDLE event = CreateEventW(nullptr, TRUE, FALSE, nullptr);
  5555. if (!event) { return EAI_FAIL; }
  5556. overlapped.hEvent = event;
  5557. PADDRINFOEXW result_addrinfo = nullptr;
  5558. HANDLE cancel_handle = nullptr;
  5559. ADDRINFOEXW hints_ex = {};
  5560. if (hints) {
  5561. hints_ex.ai_flags = hints->ai_flags;
  5562. hints_ex.ai_family = hints->ai_family;
  5563. hints_ex.ai_socktype = hints->ai_socktype;
  5564. hints_ex.ai_protocol = hints->ai_protocol;
  5565. }
  5566. auto wnode = u8string_to_wstring(node);
  5567. auto wservice = u8string_to_wstring(service);
  5568. auto ret = ::GetAddrInfoExW(wnode.data(), wservice.data(), NS_DNS, nullptr,
  5569. hints ? &hints_ex : nullptr, &result_addrinfo,
  5570. nullptr, &overlapped, nullptr, &cancel_handle);
  5571. if (ret == WSA_IO_PENDING) {
  5572. auto wait_result =
  5573. ::WaitForSingleObject(event, static_cast<DWORD>(timeout_sec * 1000));
  5574. if (wait_result == WAIT_TIMEOUT) {
  5575. if (cancel_handle) { ::GetAddrInfoExCancel(&cancel_handle); }
  5576. ::CloseHandle(event);
  5577. return EAI_AGAIN;
  5578. }
  5579. DWORD bytes_returned;
  5580. if (!::GetOverlappedResult((HANDLE)INVALID_SOCKET, &overlapped,
  5581. &bytes_returned, FALSE)) {
  5582. ::CloseHandle(event);
  5583. return ::WSAGetLastError();
  5584. }
  5585. }
  5586. ::CloseHandle(event);
  5587. if (ret == NO_ERROR || ret == WSA_IO_PENDING) {
  5588. *res = reinterpret_cast<struct addrinfo *>(result_addrinfo);
  5589. return 0;
  5590. }
  5591. return ret;
  5592. #elif TARGET_OS_MAC && defined(__clang__)
  5593. if (!node) { return EAI_NONAME; }
  5594. // macOS implementation using CFHost API for asynchronous DNS resolution
  5595. CFStringRef hostname_ref = CFStringCreateWithCString(
  5596. kCFAllocatorDefault, node, kCFStringEncodingUTF8);
  5597. if (!hostname_ref) { return EAI_MEMORY; }
  5598. CFHostRef host_ref = CFHostCreateWithName(kCFAllocatorDefault, hostname_ref);
  5599. CFRelease(hostname_ref);
  5600. if (!host_ref) { return EAI_MEMORY; }
  5601. // Set up context for callback
  5602. struct CFHostContext {
  5603. bool completed = false;
  5604. bool success = false;
  5605. CFArrayRef addresses = nullptr;
  5606. std::mutex mutex;
  5607. std::condition_variable cv;
  5608. } context;
  5609. CFHostClientContext client_context;
  5610. memset(&client_context, 0, sizeof(client_context));
  5611. client_context.info = &context;
  5612. // Set callback
  5613. auto callback = [](CFHostRef theHost, CFHostInfoType /*typeInfo*/,
  5614. const CFStreamError *error, void *info) {
  5615. auto ctx = static_cast<CFHostContext *>(info);
  5616. std::lock_guard<std::mutex> lock(ctx->mutex);
  5617. if (error && error->error != 0) {
  5618. ctx->success = false;
  5619. } else {
  5620. Boolean hasBeenResolved;
  5621. ctx->addresses = CFHostGetAddressing(theHost, &hasBeenResolved);
  5622. if (ctx->addresses && hasBeenResolved) {
  5623. CFRetain(ctx->addresses);
  5624. ctx->success = true;
  5625. } else {
  5626. ctx->success = false;
  5627. }
  5628. }
  5629. ctx->completed = true;
  5630. ctx->cv.notify_one();
  5631. };
  5632. if (!CFHostSetClient(host_ref, callback, &client_context)) {
  5633. CFRelease(host_ref);
  5634. return EAI_SYSTEM;
  5635. }
  5636. // Schedule on run loop
  5637. CFRunLoopRef run_loop = CFRunLoopGetCurrent();
  5638. CFHostScheduleWithRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5639. // Start resolution
  5640. CFStreamError stream_error;
  5641. if (!CFHostStartInfoResolution(host_ref, kCFHostAddresses, &stream_error)) {
  5642. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5643. CFRelease(host_ref);
  5644. return EAI_FAIL;
  5645. }
  5646. // Wait for completion with timeout
  5647. auto timeout_time =
  5648. std::chrono::steady_clock::now() + std::chrono::seconds(timeout_sec);
  5649. bool timed_out = false;
  5650. {
  5651. std::unique_lock<std::mutex> lock(context.mutex);
  5652. while (!context.completed) {
  5653. auto now = std::chrono::steady_clock::now();
  5654. if (now >= timeout_time) {
  5655. timed_out = true;
  5656. break;
  5657. }
  5658. // Run the runloop for a short time
  5659. lock.unlock();
  5660. CFRunLoopRunInMode(kCFRunLoopDefaultMode, 0.1, true);
  5661. lock.lock();
  5662. }
  5663. }
  5664. // Clean up
  5665. CFHostUnscheduleFromRunLoop(host_ref, run_loop, kCFRunLoopDefaultMode);
  5666. CFHostSetClient(host_ref, nullptr, nullptr);
  5667. if (timed_out || !context.completed) {
  5668. CFHostCancelInfoResolution(host_ref, kCFHostAddresses);
  5669. CFRelease(host_ref);
  5670. return EAI_AGAIN;
  5671. }
  5672. if (!context.success || !context.addresses) {
  5673. CFRelease(host_ref);
  5674. return EAI_NODATA;
  5675. }
  5676. // Convert CFArray to addrinfo
  5677. CFIndex count = CFArrayGetCount(context.addresses);
  5678. if (count == 0) {
  5679. CFRelease(context.addresses);
  5680. CFRelease(host_ref);
  5681. return EAI_NODATA;
  5682. }
  5683. struct addrinfo *result_addrinfo = nullptr;
  5684. struct addrinfo **current = &result_addrinfo;
  5685. for (CFIndex i = 0; i < count; i++) {
  5686. CFDataRef addr_data =
  5687. static_cast<CFDataRef>(CFArrayGetValueAtIndex(context.addresses, i));
  5688. if (!addr_data) continue;
  5689. const struct sockaddr *sockaddr_ptr =
  5690. reinterpret_cast<const struct sockaddr *>(CFDataGetBytePtr(addr_data));
  5691. socklen_t sockaddr_len = static_cast<socklen_t>(CFDataGetLength(addr_data));
  5692. // Allocate addrinfo structure
  5693. *current = static_cast<struct addrinfo *>(malloc(sizeof(struct addrinfo)));
  5694. if (!*current) {
  5695. freeaddrinfo(result_addrinfo);
  5696. CFRelease(context.addresses);
  5697. CFRelease(host_ref);
  5698. return EAI_MEMORY;
  5699. }
  5700. memset(*current, 0, sizeof(struct addrinfo));
  5701. // Set up addrinfo fields
  5702. (*current)->ai_family = sockaddr_ptr->sa_family;
  5703. (*current)->ai_socktype = hints ? hints->ai_socktype : SOCK_STREAM;
  5704. (*current)->ai_protocol = hints ? hints->ai_protocol : IPPROTO_TCP;
  5705. (*current)->ai_addrlen = sockaddr_len;
  5706. // Copy sockaddr
  5707. (*current)->ai_addr = static_cast<struct sockaddr *>(malloc(sockaddr_len));
  5708. if (!(*current)->ai_addr) {
  5709. freeaddrinfo(result_addrinfo);
  5710. CFRelease(context.addresses);
  5711. CFRelease(host_ref);
  5712. return EAI_MEMORY;
  5713. }
  5714. memcpy((*current)->ai_addr, sockaddr_ptr, sockaddr_len);
  5715. // Set port if service is specified
  5716. if (service && *service) {
  5717. int port = 0;
  5718. if (parse_port(service, strlen(service), port)) {
  5719. if (sockaddr_ptr->sa_family == AF_INET) {
  5720. reinterpret_cast<struct sockaddr_in *>((*current)->ai_addr)
  5721. ->sin_port = htons(static_cast<uint16_t>(port));
  5722. } else if (sockaddr_ptr->sa_family == AF_INET6) {
  5723. reinterpret_cast<struct sockaddr_in6 *>((*current)->ai_addr)
  5724. ->sin6_port = htons(static_cast<uint16_t>(port));
  5725. }
  5726. }
  5727. }
  5728. current = &((*current)->ai_next);
  5729. }
  5730. CFRelease(context.addresses);
  5731. CFRelease(host_ref);
  5732. *res = result_addrinfo;
  5733. return 0;
  5734. #elif defined(_GNU_SOURCE) && defined(__GLIBC__) && \
  5735. (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 2))
  5736. // #2431: gai_cancel() is non-blocking and may return EAI_NOTCANCELED while
  5737. // the resolver worker still references the stack-local gaicb. The cancel
  5738. // path therefore waits (gai_suspend with no timeout) for the worker to
  5739. // actually finish before letting the stack frame go. The trade-off is that
  5740. // a wedged DNS server can hold this thread for the system resolver timeout
  5741. // (~30s by default) past the caller's connection timeout.
  5742. struct gaicb request{};
  5743. struct gaicb *requests[1] = {&request};
  5744. struct sigevent sevp{};
  5745. struct timespec timeout{timeout_sec, 0};
  5746. request.ar_name = node;
  5747. request.ar_service = service;
  5748. request.ar_request = hints;
  5749. sevp.sigev_notify = SIGEV_NONE;
  5750. int rc = getaddrinfo_a(GAI_NOWAIT, requests, 1, &sevp);
  5751. if (rc != 0) { return rc; }
  5752. auto cleanup = scope_exit([&] {
  5753. if (request.ar_result) { freeaddrinfo(request.ar_result); }
  5754. });
  5755. int wait_result = gai_suspend(requests, 1, &timeout);
  5756. if (wait_result == 0 || wait_result == EAI_ALLDONE) {
  5757. int gai_result = gai_error(&request);
  5758. if (gai_result == 0) {
  5759. *res = request.ar_result;
  5760. request.ar_result = nullptr;
  5761. return 0;
  5762. }
  5763. return gai_result;
  5764. }
  5765. gai_cancel(&request);
  5766. while (gai_error(&request) == EAI_INPROGRESS) {
  5767. gai_suspend(requests, 1, nullptr);
  5768. }
  5769. return wait_result;
  5770. #else
  5771. // Fallback implementation using thread-based timeout for other Unix systems.
  5772. struct GetAddrInfoState {
  5773. ~GetAddrInfoState() {
  5774. if (info) { freeaddrinfo(info); }
  5775. }
  5776. std::mutex mutex;
  5777. std::condition_variable result_cv;
  5778. bool completed = false;
  5779. int result = EAI_SYSTEM;
  5780. std::string node;
  5781. std::string service;
  5782. struct addrinfo hints;
  5783. struct addrinfo *info = nullptr;
  5784. };
  5785. // Allocate on the heap, so the resolver thread can keep using the data.
  5786. auto state = std::make_shared<GetAddrInfoState>();
  5787. if (node) { state->node = node; }
  5788. state->service = service;
  5789. state->hints = *hints;
  5790. std::thread resolve_thread([state]() {
  5791. auto thread_result =
  5792. getaddrinfo(state->node.c_str(), state->service.c_str(), &state->hints,
  5793. &state->info);
  5794. std::lock_guard<std::mutex> lock(state->mutex);
  5795. state->result = thread_result;
  5796. state->completed = true;
  5797. state->result_cv.notify_one();
  5798. });
  5799. // Wait for completion or timeout
  5800. std::unique_lock<std::mutex> lock(state->mutex);
  5801. auto finished =
  5802. state->result_cv.wait_for(lock, std::chrono::seconds(timeout_sec),
  5803. [&] { return state->completed; });
  5804. if (finished) {
  5805. // Operation completed within timeout
  5806. resolve_thread.join();
  5807. *res = state->info;
  5808. state->info = nullptr; // Pass ownership to caller
  5809. return state->result;
  5810. } else {
  5811. // Timeout occurred
  5812. resolve_thread.detach(); // Let the thread finish in background
  5813. return EAI_AGAIN; // Return timeout error
  5814. }
  5815. #endif
  5816. #else
  5817. (void)(timeout_sec); // Unused parameter for non-blocking getaddrinfo
  5818. return getaddrinfo(node, service, hints, res);
  5819. #endif
  5820. }
  5821. template <typename BindOrConnect>
  5822. socket_t create_socket(const std::string &host, const std::string &ip, int port,
  5823. int address_family, int socket_flags, bool tcp_nodelay,
  5824. bool ipv6_v6only, SocketOptions socket_options,
  5825. BindOrConnect bind_or_connect, time_t timeout_sec = 0) {
  5826. // Get address info
  5827. const char *node = nullptr;
  5828. struct addrinfo hints;
  5829. struct addrinfo *result;
  5830. memset(&hints, 0, sizeof(struct addrinfo));
  5831. hints.ai_socktype = SOCK_STREAM;
  5832. hints.ai_protocol = IPPROTO_IP;
  5833. if (!ip.empty()) {
  5834. node = ip.c_str();
  5835. // Ask getaddrinfo to convert IP in c-string to address
  5836. hints.ai_family = AF_UNSPEC;
  5837. hints.ai_flags = AI_NUMERICHOST;
  5838. } else {
  5839. if (!host.empty()) { node = host.c_str(); }
  5840. hints.ai_family = address_family;
  5841. hints.ai_flags = socket_flags;
  5842. }
  5843. #if !defined(_WIN32) || defined(CPPHTTPLIB_HAVE_AFUNIX_H)
  5844. if (hints.ai_family == AF_UNIX) {
  5845. const auto addrlen = host.length();
  5846. if (addrlen > sizeof(sockaddr_un::sun_path)) { return INVALID_SOCKET; }
  5847. #ifdef SOCK_CLOEXEC
  5848. auto sock = socket(hints.ai_family, hints.ai_socktype | SOCK_CLOEXEC,
  5849. hints.ai_protocol);
  5850. #else
  5851. auto sock = socket(hints.ai_family, hints.ai_socktype, hints.ai_protocol);
  5852. #endif
  5853. if (sock != INVALID_SOCKET) {
  5854. sockaddr_un addr{};
  5855. addr.sun_family = AF_UNIX;
  5856. auto unescaped_host = unescape_abstract_namespace_unix_domain(host);
  5857. std::copy(unescaped_host.begin(), unescaped_host.end(), addr.sun_path);
  5858. hints.ai_addr = reinterpret_cast<sockaddr *>(&addr);
  5859. hints.ai_addrlen = static_cast<socklen_t>(
  5860. sizeof(addr) - sizeof(addr.sun_path) + addrlen);
  5861. #ifndef SOCK_CLOEXEC
  5862. #ifndef _WIN32
  5863. fcntl(sock, F_SETFD, FD_CLOEXEC);
  5864. #endif
  5865. #endif
  5866. if (socket_options) { socket_options(sock); }
  5867. #ifdef _WIN32
  5868. // Setting SO_REUSEADDR seems not to work well with AF_UNIX on windows, so
  5869. // remove the option.
  5870. set_socket_opt(sock, SOL_SOCKET, SO_REUSEADDR, 0);
  5871. #endif
  5872. bool dummy;
  5873. if (!bind_or_connect(sock, hints, dummy)) {
  5874. close_socket(sock);
  5875. sock = INVALID_SOCKET;
  5876. }
  5877. }
  5878. return sock;
  5879. }
  5880. #endif
  5881. auto service = std::to_string(port);
  5882. if (getaddrinfo_with_timeout(node, service.c_str(), &hints, &result,
  5883. timeout_sec)) {
  5884. #if defined __linux__ && !defined __ANDROID__
  5885. res_init();
  5886. #endif
  5887. return INVALID_SOCKET;
  5888. }
  5889. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5890. for (auto rp = result; rp; rp = rp->ai_next) {
  5891. // Create a socket
  5892. #ifdef _WIN32
  5893. auto sock =
  5894. WSASocketW(rp->ai_family, rp->ai_socktype, rp->ai_protocol, nullptr, 0,
  5895. WSA_FLAG_NO_HANDLE_INHERIT | WSA_FLAG_OVERLAPPED);
  5896. /**
  5897. * Since the WSA_FLAG_NO_HANDLE_INHERIT is only supported on Windows 7 SP1
  5898. * and above the socket creation fails on older Windows Systems.
  5899. *
  5900. * Let's try to create a socket the old way in this case.
  5901. *
  5902. * Reference:
  5903. * https://docs.microsoft.com/en-us/windows/win32/api/winsock2/nf-winsock2-wsasocketa
  5904. *
  5905. * WSA_FLAG_NO_HANDLE_INHERIT:
  5906. * This flag is supported on Windows 7 with SP1, Windows Server 2008 R2 with
  5907. * SP1, and later
  5908. *
  5909. */
  5910. if (sock == INVALID_SOCKET) {
  5911. sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5912. }
  5913. #else
  5914. #ifdef SOCK_CLOEXEC
  5915. auto sock =
  5916. socket(rp->ai_family, rp->ai_socktype | SOCK_CLOEXEC, rp->ai_protocol);
  5917. #else
  5918. auto sock = socket(rp->ai_family, rp->ai_socktype, rp->ai_protocol);
  5919. #endif
  5920. #endif
  5921. if (sock == INVALID_SOCKET) { continue; }
  5922. #if !defined _WIN32 && !defined SOCK_CLOEXEC
  5923. if (fcntl(sock, F_SETFD, FD_CLOEXEC) == -1) {
  5924. close_socket(sock);
  5925. continue;
  5926. }
  5927. #endif
  5928. if (tcp_nodelay) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  5929. if (rp->ai_family == AF_INET6) {
  5930. set_socket_opt(sock, IPPROTO_IPV6, IPV6_V6ONLY, ipv6_v6only ? 1 : 0);
  5931. }
  5932. if (socket_options) { socket_options(sock); }
  5933. // bind or connect
  5934. auto quit = false;
  5935. if (bind_or_connect(sock, *rp, quit)) { return sock; }
  5936. close_socket(sock);
  5937. if (quit) { break; }
  5938. }
  5939. return INVALID_SOCKET;
  5940. }
  5941. inline void set_nonblocking(socket_t sock, bool nonblocking) {
  5942. #ifdef _WIN32
  5943. auto flags = nonblocking ? 1UL : 0UL;
  5944. ioctlsocket(sock, FIONBIO, &flags);
  5945. #else
  5946. auto flags = fcntl(sock, F_GETFL, 0);
  5947. fcntl(sock, F_SETFL,
  5948. nonblocking ? (flags | O_NONBLOCK) : (flags & (~O_NONBLOCK)));
  5949. #endif
  5950. }
  5951. inline bool is_connection_error() {
  5952. #ifdef _WIN32
  5953. return WSAGetLastError() != WSAEWOULDBLOCK;
  5954. #else
  5955. return errno != EINPROGRESS;
  5956. #endif
  5957. }
  5958. // accept() failed because the process or the network stack is temporarily out
  5959. // of resources. The listening socket is still usable, so back off briefly and
  5960. // try again.
  5961. inline bool is_accept_resource_error() {
  5962. #ifdef _WIN32
  5963. auto err = WSAGetLastError();
  5964. return err == WSAEMFILE || err == WSAENOBUFS;
  5965. #else
  5966. auto err = errno;
  5967. return err == EMFILE || err == ENFILE || err == ENOBUFS || err == ENOMEM;
  5968. #endif
  5969. }
  5970. // accept() failed for a reason that says nothing about the listening socket:
  5971. // the pending connection went away before it could be accepted, or the call
  5972. // was interrupted. Retry immediately. WSAAccept()'s own documentation omits
  5973. // WSAECONNRESET, but the accept() it wraps reports an aborted pending
  5974. // connection that way.
  5975. inline bool is_accept_transient_error() {
  5976. #ifdef _WIN32
  5977. auto err = WSAGetLastError();
  5978. return err == WSAEINTR || err == WSAEWOULDBLOCK || err == WSAECONNRESET ||
  5979. err == WSAECONNABORTED;
  5980. #else
  5981. auto err = errno;
  5982. return err == EINTR || err == EAGAIN || err == EWOULDBLOCK ||
  5983. err == ECONNABORTED;
  5984. #endif
  5985. }
  5986. inline bool bind_ip_address(socket_t sock, const std::string &host) {
  5987. struct addrinfo hints;
  5988. struct addrinfo *result;
  5989. memset(&hints, 0, sizeof(struct addrinfo));
  5990. hints.ai_family = AF_UNSPEC;
  5991. hints.ai_socktype = SOCK_STREAM;
  5992. hints.ai_protocol = 0;
  5993. if (getaddrinfo_with_timeout(host.c_str(), "0", &hints, &result, 0)) {
  5994. return false;
  5995. }
  5996. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  5997. auto ret = false;
  5998. for (auto rp = result; rp; rp = rp->ai_next) {
  5999. const auto &ai = *rp;
  6000. if (!::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  6001. ret = true;
  6002. break;
  6003. }
  6004. }
  6005. return ret;
  6006. }
  6007. #if !defined _WIN32 && !defined ANDROID && !defined _AIX && !defined __MVS__
  6008. #define USE_IF2IP
  6009. #endif
  6010. #ifdef USE_IF2IP
  6011. inline std::string if2ip(int address_family, const std::string &ifn) {
  6012. struct ifaddrs *ifap;
  6013. getifaddrs(&ifap);
  6014. auto se = detail::scope_exit([&] { freeifaddrs(ifap); });
  6015. std::string addr_candidate;
  6016. for (auto ifa = ifap; ifa; ifa = ifa->ifa_next) {
  6017. if (ifa->ifa_addr && ifn == ifa->ifa_name &&
  6018. (AF_UNSPEC == address_family ||
  6019. ifa->ifa_addr->sa_family == address_family)) {
  6020. if (ifa->ifa_addr->sa_family == AF_INET) {
  6021. auto sa = reinterpret_cast<struct sockaddr_in *>(ifa->ifa_addr);
  6022. char buf[INET_ADDRSTRLEN];
  6023. if (inet_ntop(AF_INET, &sa->sin_addr, buf, INET_ADDRSTRLEN)) {
  6024. return std::string(buf, INET_ADDRSTRLEN);
  6025. }
  6026. } else if (ifa->ifa_addr->sa_family == AF_INET6) {
  6027. auto sa = reinterpret_cast<struct sockaddr_in6 *>(ifa->ifa_addr);
  6028. if (!IN6_IS_ADDR_LINKLOCAL(&sa->sin6_addr)) {
  6029. char buf[INET6_ADDRSTRLEN] = {};
  6030. if (inet_ntop(AF_INET6, &sa->sin6_addr, buf, INET6_ADDRSTRLEN)) {
  6031. // equivalent to mac's IN6_IS_ADDR_UNIQUE_LOCAL
  6032. auto s6_addr_head = sa->sin6_addr.s6_addr[0];
  6033. if (s6_addr_head == 0xfc || s6_addr_head == 0xfd) {
  6034. addr_candidate = std::string(buf, INET6_ADDRSTRLEN);
  6035. } else {
  6036. return std::string(buf, INET6_ADDRSTRLEN);
  6037. }
  6038. }
  6039. }
  6040. }
  6041. }
  6042. }
  6043. return addr_candidate;
  6044. }
  6045. #endif
  6046. inline socket_t create_client_socket(
  6047. const std::string &host, const std::string &ip, int port,
  6048. int address_family, bool tcp_nodelay, bool ipv6_v6only,
  6049. SocketOptions socket_options, time_t connection_timeout_sec,
  6050. time_t connection_timeout_usec, time_t read_timeout_sec,
  6051. time_t read_timeout_usec, time_t write_timeout_sec,
  6052. time_t write_timeout_usec, const std::string &intf, Error &error) {
  6053. auto sock = create_socket(
  6054. host, ip, port, address_family, 0, tcp_nodelay, ipv6_v6only,
  6055. std::move(socket_options),
  6056. [&](socket_t sock2, struct addrinfo &ai, bool &quit) -> bool {
  6057. if (!intf.empty()) {
  6058. #ifdef USE_IF2IP
  6059. auto ip_from_if = if2ip(address_family, intf);
  6060. if (ip_from_if.empty()) { ip_from_if = intf; }
  6061. if (!bind_ip_address(sock2, ip_from_if)) {
  6062. error = Error::BindIPAddress;
  6063. return false;
  6064. }
  6065. #endif
  6066. }
  6067. set_nonblocking(sock2, true);
  6068. auto ret =
  6069. ::connect(sock2, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen));
  6070. if (ret < 0) {
  6071. if (is_connection_error()) {
  6072. error = Error::Connection;
  6073. return false;
  6074. }
  6075. error = wait_until_socket_is_ready(sock2, connection_timeout_sec,
  6076. connection_timeout_usec);
  6077. if (error != Error::Success) {
  6078. if (error == Error::ConnectionTimeout) { quit = true; }
  6079. return false;
  6080. }
  6081. }
  6082. set_nonblocking(sock2, false);
  6083. set_socket_opt_time(sock2, SOL_SOCKET, SO_RCVTIMEO, read_timeout_sec,
  6084. read_timeout_usec);
  6085. set_socket_opt_time(sock2, SOL_SOCKET, SO_SNDTIMEO, write_timeout_sec,
  6086. write_timeout_usec);
  6087. error = Error::Success;
  6088. return true;
  6089. },
  6090. connection_timeout_sec); // Pass DNS timeout
  6091. if (sock != INVALID_SOCKET) {
  6092. error = Error::Success;
  6093. } else {
  6094. if (error == Error::Success) { error = Error::Connection; }
  6095. }
  6096. return sock;
  6097. }
  6098. inline bool get_ip_and_port(const struct sockaddr_storage &addr,
  6099. socklen_t addr_len, std::string &ip, int &port) {
  6100. if (addr.ss_family == AF_INET) {
  6101. port = ntohs(reinterpret_cast<const struct sockaddr_in *>(&addr)->sin_port);
  6102. } else if (addr.ss_family == AF_INET6) {
  6103. port =
  6104. ntohs(reinterpret_cast<const struct sockaddr_in6 *>(&addr)->sin6_port);
  6105. } else {
  6106. return false;
  6107. }
  6108. std::array<char, NI_MAXHOST> ipstr{};
  6109. if (getnameinfo(reinterpret_cast<const struct sockaddr *>(&addr), addr_len,
  6110. ipstr.data(), static_cast<socklen_t>(ipstr.size()), nullptr,
  6111. 0, NI_NUMERICHOST)) {
  6112. return false;
  6113. }
  6114. ip = ipstr.data();
  6115. return true;
  6116. }
  6117. inline void get_local_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6118. struct sockaddr_storage addr;
  6119. socklen_t addr_len = sizeof(addr);
  6120. if (!getsockname(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6121. &addr_len)) {
  6122. get_ip_and_port(addr, addr_len, ip, port);
  6123. }
  6124. }
  6125. inline void get_remote_ip_and_port(socket_t sock, std::string &ip, int &port) {
  6126. struct sockaddr_storage addr;
  6127. socklen_t addr_len = sizeof(addr);
  6128. if (!getpeername(sock, reinterpret_cast<struct sockaddr *>(&addr),
  6129. &addr_len)) {
  6130. #ifndef _WIN32
  6131. if (addr.ss_family == AF_UNIX) {
  6132. #if defined(__linux__)
  6133. struct ucred ucred;
  6134. socklen_t len = sizeof(ucred);
  6135. if (getsockopt(sock, SOL_SOCKET, SO_PEERCRED, &ucred, &len) == 0) {
  6136. port = ucred.pid;
  6137. }
  6138. #elif defined(SOL_LOCAL) && defined(SO_PEERPID)
  6139. pid_t pid;
  6140. socklen_t len = sizeof(pid);
  6141. if (getsockopt(sock, SOL_LOCAL, SO_PEERPID, &pid, &len) == 0) {
  6142. port = pid;
  6143. }
  6144. #endif
  6145. return;
  6146. }
  6147. #endif
  6148. get_ip_and_port(addr, addr_len, ip, port);
  6149. }
  6150. }
  6151. // Recursive form retained so operator""_t below can compute hashes for
  6152. // switch-case labels at compile time (C++11 constexpr forbids loops). Do not
  6153. // call from runtime paths with arbitrary-length inputs — use str2tag()
  6154. // instead, which is iterative and stack-safe.
  6155. inline constexpr unsigned int str2tag_core(const char *s, size_t l,
  6156. unsigned int h) {
  6157. return (l == 0)
  6158. ? h
  6159. : str2tag_core(
  6160. s + 1, l - 1,
  6161. // Unsets the 6 high bits of h, therefore no overflow happens
  6162. (((std::numeric_limits<unsigned int>::max)() >> 6) &
  6163. h * 33) ^
  6164. static_cast<unsigned char>(*s));
  6165. }
  6166. inline unsigned int str2tag(const std::string &s) {
  6167. // Iterative form of str2tag_core: the recursive constexpr version is kept
  6168. // for compile-time UDL evaluation of short string literals, but at runtime
  6169. // we may receive arbitrarily long inputs (e.g. fuzzed Content-Type) that
  6170. // would blow the stack with one frame per character.
  6171. unsigned int h = 0;
  6172. for (auto c : s) {
  6173. h = (((std::numeric_limits<unsigned int>::max)() >> 6) & h * 33) ^
  6174. static_cast<unsigned char>(c);
  6175. }
  6176. return h;
  6177. }
  6178. namespace udl {
  6179. inline constexpr unsigned int operator""_t(const char *s, size_t l) {
  6180. return str2tag_core(s, l, 0);
  6181. }
  6182. } // namespace udl
  6183. inline std::string
  6184. find_content_type(const std::string &path,
  6185. const std::map<std::string, std::string> &user_data,
  6186. const std::string &default_content_type) {
  6187. auto ext = file_extension(path);
  6188. auto it = user_data.find(ext);
  6189. if (it != user_data.end()) { return it->second; }
  6190. using udl::operator""_t;
  6191. switch (str2tag(ext)) {
  6192. default: return default_content_type;
  6193. case "css"_t: return "text/css";
  6194. case "csv"_t: return "text/csv";
  6195. case "htm"_t:
  6196. case "html"_t: return "text/html";
  6197. case "js"_t:
  6198. case "mjs"_t: return "text/javascript";
  6199. case "txt"_t: return "text/plain";
  6200. case "vtt"_t: return "text/vtt";
  6201. case "apng"_t: return "image/apng";
  6202. case "avif"_t: return "image/avif";
  6203. case "bmp"_t: return "image/bmp";
  6204. case "gif"_t: return "image/gif";
  6205. case "png"_t: return "image/png";
  6206. case "svg"_t: return "image/svg+xml";
  6207. case "webp"_t: return "image/webp";
  6208. case "ico"_t: return "image/x-icon";
  6209. case "tif"_t: return "image/tiff";
  6210. case "tiff"_t: return "image/tiff";
  6211. case "jpg"_t:
  6212. case "jpeg"_t: return "image/jpeg";
  6213. case "mp4"_t: return "video/mp4";
  6214. case "mpeg"_t: return "video/mpeg";
  6215. case "webm"_t: return "video/webm";
  6216. case "mp3"_t: return "audio/mp3";
  6217. case "mpga"_t: return "audio/mpeg";
  6218. case "weba"_t: return "audio/webm";
  6219. case "wav"_t: return "audio/wave";
  6220. case "otf"_t: return "font/otf";
  6221. case "ttf"_t: return "font/ttf";
  6222. case "woff"_t: return "font/woff";
  6223. case "woff2"_t: return "font/woff2";
  6224. case "7z"_t: return "application/x-7z-compressed";
  6225. case "atom"_t: return "application/atom+xml";
  6226. case "pdf"_t: return "application/pdf";
  6227. case "json"_t: return "application/json";
  6228. case "rss"_t: return "application/rss+xml";
  6229. case "tar"_t: return "application/x-tar";
  6230. case "xht"_t:
  6231. case "xhtml"_t: return "application/xhtml+xml";
  6232. case "xslt"_t: return "application/xslt+xml";
  6233. case "xml"_t: return "application/xml";
  6234. case "gz"_t: return "application/gzip";
  6235. case "zip"_t: return "application/zip";
  6236. case "wasm"_t: return "application/wasm";
  6237. }
  6238. }
  6239. inline std::string
  6240. extract_media_type(const std::string &content_type,
  6241. std::map<std::string, std::string> *params = nullptr) {
  6242. // Extract type/subtype from Content-Type value (RFC 2045)
  6243. // e.g. "application/json; charset=utf-8" -> "application/json"
  6244. auto media_type = content_type;
  6245. auto semicolon_pos = media_type.find(';');
  6246. if (semicolon_pos != std::string::npos) {
  6247. auto param_str = media_type.substr(semicolon_pos + 1);
  6248. media_type = media_type.substr(0, semicolon_pos);
  6249. if (params) {
  6250. // Parse parameters: key=value pairs separated by ';'
  6251. split_unquoted(param_str.data(), param_str.data() + param_str.size(), ';',
  6252. [&](const char *b, const char *e) {
  6253. std::string key;
  6254. std::string val;
  6255. divide_param_pair(b, e, key, val);
  6256. if (!key.empty()) {
  6257. params->emplace(trim_copy(key),
  6258. trim_double_quotes_copy(val));
  6259. }
  6260. });
  6261. }
  6262. }
  6263. // Trim whitespace from media type
  6264. return trim_copy(media_type);
  6265. }
  6266. inline bool can_compress_content_type(const std::string &content_type) {
  6267. using udl::operator""_t;
  6268. auto mime_type = extract_media_type(content_type);
  6269. auto tag = str2tag(mime_type);
  6270. switch (tag) {
  6271. case "image/svg+xml"_t:
  6272. case "application/javascript"_t:
  6273. case "application/x-javascript"_t:
  6274. case "application/json"_t:
  6275. case "application/ld+json"_t:
  6276. case "application/xml"_t:
  6277. case "application/xhtml+xml"_t:
  6278. case "application/rss+xml"_t:
  6279. case "application/atom+xml"_t:
  6280. case "application/xslt+xml"_t:
  6281. case "application/protobuf"_t: return true;
  6282. case "text/event-stream"_t: return false;
  6283. default: return !mime_type.rfind("text/", 0);
  6284. }
  6285. }
  6286. inline bool parse_quality(const char *b, const char *e, std::string &token,
  6287. double &quality) {
  6288. quality = 1.0;
  6289. token.clear();
  6290. // Split on first ';': left = token name, right = parameters
  6291. const char *params_b = nullptr;
  6292. std::size_t params_len = 0;
  6293. divide(
  6294. b, static_cast<std::size_t>(e - b), ';',
  6295. [&](const char *lb, std::size_t llen, const char *rb, std::size_t rlen) {
  6296. auto r = trim(lb, lb + llen, 0, llen);
  6297. if (r.first < r.second) { token.assign(lb + r.first, lb + r.second); }
  6298. params_b = rb;
  6299. params_len = rlen;
  6300. });
  6301. if (token.empty()) { return false; }
  6302. if (params_len == 0) { return true; }
  6303. // Scan parameters for q= (stops on first match)
  6304. bool invalid = false;
  6305. split_find(params_b, params_b + params_len, ';',
  6306. (std::numeric_limits<size_t>::max)(),
  6307. [&](const char *pb, const char *pe) -> bool {
  6308. // Match exactly "q=" or "Q=" (not "query=" etc.)
  6309. auto len = static_cast<size_t>(pe - pb);
  6310. if (len < 2) { return false; }
  6311. if ((pb[0] != 'q' && pb[0] != 'Q') || pb[1] != '=') {
  6312. return false;
  6313. }
  6314. // Trim the value portion
  6315. auto r = trim(pb, pe, 2, len);
  6316. if (r.first >= r.second) {
  6317. invalid = true;
  6318. return true;
  6319. }
  6320. double v = 0.0;
  6321. auto res = from_chars(pb + r.first, pb + r.second, v);
  6322. if (res.ec != std::errc{} || v < 0.0 || v > 1.0) {
  6323. invalid = true;
  6324. return true;
  6325. }
  6326. quality = v;
  6327. return true;
  6328. });
  6329. return !invalid;
  6330. }
  6331. inline EncodingType encoding_type(const Request &req,
  6332. const std::string &content_type) {
  6333. if (!can_compress_content_type(content_type)) { return EncodingType::None; }
  6334. auto s = get_combined_header_value(req.headers, "Accept-Encoding");
  6335. if (s.empty()) { return EncodingType::None; }
  6336. // Single-pass: iterate tokens and track the best supported encoding.
  6337. // Server preference breaks ties (br > gzip > zstd).
  6338. EncodingType best = EncodingType::None;
  6339. double best_q = 0.0; // q=0 means "not acceptable"
  6340. // Server preference: Brotli > Gzip > Zstd (lower = more preferred)
  6341. auto priority = [](EncodingType t) -> int {
  6342. switch (t) {
  6343. case EncodingType::Brotli: return 0;
  6344. case EncodingType::Gzip: return 1;
  6345. case EncodingType::Zstd: return 2;
  6346. default: return 3;
  6347. }
  6348. };
  6349. std::string name;
  6350. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  6351. double quality = 1.0;
  6352. if (!parse_quality(b, e, name, quality)) { return; }
  6353. if (quality <= 0.0) { return; }
  6354. EncodingType type = EncodingType::None;
  6355. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6356. if (case_ignore::equal(name, "br")) { type = EncodingType::Brotli; }
  6357. #endif
  6358. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6359. if (type == EncodingType::None && case_ignore::equal(name, "gzip")) {
  6360. type = EncodingType::Gzip;
  6361. }
  6362. #endif
  6363. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6364. if (type == EncodingType::None && case_ignore::equal(name, "zstd")) {
  6365. type = EncodingType::Zstd;
  6366. }
  6367. #endif
  6368. if (type == EncodingType::None) { return; }
  6369. // Higher q-value wins; for equal q, server preference breaks ties
  6370. if (quality > best_q ||
  6371. (quality == best_q && priority(type) < priority(best))) {
  6372. best_q = quality;
  6373. best = type;
  6374. }
  6375. });
  6376. return best;
  6377. }
  6378. // `content_type` is taken separately because a file-backed response has not
  6379. // been given one yet when its coding has to be decided.
  6380. inline EncodingType encoding_type(const Request &req, const Response &res,
  6381. const std::string &content_type) {
  6382. // The response already names a content coding of its own: a handler serving
  6383. // a body it encoded itself (pre-compressed static assets, say), or a mount
  6384. // point whose headers name the coding its files are stored in. Applying one
  6385. // on top of that would double-encode the body and append a second
  6386. // `Content-Encoding` field line.
  6387. if (res.has_header("Content-Encoding")) { return EncodingType::None; }
  6388. return encoding_type(req, content_type);
  6389. }
  6390. inline EncodingType encoding_type(const Request &req, const Response &res) {
  6391. return encoding_type(req, res, res.get_header_value("Content-Type"));
  6392. }
  6393. inline std::unique_ptr<compressor> make_compressor(EncodingType type) {
  6394. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6395. if (type == EncodingType::Gzip) {
  6396. return detail::make_unique<gzip_compressor>();
  6397. }
  6398. #endif
  6399. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6400. if (type == EncodingType::Brotli) {
  6401. return detail::make_unique<brotli_compressor>();
  6402. }
  6403. #endif
  6404. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6405. if (type == EncodingType::Zstd) {
  6406. return detail::make_unique<zstd_compressor>();
  6407. }
  6408. #endif
  6409. (void)type;
  6410. return nullptr;
  6411. }
  6412. inline const char *encoding_name(EncodingType type) {
  6413. switch (type) {
  6414. case EncodingType::Gzip: return "gzip";
  6415. case EncodingType::Brotli: return "br";
  6416. case EncodingType::Zstd: return "zstd";
  6417. default: return "";
  6418. }
  6419. }
  6420. inline bool nocompressor::compress(const char *data, size_t data_length,
  6421. bool /*last*/, Callback callback) {
  6422. if (!data_length) { return true; }
  6423. return callback(data, data_length);
  6424. }
  6425. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6426. inline gzip_compressor::gzip_compressor() {
  6427. std::memset(&strm_, 0, sizeof(strm_));
  6428. strm_.zalloc = Z_NULL;
  6429. strm_.zfree = Z_NULL;
  6430. strm_.opaque = Z_NULL;
  6431. is_valid_ = deflateInit2(&strm_, Z_DEFAULT_COMPRESSION, Z_DEFLATED, 31, 8,
  6432. Z_DEFAULT_STRATEGY) == Z_OK;
  6433. }
  6434. inline gzip_compressor::~gzip_compressor() { deflateEnd(&strm_); }
  6435. inline bool gzip_compressor::compress(const char *data, size_t data_length,
  6436. bool last, Callback callback) {
  6437. assert(is_valid_);
  6438. do {
  6439. constexpr size_t max_avail_in =
  6440. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6441. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6442. (std::min)(data_length, max_avail_in));
  6443. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6444. data_length -= strm_.avail_in;
  6445. data += strm_.avail_in;
  6446. auto flush = (last && data_length == 0) ? Z_FINISH : Z_NO_FLUSH;
  6447. auto ret = Z_OK;
  6448. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6449. do {
  6450. strm_.avail_out = static_cast<uInt>(buff.size());
  6451. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6452. ret = deflate(&strm_, flush);
  6453. if (ret == Z_STREAM_ERROR) { return false; }
  6454. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6455. return false;
  6456. }
  6457. } while (strm_.avail_out == 0);
  6458. assert((flush == Z_FINISH && ret == Z_STREAM_END) ||
  6459. (flush == Z_NO_FLUSH && ret == Z_OK));
  6460. assert(strm_.avail_in == 0);
  6461. } while (data_length > 0);
  6462. return true;
  6463. }
  6464. inline gzip_decompressor::gzip_decompressor() {
  6465. std::memset(&strm_, 0, sizeof(strm_));
  6466. strm_.zalloc = Z_NULL;
  6467. strm_.zfree = Z_NULL;
  6468. strm_.opaque = Z_NULL;
  6469. // 15 is the value of wbits, which should be at the maximum possible value
  6470. // to ensure that any gzip stream can be decoded. The offset of 32 specifies
  6471. // that the stream type should be automatically detected either gzip or
  6472. // deflate.
  6473. is_valid_ = inflateInit2(&strm_, 32 + 15) == Z_OK;
  6474. }
  6475. inline gzip_decompressor::~gzip_decompressor() { inflateEnd(&strm_); }
  6476. inline bool gzip_decompressor::is_valid() const { return is_valid_; }
  6477. inline bool gzip_decompressor::decompress(const char *data, size_t data_length,
  6478. Callback callback) {
  6479. assert(is_valid_);
  6480. auto ret = Z_OK;
  6481. do {
  6482. constexpr size_t max_avail_in =
  6483. (std::numeric_limits<decltype(strm_.avail_in)>::max)();
  6484. strm_.avail_in = static_cast<decltype(strm_.avail_in)>(
  6485. (std::min)(data_length, max_avail_in));
  6486. strm_.next_in = const_cast<Bytef *>(reinterpret_cast<const Bytef *>(data));
  6487. data_length -= strm_.avail_in;
  6488. data += strm_.avail_in;
  6489. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6490. while (strm_.avail_in > 0 && ret == Z_OK) {
  6491. strm_.avail_out = static_cast<uInt>(buff.size());
  6492. strm_.next_out = reinterpret_cast<Bytef *>(buff.data());
  6493. ret = inflate(&strm_, Z_NO_FLUSH);
  6494. assert(ret != Z_STREAM_ERROR);
  6495. switch (ret) {
  6496. case Z_NEED_DICT:
  6497. case Z_DATA_ERROR:
  6498. case Z_MEM_ERROR: inflateEnd(&strm_); return false;
  6499. }
  6500. if (!callback(buff.data(), buff.size() - strm_.avail_out)) {
  6501. return false;
  6502. }
  6503. }
  6504. if (ret != Z_OK && ret != Z_STREAM_END) { return false; }
  6505. } while (data_length > 0);
  6506. return true;
  6507. }
  6508. #endif
  6509. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6510. inline brotli_compressor::brotli_compressor() {
  6511. state_ = BrotliEncoderCreateInstance(nullptr, nullptr, nullptr);
  6512. }
  6513. inline brotli_compressor::~brotli_compressor() {
  6514. BrotliEncoderDestroyInstance(state_);
  6515. }
  6516. inline bool brotli_compressor::compress(const char *data, size_t data_length,
  6517. bool last, Callback callback) {
  6518. std::array<uint8_t, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6519. auto operation = last ? BROTLI_OPERATION_FINISH : BROTLI_OPERATION_PROCESS;
  6520. auto available_in = data_length;
  6521. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6522. for (;;) {
  6523. if (last) {
  6524. if (BrotliEncoderIsFinished(state_)) { break; }
  6525. } else {
  6526. if (!available_in) { break; }
  6527. }
  6528. auto available_out = buff.size();
  6529. auto next_out = buff.data();
  6530. if (!BrotliEncoderCompressStream(state_, operation, &available_in, &next_in,
  6531. &available_out, &next_out, nullptr)) {
  6532. return false;
  6533. }
  6534. auto output_bytes = buff.size() - available_out;
  6535. if (output_bytes) {
  6536. callback(reinterpret_cast<const char *>(buff.data()), output_bytes);
  6537. }
  6538. }
  6539. return true;
  6540. }
  6541. inline brotli_decompressor::brotli_decompressor() {
  6542. decoder_s = BrotliDecoderCreateInstance(0, 0, 0);
  6543. decoder_r = decoder_s ? BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
  6544. : BROTLI_DECODER_RESULT_ERROR;
  6545. }
  6546. inline brotli_decompressor::~brotli_decompressor() {
  6547. if (decoder_s) { BrotliDecoderDestroyInstance(decoder_s); }
  6548. }
  6549. inline bool brotli_decompressor::is_valid() const { return decoder_s; }
  6550. inline bool brotli_decompressor::decompress(const char *data,
  6551. size_t data_length,
  6552. Callback callback) {
  6553. if (decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6554. decoder_r == BROTLI_DECODER_RESULT_ERROR) {
  6555. return 0;
  6556. }
  6557. auto next_in = reinterpret_cast<const uint8_t *>(data);
  6558. size_t avail_in = data_length;
  6559. size_t total_out;
  6560. decoder_r = BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT;
  6561. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6562. while (decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT) {
  6563. char *next_out = buff.data();
  6564. size_t avail_out = buff.size();
  6565. decoder_r = BrotliDecoderDecompressStream(
  6566. decoder_s, &avail_in, &next_in, &avail_out,
  6567. reinterpret_cast<uint8_t **>(&next_out), &total_out);
  6568. if (decoder_r == BROTLI_DECODER_RESULT_ERROR) { return false; }
  6569. if (!callback(buff.data(), buff.size() - avail_out)) { return false; }
  6570. }
  6571. return decoder_r == BROTLI_DECODER_RESULT_SUCCESS ||
  6572. decoder_r == BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT;
  6573. }
  6574. #endif
  6575. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6576. inline zstd_compressor::zstd_compressor() {
  6577. ctx_ = ZSTD_createCCtx();
  6578. ZSTD_CCtx_setParameter(ctx_, ZSTD_c_compressionLevel, ZSTD_fast);
  6579. }
  6580. inline zstd_compressor::~zstd_compressor() { ZSTD_freeCCtx(ctx_); }
  6581. inline bool zstd_compressor::compress(const char *data, size_t data_length,
  6582. bool last, Callback callback) {
  6583. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6584. ZSTD_EndDirective mode = last ? ZSTD_e_end : ZSTD_e_continue;
  6585. ZSTD_inBuffer input = {data, data_length, 0};
  6586. bool finished;
  6587. do {
  6588. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6589. size_t const remaining = ZSTD_compressStream2(ctx_, &output, &input, mode);
  6590. if (ZSTD_isError(remaining)) { return false; }
  6591. if (!callback(buff.data(), output.pos)) { return false; }
  6592. finished = last ? (remaining == 0) : (input.pos == input.size);
  6593. } while (!finished);
  6594. return true;
  6595. }
  6596. inline zstd_decompressor::zstd_decompressor() { ctx_ = ZSTD_createDCtx(); }
  6597. inline zstd_decompressor::~zstd_decompressor() { ZSTD_freeDCtx(ctx_); }
  6598. inline bool zstd_decompressor::is_valid() const { return ctx_ != nullptr; }
  6599. inline bool zstd_decompressor::decompress(const char *data, size_t data_length,
  6600. Callback callback) {
  6601. std::array<char, CPPHTTPLIB_COMPRESSION_BUFSIZ> buff{};
  6602. ZSTD_inBuffer input = {data, data_length, 0};
  6603. while (input.pos < input.size) {
  6604. ZSTD_outBuffer output = {buff.data(), CPPHTTPLIB_COMPRESSION_BUFSIZ, 0};
  6605. size_t const remaining = ZSTD_decompressStream(ctx_, &output, &input);
  6606. if (ZSTD_isError(remaining)) { return false; }
  6607. if (!callback(buff.data(), output.pos)) { return false; }
  6608. }
  6609. return true;
  6610. }
  6611. #endif
  6612. // Content codings are case-insensitive (RFC 9110 8.4.1). Matching them
  6613. // case-sensitively would make a response labeled e.g. "GZIP" look like an
  6614. // unknown coding, and its payload would be handed back still compressed.
  6615. inline bool is_zlib_encoding(const std::string &encoding) {
  6616. return case_ignore::equal(encoding, "gzip") ||
  6617. case_ignore::equal(encoding, "deflate");
  6618. }
  6619. inline bool is_brotli_encoding(const std::string &encoding) {
  6620. return case_ignore::equal(encoding, "br");
  6621. }
  6622. inline bool is_zstd_encoding(const std::string &encoding) {
  6623. return case_ignore::equal(encoding, "zstd");
  6624. }
  6625. // Returns true if the content coding is one cpp-httplib is able to decompress
  6626. // when the corresponding support is compiled in.
  6627. inline bool is_known_content_encoding(const std::string &encoding) {
  6628. return is_zlib_encoding(encoding) || is_brotli_encoding(encoding) ||
  6629. is_zstd_encoding(encoding);
  6630. }
  6631. inline std::unique_ptr<decompressor>
  6632. create_decompressor(const std::string &encoding) {
  6633. std::unique_ptr<decompressor> decompressor;
  6634. if (is_zlib_encoding(encoding)) {
  6635. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  6636. decompressor = detail::make_unique<gzip_decompressor>();
  6637. #endif
  6638. } else if (is_brotli_encoding(encoding)) {
  6639. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6640. decompressor = detail::make_unique<brotli_decompressor>();
  6641. #endif
  6642. } else if (is_zstd_encoding(encoding)) {
  6643. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  6644. decompressor = detail::make_unique<zstd_decompressor>();
  6645. #endif
  6646. }
  6647. return decompressor;
  6648. }
  6649. // Returns the best available compressor and its Content-Encoding name.
  6650. // Priority: Brotli > Gzip > Zstd (matches server-side preference).
  6651. inline std::pair<std::unique_ptr<compressor>, const char *>
  6652. create_compressor() {
  6653. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  6654. return {detail::make_unique<brotli_compressor>(), "br"};
  6655. #elif defined(CPPHTTPLIB_ZLIB_SUPPORT)
  6656. return {detail::make_unique<gzip_compressor>(), "gzip"};
  6657. #elif defined(CPPHTTPLIB_ZSTD_SUPPORT)
  6658. return {detail::make_unique<zstd_compressor>(), "zstd"};
  6659. #else
  6660. return {nullptr, nullptr};
  6661. #endif
  6662. }
  6663. inline bool is_prohibited_header_name(const std::string &name) {
  6664. using udl::operator""_t;
  6665. switch (str2tag(name)) {
  6666. case "REMOTE_ADDR"_t:
  6667. case "REMOTE_PORT"_t:
  6668. case "LOCAL_ADDR"_t:
  6669. case "LOCAL_PORT"_t: return true;
  6670. default: return false;
  6671. }
  6672. }
  6673. inline bool has_header(const Headers &headers, const std::string &key) {
  6674. if (is_prohibited_header_name(key)) { return false; }
  6675. return headers.find(key) != headers.end();
  6676. }
  6677. inline const char *get_header_value(const Headers &headers,
  6678. const std::string &key, const char *def,
  6679. size_t id) {
  6680. if (is_prohibited_header_name(key)) {
  6681. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  6682. std::string msg = "Prohibited header name '" + key + "' is specified.";
  6683. throw std::invalid_argument(msg);
  6684. #else
  6685. return "";
  6686. #endif
  6687. }
  6688. auto rng = headers.equal_range(key);
  6689. auto it = rng.first;
  6690. std::advance(it, static_cast<ssize_t>(id));
  6691. if (it != rng.second) { return it->second.c_str(); }
  6692. return def;
  6693. }
  6694. inline size_t get_header_value_count(const Headers &headers,
  6695. const std::string &key) {
  6696. return headers.count(key);
  6697. }
  6698. // RFC 9110 Section 5.2 and 5.3: a field that is defined as a comma-separated
  6699. // list may be sent as several field lines, and the combined field value is
  6700. // those values joined by commas in the order they were received. Callers that
  6701. // parse such a list must work on the combined value; reading only the first
  6702. // occurrence silently drops whatever the later field lines carry.
  6703. inline std::string get_combined_header_value(const Headers &headers,
  6704. const std::string &key) {
  6705. std::string combined;
  6706. auto rng = headers.equal_range(key);
  6707. for (auto it = rng.first; it != rng.second; ++it) {
  6708. // RFC 9110 Section 5.6.1.2: a recipient has to parse and ignore empty list
  6709. // elements, so an empty field line must not contribute a bare comma to the
  6710. // combined value.
  6711. if (it->second.empty()) { continue; }
  6712. if (!combined.empty()) { combined += ", "; }
  6713. combined += it->second;
  6714. }
  6715. return combined;
  6716. }
  6717. inline bool has_header_token(const Headers &headers, const std::string &key,
  6718. const std::string &token) {
  6719. // RFC 9110 7.6.1: a comma-separated token list field such as Connection may
  6720. // carry several tokens, and RFC 9110 5.3 lets that list be split across
  6721. // several lines. Match complete tokens rather than searching the raw value,
  6722. // so that a value such as "notupgrade" is not read as the token "upgrade".
  6723. auto rng = headers.equal_range(key);
  6724. for (auto it = rng.first; it != rng.second; ++it) {
  6725. const auto &value = it->second;
  6726. if (split_find(value.data(), value.data() + value.size(), ',',
  6727. [&](const char *b, const char *e) {
  6728. return case_ignore::equal(std::string(b, e), token);
  6729. })) {
  6730. return true;
  6731. }
  6732. }
  6733. return false;
  6734. }
  6735. template <typename Map>
  6736. inline typename Map::mapped_type
  6737. get_multimap_value(const Map &m, const std::string &key, size_t id) {
  6738. auto rng = m.equal_range(key);
  6739. auto it = rng.first;
  6740. std::advance(it, static_cast<ssize_t>(id));
  6741. if (it != rng.second) { return it->second; }
  6742. return typename Map::mapped_type();
  6743. }
  6744. inline void set_header(Headers &headers, const std::string &key,
  6745. const std::string &val) {
  6746. if (fields::is_field_valid(key, val)) { headers.emplace(key, val); }
  6747. }
  6748. inline bool read_headers(Stream &strm, Headers &headers) {
  6749. const auto bufsiz = 2048;
  6750. char buf[bufsiz];
  6751. stream_line_reader line_reader(strm, buf, bufsiz);
  6752. size_t header_count = 0;
  6753. for (;;) {
  6754. if (!line_reader.getline()) { return false; }
  6755. // Check if the line ends with CRLF.
  6756. auto line_terminator_len = 2;
  6757. if (line_reader.end_with_crlf()) {
  6758. // Blank line indicates end of headers.
  6759. if (line_reader.size() == 2) { break; }
  6760. } else {
  6761. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6762. // Blank line indicates end of headers.
  6763. if (line_reader.size() == 1) { break; }
  6764. line_terminator_len = 1;
  6765. #else
  6766. continue; // Skip invalid line.
  6767. #endif
  6768. }
  6769. if (line_reader.size() > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  6770. // Check header count limit
  6771. if (header_count >= CPPHTTPLIB_HEADER_MAX_COUNT) { return false; }
  6772. // Exclude line terminator
  6773. auto end = line_reader.ptr() + line_reader.size() - line_terminator_len;
  6774. if (!parse_header(line_reader.ptr(), end,
  6775. [&](const std::string &key, const std::string &val) {
  6776. headers.emplace(key, val);
  6777. })) {
  6778. return false;
  6779. }
  6780. header_count++;
  6781. }
  6782. // RFC 9110 Section 8.6: Reject requests with multiple Content-Length
  6783. // headers that have different values to prevent request smuggling.
  6784. auto cl_range = headers.equal_range("Content-Length");
  6785. if (cl_range.first != cl_range.second) {
  6786. const auto &first_val = cl_range.first->second;
  6787. for (auto it = std::next(cl_range.first); it != cl_range.second; ++it) {
  6788. if (it->second != first_val) { return false; }
  6789. }
  6790. }
  6791. return true;
  6792. }
  6793. inline bool parse_status_line(const char *line, std::string &version,
  6794. int &status, std::string &reason) {
  6795. #ifdef CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR
  6796. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r?\n");
  6797. #else
  6798. thread_local const std::regex re("(HTTP/1\\.[01]) (\\d{3})(?: (.*?))?\r\n");
  6799. #endif
  6800. std::cmatch m;
  6801. if (!std::regex_match(line, m, re)) { return false; }
  6802. version = std::string(m[1]);
  6803. status = std::stoi(std::string(m[2]));
  6804. reason = std::string(m[3]);
  6805. return true;
  6806. }
  6807. // Everything WebSocketClient::connect() reports about the upgrade exchange.
  6808. // status stays -1 until a status line is parsed, mirroring stream::Result.
  6809. struct WebSocketUpgradeResponse {
  6810. Error error = Error::Success;
  6811. int status = -1;
  6812. Headers headers;
  6813. std::string selected_subprotocol;
  6814. };
  6815. inline bool read_websocket_upgrade_response(Stream &strm,
  6816. const std::string &expected_accept,
  6817. WebSocketUpgradeResponse &upgrade) {
  6818. // Read status line
  6819. const auto bufsiz = 2048;
  6820. char buf[bufsiz];
  6821. stream_line_reader line_reader(strm, buf, bufsiz);
  6822. if (!line_reader.getline()) {
  6823. upgrade.error = Error::Read;
  6824. return false;
  6825. }
  6826. std::string version;
  6827. std::string reason;
  6828. if (!parse_status_line(line_reader.ptr(), version, upgrade.status, reason)) {
  6829. upgrade.error = Error::WebSocketHandshake;
  6830. return false;
  6831. }
  6832. // Read the headers even for a rejection so the caller can see why the
  6833. // server refused the upgrade. A non-101 response may carry a body; it is
  6834. // deliberately left unread since the caller closes the socket right away.
  6835. if (!read_headers(strm, upgrade.headers)) {
  6836. upgrade.error = Error::Read;
  6837. return false;
  6838. }
  6839. const auto &headers = upgrade.headers;
  6840. if (upgrade.status != StatusCode::SwitchingProtocol_101) {
  6841. upgrade.error = Error::WebSocketHandshake;
  6842. return false;
  6843. }
  6844. // Verify Upgrade: websocket (a comma-separated list, matched per token)
  6845. if (!has_header_token(headers, "Upgrade", "websocket")) {
  6846. upgrade.error = Error::WebSocketHandshake;
  6847. return false;
  6848. }
  6849. // Verify Connection: Upgrade
  6850. if (!has_header_token(headers, "Connection", "upgrade")) {
  6851. upgrade.error = Error::WebSocketHandshake;
  6852. return false;
  6853. }
  6854. // Verify Sec-WebSocket-Accept header value
  6855. auto it = headers.find("Sec-WebSocket-Accept");
  6856. if (it == headers.end() || it->second != expected_accept) {
  6857. upgrade.error = Error::WebSocketHandshake;
  6858. return false;
  6859. }
  6860. // Extract negotiated subprotocol
  6861. auto proto_it = headers.find("Sec-WebSocket-Protocol");
  6862. if (proto_it != headers.end()) {
  6863. upgrade.selected_subprotocol = proto_it->second;
  6864. }
  6865. return true;
  6866. }
  6867. enum class ReadContentResult {
  6868. Success, // Successfully read the content
  6869. PayloadTooLarge, // The content exceeds the specified payload limit
  6870. Error // An error occurred while reading the content
  6871. };
  6872. inline ReadContentResult read_content_with_length(
  6873. Stream &strm, size_t len, DownloadProgress progress,
  6874. ContentReceiverWithProgress out,
  6875. size_t payload_max_length = (std::numeric_limits<size_t>::max)()) {
  6876. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6877. detail::BodyReader br;
  6878. br.stream = &strm;
  6879. br.has_content_length = true;
  6880. br.content_length = len;
  6881. br.payload_max_length = payload_max_length;
  6882. br.chunked = false;
  6883. br.bytes_read = 0;
  6884. br.last_error = Error::Success;
  6885. size_t r = 0;
  6886. while (r < len) {
  6887. auto read_len = static_cast<size_t>(len - r);
  6888. auto to_read = (std::min)(read_len, CPPHTTPLIB_RECV_BUFSIZ);
  6889. auto n = detail::read_body_content(&strm, br, buf, to_read);
  6890. if (n <= 0) {
  6891. // Check if it was a payload size error
  6892. if (br.last_error == Error::ExceedMaxPayloadSize) {
  6893. return ReadContentResult::PayloadTooLarge;
  6894. }
  6895. return ReadContentResult::Error;
  6896. }
  6897. if (!out(buf, static_cast<size_t>(n), r, len)) {
  6898. return ReadContentResult::Error;
  6899. }
  6900. r += static_cast<size_t>(n);
  6901. if (progress) {
  6902. if (!progress(r, len)) { return ReadContentResult::Error; }
  6903. }
  6904. }
  6905. return ReadContentResult::Success;
  6906. }
  6907. inline ReadContentResult
  6908. read_content_without_length(Stream &strm, size_t payload_max_length,
  6909. ContentReceiverWithProgress out) {
  6910. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6911. size_t r = 0;
  6912. for (;;) {
  6913. auto n = strm.read(buf, CPPHTTPLIB_RECV_BUFSIZ);
  6914. if (n == 0) { return ReadContentResult::Success; }
  6915. if (n < 0) { return ReadContentResult::Error; }
  6916. // Check if adding this data would exceed the payload limit
  6917. if (r > payload_max_length ||
  6918. payload_max_length - r < static_cast<size_t>(n)) {
  6919. return ReadContentResult::PayloadTooLarge;
  6920. }
  6921. if (!out(buf, static_cast<size_t>(n), r, 0)) {
  6922. return ReadContentResult::Error;
  6923. }
  6924. r += static_cast<size_t>(n);
  6925. }
  6926. return ReadContentResult::Success;
  6927. }
  6928. template <typename T>
  6929. inline ReadContentResult read_content_chunked(Stream &strm, T &x,
  6930. size_t payload_max_length,
  6931. ContentReceiverWithProgress out) {
  6932. detail::ChunkedDecoder dec(strm);
  6933. char buf[CPPHTTPLIB_RECV_BUFSIZ];
  6934. size_t total_len = 0;
  6935. for (;;) {
  6936. size_t chunk_offset = 0;
  6937. size_t chunk_total = 0;
  6938. auto n = dec.read_payload(buf, sizeof(buf), chunk_offset, chunk_total);
  6939. if (n < 0) { return ReadContentResult::Error; }
  6940. if (n == 0) {
  6941. if (!dec.parse_trailers_into(x.trailers, x.headers)) {
  6942. return ReadContentResult::Error;
  6943. }
  6944. return ReadContentResult::Success;
  6945. }
  6946. if (total_len > payload_max_length ||
  6947. payload_max_length - total_len < static_cast<size_t>(n)) {
  6948. return ReadContentResult::PayloadTooLarge;
  6949. }
  6950. if (!out(buf, static_cast<size_t>(n), chunk_offset, chunk_total)) {
  6951. return ReadContentResult::Error;
  6952. }
  6953. total_len += static_cast<size_t>(n);
  6954. }
  6955. }
  6956. inline bool is_chunked_transfer_encoding(const Headers &headers) {
  6957. // RFC 9112 6.1: a message is framed with the chunked coding when "chunked"
  6958. // is the final transfer coding. A single field value may list several
  6959. // codings ("gzip, chunked"), and RFC 9110 5.3 lets that list be split across
  6960. // several Transfer-Encoding lines, which combine into one comma-separated
  6961. // list in the order the lines were received. Headers preserves that order,
  6962. // so the final coding is the last token of the last line. Match it
  6963. // case-insensitively rather than comparing the whole value against
  6964. // "chunked".
  6965. //
  6966. // Security: reading a chunked message as unframed leaves its body in the
  6967. // socket, where a keep-alive connection parses it as a smuggled request.
  6968. // Server::process_request() answers 400 and closes when the final coding is
  6969. // not chunked, so a request whose framing cannot be determined never
  6970. // reaches the "no body" path.
  6971. auto rng = headers.equal_range("Transfer-Encoding");
  6972. if (rng.first == rng.second) { return false; }
  6973. // Cleared per line, so a trailing line carrying no coding at all leaves the
  6974. // combined list ending in nothing rather than inheriting the line before it.
  6975. std::string last_coding;
  6976. for (auto it = rng.first; it != rng.second; ++it) {
  6977. const auto &value = it->second;
  6978. last_coding.clear();
  6979. split(value.data(), value.data() + value.size(), ',',
  6980. [&](const char *b, const char *e) { last_coding.assign(b, e); });
  6981. }
  6982. return case_ignore::equal(last_coding, "chunked");
  6983. }
  6984. inline bool has_conflicting_content_length(const Headers &headers) {
  6985. // RFC 9112 §6.3: a message carrying both Transfer-Encoding and a non-zero
  6986. // Content-Length is framed ambiguously. The body readers here delimit it by
  6987. // the transfer coding and drop Content-Length, while an intermediary may do
  6988. // the reverse, so the two disagree on where the body ends and a reused
  6989. // connection is desynchronised (request/response smuggling). Content-Length:
  6990. // 0 is tolerated for compatibility with existing peers.
  6991. return has_header(headers, "Transfer-Encoding") &&
  6992. get_header_value_u64(headers, "Content-Length", 0, 0) > 0;
  6993. }
  6994. template <typename T, typename U>
  6995. bool prepare_content_receiver(T &x, int &status,
  6996. ContentReceiverWithProgress receiver,
  6997. bool decompress, size_t payload_max_length,
  6998. bool &exceed_payload_max_length, U callback) {
  6999. if (decompress) {
  7000. auto encoding = get_combined_header_value(x.headers, "Content-Encoding");
  7001. std::unique_ptr<decompressor> decompressor;
  7002. if (!encoding.empty()) {
  7003. // A coding we know about but were not built with is an error. An
  7004. // unrecognized coding (including "identity") is left alone and the
  7005. // payload is passed through as-is, since some servers misuse the header,
  7006. // e.g. by sending a character set such as "Content-Encoding: UTF-8".
  7007. decompressor = detail::create_decompressor(encoding);
  7008. if (!decompressor && detail::is_known_content_encoding(encoding)) {
  7009. status = StatusCode::UnsupportedMediaType_415;
  7010. return false;
  7011. }
  7012. }
  7013. if (decompressor) {
  7014. if (decompressor->is_valid()) {
  7015. size_t decompressed_size = 0;
  7016. ContentReceiverWithProgress out = [&](const char *buf, size_t n,
  7017. size_t off, size_t len) {
  7018. return decompressor->decompress(
  7019. buf, n, [&](const char *buf2, size_t n2) {
  7020. // Guard against zip-bomb: check
  7021. // decompressed size against limit.
  7022. if (payload_max_length > 0 &&
  7023. (decompressed_size >= payload_max_length ||
  7024. n2 > payload_max_length - decompressed_size)) {
  7025. exceed_payload_max_length = true;
  7026. return false;
  7027. }
  7028. decompressed_size += n2;
  7029. return receiver(buf2, n2, off, len);
  7030. });
  7031. };
  7032. return callback(std::move(out));
  7033. } else {
  7034. status = StatusCode::InternalServerError_500;
  7035. return false;
  7036. }
  7037. }
  7038. }
  7039. ContentReceiverWithProgress out = [&](const char *buf, size_t n, size_t off,
  7040. size_t len) {
  7041. return receiver(buf, n, off, len);
  7042. };
  7043. return callback(std::move(out));
  7044. }
  7045. template <typename T>
  7046. bool read_content(Stream &strm, T &x, size_t payload_max_length, int &status,
  7047. DownloadProgress progress,
  7048. ContentReceiverWithProgress receiver, bool decompress) {
  7049. bool exceed_payload_max_length = false;
  7050. return prepare_content_receiver(
  7051. x, status, std::move(receiver), decompress, payload_max_length,
  7052. exceed_payload_max_length, [&](const ContentReceiverWithProgress &out) {
  7053. auto ret = true;
  7054. // Note: exceed_payload_max_length may also be set by the decompressor
  7055. // wrapper in prepare_content_receiver when the decompressed payload
  7056. // size exceeds the limit.
  7057. if (is_chunked_transfer_encoding(x.headers)) {
  7058. auto result = read_content_chunked(strm, x, payload_max_length, out);
  7059. if (result == ReadContentResult::Success) {
  7060. ret = true;
  7061. } else if (result == ReadContentResult::PayloadTooLarge) {
  7062. exceed_payload_max_length = true;
  7063. ret = false;
  7064. } else {
  7065. ret = false;
  7066. }
  7067. } else if (!has_header(x.headers, "Content-Length")) {
  7068. auto result =
  7069. read_content_without_length(strm, payload_max_length, out);
  7070. if (result == ReadContentResult::Success) {
  7071. ret = true;
  7072. } else if (result == ReadContentResult::PayloadTooLarge) {
  7073. exceed_payload_max_length = true;
  7074. ret = false;
  7075. } else {
  7076. ret = false;
  7077. }
  7078. } else {
  7079. auto is_invalid_value = false;
  7080. auto len = get_header_value_u64(x.headers, "Content-Length",
  7081. (std::numeric_limits<size_t>::max)(),
  7082. 0, is_invalid_value);
  7083. if (is_invalid_value) {
  7084. ret = false;
  7085. } else if (len > 0) {
  7086. auto result = read_content_with_length(
  7087. strm, len, std::move(progress), out, payload_max_length);
  7088. ret = (result == ReadContentResult::Success);
  7089. if (result == ReadContentResult::PayloadTooLarge) {
  7090. exceed_payload_max_length = true;
  7091. }
  7092. }
  7093. }
  7094. if (!ret) {
  7095. status = exceed_payload_max_length ? StatusCode::PayloadTooLarge_413
  7096. : StatusCode::BadRequest_400;
  7097. }
  7098. return ret;
  7099. });
  7100. }
  7101. inline ssize_t write_request_line(Stream &strm, const std::string &method,
  7102. const std::string &path) {
  7103. // Neither the method nor the request target may carry CR/LF (or other
  7104. // control octets); otherwise a value smuggled into either splits the request
  7105. // line and injects headers or a whole request. The method must be a token
  7106. // (RFC 9110 Section 9.1), which also rejects an empty method and embedded
  7107. // spaces. The target gets the same field-value check that already guards
  7108. // header values in check_and_write_headers.
  7109. if (!fields::is_token(method)) { return -1; }
  7110. if (!fields::is_field_value(path)) { return -1; }
  7111. std::string s = method;
  7112. s += ' ';
  7113. s += path;
  7114. s += " HTTP/1.1\r\n";
  7115. return strm.write(s.data(), s.size());
  7116. }
  7117. inline ssize_t write_response_line(Stream &strm, int status) {
  7118. std::string s = "HTTP/1.1 ";
  7119. s += std::to_string(status);
  7120. s += ' ';
  7121. s += httplib::status_message(status);
  7122. s += "\r\n";
  7123. return strm.write(s.data(), s.size());
  7124. }
  7125. inline ssize_t write_headers(Stream &strm, const Headers &headers) {
  7126. ssize_t write_len = 0;
  7127. for (const auto &x : headers) {
  7128. // Skip fields with invalid names or values to prevent response splitting
  7129. // via CR/LF injection, matching set_header(). The client validates request
  7130. // headers up front in check_and_write_headers, but the server passes
  7131. // res.headers straight to this writer, and res.headers is a public field
  7132. // an application can populate directly with request-derived values.
  7133. if (!fields::is_field_valid(x.first, x.second)) { continue; }
  7134. std::string s;
  7135. s = x.first;
  7136. s += ": ";
  7137. s += x.second;
  7138. s += "\r\n";
  7139. auto len = strm.write(s.data(), s.size());
  7140. if (len < 0) { return len; }
  7141. write_len += len;
  7142. }
  7143. auto len = strm.write("\r\n");
  7144. if (len < 0) { return len; }
  7145. write_len += len;
  7146. return write_len;
  7147. }
  7148. inline bool write_data(Stream &strm, const char *d, size_t l) {
  7149. size_t offset = 0;
  7150. while (offset < l) {
  7151. auto length = strm.write(d + offset, l - offset);
  7152. if (length < 0) { return false; }
  7153. offset += static_cast<size_t>(length);
  7154. }
  7155. return true;
  7156. }
  7157. template <typename T>
  7158. inline bool write_content_with_progress(Stream &strm,
  7159. const ContentProvider &content_provider,
  7160. size_t offset, size_t length,
  7161. T is_shutting_down,
  7162. const UploadProgress &upload_progress,
  7163. Error &error) {
  7164. size_t end_offset = offset + length;
  7165. size_t start_offset = offset;
  7166. auto ok = true;
  7167. auto finished = false;
  7168. DataSink data_sink;
  7169. data_sink.write = [&](const char *d, size_t l) -> bool {
  7170. if (ok) {
  7171. if (write_data(strm, d, l)) {
  7172. offset += l;
  7173. if (upload_progress && length > 0) {
  7174. size_t current_written = offset - start_offset;
  7175. if (!upload_progress(current_written, length)) {
  7176. ok = false;
  7177. return false;
  7178. }
  7179. }
  7180. } else {
  7181. ok = false;
  7182. }
  7183. }
  7184. return ok;
  7185. };
  7186. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7187. // The body is framed by `length`, so a provider that reports itself done
  7188. // early has truncated it. Record that and let the short-body check below
  7189. // fail the write, rather than calling the provider again forever.
  7190. data_sink.done = [&]() { finished = true; };
  7191. while (offset < end_offset && !finished && !is_shutting_down()) {
  7192. auto last_offset = offset;
  7193. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7194. error = Error::Write;
  7195. return false;
  7196. } else if (!content_provider(offset, end_offset - offset, data_sink)) {
  7197. error = Error::Canceled;
  7198. return false;
  7199. } else if (!ok) {
  7200. error = Error::Write;
  7201. return false;
  7202. }
  7203. // A provider that reports success without writing anything and without
  7204. // reporting itself done gets handed the same offset and length again on
  7205. // the next pass, so it would spin here for as long as the peer stays
  7206. // connected. Treat making no progress as a short body, like done() early.
  7207. if (!finished && offset == last_offset) {
  7208. error = Error::Write;
  7209. return false;
  7210. }
  7211. }
  7212. if (offset < end_offset) { // done() called early, or is_shutting_down()
  7213. error = Error::Write;
  7214. return false;
  7215. }
  7216. error = Error::Success;
  7217. return true;
  7218. }
  7219. template <typename T>
  7220. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7221. size_t offset, size_t length, T is_shutting_down,
  7222. Error &error) {
  7223. return write_content_with_progress<T>(strm, content_provider, offset, length,
  7224. is_shutting_down, nullptr, error);
  7225. }
  7226. template <typename T>
  7227. inline bool write_content(Stream &strm, const ContentProvider &content_provider,
  7228. size_t offset, size_t length,
  7229. const T &is_shutting_down) {
  7230. auto error = Error::Success;
  7231. return write_content(strm, content_provider, offset, length, is_shutting_down,
  7232. error);
  7233. }
  7234. template <typename T>
  7235. inline bool
  7236. write_content_without_length(Stream &strm,
  7237. const ContentProvider &content_provider,
  7238. const T &is_shutting_down) {
  7239. size_t offset = 0;
  7240. auto data_available = true;
  7241. auto ok = true;
  7242. DataSink data_sink;
  7243. data_sink.write = [&](const char *d, size_t l) -> bool {
  7244. if (ok) {
  7245. offset += l;
  7246. if (!write_data(strm, d, l)) { ok = false; }
  7247. }
  7248. return ok;
  7249. };
  7250. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7251. data_sink.done = [&](void) { data_available = false; };
  7252. while (data_available && !is_shutting_down()) {
  7253. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7254. return false;
  7255. } else if (!content_provider(offset, 0, data_sink)) {
  7256. return false;
  7257. } else if (!ok) {
  7258. return false;
  7259. }
  7260. }
  7261. return !data_available; // true only if done() was called, false if shutting
  7262. // down
  7263. }
  7264. // Runs a known-length content provider to completion and compresses what it
  7265. // writes into `out`. Nothing is buffered in identity form: a provider backed
  7266. // by an mmap hands the compressor a pointer straight into the mapping.
  7267. inline bool compress_content_provider(const ContentProvider &content_provider,
  7268. size_t length, compressor &cmp,
  7269. std::string &out) {
  7270. size_t offset = 0;
  7271. auto ok = true;
  7272. auto finished = false;
  7273. DataSink data_sink;
  7274. auto append = [&](const char *data, size_t data_len) {
  7275. out.append(data, data_len);
  7276. return true;
  7277. };
  7278. data_sink.write = [&](const char *d, size_t l) -> bool {
  7279. if (!ok) { return false; }
  7280. offset += l;
  7281. if (l > 0 && !cmp.compress(d, l, false, append)) { ok = false; }
  7282. return ok;
  7283. };
  7284. // The body is framed by `length`, so a provider that reports itself done
  7285. // early has truncated it; the short-body check below turns that into a
  7286. // failure rather than calling the provider again forever.
  7287. data_sink.done = [&]() { finished = true; };
  7288. while (offset < length && !finished) {
  7289. auto prev_offset = offset;
  7290. if (!content_provider(offset, length - offset, data_sink) || !ok) {
  7291. return false;
  7292. }
  7293. // No Stream to block on here, so a provider that keeps returning true
  7294. // without writing would spin. Treat a pass that made no progress as a
  7295. // failure.
  7296. if (offset == prev_offset) { return false; }
  7297. }
  7298. if (offset != length) { return false; }
  7299. return cmp.compress(nullptr, 0, true, append);
  7300. }
  7301. // Serves `m` as the response body. `set_content_provider()` clears the coding,
  7302. // so recording it has to come after; keeping both here means a third
  7303. // file-serving path cannot get that order wrong.
  7304. inline void set_file_content_provider(Response &res,
  7305. const std::shared_ptr<mmap> &m,
  7306. const std::string &content_type,
  7307. EncodingType encoding) {
  7308. res.set_content_provider(
  7309. m->size(), content_type,
  7310. [m](size_t offset, size_t length, DataSink &sink) -> bool {
  7311. sink.write(m->data() + offset, length);
  7312. return true;
  7313. });
  7314. res.content_coding_ = encoding;
  7315. }
  7316. template <typename T, typename U>
  7317. inline bool
  7318. write_content_chunked(Stream &strm, const ContentProvider &content_provider,
  7319. const T &is_shutting_down, U &compressor, Error &error) {
  7320. size_t offset = 0;
  7321. auto data_available = true;
  7322. auto ok = true;
  7323. DataSink data_sink;
  7324. data_sink.write = [&](const char *d, size_t l) -> bool {
  7325. // Only done()/done_with_trailer() end a chunked body. A pass with nothing
  7326. // to hand over is ordinary (an empty buffer popped off a queue), and a
  7327. // zero-length chunk is the terminator, so it must not be emitted here.
  7328. if (ok && l > 0) {
  7329. offset += l;
  7330. std::string payload;
  7331. if (compressor.compress(d, l, false,
  7332. [&](const char *data, size_t data_len) {
  7333. payload.append(data, data_len);
  7334. return true;
  7335. })) {
  7336. if (!payload.empty()) {
  7337. // Emit chunked response header and footer for each chunk
  7338. auto chunk =
  7339. from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7340. if (!write_data(strm, chunk.data(), chunk.size())) { ok = false; }
  7341. }
  7342. } else {
  7343. ok = false;
  7344. }
  7345. }
  7346. return ok;
  7347. };
  7348. data_sink.is_writable = [&]() -> bool { return strm.is_peer_alive(); };
  7349. auto done_with_trailer = [&](const Headers *trailer) {
  7350. if (!ok) { return; }
  7351. data_available = false;
  7352. std::string payload;
  7353. if (!compressor.compress(nullptr, 0, true,
  7354. [&](const char *data, size_t data_len) {
  7355. payload.append(data, data_len);
  7356. return true;
  7357. })) {
  7358. ok = false;
  7359. return;
  7360. }
  7361. if (!payload.empty()) {
  7362. // Emit chunked response header and footer for each chunk
  7363. auto chunk = from_i_to_hex(payload.size()) + "\r\n" + payload + "\r\n";
  7364. if (!write_data(strm, chunk.data(), chunk.size())) {
  7365. ok = false;
  7366. return;
  7367. }
  7368. }
  7369. constexpr const char done_marker[] = "0\r\n";
  7370. if (!write_data(strm, done_marker, str_len(done_marker))) { ok = false; }
  7371. // Trailer
  7372. if (trailer) {
  7373. for (const auto &kv : *trailer) {
  7374. // Skip fields with invalid names or values to prevent response
  7375. // splitting via CR/LF injection, matching set_header().
  7376. if (!fields::is_field_valid(kv.first, kv.second)) { continue; }
  7377. std::string field_line = kv.first + ": " + kv.second + "\r\n";
  7378. if (!write_data(strm, field_line.data(), field_line.size())) {
  7379. ok = false;
  7380. }
  7381. }
  7382. }
  7383. constexpr const char crlf[] = "\r\n";
  7384. if (!write_data(strm, crlf, str_len(crlf))) { ok = false; }
  7385. };
  7386. data_sink.done = [&](void) { done_with_trailer(nullptr); };
  7387. data_sink.done_with_trailer = [&](const Headers &trailer) {
  7388. done_with_trailer(&trailer);
  7389. };
  7390. while (data_available && !is_shutting_down()) {
  7391. if (!strm.wait_writable() || !strm.is_peer_alive()) {
  7392. error = Error::Write;
  7393. return false;
  7394. } else if (!content_provider(offset, 0, data_sink)) {
  7395. error = Error::Canceled;
  7396. return false;
  7397. } else if (!ok) {
  7398. error = Error::Write;
  7399. return false;
  7400. }
  7401. }
  7402. if (data_available) { // exited due to is_shutting_down(), not done()
  7403. error = Error::Write;
  7404. return false;
  7405. }
  7406. error = Error::Success;
  7407. return true;
  7408. }
  7409. template <typename T, typename U>
  7410. inline bool write_content_chunked(Stream &strm,
  7411. const ContentProvider &content_provider,
  7412. const T &is_shutting_down, U &compressor) {
  7413. auto error = Error::Success;
  7414. return write_content_chunked(strm, content_provider, is_shutting_down,
  7415. compressor, error);
  7416. }
  7417. template <typename T>
  7418. inline bool redirect(T &cli, Request &req, Response &res,
  7419. const std::string &path, const std::string &location,
  7420. Error &error) {
  7421. Request new_req = req;
  7422. new_req.path = path;
  7423. new_req.redirect_count_ -= 1;
  7424. if (res.status == StatusCode::SeeOther_303 &&
  7425. (req.method != "GET" && req.method != "HEAD")) {
  7426. new_req.method = "GET";
  7427. new_req.body.clear();
  7428. new_req.headers.clear();
  7429. }
  7430. Response new_res;
  7431. auto ret = cli.send(new_req, new_res, error);
  7432. if (ret) {
  7433. req = std::move(new_req);
  7434. res = std::move(new_res);
  7435. if (res.location.empty()) { res.location = location; }
  7436. }
  7437. return ret;
  7438. }
  7439. inline std::string params_to_query_str(const Params &params) {
  7440. std::string query;
  7441. for (auto it = params.begin(); it != params.end(); ++it) {
  7442. if (it != params.begin()) { query += '&'; }
  7443. query += encode_query_component(it->first);
  7444. query += '=';
  7445. query += encode_query_component(it->second);
  7446. }
  7447. return query;
  7448. }
  7449. // Splits one "key=value" span of a query string at its first '='. A span with
  7450. // no '=' at all lands entirely in key, leaving val empty, which is how a bare
  7451. // "?flag" keeps its name.
  7452. inline void divide_query_pair(const char *b, const char *e, std::string &key,
  7453. std::string &val) {
  7454. divide(b, static_cast<std::size_t>(e - b), '=',
  7455. [&](const char *lhs_data, std::size_t lhs_size, const char *rhs_data,
  7456. std::size_t rhs_size) {
  7457. key.assign(lhs_data, lhs_size);
  7458. val.assign(rhs_data, rhs_size);
  7459. });
  7460. }
  7461. inline void parse_query_text(const char *data, std::size_t size,
  7462. Params &params) {
  7463. std::set<std::string> cache;
  7464. split(data, data + size, '&', [&](const char *b, const char *e) {
  7465. std::string kv(b, e);
  7466. if (cache.find(kv) != cache.end()) { return; }
  7467. cache.insert(std::move(kv));
  7468. std::string key;
  7469. std::string val;
  7470. divide_query_pair(b, e, key, val);
  7471. if (!key.empty()) {
  7472. params.emplace(decode_query_component(key), decode_query_component(val));
  7473. }
  7474. });
  7475. }
  7476. inline void parse_query_text(const std::string &s, Params &params) {
  7477. parse_query_text(s.data(), s.size(), params);
  7478. }
  7479. // Normalize a query string by decoding and re-encoding each key/value pair
  7480. // while preserving the original parameter order. This avoids double-encoding
  7481. // and ensures consistent encoding. It works on the raw string rather than
  7482. // parsing into Params and re-serializing, because that round trip cannot
  7483. // reproduce the input: params_to_query_str() always emits '=', so a bare
  7484. // "flag" would come back as "flag=", and parse_query_text() drops exactly
  7485. // duplicated pairs.
  7486. inline std::string normalize_query_string(const std::string &query) {
  7487. std::string result;
  7488. split(query.data(), query.data() + query.size(), '&',
  7489. [&](const char *b, const char *e) {
  7490. std::string key;
  7491. std::string val;
  7492. divide_query_pair(b, e, key, val);
  7493. if (!key.empty()) {
  7494. auto dec_key = decode_query_component(key);
  7495. auto dec_val = decode_query_component(val);
  7496. if (!result.empty()) { result += '&'; }
  7497. result += encode_query_component(dec_key);
  7498. if (!val.empty() || std::find(b, e, '=') != e) {
  7499. result += '=';
  7500. result += encode_query_component(dec_val);
  7501. }
  7502. }
  7503. });
  7504. return result;
  7505. }
  7506. // Build the request target that goes on the wire from a caller-supplied path.
  7507. // Shared by the buffered send path and the streaming API so that both put the
  7508. // same bytes in the request line for the same input.
  7509. inline std::string encode_request_target(const std::string &target,
  7510. bool path_encode) {
  7511. // `substr(0, npos)` yields the whole string, which is what the no-query
  7512. // case needs.
  7513. auto query_pos = target.find('?');
  7514. auto path_part = target.substr(0, query_pos);
  7515. std::string query_part;
  7516. if (query_pos != std::string::npos) {
  7517. query_part = target.substr(query_pos + 1);
  7518. }
  7519. auto result = path_encode ? encode_path(path_part) : std::move(path_part);
  7520. if (!query_part.empty()) {
  7521. // When path encoding is disabled the caller has supplied an already-encoded
  7522. // target and expects the exact bytes to be sent on the wire, so skip
  7523. // normalization for the query too. Normalizing would decode-then-re-encode
  7524. // it and corrupt pre-encoded binary payloads (e.g. turning `%20` into `+`,
  7525. // which a strict RFC 3986 server decodes back as `+`, not a space).
  7526. if (path_encode) {
  7527. auto normalized = normalize_query_string(query_part);
  7528. if (!normalized.empty()) {
  7529. result += '?';
  7530. result += normalized;
  7531. }
  7532. } else {
  7533. result += '?';
  7534. result += query_part;
  7535. }
  7536. }
  7537. return result;
  7538. }
  7539. inline bool parse_multipart_boundary(const std::string &content_type,
  7540. std::string &boundary) {
  7541. std::map<std::string, std::string> params;
  7542. extract_media_type(content_type, &params);
  7543. auto it = params.find("boundary");
  7544. if (it == params.end()) { return false; }
  7545. boundary = it->second;
  7546. // RFC 2046 5.1.1 caps a boundary at 70 characters. The parser scans the body
  7547. // for "--" + boundary, so a body crafted to repeat that delimiter's leading
  7548. // bytes costs a nearly full comparison at nearly every position: the
  7549. // boundary's length multiplies the worst-case cost of scanning a body.
  7550. return !boundary.empty() && boundary.size() <= 70;
  7551. }
  7552. inline void parse_disposition_params(const std::string &s, Params &params) {
  7553. std::set<std::string> cache;
  7554. split_unquoted(s.data(), s.data() + s.size(), ';',
  7555. [&](const char *b, const char *e) {
  7556. std::string kv(b, e);
  7557. if (cache.find(kv) != cache.end()) { return; }
  7558. cache.insert(kv);
  7559. std::string key;
  7560. std::string val;
  7561. divide_param_pair(b, e, key, val);
  7562. if (!key.empty()) {
  7563. params.emplace(trim_double_quotes_copy(key),
  7564. trim_double_quotes_copy(val));
  7565. }
  7566. });
  7567. }
  7568. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7569. inline bool parse_range_header(const std::string &s, Ranges &ranges) {
  7570. #else
  7571. inline bool parse_range_header(const std::string &s, Ranges &ranges) try {
  7572. #endif
  7573. auto is_valid = [](const std::string &str) {
  7574. return std::all_of(str.cbegin(), str.cend(), is_ascii_digit);
  7575. };
  7576. if (s.size() > 7 && s.compare(0, 6, "bytes=") == 0) {
  7577. const auto pos = static_cast<size_t>(6);
  7578. const auto len = static_cast<size_t>(s.size() - 6);
  7579. auto all_valid_ranges = true;
  7580. split(&s[pos], &s[pos + len], ',', [&](const char *b, const char *e) {
  7581. if (!all_valid_ranges) { return; }
  7582. const auto it = std::find(b, e, '-');
  7583. if (it == e) {
  7584. all_valid_ranges = false;
  7585. return;
  7586. }
  7587. const auto lhs = std::string(b, it);
  7588. const auto rhs = std::string(it + 1, e);
  7589. if (!is_valid(lhs) || !is_valid(rhs)) {
  7590. all_valid_ranges = false;
  7591. return;
  7592. }
  7593. ssize_t first = -1;
  7594. if (!lhs.empty()) {
  7595. // Reject an overflowing first-byte-pos; treating it as absent (-1)
  7596. // would turn the range into a suffix range.
  7597. auto res =
  7598. detail::from_chars(lhs.data(), lhs.data() + lhs.size(), first);
  7599. if (res.ec != std::errc{}) {
  7600. all_valid_ranges = false;
  7601. return;
  7602. }
  7603. }
  7604. ssize_t last = -1;
  7605. if (!rhs.empty()) {
  7606. // An overflowing last-byte-pos is past any content length, so keeping
  7607. // -1 ("remainder", RFC 9110 14.1.2) is correct here.
  7608. ssize_t v;
  7609. auto res = detail::from_chars(rhs.data(), rhs.data() + rhs.size(), v);
  7610. if (res.ec == std::errc{}) { last = v; }
  7611. }
  7612. if ((first == -1 && last == -1) ||
  7613. (first != -1 && last != -1 && first > last)) {
  7614. all_valid_ranges = false;
  7615. return;
  7616. }
  7617. ranges.emplace_back(first, last);
  7618. });
  7619. return all_valid_ranges && !ranges.empty();
  7620. }
  7621. return false;
  7622. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  7623. }
  7624. #else
  7625. } catch (...) { return false; }
  7626. #endif
  7627. inline bool parse_accept_header(const std::string &s,
  7628. std::vector<std::string> &content_types) {
  7629. content_types.clear();
  7630. // Empty string is considered valid (no preference)
  7631. if (s.empty()) { return true; }
  7632. struct AcceptEntry {
  7633. std::string media_type;
  7634. double quality;
  7635. int order;
  7636. };
  7637. std::vector<AcceptEntry> entries;
  7638. int order = 0;
  7639. bool has_invalid_entry = false;
  7640. // Split by comma and parse each entry. RFC 9110 Section 5.6.1.2: a recipient
  7641. // has to parse and ignore empty list elements, so a leading, trailing or
  7642. // doubled comma must not turn a legal Accept value into 400 Bad Request.
  7643. // split() skips them, and the header length limit bounds how many a sender
  7644. // can send, so ignoring all of them cannot be used as a denial-of-service
  7645. // vector.
  7646. split(s.data(), s.data() + s.size(), ',', [&](const char *b, const char *e) {
  7647. std::string entry(b, e);
  7648. entry = trim_copy(entry);
  7649. AcceptEntry accept_entry;
  7650. accept_entry.order = order++;
  7651. if (!parse_quality(entry.data(), entry.data() + entry.size(),
  7652. accept_entry.media_type, accept_entry.quality)) {
  7653. has_invalid_entry = true;
  7654. return;
  7655. }
  7656. // Remove additional parameters from media type
  7657. accept_entry.media_type = extract_media_type(accept_entry.media_type);
  7658. // Basic validation of media type format
  7659. if (accept_entry.media_type.empty()) {
  7660. has_invalid_entry = true;
  7661. return;
  7662. }
  7663. // Check for basic media type format (should contain '/' or be '*')
  7664. if (accept_entry.media_type != "*" &&
  7665. accept_entry.media_type.find('/') == std::string::npos) {
  7666. has_invalid_entry = true;
  7667. return;
  7668. }
  7669. entries.push_back(std::move(accept_entry));
  7670. });
  7671. // Return false if any invalid entry was found
  7672. if (has_invalid_entry) { return false; }
  7673. // Sort by quality (descending), then by original order (ascending)
  7674. std::sort(entries.begin(), entries.end(),
  7675. [](const AcceptEntry &a, const AcceptEntry &b) {
  7676. if (a.quality != b.quality) {
  7677. return a.quality > b.quality; // Higher quality first
  7678. }
  7679. return a.order < b.order; // Earlier order first for same quality
  7680. });
  7681. // Extract sorted media types
  7682. content_types.reserve(entries.size());
  7683. for (auto &entry : entries) {
  7684. content_types.push_back(std::move(entry.media_type));
  7685. }
  7686. return true;
  7687. }
  7688. class FormDataParser {
  7689. public:
  7690. FormDataParser() = default;
  7691. void set_boundary(std::string &&boundary) {
  7692. boundary_ = std::move(boundary);
  7693. dash_boundary_crlf_ = dash_ + boundary_ + crlf_;
  7694. crlf_dash_boundary_ = crlf_ + dash_ + boundary_;
  7695. }
  7696. bool is_valid() const { return is_valid_; }
  7697. bool parse(const char *buf, size_t n, const FormDataHeader &header_callback,
  7698. const ContentReceiver &content_callback) {
  7699. // Once the close delimiter has been seen the rest of the body is epilogue
  7700. // to be discarded (RFC 2046). Drop it without buffering so a large epilogue
  7701. // spread across reads is not copied in only to be erased right away.
  7702. if (state_ == 5) { return true; }
  7703. buf_append(buf, n);
  7704. while (buf_size() > 0) {
  7705. switch (state_) {
  7706. case 0: { // Initial boundary
  7707. auto pos = buf_find(dash_boundary_crlf_);
  7708. if (pos == buf_size()) {
  7709. // Not found yet: keep only a possible partial boundary at the tail so
  7710. // that a body which never contains the boundary cannot grow the
  7711. // buffer (and get rescanned from the start) without bound.
  7712. auto keep = dash_boundary_crlf_.size() - 1;
  7713. if (buf_size() > keep) { buf_erase(buf_size() - keep); }
  7714. return true;
  7715. }
  7716. buf_erase(pos + dash_boundary_crlf_.size());
  7717. state_ = 1;
  7718. break;
  7719. }
  7720. case 1: { // New entry
  7721. clear_file_info();
  7722. state_ = 2;
  7723. break;
  7724. }
  7725. case 2: { // Headers
  7726. auto pos = buf_find(crlf_);
  7727. if (pos > CPPHTTPLIB_HEADER_MAX_LENGTH) { return false; }
  7728. while (pos < buf_size()) {
  7729. // Empty line
  7730. if (pos == 0) {
  7731. if (!header_callback(file_)) {
  7732. is_valid_ = false;
  7733. return false;
  7734. }
  7735. buf_erase(crlf_.size());
  7736. state_ = 3;
  7737. break;
  7738. }
  7739. // Check header count limit
  7740. if (header_count_ >= CPPHTTPLIB_HEADER_MAX_COUNT) {
  7741. is_valid_ = false;
  7742. return false;
  7743. }
  7744. header_count_++;
  7745. const auto header = buf_head(pos);
  7746. if (!parse_header(header.data(), header.data() + header.size(),
  7747. [&](const std::string &, const std::string &) {})) {
  7748. is_valid_ = false;
  7749. return false;
  7750. }
  7751. // Parse and emplace space trimmed headers into a map
  7752. if (!parse_header(
  7753. header.data(), header.data() + header.size(),
  7754. [&](const std::string &key, const std::string &val) {
  7755. file_.headers.emplace(key, val);
  7756. })) {
  7757. is_valid_ = false;
  7758. return false;
  7759. }
  7760. constexpr const char header_content_type[] = "Content-Type:";
  7761. if (start_with_case_ignore(header, header_content_type)) {
  7762. file_.content_type =
  7763. trim_copy(header.substr(str_len(header_content_type)));
  7764. } else {
  7765. std::string disposition_params;
  7766. if (parse_content_disposition(header, disposition_params)) {
  7767. Params params;
  7768. parse_disposition_params(disposition_params, params);
  7769. auto it = params.find("name");
  7770. if (it != params.end()) {
  7771. file_.name = it->second;
  7772. } else {
  7773. is_valid_ = false;
  7774. return false;
  7775. }
  7776. it = params.find("filename");
  7777. if (it != params.end()) { file_.filename = it->second; }
  7778. it = params.find("filename*");
  7779. if (it != params.end()) {
  7780. // RFC 5987: only UTF-8 encoding is allowed
  7781. const auto &val = it->second;
  7782. constexpr const char utf8_prefix[] = "UTF-8''";
  7783. constexpr size_t prefix_len = str_len(utf8_prefix);
  7784. if (val.size() > prefix_len &&
  7785. start_with_case_ignore(val, utf8_prefix)) {
  7786. file_.filename = decode_path_component(
  7787. val.substr(prefix_len)); // override...
  7788. } else {
  7789. is_valid_ = false;
  7790. return false;
  7791. }
  7792. }
  7793. }
  7794. }
  7795. buf_erase(pos + crlf_.size());
  7796. pos = buf_find(crlf_);
  7797. }
  7798. if (state_ != 3) { return true; }
  7799. break;
  7800. }
  7801. case 3: { // Body
  7802. if (crlf_dash_boundary_.size() > buf_size()) { return true; }
  7803. auto pos = buf_find(crlf_dash_boundary_);
  7804. if (pos < buf_size()) {
  7805. if (!content_callback(buf_data(), pos)) {
  7806. is_valid_ = false;
  7807. return false;
  7808. }
  7809. buf_erase(pos + crlf_dash_boundary_.size());
  7810. state_ = 4;
  7811. } else {
  7812. auto len = buf_size() - crlf_dash_boundary_.size();
  7813. if (len > 0) {
  7814. if (!content_callback(buf_data(), len)) {
  7815. is_valid_ = false;
  7816. return false;
  7817. }
  7818. buf_erase(len);
  7819. }
  7820. return true;
  7821. }
  7822. break;
  7823. }
  7824. case 4: { // Boundary
  7825. if (crlf_.size() > buf_size()) { return true; }
  7826. if (buf_start_with(crlf_)) {
  7827. buf_erase(crlf_.size());
  7828. state_ = 1;
  7829. } else if (buf_start_with(dash_)) {
  7830. buf_erase(dash_.size());
  7831. is_valid_ = true;
  7832. state_ = 5;
  7833. } else {
  7834. // Only CRLF (another part follows) and "--" (close-delimiter) are
  7835. // accepted after a boundary; RFC 2046 allows transport-padding in
  7836. // between, but this parser has never supported it. Either way the
  7837. // body is already destined to be rejected, so fail now instead of
  7838. // buffering the rest of it. Both are two bytes, so the check above
  7839. // already guarantees enough buffered data to decide.
  7840. is_valid_ = false;
  7841. return false;
  7842. }
  7843. break;
  7844. }
  7845. case 5: { // Epilogue
  7846. buf_erase(buf_size());
  7847. break;
  7848. }
  7849. }
  7850. }
  7851. return true;
  7852. }
  7853. private:
  7854. void clear_file_info() {
  7855. file_.name.clear();
  7856. file_.filename.clear();
  7857. file_.content_type.clear();
  7858. file_.headers.clear();
  7859. header_count_ = 0;
  7860. }
  7861. bool start_with_case_ignore(const std::string &a, const char *b,
  7862. size_t offset = 0) const {
  7863. const auto b_len = strlen(b);
  7864. if (a.size() < offset + b_len) { return false; }
  7865. for (size_t i = 0; i < b_len; i++) {
  7866. if (case_ignore::to_lower(a[offset + i]) != case_ignore::to_lower(b[i])) {
  7867. return false;
  7868. }
  7869. }
  7870. return true;
  7871. }
  7872. // Parses "Content-Disposition: form-data; <params>" without std::regex.
  7873. // Returns true if header matches, with the params portion in `params_out`.
  7874. bool parse_content_disposition(const std::string &header,
  7875. std::string &params_out) const {
  7876. constexpr const char prefix[] = "Content-Disposition:";
  7877. constexpr size_t prefix_len = str_len(prefix);
  7878. if (!start_with_case_ignore(header, prefix)) { return false; }
  7879. // Skip whitespace after "Content-Disposition:"
  7880. auto pos = prefix_len;
  7881. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7882. pos++;
  7883. }
  7884. // Match "form-data;" (case-insensitive)
  7885. constexpr const char form_data[] = "form-data;";
  7886. constexpr size_t form_data_len = str_len(form_data);
  7887. if (!start_with_case_ignore(header, form_data, pos)) { return false; }
  7888. pos += form_data_len;
  7889. // Skip whitespace after "form-data;"
  7890. while (pos < header.size() && (header[pos] == ' ' || header[pos] == '\t')) {
  7891. pos++;
  7892. }
  7893. params_out = header.substr(pos);
  7894. return true;
  7895. }
  7896. const std::string dash_ = "--";
  7897. const std::string crlf_ = "\r\n";
  7898. std::string boundary_;
  7899. std::string dash_boundary_crlf_;
  7900. std::string crlf_dash_boundary_;
  7901. size_t state_ = 0;
  7902. bool is_valid_ = false;
  7903. FormData file_;
  7904. size_t header_count_ = 0;
  7905. // Buffer
  7906. bool start_with(const std::string &a, size_t spos, size_t epos,
  7907. const std::string &b) const {
  7908. if (epos - spos < b.size()) { return false; }
  7909. for (size_t i = 0; i < b.size(); i++) {
  7910. if (a[i + spos] != b[i]) { return false; }
  7911. }
  7912. return true;
  7913. }
  7914. size_t buf_size() const { return buf_epos_ - buf_spos_; }
  7915. const char *buf_data() const { return &buf_[buf_spos_]; }
  7916. std::string buf_head(size_t l) const { return buf_.substr(buf_spos_, l); }
  7917. bool buf_start_with(const std::string &s) const {
  7918. return start_with(buf_, buf_spos_, buf_epos_, s);
  7919. }
  7920. size_t buf_find(const std::string &s) const {
  7921. auto c = s.front();
  7922. size_t off = buf_spos_;
  7923. while (off < buf_epos_) {
  7924. auto pos = off;
  7925. while (true) {
  7926. if (pos == buf_epos_) { return buf_size(); }
  7927. if (buf_[pos] == c) { break; }
  7928. pos++;
  7929. }
  7930. auto remaining_size = buf_epos_ - pos;
  7931. if (s.size() > remaining_size) { return buf_size(); }
  7932. if (start_with(buf_, pos, buf_epos_, s)) { return pos - buf_spos_; }
  7933. off = pos + 1;
  7934. }
  7935. return buf_size();
  7936. }
  7937. void buf_append(const char *data, size_t n) {
  7938. auto remaining_size = buf_size();
  7939. if (remaining_size > 0 && buf_spos_ > 0) {
  7940. for (size_t i = 0; i < remaining_size; i++) {
  7941. buf_[i] = buf_[buf_spos_ + i];
  7942. }
  7943. }
  7944. buf_spos_ = 0;
  7945. buf_epos_ = remaining_size;
  7946. if (remaining_size + n > buf_.size()) { buf_.resize(remaining_size + n); }
  7947. for (size_t i = 0; i < n; i++) {
  7948. buf_[buf_epos_ + i] = data[i];
  7949. }
  7950. buf_epos_ += n;
  7951. }
  7952. void buf_erase(size_t size) { buf_spos_ += size; }
  7953. std::string buf_;
  7954. size_t buf_spos_ = 0;
  7955. size_t buf_epos_ = 0;
  7956. };
  7957. inline std::string random_string(size_t length) {
  7958. constexpr const char data[] =
  7959. "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  7960. thread_local auto engine([]() {
  7961. // std::random_device might actually be deterministic on some
  7962. // platforms, but due to lack of support in the c++ standard library,
  7963. // doing better requires either some ugly hacks or breaking portability.
  7964. std::random_device seed_gen;
  7965. // Request 128 bits of entropy for initialization
  7966. std::seed_seq seed_sequence{seed_gen(), seed_gen(), seed_gen(), seed_gen()};
  7967. return std::mt19937(seed_sequence);
  7968. }());
  7969. std::string result;
  7970. for (size_t i = 0; i < length; i++) {
  7971. result += data[engine() % (sizeof(data) - 1)];
  7972. }
  7973. return result;
  7974. }
  7975. inline std::string make_multipart_data_boundary() {
  7976. return "--cpp-httplib-multipart-data-" + detail::random_string(16);
  7977. }
  7978. inline bool is_multipart_boundary_chars_valid(const std::string &boundary) {
  7979. auto valid = true;
  7980. for (size_t i = 0; i < boundary.size(); i++) {
  7981. auto c = boundary[i];
  7982. if (!is_ascii_alnum(c) && c != '-' && c != '_') {
  7983. valid = false;
  7984. break;
  7985. }
  7986. }
  7987. return valid;
  7988. }
  7989. // Escape a multipart field name/filename following the WHATWG HTML standard
  7990. // ("escape a multipart form-data name"), which is what browsers send:
  7991. // '"' -> %22, CR -> %0D, LF -> %0A
  7992. // With escape_quote = false, only CR and LF are escaped; this is for header
  7993. // values outside a quoted-string (e.g. Content-Type), where '"' is legal.
  7994. inline std::string escape_multipart_field(const std::string &s,
  7995. bool escape_quote = true) {
  7996. std::string result;
  7997. result.reserve(s.size());
  7998. for (auto c : s) {
  7999. switch (c) {
  8000. case '"':
  8001. if (escape_quote) {
  8002. result += "%22";
  8003. } else {
  8004. result += c;
  8005. }
  8006. break;
  8007. case '\r': result += "%0D"; break;
  8008. case '\n': result += "%0A"; break;
  8009. default: result += c; break;
  8010. }
  8011. }
  8012. return result;
  8013. }
  8014. template <typename T>
  8015. inline std::string
  8016. serialize_multipart_formdata_item_begin(const T &item,
  8017. const std::string &boundary) {
  8018. std::string body = "--" + boundary + "\r\n";
  8019. body += "Content-Disposition: form-data; name=\"" +
  8020. escape_multipart_field(item.name) + "\"";
  8021. if (!item.filename.empty()) {
  8022. body += "; filename=\"" + escape_multipart_field(item.filename) + "\"";
  8023. }
  8024. body += "\r\n";
  8025. if (!item.content_type.empty()) {
  8026. body +=
  8027. "Content-Type: " + escape_multipart_field(item.content_type, false) +
  8028. "\r\n";
  8029. }
  8030. body += "\r\n";
  8031. return body;
  8032. }
  8033. inline std::string serialize_multipart_formdata_item_end() { return "\r\n"; }
  8034. inline std::string
  8035. serialize_multipart_formdata_finish(const std::string &boundary) {
  8036. return "--" + boundary + "--\r\n";
  8037. }
  8038. inline std::string
  8039. serialize_multipart_formdata_get_content_type(const std::string &boundary) {
  8040. return "multipart/form-data; boundary=" + boundary;
  8041. }
  8042. inline std::string
  8043. serialize_multipart_formdata(const UploadFormDataItems &items,
  8044. const std::string &boundary, bool finish = true) {
  8045. std::string body;
  8046. for (const auto &item : items) {
  8047. body += serialize_multipart_formdata_item_begin(item, boundary);
  8048. body += item.content + serialize_multipart_formdata_item_end();
  8049. }
  8050. if (finish) { body += serialize_multipart_formdata_finish(boundary); }
  8051. return body;
  8052. }
  8053. inline size_t get_multipart_content_length(const UploadFormDataItems &items,
  8054. const std::string &boundary) {
  8055. size_t total = 0;
  8056. for (const auto &item : items) {
  8057. total += serialize_multipart_formdata_item_begin(item, boundary).size();
  8058. total += item.content.size();
  8059. total += serialize_multipart_formdata_item_end().size();
  8060. }
  8061. total += serialize_multipart_formdata_finish(boundary).size();
  8062. return total;
  8063. }
  8064. struct MultipartSegment {
  8065. const char *data;
  8066. size_t size;
  8067. };
  8068. // NOTE: items must outlive the returned ContentProvider
  8069. // (safe for synchronous use inside Post/Put/Patch)
  8070. inline ContentProvider
  8071. make_multipart_content_provider(const UploadFormDataItems &items,
  8072. const std::string &boundary) {
  8073. // Own the per-item header strings and the finish string
  8074. std::vector<std::string> owned;
  8075. owned.reserve(items.size() + 1);
  8076. for (const auto &item : items)
  8077. owned.push_back(serialize_multipart_formdata_item_begin(item, boundary));
  8078. owned.push_back(serialize_multipart_formdata_finish(boundary));
  8079. // Flat segment list: [header, content, "\r\n"] * N + [finish]
  8080. std::vector<MultipartSegment> segs;
  8081. segs.reserve(items.size() * 3 + 1);
  8082. static const char crlf[] = "\r\n";
  8083. for (size_t i = 0; i < items.size(); i++) {
  8084. segs.push_back({owned[i].data(), owned[i].size()});
  8085. segs.push_back({items[i].content.data(), items[i].content.size()});
  8086. segs.push_back({crlf, 2});
  8087. }
  8088. segs.push_back({owned.back().data(), owned.back().size()});
  8089. struct MultipartState {
  8090. std::vector<std::string> owned;
  8091. std::vector<MultipartSegment> segs;
  8092. std::vector<char> buf = std::vector<char>(CPPHTTPLIB_SEND_BUFSIZ);
  8093. };
  8094. auto state = std::make_shared<MultipartState>();
  8095. state->owned = std::move(owned);
  8096. // `segs` holds raw pointers into owned strings; std::string move preserves
  8097. // the data pointer, so these pointers remain valid after the move above.
  8098. state->segs = std::move(segs);
  8099. return [state](size_t offset, size_t length, DataSink &sink) -> bool {
  8100. // Buffer multiple small segments into fewer, larger writes to avoid
  8101. // excessive TCP packets when there are many form data items (#2410)
  8102. auto &buf = state->buf;
  8103. auto buf_size = buf.size();
  8104. size_t buf_len = 0;
  8105. size_t remaining = length;
  8106. // Find the first segment containing 'offset'
  8107. size_t pos = 0;
  8108. size_t seg_idx = 0;
  8109. for (; seg_idx < state->segs.size(); seg_idx++) {
  8110. const auto &seg = state->segs[seg_idx];
  8111. if (seg.size > 0 && offset - pos < seg.size) { break; }
  8112. pos += seg.size;
  8113. }
  8114. size_t seg_offset = (seg_idx < state->segs.size()) ? offset - pos : 0;
  8115. for (; seg_idx < state->segs.size() && remaining > 0; seg_idx++) {
  8116. const auto &seg = state->segs[seg_idx];
  8117. size_t available = seg.size - seg_offset;
  8118. size_t to_copy = (std::min)(available, remaining);
  8119. const char *src = seg.data + seg_offset;
  8120. seg_offset = 0; // only the first segment has a non-zero offset
  8121. while (to_copy > 0) {
  8122. size_t space = buf_size - buf_len;
  8123. size_t chunk = (std::min)(to_copy, space);
  8124. std::memcpy(buf.data() + buf_len, src, chunk);
  8125. buf_len += chunk;
  8126. src += chunk;
  8127. to_copy -= chunk;
  8128. remaining -= chunk;
  8129. if (buf_len == buf_size) {
  8130. if (!sink.write(buf.data(), buf_len)) { return false; }
  8131. buf_len = 0;
  8132. }
  8133. }
  8134. }
  8135. if (buf_len > 0) { return sink.write(buf.data(), buf_len); }
  8136. return true;
  8137. };
  8138. }
  8139. inline void coalesce_ranges(Ranges &ranges, size_t content_length) {
  8140. if (ranges.size() <= 1) return;
  8141. // Sort ranges by start position
  8142. std::sort(ranges.begin(), ranges.end(),
  8143. [](const Range &a, const Range &b) { return a.first < b.first; });
  8144. Ranges coalesced;
  8145. coalesced.reserve(ranges.size());
  8146. for (auto &r : ranges) {
  8147. auto first_pos = r.first;
  8148. auto last_pos = r.second;
  8149. // Handle special cases like in range_error
  8150. if (first_pos == -1 && last_pos == -1) {
  8151. first_pos = 0;
  8152. last_pos = static_cast<ssize_t>(content_length);
  8153. }
  8154. if (first_pos == -1) {
  8155. first_pos = static_cast<ssize_t>(content_length) - last_pos;
  8156. last_pos = static_cast<ssize_t>(content_length) - 1;
  8157. }
  8158. if (last_pos == -1 || last_pos >= static_cast<ssize_t>(content_length)) {
  8159. last_pos = static_cast<ssize_t>(content_length) - 1;
  8160. }
  8161. // Skip invalid ranges
  8162. if (!(0 <= first_pos && first_pos <= last_pos &&
  8163. last_pos < static_cast<ssize_t>(content_length))) {
  8164. continue;
  8165. }
  8166. // Coalesce with previous range if overlapping or adjacent (but not
  8167. // identical)
  8168. if (!coalesced.empty()) {
  8169. auto &prev = coalesced.back();
  8170. // Check if current range overlaps or is adjacent to previous range
  8171. // but don't coalesce identical ranges (allow duplicates)
  8172. if (first_pos <= prev.second + 1 &&
  8173. !(first_pos == prev.first && last_pos == prev.second)) {
  8174. // Extend the previous range
  8175. prev.second = (std::max)(prev.second, last_pos);
  8176. continue;
  8177. }
  8178. }
  8179. // Add new range
  8180. coalesced.emplace_back(first_pos, last_pos);
  8181. }
  8182. ranges = std::move(coalesced);
  8183. }
  8184. inline bool range_error(Request &req, Response &res) {
  8185. if (!req.ranges.empty() && 200 <= res.status && res.status < 300) {
  8186. if (res.body.empty() && res.content_provider_ && res.content_length_ == 0) {
  8187. req.ranges.clear();
  8188. if (res.status == StatusCode::PartialContent_206) {
  8189. res.status = StatusCode::OK_200;
  8190. }
  8191. return false;
  8192. }
  8193. ssize_t content_len = static_cast<ssize_t>(
  8194. res.content_length_ ? res.content_length_ : res.body.size());
  8195. std::vector<std::pair<ssize_t, ssize_t>> processed_ranges;
  8196. size_t overwrapping_count = 0;
  8197. // NOTE: The following Range check is based on '14.2. Range' in RFC 9110
  8198. // 'HTTP Semantics' to avoid potential denial-of-service attacks.
  8199. // https://www.rfc-editor.org/rfc/rfc9110#section-14.2
  8200. // Too many ranges
  8201. if (req.ranges.size() > CPPHTTPLIB_RANGE_MAX_COUNT) { return true; }
  8202. for (auto &r : req.ranges) {
  8203. auto &first_pos = r.first;
  8204. auto &last_pos = r.second;
  8205. if (first_pos == -1 && last_pos == -1) {
  8206. first_pos = 0;
  8207. last_pos = content_len;
  8208. }
  8209. if (first_pos == -1) {
  8210. first_pos = content_len - last_pos;
  8211. last_pos = content_len - 1;
  8212. }
  8213. // NOTE: RFC-9110 '14.1.2. Byte Ranges':
  8214. // A client can limit the number of bytes requested without knowing the
  8215. // size of the selected representation. If the last-pos value is absent,
  8216. // or if the value is greater than or equal to the current length of the
  8217. // representation data, the byte range is interpreted as the remainder of
  8218. // the representation (i.e., the server replaces the value of last-pos
  8219. // with a value that is one less than the current length of the selected
  8220. // representation).
  8221. // https://www.rfc-editor.org/rfc/rfc9110.html#section-14.1.2-6
  8222. if (last_pos == -1 || last_pos >= content_len) {
  8223. last_pos = content_len - 1;
  8224. }
  8225. // Range must be within content length
  8226. if (!(0 <= first_pos && first_pos <= last_pos &&
  8227. last_pos <= content_len - 1)) {
  8228. return true;
  8229. }
  8230. // Request must not have more than two overlapping ranges
  8231. for (const auto &processed_range : processed_ranges) {
  8232. if (!(last_pos < processed_range.first ||
  8233. first_pos > processed_range.second)) {
  8234. overwrapping_count++;
  8235. if (overwrapping_count > 2) { return true; }
  8236. break; // Only count once per range
  8237. }
  8238. }
  8239. processed_ranges.emplace_back(first_pos, last_pos);
  8240. }
  8241. // After validation, coalesce overlapping ranges as per RFC 9110
  8242. coalesce_ranges(req.ranges, static_cast<size_t>(content_len));
  8243. }
  8244. return false;
  8245. }
  8246. inline std::pair<size_t, size_t>
  8247. get_range_offset_and_length(Range r, size_t content_length) {
  8248. assert(r.first != -1 && r.second != -1);
  8249. assert(0 <= r.first && r.first < static_cast<ssize_t>(content_length));
  8250. assert(r.first <= r.second &&
  8251. r.second < static_cast<ssize_t>(content_length));
  8252. (void)(content_length);
  8253. return std::make_pair(static_cast<size_t>(r.first),
  8254. static_cast<size_t>(r.second - r.first) + 1);
  8255. }
  8256. inline std::string make_content_range_header_field(
  8257. const std::pair<size_t, size_t> &offset_and_length, size_t content_length) {
  8258. auto st = offset_and_length.first;
  8259. auto ed = st + offset_and_length.second - 1;
  8260. std::string field = "bytes ";
  8261. field += std::to_string(st);
  8262. field += '-';
  8263. field += std::to_string(ed);
  8264. field += '/';
  8265. field += std::to_string(content_length);
  8266. return field;
  8267. }
  8268. template <typename SToken, typename CToken, typename Content>
  8269. bool process_multipart_ranges_data(const Request &req,
  8270. const std::string &boundary,
  8271. const std::string &content_type,
  8272. size_t content_length, SToken stoken,
  8273. CToken ctoken, Content content) {
  8274. for (size_t i = 0; i < req.ranges.size(); i++) {
  8275. ctoken("--");
  8276. stoken(boundary);
  8277. ctoken("\r\n");
  8278. if (!content_type.empty()) {
  8279. ctoken("Content-Type: ");
  8280. stoken(content_type);
  8281. ctoken("\r\n");
  8282. }
  8283. auto offset_and_length =
  8284. get_range_offset_and_length(req.ranges[i], content_length);
  8285. ctoken("Content-Range: ");
  8286. stoken(make_content_range_header_field(offset_and_length, content_length));
  8287. ctoken("\r\n");
  8288. ctoken("\r\n");
  8289. if (!content(offset_and_length.first, offset_and_length.second)) {
  8290. return false;
  8291. }
  8292. ctoken("\r\n");
  8293. }
  8294. ctoken("--");
  8295. stoken(boundary);
  8296. ctoken("--");
  8297. return true;
  8298. }
  8299. inline void make_multipart_ranges_data(const Request &req, Response &res,
  8300. const std::string &boundary,
  8301. const std::string &content_type,
  8302. size_t content_length,
  8303. std::string &data) {
  8304. process_multipart_ranges_data(
  8305. req, boundary, content_type, content_length,
  8306. [&](const std::string &token) { data += token; },
  8307. [&](const std::string &token) { data += token; },
  8308. [&](size_t offset, size_t length) {
  8309. assert(offset + length <= content_length);
  8310. data += res.body.substr(offset, length);
  8311. return true;
  8312. });
  8313. }
  8314. inline size_t get_multipart_ranges_data_length(const Request &req,
  8315. const std::string &boundary,
  8316. const std::string &content_type,
  8317. size_t content_length) {
  8318. size_t data_length = 0;
  8319. process_multipart_ranges_data(
  8320. req, boundary, content_type, content_length,
  8321. [&](const std::string &token) { data_length += token.size(); },
  8322. [&](const std::string &token) { data_length += token.size(); },
  8323. [&](size_t /*offset*/, size_t length) {
  8324. data_length += length;
  8325. return true;
  8326. });
  8327. return data_length;
  8328. }
  8329. template <typename T>
  8330. inline bool
  8331. write_multipart_ranges_data(Stream &strm, const Request &req, Response &res,
  8332. const std::string &boundary,
  8333. const std::string &content_type,
  8334. size_t content_length, const T &is_shutting_down) {
  8335. return process_multipart_ranges_data(
  8336. req, boundary, content_type, content_length,
  8337. [&](const std::string &token) { strm.write(token); },
  8338. [&](const std::string &token) { strm.write(token); },
  8339. [&](size_t offset, size_t length) {
  8340. return write_content(strm, res.content_provider_, offset, length,
  8341. is_shutting_down);
  8342. });
  8343. }
  8344. inline bool has_framed_body(const Request &req) {
  8345. return is_chunked_transfer_encoding(req.headers) ||
  8346. req.get_header_value_u64("Content-Length") > 0;
  8347. }
  8348. inline bool is_connection_persistent(const Request &req) {
  8349. if (has_header_token(req.headers, "Connection", "close")) { return false; }
  8350. if (req.version == "HTTP/1.0" &&
  8351. !has_header_token(req.headers, "Connection", "keep-alive")) {
  8352. return false;
  8353. }
  8354. return true;
  8355. }
  8356. inline bool expect_content(const Request &req) {
  8357. if (req.method == "POST" || req.method == "PUT" || req.method == "PATCH" ||
  8358. req.method == "DELETE") {
  8359. return true;
  8360. }
  8361. return has_framed_body(req);
  8362. }
  8363. #ifdef _WIN32
  8364. class WSInit {
  8365. public:
  8366. WSInit() {
  8367. WSADATA wsaData;
  8368. if (WSAStartup(0x0002, &wsaData) == 0) is_valid_ = true;
  8369. }
  8370. ~WSInit() {
  8371. if (is_valid_) WSACleanup();
  8372. }
  8373. bool is_valid_ = false;
  8374. };
  8375. static WSInit wsinit_;
  8376. #endif
  8377. // RFC 9110 Section 11.6.1 defines a challenge list as
  8378. // WWW-Authenticate = #challenge
  8379. // challenge = auth-scheme [ 1*SP ( token68 / [ #auth-param ] ) ]
  8380. // auth-param = token BWS "=" BWS ( token / quoted-string )
  8381. // so a server may offer several schemes, each with its own comma-separated
  8382. // auth-param list, in either order and either as separate field lines or
  8383. // packed into one. Splitting on every comma would break apart a challenge's
  8384. // own param list; splitting only on the first space would miss a Digest
  8385. // challenge that isn't first. Split on commas that aren't inside a
  8386. // quoted-string instead, then track which scheme each resulting segment
  8387. // belongs to: a segment whose text before "=" contains whitespace (or that
  8388. // has no "=" at all) starts a new challenge named by its leading token.
  8389. inline std::vector<std::string> split_challenge_segments(const std::string &s) {
  8390. std::vector<std::string> segments;
  8391. size_t start = 0;
  8392. auto in_quotes = false;
  8393. for (size_t i = 0; i < s.size(); i++) {
  8394. auto c = s[i];
  8395. if (in_quotes) {
  8396. if (c == '\\' && i + 1 < s.size()) {
  8397. i++;
  8398. } else if (c == '"') {
  8399. in_quotes = false;
  8400. }
  8401. } else if (c == '"') {
  8402. in_quotes = true;
  8403. } else if (c == ',') {
  8404. segments.push_back(s.substr(start, i - start));
  8405. start = i + 1;
  8406. }
  8407. }
  8408. segments.push_back(s.substr(start));
  8409. return segments;
  8410. }
  8411. inline std::string unescape_quoted_pairs(const std::string &s) {
  8412. std::string out;
  8413. out.reserve(s.size());
  8414. for (size_t i = 0; i < s.size(); i++) {
  8415. if (s[i] == '\\' && i + 1 < s.size()) {
  8416. out += s[++i];
  8417. } else {
  8418. out += s[i];
  8419. }
  8420. }
  8421. return out;
  8422. }
  8423. inline bool parse_www_authenticate(const Response &res,
  8424. std::map<std::string, std::string> &auth,
  8425. bool is_proxy) {
  8426. auto auth_key = is_proxy ? "Proxy-Authenticate" : "WWW-Authenticate";
  8427. auto combined = get_combined_header_value(res.headers, auth_key);
  8428. if (combined.empty()) { return false; }
  8429. auto found_digest = false;
  8430. auto in_digest_challenge = false;
  8431. for (const auto &raw_segment : split_challenge_segments(combined)) {
  8432. auto segment = trim_copy(raw_segment);
  8433. if (segment.empty()) { continue; }
  8434. auto eq_pos = segment.find('=');
  8435. // BWS is allowed on both sides of "=", so the text naming the key (or,
  8436. // for the first segment of a challenge, "<scheme> <key>") must be
  8437. // trimmed before its boundaries are inspected.
  8438. auto key_part = trim_copy(
  8439. eq_pos == std::string::npos ? segment : segment.substr(0, eq_pos));
  8440. auto space_pos = key_part.find_last_of(" \t");
  8441. if (space_pos != std::string::npos || eq_pos == std::string::npos) {
  8442. // "<scheme>[ <key>]" starts a new challenge.
  8443. auto scheme_end =
  8444. space_pos == std::string::npos ? key_part.size() : space_pos;
  8445. // RFC 7616 Section 3.7: a server may offer more than one Digest
  8446. // challenge (e.g. SHA-256 and MD5); keep only the first so a nonce
  8447. // from one challenge is never paired with another's algorithm.
  8448. in_digest_challenge =
  8449. !found_digest &&
  8450. case_ignore::equal(key_part.substr(0, scheme_end), "Digest");
  8451. if (in_digest_challenge) { found_digest = true; }
  8452. if (space_pos == std::string::npos) {
  8453. // Bare scheme (or a token68), no auth-param on this segment.
  8454. continue;
  8455. }
  8456. key_part = key_part.substr(space_pos + 1);
  8457. }
  8458. if (!in_digest_challenge) { continue; }
  8459. auto val = trim_copy(segment.substr(eq_pos + 1));
  8460. auto unquoted = trim_double_quotes_copy(val);
  8461. if (unquoted.size() != val.size()) {
  8462. unquoted = unescape_quoted_pairs(unquoted);
  8463. }
  8464. auth[std::move(key_part)] = std::move(unquoted);
  8465. }
  8466. // RFC 7616 Section 3.3 requires realm and nonce on every Digest challenge;
  8467. // make_digest_authentication_header() dereferences both unconditionally, so
  8468. // a challenge missing either can't produce a usable Authorization header.
  8469. // Treat it the same as no Digest challenge at all.
  8470. return found_digest && auth.find("realm") != auth.end() &&
  8471. auth.find("nonce") != auth.end();
  8472. }
  8473. class ContentProviderAdapter {
  8474. public:
  8475. explicit ContentProviderAdapter(
  8476. ContentProviderWithoutLength &&content_provider)
  8477. : content_provider_(std::move(content_provider)) {}
  8478. bool operator()(size_t offset, size_t, DataSink &sink) {
  8479. return content_provider_(offset, sink);
  8480. }
  8481. private:
  8482. ContentProviderWithoutLength content_provider_;
  8483. };
  8484. // NOTE: https://www.rfc-editor.org/rfc/rfc9110#section-5
  8485. namespace fields {
  8486. inline bool is_token_char(char c) {
  8487. return is_ascii_alnum(c) || c == '!' || c == '#' || c == '$' || c == '%' ||
  8488. c == '&' || c == '\'' || c == '*' || c == '+' || c == '-' ||
  8489. c == '.' || c == '^' || c == '_' || c == '`' || c == '|' || c == '~';
  8490. }
  8491. inline bool is_token(const std::string &s) {
  8492. if (s.empty()) { return false; }
  8493. for (auto c : s) {
  8494. if (!is_token_char(c)) { return false; }
  8495. }
  8496. return true;
  8497. }
  8498. inline bool is_field_name(const std::string &s) { return is_token(s); }
  8499. inline bool is_vchar(char c) { return c >= 33 && c <= 126; }
  8500. inline bool is_obs_text(char c) { return 128 <= static_cast<unsigned char>(c); }
  8501. inline bool is_field_vchar(char c) { return is_vchar(c) || is_obs_text(c); }
  8502. inline bool is_field_content(const std::string &s) {
  8503. if (s.empty()) { return true; }
  8504. if (s.size() == 1) {
  8505. return is_field_vchar(s[0]);
  8506. } else if (s.size() == 2) {
  8507. return is_field_vchar(s[0]) && is_field_vchar(s[1]);
  8508. } else {
  8509. size_t i = 0;
  8510. if (!is_field_vchar(s[i])) { return false; }
  8511. i++;
  8512. while (i < s.size() - 1) {
  8513. auto c = s[i++];
  8514. if (c == ' ' || c == '\t' || is_field_vchar(c)) {
  8515. } else {
  8516. return false;
  8517. }
  8518. }
  8519. return is_field_vchar(s[i]);
  8520. }
  8521. }
  8522. inline bool is_field_value(const std::string &s) { return is_field_content(s); }
  8523. inline bool is_field_valid(const std::string &name, const std::string &value) {
  8524. return is_field_name(name) && is_field_value(value);
  8525. }
  8526. } // namespace fields
  8527. inline bool perform_websocket_handshake(Stream &strm, Request &req,
  8528. WebSocketUpgradeResponse &upgrade) {
  8529. // Generate random Sec-WebSocket-Key
  8530. thread_local std::mt19937 rng(std::random_device{}());
  8531. std::string key_bytes(16, '\0');
  8532. for (size_t i = 0; i < 16; i += 4) {
  8533. auto r = rng();
  8534. std::memcpy(&key_bytes[i], &r, (std::min)(size_t(4), size_t(16 - i)));
  8535. }
  8536. auto client_key = base64_encode(key_bytes);
  8537. req.headers.erase("Upgrade");
  8538. req.headers.erase("Connection");
  8539. req.headers.erase("Sec-WebSocket-Key");
  8540. req.headers.erase("Sec-WebSocket-Version");
  8541. req.headers.emplace("Upgrade", "websocket");
  8542. req.headers.emplace("Connection", "Upgrade");
  8543. req.headers.emplace("Sec-WebSocket-Key", client_key);
  8544. req.headers.emplace("Sec-WebSocket-Version", "13");
  8545. // Build the request in memory first, like ClientImpl::write_request does.
  8546. // Writing straight to the socket would leak a request line onto the wire
  8547. // before check_and_write_headers gets a chance to reject an invalid header,
  8548. // and would emit one small write per header.
  8549. BufferStream bstrm;
  8550. if (write_request_line(bstrm, req.method, req.path) < 0) {
  8551. upgrade.error = Error::Write;
  8552. return false;
  8553. }
  8554. auto error = Error::Success;
  8555. if (!check_and_write_headers(bstrm, req.headers, write_headers, error)) {
  8556. upgrade.error = error;
  8557. return false;
  8558. }
  8559. const auto &data = bstrm.get_buffer();
  8560. if (!write_data(strm, data.data(), data.size())) {
  8561. upgrade.error = Error::Write;
  8562. return false;
  8563. }
  8564. // Verify 101 response and Sec-WebSocket-Accept header
  8565. auto expected_accept = websocket_accept_key(client_key);
  8566. return read_websocket_upgrade_response(strm, expected_accept, upgrade);
  8567. }
  8568. inline bool is_ip_address(const std::string &host) {
  8569. struct in_addr addr4;
  8570. struct in6_addr addr6;
  8571. return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
  8572. inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
  8573. }
  8574. // Resolve where a client should connect for `host`, honoring a user-supplied
  8575. // hostname-to-address map. `host` itself is never rewritten, so it keeps
  8576. // supplying the Host header and SNI; only the connection target changes.
  8577. //
  8578. // A mapped IP literal goes to `ip`, which keeps create_socket's AI_NUMERICHOST
  8579. // path. Anything else goes to `connect_host`, which create_socket resolves as
  8580. // a name, or uses as the socket path when the address family is AF_UNIX. An
  8581. // absent or empty mapping leaves `host` as the connection target; without the
  8582. // empty check the value would reach getaddrinfo as a null node and silently
  8583. // resolve to loopback.
  8584. inline void apply_addr_map(const std::map<std::string, std::string> &addr_map,
  8585. const std::string &host, std::string &connect_host,
  8586. std::string &ip) {
  8587. connect_host = host;
  8588. ip.clear();
  8589. auto it = addr_map.find(host);
  8590. if (it == addr_map.end() || it->second.empty()) { return; }
  8591. if (is_ip_address(it->second)) {
  8592. ip = it->second;
  8593. } else {
  8594. connect_host = it->second;
  8595. }
  8596. }
  8597. } // namespace detail
  8598. /*
  8599. * Group 2: detail namespace - SSL common utilities
  8600. */
  8601. #ifdef CPPHTTPLIB_SSL_ENABLED
  8602. namespace detail {
  8603. class SSLSocketStream final : public Stream {
  8604. public:
  8605. SSLSocketStream(
  8606. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  8607. time_t read_timeout_usec, time_t write_timeout_sec,
  8608. time_t write_timeout_usec, time_t max_timeout_msec = 0,
  8609. std::chrono::time_point<std::chrono::steady_clock> start_time =
  8610. (std::chrono::steady_clock::time_point::min)());
  8611. ~SSLSocketStream() override;
  8612. bool is_readable() const override;
  8613. bool wait_readable() const override;
  8614. bool wait_writable() const override;
  8615. bool is_peer_alive() const override;
  8616. ssize_t read(char *ptr, size_t size) override;
  8617. ssize_t write(const char *ptr, size_t size) override;
  8618. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8619. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8620. socket_t socket() const override;
  8621. time_t duration() const override;
  8622. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8623. // See SocketStream::set_readable_hint().
  8624. void set_readable_hint() { readable_hint_ = true; }
  8625. private:
  8626. bool ensure_readable();
  8627. socket_t sock_;
  8628. tls::session_t session_;
  8629. time_t read_timeout_sec_;
  8630. time_t read_timeout_usec_;
  8631. time_t write_timeout_sec_;
  8632. time_t write_timeout_usec_;
  8633. time_t max_timeout_msec_;
  8634. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8635. bool readable_hint_ = false;
  8636. };
  8637. // A TLS stream for WebSocket connections, where the receive path and the
  8638. // send path (application send() plus the heartbeat ping thread) run on
  8639. // different threads. A single TLS session must never be entered
  8640. // concurrently, so every call into the session is serialized by one mutex.
  8641. //
  8642. // Unlike SSLSocketStream, the socket is kept non-blocking for the stream's
  8643. // whole lifetime and each read()/write() performs a single non-blocking TLS
  8644. // call under the lock, then waits for readiness with select() outside the
  8645. // lock. The lock is therefore held only for CPU-bound work, so a reader
  8646. // blocked waiting for data never stalls a concurrent sender.
  8647. //
  8648. // This stream is used only for wss:// connections. Plain ws:// and ordinary
  8649. // HTTP/HTTPS keep using SocketStream/SSLSocketStream unchanged.
  8650. class WebSocketSSLStream final : public Stream {
  8651. public:
  8652. WebSocketSSLStream(socket_t sock, tls::session_t session,
  8653. time_t read_timeout_sec, time_t read_timeout_usec,
  8654. time_t write_timeout_sec, time_t write_timeout_usec);
  8655. ~WebSocketSSLStream() override;
  8656. bool is_readable() const override;
  8657. bool wait_readable() const override;
  8658. bool wait_writable() const override;
  8659. ssize_t read(char *ptr, size_t size) override;
  8660. ssize_t write(const char *ptr, size_t size) override;
  8661. void get_remote_ip_and_port(std::string &ip, int &port) const override;
  8662. void get_local_ip_and_port(std::string &ip, int &port) const override;
  8663. socket_t socket() const override;
  8664. time_t duration() const override;
  8665. void set_read_timeout(time_t sec, time_t usec = 0) override;
  8666. private:
  8667. mutable std::mutex session_mutex_;
  8668. socket_t sock_;
  8669. tls::session_t session_;
  8670. // WebSocket::close() shortens the read timeout from the closing thread
  8671. // while the receive thread is inside wait_readable(), so these two are read
  8672. // and written concurrently. The write timeouts are never mutated.
  8673. std::atomic<time_t> read_timeout_sec_;
  8674. std::atomic<time_t> read_timeout_usec_;
  8675. time_t write_timeout_sec_;
  8676. time_t write_timeout_usec_;
  8677. const std::chrono::time_point<std::chrono::steady_clock> start_time_;
  8678. };
  8679. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  8680. inline std::string message_digest(const std::string &s, const EVP_MD *algo) {
  8681. auto context = std::unique_ptr<EVP_MD_CTX, decltype(&EVP_MD_CTX_free)>(
  8682. EVP_MD_CTX_new(), EVP_MD_CTX_free);
  8683. unsigned int hash_length = 0;
  8684. unsigned char hash[EVP_MAX_MD_SIZE];
  8685. EVP_DigestInit_ex(context.get(), algo, nullptr);
  8686. EVP_DigestUpdate(context.get(), s.c_str(), s.size());
  8687. EVP_DigestFinal_ex(context.get(), hash, &hash_length);
  8688. std::stringstream ss;
  8689. for (auto i = 0u; i < hash_length; ++i) {
  8690. ss << std::hex << std::setw(2) << std::setfill('0')
  8691. << static_cast<unsigned int>(hash[i]);
  8692. }
  8693. return ss.str();
  8694. }
  8695. inline std::string MD5(const std::string &s) {
  8696. return message_digest(s, EVP_md5());
  8697. }
  8698. inline std::string SHA_256(const std::string &s) {
  8699. return message_digest(s, EVP_sha256());
  8700. }
  8701. inline std::string SHA_512(const std::string &s) {
  8702. return message_digest(s, EVP_sha512());
  8703. }
  8704. #elif defined(CPPHTTPLIB_MBEDTLS_SUPPORT)
  8705. namespace {
  8706. template <size_t N>
  8707. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8708. std::stringstream ss;
  8709. for (size_t i = 0; i < N; ++i) {
  8710. ss << std::hex << std::setw(2) << std::setfill('0')
  8711. << static_cast<unsigned int>(hash[i]);
  8712. }
  8713. return ss.str();
  8714. }
  8715. } // namespace
  8716. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8717. // Mbed TLS 4.x provides hashing (and TLS RNG) via PSA Crypto, which must be
  8718. // initialized once. PSA state is process-global; do not free it.
  8719. inline bool ensure_mbedtls_psa_crypto() {
  8720. static std::once_flag once;
  8721. static bool ok = false;
  8722. std::call_once(once, []() { ok = (psa_crypto_init() == PSA_SUCCESS); });
  8723. return ok;
  8724. }
  8725. inline bool psa_hash(psa_algorithm_t alg, const std::string &s,
  8726. unsigned char *out, size_t out_size) {
  8727. if (!ensure_mbedtls_psa_crypto()) { return false; }
  8728. size_t olen = 0;
  8729. return psa_hash_compute(alg, reinterpret_cast<const uint8_t *>(s.data()),
  8730. s.size(), out, out_size, &olen) == PSA_SUCCESS &&
  8731. olen == out_size;
  8732. }
  8733. #endif
  8734. inline std::string MD5(const std::string &s) {
  8735. unsigned char hash[16];
  8736. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8737. if (!psa_hash(PSA_ALG_MD5, s, hash, sizeof(hash))) { return {}; }
  8738. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8739. mbedtls_md5(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8740. hash);
  8741. #else
  8742. mbedtls_md5_ret(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8743. hash);
  8744. #endif
  8745. return hash_to_hex(hash);
  8746. }
  8747. inline std::string SHA_256(const std::string &s) {
  8748. unsigned char hash[32];
  8749. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8750. if (!psa_hash(PSA_ALG_SHA_256, s, hash, sizeof(hash))) { return {}; }
  8751. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8752. mbedtls_sha256(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8753. hash, 0);
  8754. #else
  8755. mbedtls_sha256_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8756. s.size(), hash, 0);
  8757. #endif
  8758. return hash_to_hex(hash);
  8759. }
  8760. inline std::string SHA_512(const std::string &s) {
  8761. unsigned char hash[64];
  8762. #ifdef CPPHTTPLIB_MBEDTLS_V4
  8763. if (!psa_hash(PSA_ALG_SHA_512, s, hash, sizeof(hash))) { return {}; }
  8764. #elif defined(CPPHTTPLIB_MBEDTLS_V3)
  8765. mbedtls_sha512(reinterpret_cast<const unsigned char *>(s.c_str()), s.size(),
  8766. hash, 0);
  8767. #else
  8768. mbedtls_sha512_ret(reinterpret_cast<const unsigned char *>(s.c_str()),
  8769. s.size(), hash, 0);
  8770. #endif
  8771. return hash_to_hex(hash);
  8772. }
  8773. #elif defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  8774. namespace {
  8775. template <size_t N>
  8776. inline std::string hash_to_hex(const unsigned char (&hash)[N]) {
  8777. std::stringstream ss;
  8778. for (size_t i = 0; i < N; ++i) {
  8779. ss << std::hex << std::setw(2) << std::setfill('0')
  8780. << static_cast<unsigned int>(hash[i]);
  8781. }
  8782. return ss.str();
  8783. }
  8784. } // namespace
  8785. inline std::string MD5(const std::string &s) {
  8786. unsigned char hash[WC_MD5_DIGEST_SIZE];
  8787. wc_Md5Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8788. static_cast<word32>(s.size()), hash);
  8789. return hash_to_hex(hash);
  8790. }
  8791. inline std::string SHA_256(const std::string &s) {
  8792. unsigned char hash[WC_SHA256_DIGEST_SIZE];
  8793. wc_Sha256Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8794. static_cast<word32>(s.size()), hash);
  8795. return hash_to_hex(hash);
  8796. }
  8797. inline std::string SHA_512(const std::string &s) {
  8798. unsigned char hash[WC_SHA512_DIGEST_SIZE];
  8799. wc_Sha512Hash(reinterpret_cast<const unsigned char *>(s.c_str()),
  8800. static_cast<word32>(s.size()), hash);
  8801. return hash_to_hex(hash);
  8802. }
  8803. #endif
  8804. template <typename T>
  8805. inline bool process_server_socket_ssl(
  8806. const std::atomic<socket_t> &svr_sock, tls::session_t session,
  8807. socket_t sock, size_t keep_alive_max_count, time_t keep_alive_timeout_sec,
  8808. time_t read_timeout_sec, time_t read_timeout_usec, time_t write_timeout_sec,
  8809. time_t write_timeout_usec, T callback) {
  8810. return process_server_socket_core(
  8811. svr_sock, sock, keep_alive_max_count, keep_alive_timeout_sec,
  8812. [&](bool close_connection, bool &connection_closed) {
  8813. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8814. write_timeout_sec, write_timeout_usec);
  8815. // See the non-TLS path in process_server_socket().
  8816. strm.set_readable_hint();
  8817. return callback(strm, close_connection, connection_closed);
  8818. });
  8819. }
  8820. template <typename T>
  8821. inline bool process_client_socket_ssl(
  8822. tls::session_t session, socket_t sock, time_t read_timeout_sec,
  8823. time_t read_timeout_usec, time_t write_timeout_sec,
  8824. time_t write_timeout_usec, time_t max_timeout_msec,
  8825. std::chrono::time_point<std::chrono::steady_clock> start_time, T callback) {
  8826. SSLSocketStream strm(sock, session, read_timeout_sec, read_timeout_usec,
  8827. write_timeout_sec, write_timeout_usec, max_timeout_msec,
  8828. start_time);
  8829. return callback(strm);
  8830. }
  8831. inline std::pair<std::string, std::string> make_digest_authentication_header(
  8832. const Request &req, const std::map<std::string, std::string> &auth,
  8833. size_t cnonce_count, const std::string &cnonce, const std::string &username,
  8834. const std::string &password, bool is_proxy = false) {
  8835. std::string nc;
  8836. {
  8837. std::stringstream ss;
  8838. ss << std::setfill('0') << std::setw(8) << std::hex << cnonce_count;
  8839. nc = ss.str();
  8840. }
  8841. std::string qop;
  8842. if (auth.find("qop") != auth.end()) {
  8843. qop = auth.at("qop");
  8844. if (qop.find("auth-int") != std::string::npos) {
  8845. qop = "auth-int";
  8846. } else if (qop.find("auth") != std::string::npos) {
  8847. qop = "auth";
  8848. } else {
  8849. qop.clear();
  8850. }
  8851. }
  8852. std::string algo = "MD5";
  8853. if (auth.find("algorithm") != auth.end()) { algo = auth.at("algorithm"); }
  8854. std::string response;
  8855. {
  8856. auto H = algo == "SHA-256" ? detail::SHA_256
  8857. : algo == "SHA-512" ? detail::SHA_512
  8858. : detail::MD5;
  8859. auto A1 = username + ":" + auth.at("realm") + ":" + password;
  8860. auto A2 = req.method + ":" + req.path;
  8861. if (qop == "auth-int") { A2 += ":" + H(req.body); }
  8862. if (qop.empty()) {
  8863. response = H(H(A1) + ":" + auth.at("nonce") + ":" + H(A2));
  8864. } else {
  8865. response = H(H(A1) + ":" + auth.at("nonce") + ":" + nc + ":" + cnonce +
  8866. ":" + qop + ":" + H(A2));
  8867. }
  8868. }
  8869. auto opaque = (auth.find("opaque") != auth.end()) ? auth.at("opaque") : "";
  8870. auto field = "Digest username=\"" + username + "\", realm=\"" +
  8871. auth.at("realm") + "\", nonce=\"" + auth.at("nonce") +
  8872. "\", uri=\"" + req.path + "\", algorithm=" + algo +
  8873. (qop.empty() ? ", response=\""
  8874. : ", qop=" + qop + ", nc=" + nc + ", cnonce=\"" +
  8875. cnonce + "\", response=\"") +
  8876. response + "\"" +
  8877. (opaque.empty() ? "" : ", opaque=\"" + opaque + "\"");
  8878. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  8879. return std::make_pair(key, field);
  8880. }
  8881. inline bool match_hostname(const std::string &pattern,
  8882. const std::string &hostname) {
  8883. // Exact match (case-insensitive)
  8884. if (detail::case_ignore::equal(hostname, pattern)) { return true; }
  8885. // Split both pattern and hostname into components by '.'
  8886. std::vector<std::string> pattern_components;
  8887. if (!pattern.empty()) {
  8888. split(pattern.data(), pattern.data() + pattern.size(), '.',
  8889. [&](const char *b, const char *e) {
  8890. pattern_components.emplace_back(b, e);
  8891. });
  8892. }
  8893. std::vector<std::string> host_components;
  8894. if (!hostname.empty()) {
  8895. split(hostname.data(), hostname.data() + hostname.size(), '.',
  8896. [&](const char *b, const char *e) {
  8897. host_components.emplace_back(b, e);
  8898. });
  8899. }
  8900. // Component count must match
  8901. if (host_components.size() != pattern_components.size()) { return false; }
  8902. // Compare each component with wildcard support
  8903. // Supports: "*" (full wildcard), "prefix*" (partial wildcard)
  8904. // https://bugs.launchpad.net/ubuntu/+source/firefox-3.0/+bug/376484
  8905. auto itr = pattern_components.begin();
  8906. for (const auto &h : host_components) {
  8907. auto &p = *itr;
  8908. if (!detail::case_ignore::equal(p, h) && p != "*") {
  8909. bool partial_match = false;
  8910. if (!p.empty() && p[p.size() - 1] == '*') {
  8911. const auto prefix_length = p.size() - 1;
  8912. if (prefix_length == 0) {
  8913. partial_match = true;
  8914. } else if (h.size() >= prefix_length) {
  8915. partial_match =
  8916. std::equal(p.begin(),
  8917. p.begin() + static_cast<std::string::difference_type>(
  8918. prefix_length),
  8919. h.begin(), [](const char ca, const char cb) {
  8920. return detail::case_ignore::to_lower(ca) ==
  8921. detail::case_ignore::to_lower(cb);
  8922. });
  8923. }
  8924. }
  8925. if (!partial_match) { return false; }
  8926. }
  8927. ++itr;
  8928. }
  8929. return true;
  8930. }
  8931. #ifdef _WIN32
  8932. // Verify certificate using Windows CertGetCertificateChain API.
  8933. // This provides real-time certificate validation with Windows Update
  8934. // integration, independent of the TLS backend (OpenSSL or MbedTLS).
  8935. inline bool
  8936. verify_cert_with_windows_schannel(const std::vector<unsigned char> &der_cert,
  8937. const std::string &hostname,
  8938. bool verify_hostname, uint64_t &out_error) {
  8939. if (der_cert.empty()) { return false; }
  8940. out_error = 0;
  8941. // Create Windows certificate context from DER data
  8942. auto cert_context = CertCreateCertificateContext(
  8943. X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, der_cert.data(),
  8944. static_cast<DWORD>(der_cert.size()));
  8945. if (!cert_context) {
  8946. out_error = GetLastError();
  8947. return false;
  8948. }
  8949. auto cert_guard =
  8950. scope_exit([&] { CertFreeCertificateContext(cert_context); });
  8951. // Setup chain parameters
  8952. CERT_CHAIN_PARA chain_para = {};
  8953. chain_para.cbSize = sizeof(chain_para);
  8954. // Build certificate chain with revocation checking
  8955. PCCERT_CHAIN_CONTEXT chain_context = nullptr;
  8956. auto chain_result = CertGetCertificateChain(
  8957. nullptr, cert_context, nullptr, cert_context->hCertStore, &chain_para,
  8958. CERT_CHAIN_CACHE_END_CERT | CERT_CHAIN_REVOCATION_CHECK_END_CERT |
  8959. CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT,
  8960. nullptr, &chain_context);
  8961. if (!chain_result || !chain_context) {
  8962. out_error = GetLastError();
  8963. return false;
  8964. }
  8965. auto chain_guard =
  8966. scope_exit([&] { CertFreeCertificateChain(chain_context); });
  8967. // Check if chain has errors
  8968. if (chain_context->TrustStatus.dwErrorStatus != CERT_TRUST_NO_ERROR) {
  8969. out_error = chain_context->TrustStatus.dwErrorStatus;
  8970. return false;
  8971. }
  8972. // Verify SSL policy
  8973. SSL_EXTRA_CERT_CHAIN_POLICY_PARA extra_policy_para = {};
  8974. extra_policy_para.cbSize = sizeof(extra_policy_para);
  8975. #ifdef AUTHTYPE_SERVER
  8976. extra_policy_para.dwAuthType = AUTHTYPE_SERVER;
  8977. #endif
  8978. std::wstring whost;
  8979. if (verify_hostname) {
  8980. whost = u8string_to_wstring(hostname.c_str());
  8981. extra_policy_para.pwszServerName = const_cast<wchar_t *>(whost.c_str());
  8982. }
  8983. CERT_CHAIN_POLICY_PARA policy_para = {};
  8984. policy_para.cbSize = sizeof(policy_para);
  8985. #ifdef CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS
  8986. policy_para.dwFlags = CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS;
  8987. #else
  8988. policy_para.dwFlags = 0;
  8989. #endif
  8990. policy_para.pvExtraPolicyPara = &extra_policy_para;
  8991. CERT_CHAIN_POLICY_STATUS policy_status = {};
  8992. policy_status.cbSize = sizeof(policy_status);
  8993. if (!CertVerifyCertificateChainPolicy(CERT_CHAIN_POLICY_SSL, chain_context,
  8994. &policy_para, &policy_status)) {
  8995. out_error = GetLastError();
  8996. return false;
  8997. }
  8998. if (policy_status.dwError != 0) {
  8999. out_error = policy_status.dwError;
  9000. return false;
  9001. }
  9002. return true;
  9003. }
  9004. #endif // _WIN32
  9005. // Loads CA file/dir configuration and applies the system CA policy to a
  9006. // client TLS context. PEM data and native stores are applied to the context
  9007. // directly at set time; has_custom_store reflects them for the Auto policy
  9008. // decision.
  9009. inline bool load_client_ca_config(tls::ctx_t ctx,
  9010. const std::string &ca_cert_file_path,
  9011. const std::string &ca_cert_dir_path,
  9012. bool has_custom_store, SystemCAMode mode,
  9013. uint64_t &backend_error) {
  9014. auto ret = true;
  9015. if (!ca_cert_file_path.empty()) {
  9016. if (!tls::load_ca_file(ctx, ca_cert_file_path.c_str())) {
  9017. backend_error = tls::get_error();
  9018. ret = false;
  9019. }
  9020. } else if (!ca_cert_dir_path.empty()) {
  9021. if (!tls::load_ca_dir(ctx, ca_cert_dir_path.c_str())) {
  9022. backend_error = tls::get_error();
  9023. ret = false;
  9024. }
  9025. }
  9026. auto has_custom_ca = !ca_cert_file_path.empty() ||
  9027. !ca_cert_dir_path.empty() || has_custom_store;
  9028. if (mode == SystemCAMode::Enabled ||
  9029. (mode == SystemCAMode::Auto && !has_custom_ca)) {
  9030. if (!tls::load_system_certs(ctx)) { backend_error = tls::get_error(); }
  9031. }
  9032. return ret;
  9033. }
  9034. // The parts of session setup that only SSLClient needs, plus the handful
  9035. // WebSocketClient also exposes; everything else takes the defaults, which is
  9036. // what keeps the two clients on one implementation.
  9037. struct ClientTlsSessionOptions {
  9038. // Both SSLClient and WebSocketClient expose this independently of
  9039. // certificate verification.
  9040. bool server_hostname_verification = true;
  9041. std::function<SSLVerifierResponse(tls::session_t)> session_verifier;
  9042. // When non-null, guards session creation against concurrent use of the
  9043. // context. A WebSocketClient is not safe to use from several threads to
  9044. // begin with, so it passes nothing.
  9045. std::mutex *ctx_mutex = nullptr;
  9046. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9047. // The caller decides whether Schannel has anything to say about this
  9048. // connection; see SSLClient::initialize_ssl().
  9049. bool windows_cert_verification = false;
  9050. #endif
  9051. };
  9052. // Filled in on failure for callers that report error details.
  9053. struct ClientTlsSessionError {
  9054. Error error = Error::Success;
  9055. int ssl_error = 0;
  9056. uint64_t backend_error = 0;
  9057. };
  9058. // Establishes a client TLS session on an already connected socket. On failure
  9059. // the session is left for the caller to free: SSLClient frees it right away,
  9060. // WebSocketClient keeps it in a member that shutdown_and_close() cleans up.
  9061. inline bool setup_client_tls_session(
  9062. const std::string &host, tls::ctx_t ctx, tls::session_t &session,
  9063. socket_t sock, bool server_certificate_verification, time_t timeout_sec,
  9064. time_t timeout_usec, ClientTlsSessionError *out_error = nullptr,
  9065. const ClientTlsSessionOptions &options = ClientTlsSessionOptions()) {
  9066. using namespace tls;
  9067. auto fail = [&](Error error, int ssl_error, uint64_t backend_error) {
  9068. if (out_error) {
  9069. out_error->error = error;
  9070. out_error->ssl_error = ssl_error;
  9071. out_error->backend_error = backend_error;
  9072. }
  9073. return false;
  9074. };
  9075. if (!ctx) {
  9076. session = nullptr;
  9077. return fail(Error::SSLConnection, 0, 0);
  9078. }
  9079. #if defined(CPPHTTPLIB_MBEDTLS_SUPPORT) || defined(CPPHTTPLIB_WOLFSSL_SUPPORT)
  9080. // Mbed TLS and wolfSSL need the verification mode set explicitly; OpenSSL
  9081. // uses SSL_VERIFY_NONE and does all verification post-handshake. Chain
  9082. // verification happens during the handshake even for IP hosts; the
  9083. // certificate identity is verified post-handshake via verify_hostname().
  9084. set_verify_client(ctx, server_certificate_verification);
  9085. #endif
  9086. {
  9087. std::unique_lock<std::mutex> guard;
  9088. if (options.ctx_mutex) {
  9089. guard = std::unique_lock<std::mutex>(*options.ctx_mutex);
  9090. }
  9091. session = create_session(ctx, sock);
  9092. }
  9093. if (!session) { return fail(Error::SSLConnection, 0, get_error()); }
  9094. // RFC 6066: SNI must not be set for IP addresses; skip it for IP hosts, so
  9095. // their identity is checked post-handshake below instead. On Mbed TLS and
  9096. // wolfSSL, set_sni also drives handshake-time hostname verification, so
  9097. // options.server_hostname_verification is threaded through here.
  9098. if (!is_ip_address(host)) {
  9099. if (!set_sni(session, host.c_str(), options.server_hostname_verification)) {
  9100. return fail(Error::SSLConnection, 0, get_error());
  9101. }
  9102. }
  9103. TlsError tls_err;
  9104. if (!connect_nonblocking(session, sock, timeout_sec, timeout_usec,
  9105. &tls_err)) {
  9106. auto error = Error::SSLConnection;
  9107. if (tls_err.code == ErrorCode::CertVerifyFailed) {
  9108. error = Error::SSLServerVerification;
  9109. } else if (tls_err.code == ErrorCode::HostnameMismatch) {
  9110. error = Error::SSLServerHostnameVerification;
  9111. }
  9112. return fail(error, static_cast<int>(tls_err.code), tls_err.backend_code);
  9113. }
  9114. auto verification_status = SSLVerifierResponse::NoDecisionMade;
  9115. if (options.session_verifier) {
  9116. verification_status = options.session_verifier(session);
  9117. }
  9118. if (verification_status == SSLVerifierResponse::CertificateRejected) {
  9119. return fail(Error::SSLServerVerification, 0, get_error());
  9120. }
  9121. if (verification_status == SSLVerifierResponse::NoDecisionMade &&
  9122. server_certificate_verification) {
  9123. auto verify_result = get_verify_result(session);
  9124. if (verify_result != 0) {
  9125. return fail(Error::SSLServerVerification, 0,
  9126. static_cast<uint64_t>(verify_result));
  9127. }
  9128. auto server_cert = get_peer_cert(session);
  9129. if (!server_cert) {
  9130. return fail(Error::SSLServerVerification, 0, get_error());
  9131. }
  9132. auto cert_guard = detail::scope_exit([&] { free_cert(server_cert); });
  9133. // Identity check against the peer certificate, post-handshake for all
  9134. // backends. For IP hosts this is the only identity verification, since no
  9135. // hostname is bound during the handshake.
  9136. if (options.server_hostname_verification) {
  9137. if (!verify_hostname(server_cert, host.c_str())) {
  9138. return fail(Error::SSLServerHostnameVerification, 0,
  9139. hostname_mismatch_code());
  9140. }
  9141. }
  9142. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  9143. // Additional Windows Schannel verification.
  9144. // This provides real-time certificate validation with Windows Update
  9145. // integration, working with both OpenSSL and MbedTLS backends.
  9146. if (options.windows_cert_verification) {
  9147. std::vector<unsigned char> der;
  9148. if (get_cert_der(server_cert, der)) {
  9149. uint64_t wincrypt_error = 0;
  9150. if (!verify_cert_with_windows_schannel(
  9151. der, host, options.server_hostname_verification,
  9152. wincrypt_error)) {
  9153. return fail(Error::SSLServerVerification, 0, wincrypt_error);
  9154. }
  9155. }
  9156. }
  9157. #endif
  9158. }
  9159. return true;
  9160. }
  9161. } // namespace detail
  9162. #endif // CPPHTTPLIB_SSL_ENABLED
  9163. /*
  9164. * Group 3: httplib namespace - Non-SSL public API implementations
  9165. */
  9166. inline void default_socket_options(socket_t sock) {
  9167. set_socket_opt(sock, SOL_SOCKET,
  9168. #ifdef SO_REUSEPORT
  9169. SO_REUSEPORT,
  9170. #else
  9171. SO_REUSEADDR,
  9172. #endif
  9173. 1);
  9174. }
  9175. inline bool set_socket_opt(socket_t sock, int level, int optname, int optval) {
  9176. return detail::set_socket_opt_impl(sock, level, optname, &optval,
  9177. sizeof(optval));
  9178. }
  9179. inline std::string get_bearer_token_auth(const Request &req) {
  9180. // The auth scheme is case-insensitive (RFC 9110 11.1), and a value shorter
  9181. // than the prefix carries no token.
  9182. constexpr const char bearer_prefix[] = "Bearer ";
  9183. constexpr auto bearer_prefix_len = detail::str_len(bearer_prefix);
  9184. auto value = req.get_header_value("Authorization");
  9185. if (value.size() >= bearer_prefix_len &&
  9186. detail::case_ignore::equal(value.substr(0, bearer_prefix_len),
  9187. bearer_prefix)) {
  9188. return value.substr(bearer_prefix_len);
  9189. }
  9190. return "";
  9191. }
  9192. inline const char *status_message(int status) {
  9193. switch (status) {
  9194. case StatusCode::Continue_100: return "Continue";
  9195. case StatusCode::SwitchingProtocol_101: return "Switching Protocol";
  9196. case StatusCode::Processing_102: return "Processing";
  9197. case StatusCode::EarlyHints_103: return "Early Hints";
  9198. case StatusCode::OK_200: return "OK";
  9199. case StatusCode::Created_201: return "Created";
  9200. case StatusCode::Accepted_202: return "Accepted";
  9201. case StatusCode::NonAuthoritativeInformation_203:
  9202. return "Non-Authoritative Information";
  9203. case StatusCode::NoContent_204: return "No Content";
  9204. case StatusCode::ResetContent_205: return "Reset Content";
  9205. case StatusCode::PartialContent_206: return "Partial Content";
  9206. case StatusCode::MultiStatus_207: return "Multi-Status";
  9207. case StatusCode::AlreadyReported_208: return "Already Reported";
  9208. case StatusCode::IMUsed_226: return "IM Used";
  9209. case StatusCode::MultipleChoices_300: return "Multiple Choices";
  9210. case StatusCode::MovedPermanently_301: return "Moved Permanently";
  9211. case StatusCode::Found_302: return "Found";
  9212. case StatusCode::SeeOther_303: return "See Other";
  9213. case StatusCode::NotModified_304: return "Not Modified";
  9214. case StatusCode::UseProxy_305: return "Use Proxy";
  9215. case StatusCode::unused_306: return "unused";
  9216. case StatusCode::TemporaryRedirect_307: return "Temporary Redirect";
  9217. case StatusCode::PermanentRedirect_308: return "Permanent Redirect";
  9218. case StatusCode::BadRequest_400: return "Bad Request";
  9219. case StatusCode::Unauthorized_401: return "Unauthorized";
  9220. case StatusCode::PaymentRequired_402: return "Payment Required";
  9221. case StatusCode::Forbidden_403: return "Forbidden";
  9222. case StatusCode::NotFound_404: return "Not Found";
  9223. case StatusCode::MethodNotAllowed_405: return "Method Not Allowed";
  9224. case StatusCode::NotAcceptable_406: return "Not Acceptable";
  9225. case StatusCode::ProxyAuthenticationRequired_407:
  9226. return "Proxy Authentication Required";
  9227. case StatusCode::RequestTimeout_408: return "Request Timeout";
  9228. case StatusCode::Conflict_409: return "Conflict";
  9229. case StatusCode::Gone_410: return "Gone";
  9230. case StatusCode::LengthRequired_411: return "Length Required";
  9231. case StatusCode::PreconditionFailed_412: return "Precondition Failed";
  9232. case StatusCode::PayloadTooLarge_413: return "Payload Too Large";
  9233. case StatusCode::UriTooLong_414: return "URI Too Long";
  9234. case StatusCode::UnsupportedMediaType_415: return "Unsupported Media Type";
  9235. case StatusCode::RangeNotSatisfiable_416: return "Range Not Satisfiable";
  9236. case StatusCode::ExpectationFailed_417: return "Expectation Failed";
  9237. case StatusCode::ImATeapot_418: return "I'm a teapot";
  9238. case StatusCode::MisdirectedRequest_421: return "Misdirected Request";
  9239. case StatusCode::UnprocessableContent_422: return "Unprocessable Content";
  9240. case StatusCode::Locked_423: return "Locked";
  9241. case StatusCode::FailedDependency_424: return "Failed Dependency";
  9242. case StatusCode::TooEarly_425: return "Too Early";
  9243. case StatusCode::UpgradeRequired_426: return "Upgrade Required";
  9244. case StatusCode::PreconditionRequired_428: return "Precondition Required";
  9245. case StatusCode::TooManyRequests_429: return "Too Many Requests";
  9246. case StatusCode::RequestHeaderFieldsTooLarge_431:
  9247. return "Request Header Fields Too Large";
  9248. case StatusCode::UnavailableForLegalReasons_451:
  9249. return "Unavailable For Legal Reasons";
  9250. case StatusCode::NotImplemented_501: return "Not Implemented";
  9251. case StatusCode::BadGateway_502: return "Bad Gateway";
  9252. case StatusCode::ServiceUnavailable_503: return "Service Unavailable";
  9253. case StatusCode::GatewayTimeout_504: return "Gateway Timeout";
  9254. case StatusCode::HttpVersionNotSupported_505:
  9255. return "HTTP Version Not Supported";
  9256. case StatusCode::VariantAlsoNegotiates_506: return "Variant Also Negotiates";
  9257. case StatusCode::InsufficientStorage_507: return "Insufficient Storage";
  9258. case StatusCode::LoopDetected_508: return "Loop Detected";
  9259. case StatusCode::NotExtended_510: return "Not Extended";
  9260. case StatusCode::NetworkAuthenticationRequired_511:
  9261. return "Network Authentication Required";
  9262. default:
  9263. case StatusCode::InternalServerError_500: return "Internal Server Error";
  9264. }
  9265. }
  9266. inline std::string to_string(const Error error) {
  9267. switch (error) {
  9268. case Error::Success: return "Success (no error)";
  9269. case Error::Unknown: return "Unknown";
  9270. case Error::Connection: return "Could not establish connection";
  9271. case Error::BindIPAddress: return "Failed to bind IP address";
  9272. case Error::Read: return "Failed to read connection";
  9273. case Error::Write: return "Failed to write connection";
  9274. case Error::ExceedRedirectCount: return "Maximum redirect count exceeded";
  9275. case Error::Canceled: return "Connection handling canceled";
  9276. case Error::SSLConnection: return "SSL connection failed";
  9277. case Error::SSLLoadingCerts: return "SSL certificate loading failed";
  9278. case Error::SSLServerVerification: return "SSL server verification failed";
  9279. case Error::SSLServerHostnameVerification:
  9280. return "SSL server hostname verification failed";
  9281. case Error::UnsupportedMultipartBoundaryChars:
  9282. return "Unsupported HTTP multipart boundary characters";
  9283. case Error::Compression: return "Compression failed";
  9284. case Error::ConnectionTimeout: return "Connection timed out";
  9285. case Error::ProxyConnection: return "Proxy connection failed";
  9286. case Error::ConnectionClosed: return "Connection closed by server";
  9287. case Error::Timeout: return "Read timeout";
  9288. case Error::ResourceExhaustion: return "Resource exhaustion";
  9289. case Error::TooManyFormDataFiles: return "Too many form data files";
  9290. case Error::ExceedMaxPayloadSize: return "Exceeded maximum payload size";
  9291. case Error::ExceedUriMaxLength: return "Exceeded maximum URI length";
  9292. case Error::ExceedMaxSocketDescriptorCount:
  9293. return "Exceeded maximum socket descriptor count";
  9294. case Error::InvalidRequestLine: return "Invalid request line";
  9295. case Error::InvalidHTTPMethod: return "Invalid HTTP method";
  9296. case Error::InvalidHTTPVersion: return "Invalid HTTP version";
  9297. case Error::InvalidHeaders: return "Invalid headers";
  9298. case Error::MultipartParsing: return "Multipart parsing failed";
  9299. case Error::OpenFile: return "Failed to open file";
  9300. case Error::Listen: return "Failed to listen on socket";
  9301. case Error::GetSockName: return "Failed to get socket name";
  9302. case Error::UnsupportedAddressFamily: return "Unsupported address family";
  9303. case Error::HTTPParsing: return "HTTP parsing failed";
  9304. case Error::InvalidRangeHeader: return "Invalid Range header";
  9305. case Error::UnsupportedContentEncoding: return "Unsupported Content-Encoding";
  9306. case Error::WebSocketHandshake: return "WebSocket handshake failed";
  9307. case Error::UserCallbackException: return "User callback threw an exception";
  9308. default: break;
  9309. }
  9310. return "Invalid";
  9311. }
  9312. inline std::ostream &operator<<(std::ostream &os, const Error &obj) {
  9313. os << to_string(obj);
  9314. os << " (" << static_cast<std::underlying_type<Error>::type>(obj) << ')';
  9315. return os;
  9316. }
  9317. inline std::string hosted_at(const std::string &hostname) {
  9318. std::vector<std::string> addrs;
  9319. hosted_at(hostname, addrs);
  9320. if (addrs.empty()) { return std::string(); }
  9321. return addrs[0];
  9322. }
  9323. inline void hosted_at(const std::string &hostname,
  9324. std::vector<std::string> &addrs) {
  9325. struct addrinfo hints;
  9326. struct addrinfo *result;
  9327. memset(&hints, 0, sizeof(struct addrinfo));
  9328. hints.ai_family = AF_UNSPEC;
  9329. hints.ai_socktype = SOCK_STREAM;
  9330. hints.ai_protocol = 0;
  9331. if (detail::getaddrinfo_with_timeout(hostname.c_str(), nullptr, &hints,
  9332. &result, 0)) {
  9333. #if defined __linux__ && !defined __ANDROID__
  9334. res_init();
  9335. #endif
  9336. return;
  9337. }
  9338. auto se = detail::scope_exit([&] { freeaddrinfo(result); });
  9339. for (auto rp = result; rp; rp = rp->ai_next) {
  9340. const auto &addr =
  9341. *reinterpret_cast<struct sockaddr_storage *>(rp->ai_addr);
  9342. std::string ip;
  9343. auto dummy = -1;
  9344. if (detail::get_ip_and_port(addr, sizeof(struct sockaddr_storage), ip,
  9345. dummy)) {
  9346. addrs.emplace_back(std::move(ip));
  9347. }
  9348. }
  9349. }
  9350. inline std::string encode_uri_component(const std::string &value) {
  9351. std::ostringstream escaped;
  9352. escaped.fill('0');
  9353. escaped << std::hex;
  9354. for (auto c : value) {
  9355. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9356. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')') {
  9357. escaped << c;
  9358. } else {
  9359. escaped << std::uppercase;
  9360. escaped << '%' << std::setw(2)
  9361. << static_cast<int>(static_cast<unsigned char>(c));
  9362. escaped << std::nouppercase;
  9363. }
  9364. }
  9365. return escaped.str();
  9366. }
  9367. inline std::string encode_uri(const std::string &value) {
  9368. std::ostringstream escaped;
  9369. escaped.fill('0');
  9370. escaped << std::hex;
  9371. for (auto c : value) {
  9372. if (detail::is_ascii_alnum(c) || c == '-' || c == '_' || c == '.' ||
  9373. c == '!' || c == '~' || c == '*' || c == '\'' || c == '(' || c == ')' ||
  9374. c == ';' || c == '/' || c == '?' || c == ':' || c == '@' || c == '&' ||
  9375. c == '=' || c == '+' || c == '$' || c == ',' || c == '#') {
  9376. escaped << c;
  9377. } else {
  9378. escaped << std::uppercase;
  9379. escaped << '%' << std::setw(2)
  9380. << static_cast<int>(static_cast<unsigned char>(c));
  9381. escaped << std::nouppercase;
  9382. }
  9383. }
  9384. return escaped.str();
  9385. }
  9386. inline std::string decode_uri_component(const std::string &value) {
  9387. std::string result;
  9388. for (size_t i = 0; i < value.size(); i++) {
  9389. if (value[i] == '%' && i + 2 < value.size()) {
  9390. auto val = 0;
  9391. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9392. result += static_cast<char>(val);
  9393. i += 2;
  9394. } else {
  9395. result += value[i];
  9396. }
  9397. } else {
  9398. result += value[i];
  9399. }
  9400. }
  9401. return result;
  9402. }
  9403. inline std::string decode_uri(const std::string &value) {
  9404. std::string result;
  9405. for (size_t i = 0; i < value.size(); i++) {
  9406. if (value[i] == '%' && i + 2 < value.size()) {
  9407. auto val = 0;
  9408. if (detail::from_hex_to_i(value, i + 1, 2, val)) {
  9409. auto c = static_cast<char>(val);
  9410. // Keep escapes of the reserved characters that encode_uri leaves
  9411. // literal, so decode_uri is the inverse of encode_uri and an escaped
  9412. // delimiter is not promoted into a real one (as with JS decodeURI).
  9413. if (c == ';' || c == '/' || c == '?' || c == ':' || c == '@' ||
  9414. c == '&' || c == '=' || c == '+' || c == '$' || c == ',' ||
  9415. c == '#') {
  9416. result += value[i];
  9417. result += value[i + 1];
  9418. result += value[i + 2];
  9419. } else {
  9420. result += c;
  9421. }
  9422. i += 2;
  9423. } else {
  9424. result += value[i];
  9425. }
  9426. } else {
  9427. result += value[i];
  9428. }
  9429. }
  9430. return result;
  9431. }
  9432. inline std::string encode_path_component(const std::string &component) {
  9433. std::string result;
  9434. result.reserve(component.size() * 3);
  9435. for (size_t i = 0; i < component.size(); i++) {
  9436. auto c = static_cast<unsigned char>(component[i]);
  9437. // Unreserved characters per RFC 3986: ALPHA / DIGIT / "-" / "." / "_" / "~"
  9438. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9439. c == '_' || c == '~') {
  9440. result += static_cast<char>(c);
  9441. }
  9442. // Path-safe sub-delimiters: "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" /
  9443. // "," / ";" / "="
  9444. else if (c == '!' || c == '$' || c == '&' || c == '\'' || c == '(' ||
  9445. c == ')' || c == '*' || c == '+' || c == ',' || c == ';' ||
  9446. c == '=') {
  9447. result += static_cast<char>(c);
  9448. }
  9449. // Colon is allowed in path segments except first segment
  9450. else if (c == ':') {
  9451. result += static_cast<char>(c);
  9452. }
  9453. // @ is allowed in path
  9454. else if (c == '@') {
  9455. result += static_cast<char>(c);
  9456. } else {
  9457. result += '%';
  9458. char hex[3];
  9459. snprintf(hex, sizeof(hex), "%02X", c);
  9460. result.append(hex, 2);
  9461. }
  9462. }
  9463. return result;
  9464. }
  9465. inline std::string decode_path_component(const std::string &component) {
  9466. std::string result;
  9467. result.reserve(component.size());
  9468. for (size_t i = 0; i < component.size(); i++) {
  9469. if (component[i] == '%' && i + 1 < component.size()) {
  9470. if (component[i + 1] == 'u') {
  9471. // Unicode %uXXXX encoding
  9472. auto val = 0;
  9473. if (detail::from_hex_to_i(component, i + 2, 4, val)) {
  9474. // 4 digits Unicode codes: val is 0x0000-0xFFFF (from 4 hex digits),
  9475. // so to_utf8 writes at most 3 bytes. buff[4] is safe.
  9476. char buff[4];
  9477. size_t len = detail::to_utf8(val, buff);
  9478. if (len > 0) { result.append(buff, len); }
  9479. i += 5; // 'u0000'
  9480. } else {
  9481. result += component[i];
  9482. }
  9483. } else {
  9484. // Standard %XX encoding
  9485. auto val = 0;
  9486. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9487. // 2 digits hex codes
  9488. result += static_cast<char>(val);
  9489. i += 2; // 'XX'
  9490. } else {
  9491. result += component[i];
  9492. }
  9493. }
  9494. } else {
  9495. result += component[i];
  9496. }
  9497. }
  9498. return result;
  9499. }
  9500. inline std::string encode_query_component(const std::string &component,
  9501. bool space_as_plus) {
  9502. std::string result;
  9503. result.reserve(component.size() * 3);
  9504. for (size_t i = 0; i < component.size(); i++) {
  9505. auto c = static_cast<unsigned char>(component[i]);
  9506. // Unreserved characters per RFC 3986
  9507. if (detail::is_ascii_alnum(static_cast<char>(c)) || c == '-' || c == '.' ||
  9508. c == '_' || c == '~') {
  9509. result += static_cast<char>(c);
  9510. }
  9511. // Space handling
  9512. else if (c == ' ') {
  9513. if (space_as_plus) {
  9514. result += '+';
  9515. } else {
  9516. result += "%20";
  9517. }
  9518. }
  9519. // Plus sign handling
  9520. else if (c == '+') {
  9521. if (space_as_plus) {
  9522. result += "%2B";
  9523. } else {
  9524. result += static_cast<char>(c);
  9525. }
  9526. }
  9527. // Query-safe sub-delimiters (excluding & and = which are query delimiters)
  9528. else if (c == '!' || c == '$' || c == '\'' || c == '(' || c == ')' ||
  9529. c == '*' || c == ',' || c == ';') {
  9530. result += static_cast<char>(c);
  9531. }
  9532. // Colon and @ are allowed in query
  9533. else if (c == ':' || c == '@') {
  9534. result += static_cast<char>(c);
  9535. }
  9536. // Forward slash is allowed in query values
  9537. else if (c == '/') {
  9538. result += static_cast<char>(c);
  9539. }
  9540. // Question mark is allowed in query values (after first ?)
  9541. else if (c == '?') {
  9542. result += static_cast<char>(c);
  9543. } else {
  9544. result += '%';
  9545. char hex[3];
  9546. snprintf(hex, sizeof(hex), "%02X", c);
  9547. result.append(hex, 2);
  9548. }
  9549. }
  9550. return result;
  9551. }
  9552. inline std::string decode_query_component(const std::string &component,
  9553. bool plus_as_space) {
  9554. std::string result;
  9555. result.reserve(component.size());
  9556. for (size_t i = 0; i < component.size(); i++) {
  9557. if (component[i] == '%' && i + 2 < component.size()) {
  9558. auto val = 0;
  9559. if (detail::from_hex_to_i(component, i + 1, 2, val)) {
  9560. result += static_cast<char>(val);
  9561. i += 2;
  9562. } else {
  9563. result += component[i];
  9564. }
  9565. } else if (component[i] == '+' && plus_as_space) {
  9566. result += ' '; // + becomes space in form-urlencoded
  9567. } else {
  9568. result += component[i];
  9569. }
  9570. }
  9571. return result;
  9572. }
  9573. inline std::string sanitize_filename(const std::string &filename) {
  9574. // Extract basename: find the last path separator (/ or \)
  9575. auto pos = filename.find_last_of("/\\");
  9576. auto result =
  9577. (pos != std::string::npos) ? filename.substr(pos + 1) : filename;
  9578. // Strip null bytes
  9579. result.erase(std::remove(result.begin(), result.end(), '\0'), result.end());
  9580. // Trim whitespace
  9581. {
  9582. auto start = result.find_first_not_of(" \t");
  9583. auto end = result.find_last_not_of(" \t");
  9584. result = (start == std::string::npos)
  9585. ? ""
  9586. : result.substr(start, end - start + 1);
  9587. }
  9588. // Reject . and ..
  9589. if (result == "." || result == "..") { return ""; }
  9590. return result;
  9591. }
  9592. inline std::string append_query_params(const std::string &path,
  9593. const Params &params) {
  9594. std::string path_with_query = path;
  9595. thread_local const std::regex re("[^?]+\\?.*");
  9596. auto delm = std::regex_match(path, re) ? '&' : '?';
  9597. path_with_query += delm + detail::params_to_query_str(params);
  9598. return path_with_query;
  9599. }
  9600. // Header utilities
  9601. inline std::pair<std::string, std::string>
  9602. make_range_header(const Ranges &ranges) {
  9603. std::string field = "bytes=";
  9604. auto i = 0;
  9605. for (const auto &r : ranges) {
  9606. if (i != 0) { field += ", "; }
  9607. if (r.first != -1) { field += std::to_string(r.first); }
  9608. field += '-';
  9609. if (r.second != -1) { field += std::to_string(r.second); }
  9610. i++;
  9611. }
  9612. return std::make_pair("Range", std::move(field));
  9613. }
  9614. inline std::pair<std::string, std::string>
  9615. make_basic_authentication_header(const std::string &username,
  9616. const std::string &password, bool is_proxy) {
  9617. auto field = "Basic " + detail::base64_encode(username + ":" + password);
  9618. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9619. return std::make_pair(key, std::move(field));
  9620. }
  9621. inline std::pair<std::string, std::string>
  9622. make_bearer_token_authentication_header(const std::string &token,
  9623. bool is_proxy = false) {
  9624. auto field = "Bearer " + token;
  9625. auto key = is_proxy ? "Proxy-Authorization" : "Authorization";
  9626. return std::make_pair(key, std::move(field));
  9627. }
  9628. // Request implementation
  9629. inline size_t Request::get_header_value_u64(const std::string &key, size_t def,
  9630. size_t id) const {
  9631. return detail::get_header_value_u64(headers, key, def, id);
  9632. }
  9633. inline bool Request::has_header(const std::string &key) const {
  9634. return detail::has_header(headers, key);
  9635. }
  9636. inline std::string Request::get_header_value(const std::string &key,
  9637. const char *def, size_t id) const {
  9638. return detail::get_header_value(headers, key, def, id);
  9639. }
  9640. inline size_t Request::get_header_value_count(const std::string &key) const {
  9641. return detail::get_header_value_count(headers, key);
  9642. }
  9643. inline void Request::set_header(const std::string &key,
  9644. const std::string &val) {
  9645. detail::set_header(headers, key, val);
  9646. }
  9647. inline bool Request::has_trailer(const std::string &key) const {
  9648. return trailers.find(key) != trailers.end();
  9649. }
  9650. inline std::string Request::get_trailer_value(const std::string &key,
  9651. size_t id) const {
  9652. return detail::get_multimap_value(trailers, key, id);
  9653. }
  9654. inline size_t Request::get_trailer_value_count(const std::string &key) const {
  9655. return trailers.count(key);
  9656. }
  9657. inline bool Request::has_param(const std::string &key) const {
  9658. return params.find(key) != params.end();
  9659. }
  9660. inline std::string Request::get_param_value(const std::string &key,
  9661. size_t id) const {
  9662. return detail::get_multimap_value(params, key, id);
  9663. }
  9664. inline std::vector<std::string>
  9665. Request::get_param_values(const std::string &key) const {
  9666. auto rng = params.equal_range(key);
  9667. std::vector<std::string> values;
  9668. values.reserve(static_cast<size_t>(std::distance(rng.first, rng.second)));
  9669. for (auto it = rng.first; it != rng.second; ++it) {
  9670. values.push_back(it->second);
  9671. }
  9672. return values;
  9673. }
  9674. inline size_t Request::get_param_value_count(const std::string &key) const {
  9675. return params.count(key);
  9676. }
  9677. inline bool Request::is_multipart_form_data() const {
  9678. const auto &content_type = get_header_value("Content-Type");
  9679. return detail::extract_media_type(content_type) == "multipart/form-data";
  9680. }
  9681. // Multipart FormData implementation
  9682. inline std::string MultipartFormData::get_field(const std::string &key,
  9683. size_t id) const {
  9684. auto rng = fields.equal_range(key);
  9685. auto it = rng.first;
  9686. std::advance(it, static_cast<ssize_t>(id));
  9687. if (it != rng.second) { return it->second.content; }
  9688. return std::string();
  9689. }
  9690. inline std::vector<std::string>
  9691. MultipartFormData::get_fields(const std::string &key) const {
  9692. std::vector<std::string> values;
  9693. auto rng = fields.equal_range(key);
  9694. for (auto it = rng.first; it != rng.second; it++) {
  9695. values.push_back(it->second.content);
  9696. }
  9697. return values;
  9698. }
  9699. inline bool MultipartFormData::has_field(const std::string &key) const {
  9700. return fields.find(key) != fields.end();
  9701. }
  9702. inline size_t MultipartFormData::get_field_count(const std::string &key) const {
  9703. return fields.count(key);
  9704. }
  9705. inline FormData MultipartFormData::get_file(const std::string &key,
  9706. size_t id) const {
  9707. return detail::get_multimap_value(files, key, id);
  9708. }
  9709. inline std::vector<FormData>
  9710. MultipartFormData::get_files(const std::string &key) const {
  9711. std::vector<FormData> values;
  9712. auto rng = files.equal_range(key);
  9713. for (auto it = rng.first; it != rng.second; it++) {
  9714. values.push_back(it->second);
  9715. }
  9716. return values;
  9717. }
  9718. inline bool MultipartFormData::has_file(const std::string &key) const {
  9719. return files.find(key) != files.end();
  9720. }
  9721. inline size_t MultipartFormData::get_file_count(const std::string &key) const {
  9722. return files.count(key);
  9723. }
  9724. // Multipart FormData writer implementation
  9725. inline bool is_valid_multipart_boundary(const std::string &boundary) {
  9726. return detail::is_multipart_boundary_chars_valid(boundary);
  9727. }
  9728. inline MultipartFormDataWriter::MultipartFormDataWriter()
  9729. : boundary_(detail::make_multipart_data_boundary()) {}
  9730. inline MultipartFormDataWriter::MultipartFormDataWriter(std::string boundary)
  9731. : boundary_(std::move(boundary)) {}
  9732. inline const std::string &MultipartFormDataWriter::boundary() const {
  9733. return boundary_;
  9734. }
  9735. inline std::string MultipartFormDataWriter::content_type() const {
  9736. return detail::serialize_multipart_formdata_get_content_type(boundary_);
  9737. }
  9738. inline std::string
  9739. MultipartFormDataWriter::serialize(const UploadFormDataItems &items) const {
  9740. return detail::serialize_multipart_formdata(items, boundary_);
  9741. }
  9742. inline size_t MultipartFormDataWriter::content_length(
  9743. const UploadFormDataItems &items) const {
  9744. return detail::get_multipart_content_length(items, boundary_);
  9745. }
  9746. inline std::string
  9747. MultipartFormDataWriter::item_begin(const UploadFormData &item) const {
  9748. return detail::serialize_multipart_formdata_item_begin(item, boundary_);
  9749. }
  9750. inline std::string MultipartFormDataWriter::item_end() {
  9751. return detail::serialize_multipart_formdata_item_end();
  9752. }
  9753. inline std::string MultipartFormDataWriter::finish() const {
  9754. return detail::serialize_multipart_formdata_finish(boundary_);
  9755. }
  9756. // Response implementation
  9757. inline size_t Response::get_header_value_u64(const std::string &key, size_t def,
  9758. size_t id) const {
  9759. return detail::get_header_value_u64(headers, key, def, id);
  9760. }
  9761. inline bool Response::has_header(const std::string &key) const {
  9762. return headers.find(key) != headers.end();
  9763. }
  9764. inline std::string Response::get_header_value(const std::string &key,
  9765. const char *def,
  9766. size_t id) const {
  9767. return detail::get_header_value(headers, key, def, id);
  9768. }
  9769. inline size_t Response::get_header_value_count(const std::string &key) const {
  9770. return detail::get_header_value_count(headers, key);
  9771. }
  9772. inline void Response::set_header(const std::string &key,
  9773. const std::string &val) {
  9774. detail::set_header(headers, key, val);
  9775. }
  9776. inline bool Response::has_trailer(const std::string &key) const {
  9777. return trailers.find(key) != trailers.end();
  9778. }
  9779. inline std::string Response::get_trailer_value(const std::string &key,
  9780. size_t id) const {
  9781. return detail::get_multimap_value(trailers, key, id);
  9782. }
  9783. inline size_t Response::get_trailer_value_count(const std::string &key) const {
  9784. return trailers.count(key);
  9785. }
  9786. inline void Response::set_redirect(const std::string &url, int stat) {
  9787. if (detail::fields::is_field_value(url)) {
  9788. set_header("Location", url);
  9789. if (300 <= stat && stat < 400) {
  9790. this->status = stat;
  9791. } else {
  9792. this->status = StatusCode::Found_302;
  9793. }
  9794. }
  9795. }
  9796. inline void Response::set_content(const char *s, size_t n,
  9797. const std::string &content_type) {
  9798. body.assign(s, n);
  9799. auto rng = headers.equal_range("Content-Type");
  9800. headers.erase(rng.first, rng.second);
  9801. set_header("Content-Type", content_type);
  9802. content_coding_ = detail::EncodingType::None;
  9803. }
  9804. inline void Response::set_content(const std::string &s,
  9805. const std::string &content_type) {
  9806. set_content(s.data(), s.size(), content_type);
  9807. }
  9808. inline void Response::set_content(std::string &&s,
  9809. const std::string &content_type) {
  9810. body = std::move(s);
  9811. auto rng = headers.equal_range("Content-Type");
  9812. headers.erase(rng.first, rng.second);
  9813. set_header("Content-Type", content_type);
  9814. content_coding_ = detail::EncodingType::None;
  9815. }
  9816. inline void Response::set_content_provider(
  9817. size_t in_length, const std::string &content_type, ContentProvider provider,
  9818. ContentProviderResourceReleaser resource_releaser) {
  9819. set_header("Content-Type", content_type);
  9820. content_length_ = in_length;
  9821. if (in_length > 0) { content_provider_ = std::move(provider); }
  9822. content_provider_resource_releaser_ = std::move(resource_releaser);
  9823. is_chunked_content_provider_ = false;
  9824. content_coding_ = detail::EncodingType::None;
  9825. }
  9826. inline void Response::set_content_provider(
  9827. const std::string &content_type, ContentProviderWithoutLength provider,
  9828. ContentProviderResourceReleaser resource_releaser) {
  9829. set_header("Content-Type", content_type);
  9830. content_length_ = 0;
  9831. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9832. content_provider_resource_releaser_ = std::move(resource_releaser);
  9833. is_chunked_content_provider_ = false;
  9834. content_coding_ = detail::EncodingType::None;
  9835. }
  9836. inline void Response::set_chunked_content_provider(
  9837. const std::string &content_type, ContentProviderWithoutLength provider,
  9838. ContentProviderResourceReleaser resource_releaser) {
  9839. set_header("Content-Type", content_type);
  9840. content_length_ = 0;
  9841. content_provider_ = detail::ContentProviderAdapter(std::move(provider));
  9842. content_provider_resource_releaser_ = std::move(resource_releaser);
  9843. is_chunked_content_provider_ = true;
  9844. content_coding_ = detail::EncodingType::None;
  9845. }
  9846. inline void Response::set_file_content(const std::string &path,
  9847. const std::string &content_type) {
  9848. file_content_path_ = path;
  9849. file_content_content_type_ = content_type;
  9850. }
  9851. inline void Response::set_file_content(const std::string &path) {
  9852. file_content_path_ = path;
  9853. }
  9854. // Result implementation
  9855. inline size_t Result::get_request_header_value_u64(const std::string &key,
  9856. size_t def,
  9857. size_t id) const {
  9858. return detail::get_header_value_u64(request_headers_, key, def, id);
  9859. }
  9860. inline bool Result::has_request_header(const std::string &key) const {
  9861. return request_headers_.find(key) != request_headers_.end();
  9862. }
  9863. inline std::string Result::get_request_header_value(const std::string &key,
  9864. const char *def,
  9865. size_t id) const {
  9866. return detail::get_header_value(request_headers_, key, def, id);
  9867. }
  9868. inline size_t
  9869. Result::get_request_header_value_count(const std::string &key) const {
  9870. return request_headers_.count(key);
  9871. }
  9872. // Stream implementation
  9873. inline ssize_t Stream::write(const char *ptr) {
  9874. return write(ptr, strlen(ptr));
  9875. }
  9876. inline ssize_t Stream::write(const std::string &s) {
  9877. return write(s.data(), s.size());
  9878. }
  9879. // BodyReader implementation
  9880. inline ssize_t detail::BodyReader::read(char *buf, size_t len) {
  9881. if (!stream) {
  9882. last_error = Error::Connection;
  9883. return -1;
  9884. }
  9885. if (eof) { return 0; }
  9886. if (!chunked) {
  9887. // Content-Length based reading
  9888. if (has_content_length && bytes_read >= content_length) {
  9889. eof = true;
  9890. return 0;
  9891. }
  9892. auto to_read = len;
  9893. if (has_content_length) {
  9894. auto remaining = content_length - bytes_read;
  9895. to_read = (std::min)(len, remaining);
  9896. }
  9897. auto n = stream->read(buf, to_read);
  9898. if (n < 0) {
  9899. last_error = stream->get_error();
  9900. if (last_error == Error::Success) { last_error = Error::Read; }
  9901. eof = true;
  9902. return n;
  9903. }
  9904. if (n == 0) {
  9905. // Unexpected EOF before content_length
  9906. last_error = stream->get_error();
  9907. if (last_error == Error::Success) { last_error = Error::Read; }
  9908. eof = true;
  9909. return 0;
  9910. }
  9911. bytes_read += static_cast<size_t>(n);
  9912. if (has_content_length && bytes_read >= content_length) { eof = true; }
  9913. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9914. last_error = Error::ExceedMaxPayloadSize;
  9915. eof = true;
  9916. return -1;
  9917. }
  9918. return n;
  9919. }
  9920. // Chunked transfer encoding: delegate to shared decoder instance.
  9921. if (!chunked_decoder) { chunked_decoder.reset(new ChunkedDecoder(*stream)); }
  9922. size_t chunk_offset = 0;
  9923. size_t chunk_total = 0;
  9924. auto n = chunked_decoder->read_payload(buf, len, chunk_offset, chunk_total);
  9925. if (n < 0) {
  9926. last_error = stream->get_error();
  9927. if (last_error == Error::Success) { last_error = Error::Read; }
  9928. eof = true;
  9929. return n;
  9930. }
  9931. if (n == 0) {
  9932. // Final chunk observed. Leave trailer parsing to the caller (StreamHandle).
  9933. eof = true;
  9934. return 0;
  9935. }
  9936. bytes_read += static_cast<size_t>(n);
  9937. if (payload_max_length > 0 && bytes_read > payload_max_length) {
  9938. last_error = Error::ExceedMaxPayloadSize;
  9939. eof = true;
  9940. return -1;
  9941. }
  9942. return n;
  9943. }
  9944. // ThreadPool implementation
  9945. inline ThreadPool::ThreadPool(size_t n, size_t max_n, size_t mqr,
  9946. time_t idle_timeout_sec)
  9947. : base_thread_count_(n), max_queued_requests_(mqr),
  9948. idle_timeout_sec_(idle_timeout_sec), idle_thread_count_(0),
  9949. shutdown_(false) {
  9950. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9951. if (max_n != 0 && max_n < n) {
  9952. std::string msg = "max_threads must be >= base_threads";
  9953. throw std::invalid_argument(msg);
  9954. }
  9955. #endif
  9956. max_thread_count_ = max_n == 0 ? n : max_n;
  9957. threads_.reserve(base_thread_count_);
  9958. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9959. try {
  9960. #endif
  9961. for (size_t i = 0; i < base_thread_count_; i++) {
  9962. threads_.emplace_back(std::thread([this]() { worker(false); }));
  9963. }
  9964. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  9965. } catch (...) {
  9966. // If thread creation fails partway (e.g., pthread_create returns EAGAIN),
  9967. // signal the workers we already spawned to exit and join them so the
  9968. // vector destructor does not see joinable threads (which would call
  9969. // std::terminate). Then rethrow so the caller learns of the failure.
  9970. {
  9971. std::unique_lock<std::mutex> lock(mutex_);
  9972. shutdown_ = true;
  9973. }
  9974. cond_.notify_all();
  9975. for (auto &t : threads_) {
  9976. if (t.joinable()) { t.join(); }
  9977. }
  9978. throw;
  9979. }
  9980. #endif
  9981. }
  9982. inline bool ThreadPool::enqueue(std::function<void()> fn) {
  9983. {
  9984. std::unique_lock<std::mutex> lock(mutex_);
  9985. if (shutdown_) { return false; }
  9986. if (max_queued_requests_ > 0 && jobs_.size() >= max_queued_requests_) {
  9987. return false;
  9988. }
  9989. jobs_.push_back(std::move(fn));
  9990. // Spawn a dynamic thread if no idle threads and under max
  9991. if (idle_thread_count_ == 0 &&
  9992. threads_.size() + dynamic_threads_.size() < max_thread_count_) {
  9993. cleanup_finished_threads();
  9994. dynamic_threads_.emplace_back(std::thread([this]() { worker(true); }));
  9995. }
  9996. }
  9997. cond_.notify_one();
  9998. return true;
  9999. }
  10000. inline void ThreadPool::shutdown() {
  10001. {
  10002. std::unique_lock<std::mutex> lock(mutex_);
  10003. shutdown_ = true;
  10004. }
  10005. cond_.notify_all();
  10006. for (auto &t : threads_) {
  10007. if (t.joinable()) { t.join(); }
  10008. }
  10009. // Move dynamic_threads_ to a local list under the lock to avoid racing
  10010. // with worker threads that call move_to_finished() concurrently.
  10011. std::list<std::thread> remaining_dynamic;
  10012. {
  10013. std::unique_lock<std::mutex> lock(mutex_);
  10014. remaining_dynamic = std::move(dynamic_threads_);
  10015. }
  10016. for (auto &t : remaining_dynamic) {
  10017. if (t.joinable()) { t.join(); }
  10018. }
  10019. std::unique_lock<std::mutex> lock(mutex_);
  10020. cleanup_finished_threads();
  10021. }
  10022. inline void ThreadPool::move_to_finished(std::thread::id id) {
  10023. // Must be called with mutex_ held
  10024. for (auto it = dynamic_threads_.begin(); it != dynamic_threads_.end(); ++it) {
  10025. if (it->get_id() == id) {
  10026. finished_threads_.push_back(std::move(*it));
  10027. dynamic_threads_.erase(it);
  10028. return;
  10029. }
  10030. }
  10031. }
  10032. inline void ThreadPool::cleanup_finished_threads() {
  10033. // Must be called with mutex_ held
  10034. for (auto &t : finished_threads_) {
  10035. if (t.joinable()) { t.join(); }
  10036. }
  10037. finished_threads_.clear();
  10038. }
  10039. inline void ThreadPool::worker(bool is_dynamic) {
  10040. for (;;) {
  10041. std::function<void()> fn;
  10042. {
  10043. std::unique_lock<std::mutex> lock(mutex_);
  10044. idle_thread_count_++;
  10045. if (is_dynamic) {
  10046. auto has_work =
  10047. cond_.wait_for(lock, std::chrono::seconds(idle_timeout_sec_),
  10048. [&] { return !jobs_.empty() || shutdown_; });
  10049. if (!has_work) {
  10050. // Timed out with no work - exit this dynamic thread
  10051. idle_thread_count_--;
  10052. move_to_finished(std::this_thread::get_id());
  10053. break;
  10054. }
  10055. } else {
  10056. cond_.wait(lock, [&] { return !jobs_.empty() || shutdown_; });
  10057. }
  10058. idle_thread_count_--;
  10059. if (shutdown_ && jobs_.empty()) { break; }
  10060. fn = std::move(jobs_.front());
  10061. jobs_.pop_front();
  10062. }
  10063. assert(true == static_cast<bool>(fn));
  10064. fn();
  10065. }
  10066. #if defined(CPPHTTPLIB_OPENSSL_SUPPORT) && !defined(OPENSSL_IS_BORINGSSL) && \
  10067. !defined(LIBRESSL_VERSION_NUMBER)
  10068. OPENSSL_thread_stop();
  10069. #endif
  10070. }
  10071. /*
  10072. * Group 1 (continued): detail namespace - Stream implementations
  10073. */
  10074. namespace detail {
  10075. inline void calc_actual_timeout(time_t max_timeout_msec, time_t duration_msec,
  10076. time_t timeout_sec, time_t timeout_usec,
  10077. time_t &actual_timeout_sec,
  10078. time_t &actual_timeout_usec) {
  10079. auto timeout_msec = (timeout_sec * 1000) + (timeout_usec / 1000);
  10080. auto actual_timeout_msec =
  10081. (std::min)(max_timeout_msec - duration_msec, timeout_msec);
  10082. if (actual_timeout_msec < 0) { actual_timeout_msec = 0; }
  10083. actual_timeout_sec = actual_timeout_msec / 1000;
  10084. actual_timeout_usec = (actual_timeout_msec % 1000) * 1000;
  10085. }
  10086. // Socket stream implementation
  10087. inline SocketStream::SocketStream(
  10088. socket_t sock, time_t read_timeout_sec, time_t read_timeout_usec,
  10089. time_t write_timeout_sec, time_t write_timeout_usec,
  10090. time_t max_timeout_msec,
  10091. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10092. : sock_(sock), read_timeout_sec_(read_timeout_sec),
  10093. read_timeout_usec_(read_timeout_usec),
  10094. write_timeout_sec_(write_timeout_sec),
  10095. write_timeout_usec_(write_timeout_usec),
  10096. max_timeout_msec_(max_timeout_msec), start_time_(start_time),
  10097. read_buff_(read_buff_size_, 0) {}
  10098. inline SocketStream::~SocketStream() = default;
  10099. inline bool SocketStream::is_readable() const {
  10100. return read_buff_off_ < read_buff_content_size_;
  10101. }
  10102. inline bool SocketStream::wait_readable() const {
  10103. if (max_timeout_msec_ <= 0) {
  10104. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10105. }
  10106. time_t read_timeout_sec;
  10107. time_t read_timeout_usec;
  10108. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10109. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10110. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10111. }
  10112. inline bool SocketStream::wait_writable() const {
  10113. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10114. }
  10115. inline bool SocketStream::ensure_readable() {
  10116. if (readable_hint_) {
  10117. readable_hint_ = false;
  10118. return true;
  10119. }
  10120. return wait_readable();
  10121. }
  10122. inline const char *SocketStream::buffered_data(size_t &size) const {
  10123. size = read_buff_content_size_ - read_buff_off_;
  10124. return size ? read_buff_.data() + read_buff_off_ : nullptr;
  10125. }
  10126. inline void SocketStream::consume_buffered(size_t size) {
  10127. assert(size <= read_buff_content_size_ - read_buff_off_);
  10128. read_buff_off_ += size;
  10129. }
  10130. inline bool SocketStream::is_peer_alive() const {
  10131. return detail::is_socket_alive(sock_);
  10132. }
  10133. inline ssize_t SocketStream::read(char *ptr, size_t size) {
  10134. #ifdef _WIN32
  10135. size =
  10136. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10137. #else
  10138. size = (std::min)(size,
  10139. static_cast<size_t>((std::numeric_limits<ssize_t>::max)()));
  10140. #endif
  10141. if (read_buff_off_ < read_buff_content_size_) {
  10142. auto remaining_size = read_buff_content_size_ - read_buff_off_;
  10143. if (size <= remaining_size) {
  10144. memcpy(ptr, read_buff_.data() + read_buff_off_, size);
  10145. read_buff_off_ += size;
  10146. return static_cast<ssize_t>(size);
  10147. } else {
  10148. memcpy(ptr, read_buff_.data() + read_buff_off_, remaining_size);
  10149. read_buff_off_ += remaining_size;
  10150. return static_cast<ssize_t>(remaining_size);
  10151. }
  10152. }
  10153. if (!ensure_readable()) {
  10154. error_ = Error::Timeout;
  10155. return -1;
  10156. }
  10157. read_buff_off_ = 0;
  10158. read_buff_content_size_ = 0;
  10159. if (size < read_buff_size_) {
  10160. auto n = read_socket(sock_, read_buff_.data(), read_buff_size_,
  10161. CPPHTTPLIB_RECV_FLAGS);
  10162. if (n <= 0) {
  10163. if (n == 0) {
  10164. error_ = Error::ConnectionClosed;
  10165. } else {
  10166. error_ = Error::Read;
  10167. }
  10168. return n;
  10169. } else if (n <= static_cast<ssize_t>(size)) {
  10170. memcpy(ptr, read_buff_.data(), static_cast<size_t>(n));
  10171. return n;
  10172. } else {
  10173. memcpy(ptr, read_buff_.data(), size);
  10174. read_buff_off_ = size;
  10175. read_buff_content_size_ = static_cast<size_t>(n);
  10176. return static_cast<ssize_t>(size);
  10177. }
  10178. } else {
  10179. auto n = read_socket(sock_, ptr, size, CPPHTTPLIB_RECV_FLAGS);
  10180. if (n <= 0) {
  10181. if (n == 0) {
  10182. error_ = Error::ConnectionClosed;
  10183. } else {
  10184. error_ = Error::Read;
  10185. }
  10186. }
  10187. return n;
  10188. }
  10189. }
  10190. inline ssize_t SocketStream::write(const char *ptr, size_t size) {
  10191. if (!wait_writable()) { return -1; }
  10192. #if defined(_WIN32) && !defined(_WIN64)
  10193. size =
  10194. (std::min)(size, static_cast<size_t>((std::numeric_limits<int>::max)()));
  10195. #endif
  10196. return send_socket(sock_, ptr, size, CPPHTTPLIB_SEND_FLAGS);
  10197. }
  10198. inline void SocketStream::get_remote_ip_and_port(std::string &ip,
  10199. int &port) const {
  10200. return detail::get_remote_ip_and_port(sock_, ip, port);
  10201. }
  10202. inline void SocketStream::get_local_ip_and_port(std::string &ip,
  10203. int &port) const {
  10204. return detail::get_local_ip_and_port(sock_, ip, port);
  10205. }
  10206. inline socket_t SocketStream::socket() const { return sock_; }
  10207. inline time_t SocketStream::duration() const {
  10208. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10209. std::chrono::steady_clock::now() - start_time_)
  10210. .count();
  10211. }
  10212. inline void SocketStream::set_read_timeout(time_t sec, time_t usec) {
  10213. read_timeout_sec_ = sec;
  10214. read_timeout_usec_ = usec;
  10215. }
  10216. // Buffer stream implementation
  10217. inline bool BufferStream::is_readable() const { return true; }
  10218. inline bool BufferStream::wait_readable() const { return true; }
  10219. inline bool BufferStream::wait_writable() const { return true; }
  10220. inline ssize_t BufferStream::read(char *ptr, size_t size) {
  10221. #if defined(_MSC_VER) && _MSC_VER < 1910
  10222. auto len_read = buffer._Copy_s(ptr, size, size, position);
  10223. #else
  10224. auto len_read = buffer.copy(ptr, size, position);
  10225. #endif
  10226. position += static_cast<size_t>(len_read);
  10227. return static_cast<ssize_t>(len_read);
  10228. }
  10229. inline ssize_t BufferStream::write(const char *ptr, size_t size) {
  10230. buffer.append(ptr, size);
  10231. return static_cast<ssize_t>(size);
  10232. }
  10233. inline void BufferStream::get_remote_ip_and_port(std::string & /*ip*/,
  10234. int & /*port*/) const {}
  10235. inline void BufferStream::get_local_ip_and_port(std::string & /*ip*/,
  10236. int & /*port*/) const {}
  10237. inline socket_t BufferStream::socket() const { return 0; }
  10238. inline time_t BufferStream::duration() const { return 0; }
  10239. inline const std::string &BufferStream::get_buffer() const { return buffer; }
  10240. inline PathParamsMatcher::PathParamsMatcher(const std::string &pattern)
  10241. : MatcherBase(pattern) {
  10242. constexpr const char marker[] = "/:";
  10243. // One past the last ending position of a path param substring
  10244. std::size_t last_param_end = 0;
  10245. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10246. // Needed to ensure that parameter names are unique during matcher
  10247. // construction
  10248. // If exceptions are disabled, only last duplicate path
  10249. // parameter will be set
  10250. std::unordered_set<std::string> param_name_set;
  10251. #endif
  10252. while (true) {
  10253. const auto marker_pos = pattern.find(
  10254. marker, last_param_end == 0 ? last_param_end : last_param_end - 1);
  10255. if (marker_pos == std::string::npos) { break; }
  10256. static_fragments_.push_back(
  10257. pattern.substr(last_param_end, marker_pos - last_param_end + 1));
  10258. const auto param_name_start = marker_pos + str_len(marker);
  10259. auto sep_pos = pattern.find(separator, param_name_start);
  10260. if (sep_pos == std::string::npos) { sep_pos = pattern.length(); }
  10261. auto param_name =
  10262. pattern.substr(param_name_start, sep_pos - param_name_start);
  10263. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  10264. if (param_name_set.find(param_name) != param_name_set.cend()) {
  10265. std::string msg = "Encountered path parameter '" + param_name +
  10266. "' multiple times in route pattern '" + pattern + "'.";
  10267. throw std::invalid_argument(msg);
  10268. }
  10269. #endif
  10270. param_names_.push_back(std::move(param_name));
  10271. last_param_end = sep_pos + 1;
  10272. }
  10273. if (last_param_end < pattern.length()) {
  10274. static_fragments_.push_back(pattern.substr(last_param_end));
  10275. }
  10276. }
  10277. inline bool PathParamsMatcher::match(Request &request) const {
  10278. request.matches = std::smatch();
  10279. request.path_params.clear();
  10280. // A pattern without parameters is just a literal path to compare against
  10281. if (param_names_.empty()) { return request.path == pattern(); }
  10282. request.path_params.reserve(param_names_.size());
  10283. // One past the position at which the path matched the pattern last time
  10284. std::size_t starting_pos = 0;
  10285. for (size_t i = 0; i < static_fragments_.size(); ++i) {
  10286. const auto &fragment = static_fragments_[i];
  10287. if (starting_pos + fragment.length() > request.path.length()) {
  10288. return false;
  10289. }
  10290. // Avoid unnecessary allocation by using strncmp instead of substr +
  10291. // comparison
  10292. if (std::strncmp(request.path.c_str() + starting_pos, fragment.c_str(),
  10293. fragment.length()) != 0) {
  10294. return false;
  10295. }
  10296. starting_pos += fragment.length();
  10297. // Should only happen when we have a static fragment after a param
  10298. // Example: '/users/:id/subscriptions'
  10299. // The 'subscriptions' fragment here does not have a corresponding param
  10300. if (i >= param_names_.size()) { continue; }
  10301. auto sep_pos = request.path.find(separator, starting_pos);
  10302. if (sep_pos == std::string::npos) { sep_pos = request.path.length(); }
  10303. const auto &param_name = param_names_[i];
  10304. request.path_params.emplace(
  10305. param_name, request.path.substr(starting_pos, sep_pos - starting_pos));
  10306. // Mark everything up to '/' as matched
  10307. starting_pos = sep_pos + 1;
  10308. }
  10309. // Returns false if the path is longer than the pattern
  10310. return starting_pos >= request.path.length();
  10311. }
  10312. inline bool RegexMatcher::match(Request &request) const {
  10313. request.path_params.clear();
  10314. // See CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH: an overlong path is treated as
  10315. // a non-match rather than risking a stack overflow in std::regex_match.
  10316. if (request.path.length() > CPPHTTPLIB_REGEX_ROUTE_PATH_MAX_LENGTH) {
  10317. return false;
  10318. }
  10319. return std::regex_match(request.path, request.matches, regex_);
  10320. }
  10321. // Enclose IPv6 address in brackets if needed
  10322. inline std::string prepare_host_string(const std::string &host) {
  10323. // Enclose IPv6 address in brackets (but not if already enclosed)
  10324. if (host.find(':') == std::string::npos ||
  10325. (!host.empty() && host[0] == '[')) {
  10326. // IPv4, hostname, or already bracketed IPv6
  10327. return host;
  10328. } else {
  10329. // IPv6 address without brackets
  10330. return "[" + host + "]";
  10331. }
  10332. }
  10333. inline std::string make_host_and_port_string(const std::string &host, int port,
  10334. bool is_ssl) {
  10335. auto result = prepare_host_string(host);
  10336. // Append port if not default
  10337. if ((!is_ssl && port == 80) || (is_ssl && port == 443)) {
  10338. ; // do nothing
  10339. } else {
  10340. result += ":" + std::to_string(port);
  10341. }
  10342. return result;
  10343. }
  10344. // Create "host:port" string always including port number (for CONNECT method)
  10345. inline std::string
  10346. make_host_and_port_string_always_port(const std::string &host, int port) {
  10347. return prepare_host_string(host) + ":" + std::to_string(port);
  10348. }
  10349. // Value for the Host header a client sends when the caller supplied none.
  10350. // Only the value: callers decide where in their header list it goes.
  10351. inline std::string make_default_host_header_value(const std::string &host,
  10352. int port, bool is_ssl,
  10353. int address_family) {
  10354. if (address_family == AF_UNIX) { return "localhost"; }
  10355. return make_host_and_port_string(host, port, is_ssl);
  10356. }
  10357. inline void add_default_user_agent_header(Request &req) {
  10358. #ifndef CPPHTTPLIB_NO_DEFAULT_USER_AGENT
  10359. if (!req.has_header("User-Agent")) {
  10360. req.set_header("User-Agent",
  10361. std::string("cpp-httplib/") + CPPHTTPLIB_VERSION);
  10362. }
  10363. #else
  10364. (void)req;
  10365. #endif
  10366. }
  10367. bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out);
  10368. NormalizedTarget normalize_target(const std::string &host);
  10369. bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits);
  10370. bool host_matches_no_proxy(const NormalizedTarget &target,
  10371. const std::vector<NoProxyEntry> &entries);
  10372. inline bool ip_in_cidr(const IPBytes &ip, const IPBytes &net, int prefix_bits) {
  10373. if (prefix_bits < 0 || prefix_bits > 128) { return false; }
  10374. if (prefix_bits == 0) { return true; }
  10375. int full_bytes = prefix_bits / 8;
  10376. int rem_bits = prefix_bits % 8;
  10377. if (full_bytes > 0 && std::memcmp(ip.data(), net.data(),
  10378. static_cast<size_t>(full_bytes)) != 0) {
  10379. return false;
  10380. }
  10381. if (rem_bits == 0) { return true; }
  10382. auto i = static_cast<size_t>(full_bytes);
  10383. auto mask = static_cast<uint8_t>(0xFFu << (8 - rem_bits));
  10384. return (ip[i] & mask) == (net[i] & mask);
  10385. }
  10386. inline bool parse_no_proxy_entry(const std::string &token, NoProxyEntry &out) {
  10387. if (token.empty()) { return false; }
  10388. if (token == "*") {
  10389. out.kind = NoProxyKind::Wildcard;
  10390. return true;
  10391. }
  10392. auto slash = token.find('/');
  10393. std::string addr_part =
  10394. (slash == std::string::npos) ? token : token.substr(0, slash);
  10395. std::string prefix_part =
  10396. (slash == std::string::npos) ? std::string() : token.substr(slash + 1);
  10397. // A bare slash or trailing-slash CIDR like "10.0.0.0/" is malformed;
  10398. // don't silently treat it as a /32 (or /128).
  10399. if (slash != std::string::npos && prefix_part.empty()) { return false; }
  10400. // Accept the bracketed IPv6 form ("[::1]", "[fe80::]/10") as well as the
  10401. // bare form. Brackets have no meaning for IPv4, so skip the IPv4 attempt
  10402. // when brackets are present.
  10403. bool bracketed = addr_part.size() >= 2 && addr_part.front() == '[' &&
  10404. addr_part.back() == ']';
  10405. if (bracketed) { addr_part = addr_part.substr(1, addr_part.size() - 2); }
  10406. if (!bracketed) {
  10407. struct in_addr v4;
  10408. if (inet_pton(AF_INET, addr_part.c_str(), &v4) == 1) {
  10409. int prefix = 32;
  10410. if (!prefix_part.empty()) {
  10411. auto r = from_chars(prefix_part.data(),
  10412. prefix_part.data() + prefix_part.size(), prefix);
  10413. if (r.ec != std::errc{} ||
  10414. r.ptr != prefix_part.data() + prefix_part.size()) {
  10415. return false;
  10416. }
  10417. if (prefix < 0 || prefix > 32) { return false; }
  10418. }
  10419. out.kind = NoProxyKind::IPv4Cidr;
  10420. std::memcpy(out.net.data(), &v4, sizeof(v4));
  10421. out.prefix_bits = prefix;
  10422. return true;
  10423. }
  10424. }
  10425. struct in6_addr v6;
  10426. if (inet_pton(AF_INET6, addr_part.c_str(), &v6) == 1) {
  10427. int prefix = 128;
  10428. if (!prefix_part.empty()) {
  10429. auto r = from_chars(prefix_part.data(),
  10430. prefix_part.data() + prefix_part.size(), prefix);
  10431. if (r.ec != std::errc{} ||
  10432. r.ptr != prefix_part.data() + prefix_part.size()) {
  10433. return false;
  10434. }
  10435. if (prefix < 0 || prefix > 128) { return false; }
  10436. }
  10437. out.kind = NoProxyKind::IPv6Cidr;
  10438. std::memcpy(out.net.data(), &v6, sizeof(v6));
  10439. out.prefix_bits = prefix;
  10440. return true;
  10441. }
  10442. // Bracketed entries can only be IPv6. If the IPv6 parse above failed,
  10443. // the entry is malformed — don't fall through to the hostname branch.
  10444. if (bracketed) { return false; }
  10445. // A '/' on a non-IP token means a CIDR prefix without an address. Reject.
  10446. if (slash != std::string::npos) { return false; }
  10447. // Port-specific entries (host:port) are not supported.
  10448. if (token.find(':') != std::string::npos) { return false; }
  10449. std::string hostname = case_ignore::to_lower(token);
  10450. while (!hostname.empty() && hostname.front() == '.') {
  10451. hostname.erase(hostname.begin());
  10452. }
  10453. while (!hostname.empty() && hostname.back() == '.') {
  10454. hostname.pop_back();
  10455. }
  10456. if (hostname.empty()) { return false; }
  10457. out.kind = NoProxyKind::HostnameSuffix;
  10458. out.hostname_pattern = std::move(hostname);
  10459. return true;
  10460. }
  10461. inline NormalizedTarget normalize_target(const std::string &host) {
  10462. NormalizedTarget t;
  10463. std::string h = host;
  10464. if (h.size() >= 2 && h.front() == '[' && h.back() == ']') {
  10465. h = h.substr(1, h.size() - 2);
  10466. }
  10467. // Strip a single trailing dot so "example.com." canonicalizes to
  10468. // "example.com".
  10469. if (!h.empty() && h.back() == '.') { h.pop_back(); }
  10470. t.hostname = case_ignore::to_lower(h);
  10471. if (!t.hostname.empty()) {
  10472. struct in_addr v4;
  10473. struct in6_addr v6;
  10474. if (inet_pton(AF_INET, t.hostname.c_str(), &v4) == 1) {
  10475. t.is_ipv4 = true;
  10476. std::memcpy(t.ip.data(), &v4, sizeof(v4));
  10477. } else if (inet_pton(AF_INET6, t.hostname.c_str(), &v6) == 1) {
  10478. t.is_ipv6 = true;
  10479. std::memcpy(t.ip.data(), &v6, sizeof(v6));
  10480. }
  10481. }
  10482. return t;
  10483. }
  10484. inline bool host_matches_no_proxy(const NormalizedTarget &target,
  10485. const std::vector<NoProxyEntry> &entries) {
  10486. if (target.hostname.empty()) { return false; }
  10487. for (const auto &e : entries) {
  10488. switch (e.kind) {
  10489. case NoProxyKind::Wildcard: return true;
  10490. case NoProxyKind::IPv4Cidr:
  10491. if (target.is_ipv4 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10492. return true;
  10493. }
  10494. break;
  10495. case NoProxyKind::IPv6Cidr:
  10496. if (target.is_ipv6 && ip_in_cidr(target.ip, e.net, e.prefix_bits)) {
  10497. return true;
  10498. }
  10499. break;
  10500. case NoProxyKind::HostnameSuffix:
  10501. if (target.is_ipv4 || target.is_ipv6) { break; }
  10502. if (target.hostname == e.hostname_pattern) { return true; }
  10503. // Dot-boundary suffix match: prevents "evilexample.com" from matching
  10504. // an entry of "example.com".
  10505. if (target.hostname.size() > e.hostname_pattern.size() + 1) {
  10506. auto offset = target.hostname.size() - e.hostname_pattern.size();
  10507. if (target.hostname[offset - 1] == '.' &&
  10508. target.hostname.compare(offset, e.hostname_pattern.size(),
  10509. e.hostname_pattern) == 0) {
  10510. return true;
  10511. }
  10512. }
  10513. break;
  10514. }
  10515. }
  10516. return false;
  10517. }
  10518. template <typename T>
  10519. inline bool check_and_write_headers(Stream &strm, Headers &headers,
  10520. T header_writer, Error &error) {
  10521. for (const auto &h : headers) {
  10522. if (!detail::fields::is_field_valid(h.first, h.second)) {
  10523. error = Error::InvalidHeaders;
  10524. return false;
  10525. }
  10526. }
  10527. if (header_writer(strm, headers) <= 0) {
  10528. error = Error::Write;
  10529. return false;
  10530. }
  10531. return true;
  10532. }
  10533. } // namespace detail
  10534. /*
  10535. * Group 2 (continued): detail namespace - SSLSocketStream implementation
  10536. */
  10537. #ifdef CPPHTTPLIB_SSL_ENABLED
  10538. namespace detail {
  10539. // SSL socket stream implementation
  10540. inline SSLSocketStream::SSLSocketStream(
  10541. socket_t sock, tls::session_t session, time_t read_timeout_sec,
  10542. time_t read_timeout_usec, time_t write_timeout_sec,
  10543. time_t write_timeout_usec, time_t max_timeout_msec,
  10544. std::chrono::time_point<std::chrono::steady_clock> start_time)
  10545. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10546. read_timeout_usec_(read_timeout_usec),
  10547. write_timeout_sec_(write_timeout_sec),
  10548. write_timeout_usec_(write_timeout_usec),
  10549. max_timeout_msec_(max_timeout_msec), start_time_(start_time) {
  10550. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10551. // Clear AUTO_RETRY for proper non-blocking I/O timeout handling
  10552. // Note: create_session() also clears this, but SSLClient currently
  10553. // uses ssl_new() which does not. Until full TLS API migration is complete,
  10554. // we need to ensure AUTO_RETRY is cleared here regardless of how the
  10555. // SSL session was created.
  10556. SSL_clear_mode(static_cast<SSL *>(session), SSL_MODE_AUTO_RETRY);
  10557. #endif
  10558. }
  10559. inline SSLSocketStream::~SSLSocketStream() = default;
  10560. inline bool SSLSocketStream::is_readable() const {
  10561. return tls::pending(session_) > 0;
  10562. }
  10563. inline bool SSLSocketStream::wait_readable() const {
  10564. if (max_timeout_msec_ <= 0) {
  10565. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10566. }
  10567. time_t read_timeout_sec;
  10568. time_t read_timeout_usec;
  10569. calc_actual_timeout(max_timeout_msec_, duration(), read_timeout_sec_,
  10570. read_timeout_usec_, read_timeout_sec, read_timeout_usec);
  10571. return select_read(sock_, read_timeout_sec, read_timeout_usec) > 0;
  10572. }
  10573. inline bool SSLSocketStream::wait_writable() const {
  10574. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0 &&
  10575. !tls::is_peer_closed(session_, sock_);
  10576. }
  10577. inline bool SSLSocketStream::ensure_readable() {
  10578. if (readable_hint_) {
  10579. readable_hint_ = false;
  10580. return true;
  10581. }
  10582. return wait_readable();
  10583. }
  10584. inline bool SSLSocketStream::is_peer_alive() const {
  10585. return !tls::is_peer_closed(session_, sock_);
  10586. }
  10587. inline ssize_t SSLSocketStream::read(char *ptr, size_t size) {
  10588. if (tls::pending(session_) > 0) {
  10589. tls::TlsError err;
  10590. auto ret = tls::read(session_, ptr, size, err);
  10591. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10592. error_ = Error::ConnectionClosed;
  10593. }
  10594. return ret;
  10595. } else if (ensure_readable()) {
  10596. tls::TlsError err;
  10597. auto ret = tls::read(session_, ptr, size, err);
  10598. if (ret < 0) {
  10599. auto n = 1000;
  10600. #ifdef _WIN32
  10601. while (--n >= 0 && (err.code == tls::ErrorCode::WantRead ||
  10602. (err.code == tls::ErrorCode::SyscallError &&
  10603. WSAGetLastError() == WSAETIMEDOUT))) {
  10604. #else
  10605. while (--n >= 0 && err.code == tls::ErrorCode::WantRead) {
  10606. #endif
  10607. if (tls::pending(session_) > 0) {
  10608. return tls::read(session_, ptr, size, err);
  10609. } else if (wait_readable()) {
  10610. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10611. ret = tls::read(session_, ptr, size, err);
  10612. if (ret >= 0) { return ret; }
  10613. } else {
  10614. break;
  10615. }
  10616. }
  10617. assert(ret < 0);
  10618. } else if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10619. error_ = Error::ConnectionClosed;
  10620. }
  10621. return ret;
  10622. } else {
  10623. error_ = Error::Timeout;
  10624. return -1;
  10625. }
  10626. }
  10627. inline ssize_t SSLSocketStream::write(const char *ptr, size_t size) {
  10628. if (wait_writable()) {
  10629. auto handle_size =
  10630. std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10631. tls::TlsError err;
  10632. auto ret = tls::write(session_, ptr, handle_size, err);
  10633. if (ret < 0) {
  10634. auto n = 1000;
  10635. #ifdef _WIN32
  10636. while (--n >= 0 && (err.code == tls::ErrorCode::WantWrite ||
  10637. (err.code == tls::ErrorCode::SyscallError &&
  10638. WSAGetLastError() == WSAETIMEDOUT))) {
  10639. #else
  10640. while (--n >= 0 && err.code == tls::ErrorCode::WantWrite) {
  10641. #endif
  10642. if (wait_writable()) {
  10643. std::this_thread::sleep_for(std::chrono::microseconds{10});
  10644. ret = tls::write(session_, ptr, handle_size, err);
  10645. if (ret >= 0) { return ret; }
  10646. } else {
  10647. break;
  10648. }
  10649. }
  10650. assert(ret < 0);
  10651. }
  10652. return ret;
  10653. }
  10654. return -1;
  10655. }
  10656. inline void SSLSocketStream::get_remote_ip_and_port(std::string &ip,
  10657. int &port) const {
  10658. detail::get_remote_ip_and_port(sock_, ip, port);
  10659. }
  10660. inline void SSLSocketStream::get_local_ip_and_port(std::string &ip,
  10661. int &port) const {
  10662. detail::get_local_ip_and_port(sock_, ip, port);
  10663. }
  10664. inline socket_t SSLSocketStream::socket() const { return sock_; }
  10665. inline time_t SSLSocketStream::duration() const {
  10666. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10667. std::chrono::steady_clock::now() - start_time_)
  10668. .count();
  10669. }
  10670. inline void SSLSocketStream::set_read_timeout(time_t sec, time_t usec) {
  10671. read_timeout_sec_ = sec;
  10672. read_timeout_usec_ = usec;
  10673. }
  10674. inline WebSocketSSLStream::WebSocketSSLStream(socket_t sock,
  10675. tls::session_t session,
  10676. time_t read_timeout_sec,
  10677. time_t read_timeout_usec,
  10678. time_t write_timeout_sec,
  10679. time_t write_timeout_usec)
  10680. : sock_(sock), session_(session), read_timeout_sec_(read_timeout_sec),
  10681. read_timeout_usec_(read_timeout_usec),
  10682. write_timeout_sec_(write_timeout_sec),
  10683. write_timeout_usec_(write_timeout_usec),
  10684. start_time_(std::chrono::steady_clock::now()) {
  10685. // The receive and send paths run on different threads, so each TLS call is
  10686. // driven in non-blocking mode and readiness is awaited with select()
  10687. // outside the session lock. Set the socket non-blocking once here; it is
  10688. // never flipped back, so no thread races on the flag.
  10689. detail::set_nonblocking(sock_, true);
  10690. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  10691. SSL_clear_mode(static_cast<SSL *>(session_), SSL_MODE_AUTO_RETRY);
  10692. #endif
  10693. }
  10694. inline WebSocketSSLStream::~WebSocketSSLStream() = default;
  10695. inline bool WebSocketSSLStream::is_readable() const {
  10696. std::lock_guard<std::mutex> guard(session_mutex_);
  10697. return tls::pending(session_) > 0;
  10698. }
  10699. inline bool WebSocketSSLStream::wait_readable() const {
  10700. return select_read(sock_, read_timeout_sec_, read_timeout_usec_) > 0;
  10701. }
  10702. inline bool WebSocketSSLStream::wait_writable() const {
  10703. // Unlike SSLSocketStream, this deliberately does not call is_peer_closed():
  10704. // that probe toggles the socket's blocking flag, which would race with the
  10705. // concurrent reader on a permanently non-blocking socket.
  10706. return select_write(sock_, write_timeout_sec_, write_timeout_usec_) > 0;
  10707. }
  10708. inline ssize_t WebSocketSSLStream::read(char *ptr, size_t size) {
  10709. tls::TlsError err;
  10710. auto n = 1000;
  10711. while (--n >= 0) {
  10712. {
  10713. std::lock_guard<std::mutex> guard(session_mutex_);
  10714. auto ret = tls::read(session_, ptr, size, err);
  10715. if (ret > 0) { return ret; }
  10716. if (ret == 0 || err.code == tls::ErrorCode::PeerClosed) {
  10717. error_ = Error::ConnectionClosed;
  10718. return ret;
  10719. }
  10720. }
  10721. // ret < 0. On a non-blocking socket a TLS read can stop needing either
  10722. // direction: the send path shares this session, so output it left pending
  10723. // has to be flushed before more input can be decrypted. Anything else is
  10724. // a hard error.
  10725. auto needs_readable = err.code == tls::ErrorCode::WantRead;
  10726. #ifdef _WIN32
  10727. // On Windows a socket timeout surfaces as a syscall error, not WantRead.
  10728. needs_readable =
  10729. needs_readable || (err.code == tls::ErrorCode::SyscallError &&
  10730. WSAGetLastError() == WSAETIMEDOUT);
  10731. #endif
  10732. if (!needs_readable && err.code != tls::ErrorCode::WantWrite) {
  10733. error_ = Error::Read;
  10734. return -1;
  10735. }
  10736. if (!(needs_readable ? wait_readable() : wait_writable())) {
  10737. error_ = Error::Timeout;
  10738. return -1;
  10739. }
  10740. }
  10741. // Out of retries. Recording a reason matters: a caller that reads get_error()
  10742. // to tell a timeout from a close would otherwise see whatever the previous
  10743. // failure left behind (error_ is never cleared on success).
  10744. error_ = Error::Read;
  10745. return -1;
  10746. }
  10747. inline ssize_t WebSocketSSLStream::write(const char *ptr, size_t size) {
  10748. auto handle_size = std::min<size_t>(size, (std::numeric_limits<int>::max)());
  10749. tls::TlsError err;
  10750. auto n = 1000;
  10751. while (--n >= 0) {
  10752. {
  10753. std::lock_guard<std::mutex> guard(session_mutex_);
  10754. auto ret = tls::write(session_, ptr, handle_size, err);
  10755. if (ret >= 0) { return ret; }
  10756. }
  10757. // ret < 0. As in read(), either direction can be needed: a renegotiation
  10758. // or a post-handshake message must be consumed before the record goes
  10759. // out. Anything else is a hard error.
  10760. auto needs_writable = err.code == tls::ErrorCode::WantWrite;
  10761. #ifdef _WIN32
  10762. // On Windows a socket timeout surfaces as a syscall error, not WantWrite.
  10763. needs_writable =
  10764. needs_writable || (err.code == tls::ErrorCode::SyscallError &&
  10765. WSAGetLastError() == WSAETIMEDOUT);
  10766. #endif
  10767. if (!needs_writable && err.code != tls::ErrorCode::WantRead) { return -1; }
  10768. if (!(needs_writable ? wait_writable() : wait_readable())) { return -1; }
  10769. }
  10770. return -1;
  10771. }
  10772. inline void WebSocketSSLStream::get_remote_ip_and_port(std::string &ip,
  10773. int &port) const {
  10774. detail::get_remote_ip_and_port(sock_, ip, port);
  10775. }
  10776. inline void WebSocketSSLStream::get_local_ip_and_port(std::string &ip,
  10777. int &port) const {
  10778. detail::get_local_ip_and_port(sock_, ip, port);
  10779. }
  10780. inline socket_t WebSocketSSLStream::socket() const { return sock_; }
  10781. inline time_t WebSocketSSLStream::duration() const {
  10782. return std::chrono::duration_cast<std::chrono::milliseconds>(
  10783. std::chrono::steady_clock::now() - start_time_)
  10784. .count();
  10785. }
  10786. inline void WebSocketSSLStream::set_read_timeout(time_t sec, time_t usec) {
  10787. read_timeout_sec_ = sec;
  10788. read_timeout_usec_ = usec;
  10789. }
  10790. } // namespace detail
  10791. #endif // CPPHTTPLIB_SSL_ENABLED
  10792. /*
  10793. * Group 4: Server implementation
  10794. */
  10795. // HTTP server implementation
  10796. inline Server::Server()
  10797. : new_task_queue([] {
  10798. return new ThreadPool(CPPHTTPLIB_THREAD_POOL_COUNT,
  10799. CPPHTTPLIB_THREAD_POOL_MAX_COUNT);
  10800. }) {
  10801. #ifndef _WIN32
  10802. signal(SIGPIPE, SIG_IGN);
  10803. #endif
  10804. }
  10805. inline Server::~Server() = default;
  10806. inline std::unique_ptr<detail::MatcherBase>
  10807. Server::make_matcher(const std::string &pattern) {
  10808. // Path params take precedence, so "/users/:id/(.*)" keeps being matched as
  10809. // a path params pattern
  10810. if (pattern.find("/:") != std::string::npos) {
  10811. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10812. }
  10813. // A pattern with no regex metacharacter only has to be compared literally,
  10814. // which is what PathParamsMatcher already does when it captures no
  10815. // parameter, so std::regex is only worth building for the patterns that
  10816. // actually need it
  10817. if (pattern.find_first_of(".^$|()[]{}*+?\\") == std::string::npos) {
  10818. return detail::make_unique<detail::PathParamsMatcher>(pattern);
  10819. }
  10820. return detail::make_unique<detail::RegexMatcher>(pattern);
  10821. }
  10822. inline Server &Server::Get(const std::string &pattern, Handler handler) {
  10823. return add_handler(get_handlers_, pattern, std::move(handler));
  10824. }
  10825. inline Server &Server::Post(const std::string &pattern, Handler handler) {
  10826. return add_handler(post_handlers_, pattern, std::move(handler));
  10827. }
  10828. inline Server &Server::Post(const std::string &pattern,
  10829. HandlerWithContentReader handler) {
  10830. return add_handler(post_handlers_for_content_reader_, pattern,
  10831. std::move(handler));
  10832. }
  10833. inline Server &Server::Put(const std::string &pattern, Handler handler) {
  10834. return add_handler(put_handlers_, pattern, std::move(handler));
  10835. }
  10836. inline Server &Server::Put(const std::string &pattern,
  10837. HandlerWithContentReader handler) {
  10838. return add_handler(put_handlers_for_content_reader_, pattern,
  10839. std::move(handler));
  10840. }
  10841. inline Server &Server::Patch(const std::string &pattern, Handler handler) {
  10842. return add_handler(patch_handlers_, pattern, std::move(handler));
  10843. }
  10844. inline Server &Server::Patch(const std::string &pattern,
  10845. HandlerWithContentReader handler) {
  10846. return add_handler(patch_handlers_for_content_reader_, pattern,
  10847. std::move(handler));
  10848. }
  10849. inline Server &Server::Delete(const std::string &pattern, Handler handler) {
  10850. return add_handler(delete_handlers_, pattern, std::move(handler));
  10851. }
  10852. inline Server &Server::Delete(const std::string &pattern,
  10853. HandlerWithContentReader handler) {
  10854. return add_handler(delete_handlers_for_content_reader_, pattern,
  10855. std::move(handler));
  10856. }
  10857. inline Server &Server::Options(const std::string &pattern, Handler handler) {
  10858. return add_handler(options_handlers_, pattern, std::move(handler));
  10859. }
  10860. inline const std::set<std::string> &Server::builtin_methods() {
  10861. thread_local const std::set<std::string> methods{
  10862. "GET", "HEAD", "POST", "PUT", "DELETE",
  10863. "CONNECT", "OPTIONS", "TRACE", "PATCH", "PRI"};
  10864. return methods;
  10865. }
  10866. inline Server::CustomHandlerEntry *
  10867. Server::custom_entry_for_registration(const std::string &method) {
  10868. // Built-in methods are refused for two different reasons. GET, HEAD, POST,
  10869. // PUT, DELETE, OPTIONS and PATCH are dispatched by the if/else chain in
  10870. // routing() before the custom tables are consulted, so a route registered
  10871. // for one of them could never fire. CONNECT, TRACE and PRI have no branch
  10872. // there and would be reachable, but they carry protocol-level meaning
  10873. // (tunnel setup, request echo, the HTTP/2 connection preface) that this
  10874. // library does not route.
  10875. if (!detail::fields::is_token(method) || builtin_methods().count(method)) {
  10876. output_error_log(Error::InvalidHTTPMethod, nullptr);
  10877. has_invalid_registration_ = true;
  10878. return nullptr;
  10879. }
  10880. return &custom_handlers_[method];
  10881. }
  10882. inline Server &Server::CustomRoute(const std::string &method,
  10883. const std::string &pattern,
  10884. Handler handler) {
  10885. auto *entry = custom_entry_for_registration(method);
  10886. if (!entry) { return *this; }
  10887. return add_handler(entry->handlers, pattern, std::move(handler));
  10888. }
  10889. inline Server &Server::CustomRoute(const std::string &method,
  10890. const std::string &pattern,
  10891. HandlerWithContentReader handler) {
  10892. auto *entry = custom_entry_for_registration(method);
  10893. if (!entry) { return *this; }
  10894. return add_handler(entry->handlers_for_content_reader, pattern,
  10895. std::move(handler));
  10896. }
  10897. inline const Server::CustomHandlerEntry *
  10898. Server::find_custom_entry(const std::string &method) const {
  10899. // find() alone would be correct here. The empty() check is what keeps the
  10900. // per-request cost off servers that never call CustomRoute(), which is the
  10901. // overwhelmingly common case; keep it rather than walking into the tree.
  10902. if (custom_handlers_.empty()) { return nullptr; }
  10903. auto it = custom_handlers_.find(method);
  10904. return it == custom_handlers_.end() ? nullptr : &it->second;
  10905. }
  10906. inline Server &Server::WebSocket(const std::string &pattern,
  10907. WebSocketHandler handler) {
  10908. websocket_handlers_.push_back(
  10909. {make_matcher(pattern), std::move(handler), nullptr});
  10910. return *this;
  10911. }
  10912. inline Server &Server::WebSocket(const std::string &pattern,
  10913. WebSocketHandler handler,
  10914. SubProtocolSelector sub_protocol_selector) {
  10915. websocket_handlers_.push_back({make_matcher(pattern), std::move(handler),
  10916. std::move(sub_protocol_selector)});
  10917. return *this;
  10918. }
  10919. inline bool Server::set_base_dir(const std::string &dir,
  10920. const std::string &mount_point) {
  10921. return set_mount_point(mount_point, dir);
  10922. }
  10923. inline bool Server::set_mount_point(const std::string &mount_point,
  10924. const std::string &dir, Headers headers) {
  10925. detail::FileStat stat(dir);
  10926. if (stat.is_dir()) {
  10927. std::string mnt = !mount_point.empty() ? mount_point : "/";
  10928. if (!mnt.empty() && mnt[0] == '/') {
  10929. std::string resolved_base;
  10930. if (detail::canonicalize_path(dir.c_str(), resolved_base)) {
  10931. #if defined(_WIN32)
  10932. if (resolved_base.back() != '\\' && resolved_base.back() != '/') {
  10933. resolved_base += '\\';
  10934. }
  10935. #else
  10936. if (resolved_base.back() != '/') { resolved_base += '/'; }
  10937. #endif
  10938. }
  10939. base_dirs_.push_back(
  10940. {std::move(mnt), dir, std::move(resolved_base), std::move(headers)});
  10941. return true;
  10942. }
  10943. }
  10944. return false;
  10945. }
  10946. inline bool Server::remove_mount_point(const std::string &mount_point) {
  10947. for (auto it = base_dirs_.begin(); it != base_dirs_.end(); ++it) {
  10948. if (it->mount_point == mount_point) {
  10949. base_dirs_.erase(it);
  10950. return true;
  10951. }
  10952. }
  10953. return false;
  10954. }
  10955. inline Server &
  10956. Server::set_file_extension_and_mimetype_mapping(const std::string &ext,
  10957. const std::string &mime) {
  10958. file_extension_and_mimetype_map_[ext] = mime;
  10959. return *this;
  10960. }
  10961. inline Server &Server::set_default_file_mimetype(const std::string &mime) {
  10962. default_file_mimetype_ = mime;
  10963. return *this;
  10964. }
  10965. inline Server &Server::set_file_request_handler(Handler handler) {
  10966. file_request_handler_ = std::move(handler);
  10967. return *this;
  10968. }
  10969. inline Server &Server::set_error_handler_core(HandlerWithResponse handler,
  10970. std::true_type) {
  10971. error_handler_ = std::move(handler);
  10972. return *this;
  10973. }
  10974. inline Server &Server::set_error_handler_core(Handler handler,
  10975. std::false_type) {
  10976. error_handler_ = [handler](const Request &req, Response &res) {
  10977. handler(req, res);
  10978. return HandlerResponse::Handled;
  10979. };
  10980. return *this;
  10981. }
  10982. inline Server &Server::set_exception_handler(ExceptionHandler handler) {
  10983. exception_handler_ = std::move(handler);
  10984. return *this;
  10985. }
  10986. inline Server &Server::set_pre_routing_handler(HandlerWithResponse handler) {
  10987. pre_routing_handler_ = std::move(handler);
  10988. return *this;
  10989. }
  10990. inline Server &Server::set_post_routing_handler(Handler handler) {
  10991. post_routing_handler_ = std::move(handler);
  10992. return *this;
  10993. }
  10994. inline Server &Server::set_pre_request_handler(HandlerWithResponse handler) {
  10995. pre_request_handler_ = std::move(handler);
  10996. return *this;
  10997. }
  10998. inline Server &Server::set_logger(Logger logger) {
  10999. logger_ = std::move(logger);
  11000. return *this;
  11001. }
  11002. inline Server &Server::set_error_logger(ErrorLogger error_logger) {
  11003. error_logger_ = std::move(error_logger);
  11004. return *this;
  11005. }
  11006. inline Server &Server::set_pre_compression_logger(Logger logger) {
  11007. pre_compression_logger_ = std::move(logger);
  11008. return *this;
  11009. }
  11010. inline Server &
  11011. Server::set_expect_100_continue_handler(Expect100ContinueHandler handler) {
  11012. expect_100_continue_handler_ = std::move(handler);
  11013. return *this;
  11014. }
  11015. inline Server &Server::set_start_handler(StartHandler handler) {
  11016. start_handler_ = std::move(handler);
  11017. return *this;
  11018. }
  11019. inline Server &Server::set_address_family(int family) {
  11020. address_family_ = family;
  11021. return *this;
  11022. }
  11023. inline Server &Server::set_tcp_nodelay(bool on) {
  11024. tcp_nodelay_ = on;
  11025. return *this;
  11026. }
  11027. inline Server &Server::set_ipv6_v6only(bool on) {
  11028. ipv6_v6only_ = on;
  11029. return *this;
  11030. }
  11031. inline Server &Server::set_socket_options(SocketOptions socket_options) {
  11032. socket_options_ = std::move(socket_options);
  11033. return *this;
  11034. }
  11035. inline Server &Server::set_default_headers(Headers headers) {
  11036. default_headers_ = std::move(headers);
  11037. return *this;
  11038. }
  11039. inline Server &Server::set_header_writer(
  11040. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  11041. header_writer_ = writer;
  11042. return *this;
  11043. }
  11044. inline Server &
  11045. Server::set_trusted_proxies(const std::vector<std::string> &proxies) {
  11046. trusted_proxies_ = proxies;
  11047. return *this;
  11048. }
  11049. inline Server &Server::set_keep_alive_max_count(size_t count) {
  11050. keep_alive_max_count_ = count;
  11051. return *this;
  11052. }
  11053. inline Server &Server::set_keep_alive_timeout(time_t sec) {
  11054. keep_alive_timeout_sec_ = sec;
  11055. return *this;
  11056. }
  11057. template <class Rep, class Period>
  11058. inline Server &Server::set_keep_alive_timeout(
  11059. const std::chrono::duration<Rep, Period> &duration) {
  11060. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11061. set_keep_alive_timeout(sec);
  11062. });
  11063. return *this;
  11064. }
  11065. inline Server &Server::set_read_timeout(time_t sec, time_t usec) {
  11066. read_timeout_sec_ = sec;
  11067. read_timeout_usec_ = usec;
  11068. return *this;
  11069. }
  11070. inline Server &Server::set_write_timeout(time_t sec, time_t usec) {
  11071. write_timeout_sec_ = sec;
  11072. write_timeout_usec_ = usec;
  11073. return *this;
  11074. }
  11075. inline Server &Server::set_idle_interval(time_t sec, time_t usec) {
  11076. idle_interval_sec_ = sec;
  11077. idle_interval_usec_ = usec;
  11078. return *this;
  11079. }
  11080. inline Server &Server::set_payload_max_length(size_t length) {
  11081. payload_max_length_ = length;
  11082. return *this;
  11083. }
  11084. inline Server &Server::set_static_file_compression(bool on) {
  11085. static_file_compression_ = on;
  11086. return *this;
  11087. }
  11088. inline Server &Server::set_static_file_compression_min_length(size_t length) {
  11089. static_file_compression_min_length_ = length;
  11090. return *this;
  11091. }
  11092. inline Server &Server::set_static_file_compression_max_length(size_t length) {
  11093. static_file_compression_max_length_ = length;
  11094. return *this;
  11095. }
  11096. inline Server &Server::set_websocket_max_missed_pongs(int count) {
  11097. websocket_max_missed_pongs_ = count;
  11098. return *this;
  11099. }
  11100. inline Server &Server::set_websocket_ping_interval(time_t sec) {
  11101. websocket_ping_interval_sec_ = sec;
  11102. return *this;
  11103. }
  11104. template <class Rep, class Period>
  11105. inline Server &Server::set_websocket_ping_interval(
  11106. const std::chrono::duration<Rep, Period> &duration) {
  11107. detail::duration_to_sec_and_usec(duration, [&](time_t sec, time_t /*usec*/) {
  11108. set_websocket_ping_interval(sec);
  11109. });
  11110. return *this;
  11111. }
  11112. inline bool Server::bind_to_port(const std::string &host, int port,
  11113. int socket_flags) {
  11114. auto ret = bind_internal(host, port, socket_flags);
  11115. if (ret == -1) { is_decommissioned = true; }
  11116. return ret >= 0;
  11117. }
  11118. inline int Server::bind_to_any_port(const std::string &host, int socket_flags) {
  11119. auto ret = bind_internal(host, 0, socket_flags);
  11120. if (ret == -1) { is_decommissioned = true; }
  11121. return ret;
  11122. }
  11123. inline bool Server::listen_after_bind() { return listen_internal(); }
  11124. inline bool Server::listen(const std::string &host, int port,
  11125. int socket_flags) {
  11126. return bind_to_port(host, port, socket_flags) && listen_internal();
  11127. }
  11128. inline bool Server::is_running() const { return is_running_; }
  11129. inline void Server::wait_until_ready() const {
  11130. while (!is_running_ && !is_decommissioned) {
  11131. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  11132. }
  11133. }
  11134. inline void Server::stop() noexcept {
  11135. // Release the listening socket whether or not the accept loop is running:
  11136. // bind_to_port() without listen_after_bind() still owns the descriptor. The
  11137. // exchange is what makes this safe to call concurrently with the accept loop.
  11138. socket_t sock = svr_sock_.exchange(INVALID_SOCKET);
  11139. if (sock != INVALID_SOCKET) {
  11140. detail::shutdown_socket(sock);
  11141. detail::close_socket(sock);
  11142. }
  11143. is_decommissioned = false;
  11144. }
  11145. inline void Server::decommission() { is_decommissioned = true; }
  11146. inline bool Server::parse_request_line(const char *s, Request &req) const {
  11147. auto len = strlen(s);
  11148. if (len < 2 || s[len - 2] != '\r' || s[len - 1] != '\n') { return false; }
  11149. len -= 2;
  11150. {
  11151. size_t count = 0;
  11152. detail::split(s, s + len, ' ', [&](const char *b, const char *e) {
  11153. switch (count) {
  11154. case 0: req.method = std::string(b, e); break;
  11155. case 1: req.target = std::string(b, e); break;
  11156. case 2: req.version = std::string(b, e); break;
  11157. default: break;
  11158. }
  11159. count++;
  11160. });
  11161. if (count != 3) { return false; }
  11162. }
  11163. // A method outside the built-in set is accepted only when a handler has been
  11164. // registered for it with CustomRoute().
  11165. const auto &methods = builtin_methods();
  11166. if (methods.find(req.method) == methods.end() &&
  11167. !find_custom_entry(req.method)) {
  11168. output_error_log(Error::InvalidHTTPMethod, &req);
  11169. return false;
  11170. }
  11171. if (req.version != "HTTP/1.1" && req.version != "HTTP/1.0") {
  11172. output_error_log(Error::InvalidHTTPVersion, &req);
  11173. return false;
  11174. }
  11175. {
  11176. // Skip URL fragment
  11177. for (size_t i = 0; i < req.target.size(); i++) {
  11178. if (req.target[i] == '#') {
  11179. req.target.erase(i);
  11180. break;
  11181. }
  11182. }
  11183. detail::divide(req.target, '?',
  11184. [&](const char *lhs_data, std::size_t lhs_size,
  11185. const char *rhs_data, std::size_t rhs_size) {
  11186. req.path =
  11187. decode_path_component(std::string(lhs_data, lhs_size));
  11188. detail::parse_query_text(rhs_data, rhs_size, req.params);
  11189. });
  11190. }
  11191. return true;
  11192. }
  11193. inline bool Server::write_response(Stream &strm, bool close_connection,
  11194. Request &req, Response &res) {
  11195. // NOTE: `req.ranges` should be empty, otherwise it will be applied
  11196. // incorrectly to the error content.
  11197. req.ranges.clear();
  11198. return write_response_core(strm, close_connection, req, res, false);
  11199. }
  11200. inline bool Server::write_response_with_content(Stream &strm,
  11201. bool close_connection,
  11202. const Request &req,
  11203. Response &res) {
  11204. return write_response_core(strm, close_connection, req, res, true);
  11205. }
  11206. inline bool Server::write_response_core(Stream &strm, bool close_connection,
  11207. const Request &req, Response &res,
  11208. bool need_apply_ranges) {
  11209. assert(res.status != -1);
  11210. if (400 <= res.status && error_handler_ &&
  11211. error_handler_(req, res) == HandlerResponse::Handled) {
  11212. need_apply_ranges = true;
  11213. }
  11214. std::string content_type;
  11215. std::string boundary;
  11216. if (need_apply_ranges) { apply_ranges(req, res, content_type, boundary); }
  11217. // Prepare additional headers
  11218. if (close_connection ||
  11219. detail::has_header_token(req.headers, "Connection", "close") ||
  11220. 400 <= res.status || // Don't leave connections open after errors
  11221. // The client withholds the body until `100 Continue`, which was never
  11222. // sent, so whether and when the body follows is unknown.
  11223. (req.expect_100_continue_pending_ && detail::has_framed_body(req))) {
  11224. res.set_header("Connection", "close");
  11225. } else {
  11226. std::string s = "timeout=";
  11227. s += std::to_string(keep_alive_timeout_sec_);
  11228. s += ", max=";
  11229. s += std::to_string(keep_alive_max_count_);
  11230. res.set_header("Keep-Alive", s);
  11231. }
  11232. if ((!res.body.empty() || res.content_length_ > 0 || res.content_provider_) &&
  11233. !res.has_header("Content-Type")) {
  11234. res.set_header("Content-Type", "text/plain");
  11235. }
  11236. if (res.body.empty() && !res.content_length_ && !res.content_provider_ &&
  11237. !res.has_header("Content-Length")) {
  11238. res.set_header("Content-Length", "0");
  11239. }
  11240. if (req.method == "HEAD" && !res.has_header("Accept-Ranges")) {
  11241. res.set_header("Accept-Ranges", "bytes");
  11242. }
  11243. if (post_routing_handler_) { post_routing_handler_(req, res); }
  11244. // Response line and headers
  11245. detail::BufferStream bstrm;
  11246. if (!detail::write_response_line(bstrm, res.status)) { return false; }
  11247. if (header_writer_(bstrm, res.headers) <= 0) { return false; }
  11248. // Combine small body with headers to reduce write syscalls
  11249. if (req.method != "HEAD" && !res.body.empty() && !res.content_provider_) {
  11250. bstrm.write(res.body.data(), res.body.size());
  11251. }
  11252. // Log before writing to avoid race condition with client-side code that
  11253. // accesses logger-captured data immediately after receiving the response.
  11254. output_log(req, res);
  11255. // Flush buffer
  11256. auto &data = bstrm.get_buffer();
  11257. if (!detail::write_data(strm, data.data(), data.size())) { return false; }
  11258. // Streaming body
  11259. auto ret = true;
  11260. if (req.method != "HEAD" && res.content_provider_) {
  11261. if (write_content_with_provider(strm, req, res, boundary, content_type)) {
  11262. res.content_provider_success_ = true;
  11263. } else {
  11264. ret = false;
  11265. }
  11266. }
  11267. return ret;
  11268. }
  11269. inline bool
  11270. Server::write_content_with_provider(Stream &strm, const Request &req,
  11271. Response &res, const std::string &boundary,
  11272. const std::string &content_type) {
  11273. auto is_shutting_down = [this]() {
  11274. return this->svr_sock_ == INVALID_SOCKET;
  11275. };
  11276. if (res.content_length_ > 0) {
  11277. // Only a 206 response is served as a partial representation, matching the
  11278. // condition `apply_ranges()` used to decide the Content-Length and the
  11279. // multipart boundary. Since `detail::range_error()` validates `req.ranges`
  11280. // only for a 2xx status, slicing under any other status would write a body
  11281. // that disagrees with the header already sent, from an unchecked offset.
  11282. auto is_partial =
  11283. !req.ranges.empty() && res.status == StatusCode::PartialContent_206;
  11284. if (!is_partial) {
  11285. return detail::write_content(strm, res.content_provider_, 0,
  11286. res.content_length_, is_shutting_down);
  11287. } else if (req.ranges.size() == 1) {
  11288. auto offset_and_length = detail::get_range_offset_and_length(
  11289. req.ranges[0], res.content_length_);
  11290. return detail::write_content(strm, res.content_provider_,
  11291. offset_and_length.first,
  11292. offset_and_length.second, is_shutting_down);
  11293. } else {
  11294. return detail::write_multipart_ranges_data(
  11295. strm, req, res, boundary, content_type, res.content_length_,
  11296. is_shutting_down);
  11297. }
  11298. } else {
  11299. if (res.is_chunked_content_provider_) {
  11300. // Use the coding `apply_ranges()` chose when it wrote the headers;
  11301. // re-negotiating here would disagree with them, e.g. once a handler's
  11302. // own Content-Encoding header suppresses the negotiation.
  11303. auto compressor = detail::make_compressor(res.content_coding_);
  11304. if (!compressor) {
  11305. compressor = detail::make_unique<detail::nocompressor>();
  11306. }
  11307. return detail::write_content_chunked(strm, res.content_provider_,
  11308. is_shutting_down, *compressor);
  11309. } else {
  11310. return detail::write_content_without_length(strm, res.content_provider_,
  11311. is_shutting_down);
  11312. }
  11313. }
  11314. }
  11315. inline bool Server::read_content(Stream &strm, Request &req, Response &res) {
  11316. FormFields::iterator cur_field;
  11317. FormFiles::iterator cur_file;
  11318. auto is_text_field = false;
  11319. size_t count = 0;
  11320. if (read_content_core(
  11321. strm, req, res,
  11322. // Regular
  11323. [&](const char *buf, size_t n) {
  11324. // Prevent arithmetic overflow when checking sizes.
  11325. // Avoid computing (req.body.size() + n) directly because
  11326. // adding two unsigned `size_t` values can wrap around and
  11327. // produce a small result instead of indicating overflow.
  11328. // Instead, check using subtraction: ensure `n` does not
  11329. // exceed the remaining capacity `max_size() - size()`.
  11330. if (req.body.size() >= req.body.max_size() ||
  11331. n > req.body.max_size() - req.body.size()) {
  11332. return false;
  11333. }
  11334. // Limit decompressed body size to payload_max_length_ to protect
  11335. // against "zip bomb" attacks where a small compressed payload
  11336. // decompresses to a massive size.
  11337. if (payload_max_length_ > 0 &&
  11338. (req.body.size() >= payload_max_length_ ||
  11339. n > payload_max_length_ - req.body.size())) {
  11340. return false;
  11341. }
  11342. req.body.append(buf, n);
  11343. return true;
  11344. },
  11345. // Multipart FormData
  11346. [&](const FormData &file) {
  11347. if (count++ == CPPHTTPLIB_MULTIPART_FORM_DATA_FILE_MAX_COUNT) {
  11348. output_error_log(Error::TooManyFormDataFiles, &req);
  11349. return false;
  11350. }
  11351. if (file.filename.empty()) {
  11352. cur_field = req.form.fields.emplace(
  11353. file.name, FormField{file.name, file.content, file.headers});
  11354. is_text_field = true;
  11355. } else {
  11356. cur_file = req.form.files.emplace(file.name, file);
  11357. is_text_field = false;
  11358. }
  11359. return true;
  11360. },
  11361. [&](const char *buf, size_t n) {
  11362. if (is_text_field) {
  11363. auto &content = cur_field->second.content;
  11364. if (content.size() + n > content.max_size()) { return false; }
  11365. content.append(buf, n);
  11366. } else {
  11367. auto &content = cur_file->second.content;
  11368. if (content.size() + n > content.max_size()) { return false; }
  11369. content.append(buf, n);
  11370. }
  11371. return true;
  11372. })) {
  11373. const auto &content_type = req.get_header_value("Content-Type");
  11374. if (detail::extract_media_type(content_type) ==
  11375. "application/x-www-form-urlencoded") {
  11376. if (req.body.size() > CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH) {
  11377. res.status = StatusCode::PayloadTooLarge_413; // NOTE: should be 414?
  11378. output_error_log(Error::ExceedMaxPayloadSize, &req);
  11379. return false;
  11380. }
  11381. detail::parse_query_text(req.body, req.params);
  11382. }
  11383. return true;
  11384. }
  11385. return false;
  11386. }
  11387. inline bool Server::read_content_with_content_receiver(
  11388. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11389. FormDataHeader multipart_header, ContentReceiver multipart_receiver) {
  11390. return read_content_core(strm, req, res, std::move(receiver),
  11391. std::move(multipart_header),
  11392. std::move(multipart_receiver));
  11393. }
  11394. inline bool Server::read_content_core(
  11395. Stream &strm, Request &req, Response &res, ContentReceiver receiver,
  11396. FormDataHeader multipart_header, ContentReceiver multipart_receiver) const {
  11397. detail::FormDataParser multipart_form_data_parser;
  11398. ContentReceiverWithProgress out;
  11399. if (req.is_multipart_form_data()) {
  11400. const auto &content_type = req.get_header_value("Content-Type");
  11401. std::string boundary;
  11402. if (!detail::parse_multipart_boundary(content_type, boundary)) {
  11403. res.status = StatusCode::BadRequest_400;
  11404. output_error_log(Error::MultipartParsing, &req);
  11405. return false;
  11406. }
  11407. multipart_form_data_parser.set_boundary(std::move(boundary));
  11408. out = [&](const char *buf, size_t n, size_t /*off*/, size_t /*len*/) {
  11409. return multipart_form_data_parser.parse(buf, n, multipart_header,
  11410. multipart_receiver);
  11411. };
  11412. } else {
  11413. out = [receiver](const char *buf, size_t n, size_t /*off*/,
  11414. size_t /*len*/) { return receiver(buf, n); };
  11415. }
  11416. // RFC 9112 §6: no Transfer-Encoding and no Content-Length means no body.
  11417. // For non-SSL builds we still scan non-persistent connections for stray
  11418. // body bytes so the payload limit is enforced (413). On keep-alive,
  11419. // pending bytes may be the next request (issue #2450), so skip.
  11420. #if !defined(CPPHTTPLIB_SSL_ENABLED)
  11421. if (!req.has_header("Content-Length") &&
  11422. !detail::is_chunked_transfer_encoding(req.headers)) {
  11423. if (!detail::is_connection_persistent(req) && payload_max_length_ > 0 &&
  11424. payload_max_length_ < (std::numeric_limits<size_t>::max)()) {
  11425. auto has_data = strm.is_readable();
  11426. if (!has_data) {
  11427. auto s = strm.socket();
  11428. if (s != INVALID_SOCKET) {
  11429. has_data = detail::select_read(s, 0, 0) > 0;
  11430. }
  11431. }
  11432. if (has_data) {
  11433. // Route through the same decompressing reader used by the
  11434. // length-framed and chunked paths below, so payload_max_length_ is
  11435. // enforced on the decompressed size here too instead of only on the
  11436. // compressed wire bytes.
  11437. return detail::read_content(strm, req, payload_max_length_, res.status,
  11438. nullptr, out, true);
  11439. }
  11440. }
  11441. return true;
  11442. }
  11443. #else
  11444. if (!req.has_header("Content-Length") &&
  11445. !detail::is_chunked_transfer_encoding(req.headers)) {
  11446. return true;
  11447. }
  11448. #endif
  11449. // The client is waiting for this before it sends the body.
  11450. if (req.expect_100_continue_pending_) {
  11451. req.expect_100_continue_pending_ = false;
  11452. detail::write_response_line(strm, StatusCode::Continue_100);
  11453. strm.write("\r\n");
  11454. }
  11455. if (!detail::read_content(strm, req, payload_max_length_, res.status, nullptr,
  11456. out, true)) {
  11457. return false;
  11458. }
  11459. req.body_consumed_ = true;
  11460. if (req.is_multipart_form_data()) {
  11461. if (!multipart_form_data_parser.is_valid()) {
  11462. res.status = StatusCode::BadRequest_400;
  11463. output_error_log(Error::MultipartParsing, &req);
  11464. return false;
  11465. }
  11466. }
  11467. return true;
  11468. }
  11469. inline bool Server::handle_file_request(Request &req, Response &res) {
  11470. for (const auto &entry : base_dirs_) {
  11471. // Prefix match, on a path segment boundary. A mount point of "/mount"
  11472. // covers "/mount" and "/mount/...", but must not swallow "/mountdir/...".
  11473. // One that already ends in '/' (the root mount among them) carries its own
  11474. // boundary; set_mount_point() guarantees the mount point is not empty.
  11475. if (!req.path.compare(0, entry.mount_point.size(), entry.mount_point) &&
  11476. (entry.mount_point.back() == '/' ||
  11477. req.path.size() == entry.mount_point.size() ||
  11478. req.path[entry.mount_point.size()] == '/')) {
  11479. std::string sub_path = "/" + req.path.substr(entry.mount_point.size());
  11480. if (detail::is_valid_path(sub_path)) {
  11481. auto path = entry.base_dir + sub_path;
  11482. if (path.back() == '/') { path += "index.html"; }
  11483. // Defense-in-depth: is_valid_path blocks ".." traversal in the URL,
  11484. // but symlinks/junctions can still escape the base directory.
  11485. if (!entry.resolved_base_dir.empty()) {
  11486. std::string resolved_path;
  11487. if (detail::canonicalize_path(path.c_str(), resolved_path) &&
  11488. !detail::is_path_within_base(resolved_path,
  11489. entry.resolved_base_dir)) {
  11490. res.status = StatusCode::Forbidden_403;
  11491. return true;
  11492. }
  11493. }
  11494. detail::FileStat stat(path);
  11495. if (stat.is_dir()) {
  11496. res.set_redirect(sub_path + "/", StatusCode::MovedPermanently_301);
  11497. return true;
  11498. }
  11499. if (stat.is_file()) {
  11500. for (const auto &kv : entry.headers) {
  11501. res.set_header(kv.first, kv.second);
  11502. }
  11503. auto content_type_of = [&]() {
  11504. return detail::find_content_type(
  11505. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  11506. };
  11507. // Only the ETag needs the content type this early, and only to name
  11508. // the coding. Deciding it here would otherwise put a regex in front
  11509. // of the 304 below, which serving a file never used to pay for.
  11510. std::string content_type;
  11511. auto encoding = detail::EncodingType::None;
  11512. if (static_file_compression_) {
  11513. content_type = content_type_of();
  11514. encoding =
  11515. static_file_encoding(req, res, content_type, stat.size());
  11516. }
  11517. // The ETag names the representation actually sent, so a client that
  11518. // cached the compressed form revalidates against the compressed ETag
  11519. // and still gets a 304, while one that took identity keeps the plain
  11520. // ETag.
  11521. auto etag = detail::compute_etag(
  11522. stat, encoding == detail::EncodingType::None
  11523. ? std::string()
  11524. : std::string("-") + detail::encoding_name(encoding));
  11525. if (!etag.empty()) { res.set_header("ETag", etag); }
  11526. auto mtime = stat.mtime();
  11527. auto last_modified = detail::file_mtime_to_http_date(mtime);
  11528. if (!last_modified.empty()) {
  11529. res.set_header("Last-Modified", last_modified);
  11530. }
  11531. if (check_if_not_modified(req, res, etag, mtime)) { return true; }
  11532. check_if_range(req, etag, mtime);
  11533. auto mm = std::make_shared<detail::mmap>(path.c_str());
  11534. if (!mm->is_open()) {
  11535. output_error_log(Error::OpenFile, &req);
  11536. return false;
  11537. }
  11538. if (!static_file_compression_) { content_type = content_type_of(); }
  11539. detail::set_file_content_provider(res, mm, content_type, encoding);
  11540. if (req.method != "HEAD" && file_request_handler_) {
  11541. file_request_handler_(req, res);
  11542. }
  11543. return true;
  11544. } else {
  11545. output_error_log(Error::OpenFile, &req);
  11546. }
  11547. }
  11548. }
  11549. }
  11550. return false;
  11551. }
  11552. inline bool Server::check_if_not_modified(const Request &req, Response &res,
  11553. const std::string &etag,
  11554. time_t mtime) const {
  11555. // Handle conditional GET:
  11556. // 1. If-None-Match takes precedence (RFC 9110 Section 13.1.2)
  11557. // 2. If-Modified-Since is checked only when If-None-Match is absent
  11558. if (req.has_header("If-None-Match")) {
  11559. if (!etag.empty()) {
  11560. auto val =
  11561. detail::get_combined_header_value(req.headers, "If-None-Match");
  11562. // NOTE: We use exact string matching here. This works correctly
  11563. // because our server always generates weak ETags (W/"..."), and
  11564. // clients typically send back the same ETag they received.
  11565. // RFC 9110 Section 8.8.3.2 allows weak comparison for
  11566. // If-None-Match, where W/"x" and "x" would match, but this
  11567. // simplified implementation requires exact matches.
  11568. auto ret = detail::split_find(val.data(), val.data() + val.size(), ',',
  11569. [&](const char *b, const char *e) {
  11570. auto seg_len = static_cast<size_t>(e - b);
  11571. return (seg_len == 1 && *b == '*') ||
  11572. (seg_len == etag.size() &&
  11573. std::equal(b, e, etag.begin()));
  11574. });
  11575. if (ret) {
  11576. res.status = StatusCode::NotModified_304;
  11577. return true;
  11578. }
  11579. }
  11580. } else if (req.has_header("If-Modified-Since")) {
  11581. auto val = req.get_header_value("If-Modified-Since");
  11582. auto t = detail::parse_http_date(val);
  11583. if (t != static_cast<time_t>(-1) && mtime <= t) {
  11584. res.status = StatusCode::NotModified_304;
  11585. return true;
  11586. }
  11587. }
  11588. return false;
  11589. }
  11590. inline bool Server::check_if_range(Request &req, const std::string &etag,
  11591. time_t mtime) const {
  11592. // Handle If-Range for partial content requests (RFC 9110
  11593. // Section 13.1.5). If-Range is only evaluated when Range header is
  11594. // present. If the validator matches, serve partial content; otherwise
  11595. // serve full content.
  11596. if (!req.ranges.empty() && req.has_header("If-Range")) {
  11597. auto val = req.get_header_value("If-Range");
  11598. auto is_valid_range = [&]() {
  11599. if (detail::is_strong_etag(val)) {
  11600. // RFC 9110 Section 13.1.5: If-Range requires strong ETag
  11601. // comparison.
  11602. return (!etag.empty() && val == etag);
  11603. } else if (detail::is_weak_etag(val)) {
  11604. // Weak ETags are not valid for If-Range (RFC 9110 Section 13.1.5)
  11605. return false;
  11606. } else {
  11607. // HTTP-date comparison
  11608. auto t = detail::parse_http_date(val);
  11609. return (t != static_cast<time_t>(-1) && mtime <= t);
  11610. }
  11611. };
  11612. if (!is_valid_range()) {
  11613. // Validator doesn't match: ignore Range and serve full content
  11614. req.ranges.clear();
  11615. return false;
  11616. }
  11617. }
  11618. return true;
  11619. }
  11620. inline socket_t
  11621. Server::create_server_socket(const std::string &host, int port,
  11622. int socket_flags,
  11623. SocketOptions socket_options) const {
  11624. return detail::create_socket(
  11625. host, std::string(), port, address_family_, socket_flags, tcp_nodelay_,
  11626. ipv6_v6only_, std::move(socket_options),
  11627. [&](socket_t sock, struct addrinfo &ai, bool & /*quit*/) -> bool {
  11628. if (::bind(sock, ai.ai_addr, static_cast<socklen_t>(ai.ai_addrlen))) {
  11629. output_error_log(Error::BindIPAddress, nullptr);
  11630. return false;
  11631. }
  11632. if (::listen(sock, CPPHTTPLIB_LISTEN_BACKLOG)) {
  11633. output_error_log(Error::Listen, nullptr);
  11634. return false;
  11635. }
  11636. return true;
  11637. });
  11638. }
  11639. inline int Server::bind_internal(const std::string &host, int port,
  11640. int socket_flags) {
  11641. if (is_decommissioned) { return -1; }
  11642. if (!is_valid()) { return -1; }
  11643. svr_sock_ = create_server_socket(host, port, socket_flags, socket_options_);
  11644. if (svr_sock_ == INVALID_SOCKET) { return -1; }
  11645. if (port == 0) {
  11646. struct sockaddr_storage addr;
  11647. socklen_t addr_len = sizeof(addr);
  11648. if (getsockname(svr_sock_, reinterpret_cast<struct sockaddr *>(&addr),
  11649. &addr_len) == -1) {
  11650. output_error_log(Error::GetSockName, nullptr);
  11651. return -1;
  11652. }
  11653. if (addr.ss_family == AF_INET) {
  11654. return ntohs(reinterpret_cast<struct sockaddr_in *>(&addr)->sin_port);
  11655. } else if (addr.ss_family == AF_INET6) {
  11656. return ntohs(reinterpret_cast<struct sockaddr_in6 *>(&addr)->sin6_port);
  11657. } else {
  11658. output_error_log(Error::UnsupportedAddressFamily, nullptr);
  11659. return -1;
  11660. }
  11661. } else {
  11662. return port;
  11663. }
  11664. }
  11665. inline bool Server::listen_internal() {
  11666. // A stop() between bind and listen leaves nothing to accept on. Report
  11667. // failure instead of returning success without ever serving, and mark the
  11668. // server decommissioned the way any failed listen does so that a concurrent
  11669. // wait_until_ready() wakes up instead of spinning forever.
  11670. if (is_decommissioned || svr_sock_ == INVALID_SOCKET) {
  11671. is_decommissioned = true;
  11672. return false;
  11673. }
  11674. auto ret = true;
  11675. is_running_ = true;
  11676. auto se = detail::scope_exit([&]() { is_running_ = false; });
  11677. if (start_handler_) { start_handler_(); }
  11678. {
  11679. std::unique_ptr<TaskQueue> task_queue(new_task_queue());
  11680. while (svr_sock_ != INVALID_SOCKET) {
  11681. #ifndef _WIN32
  11682. if (idle_interval_sec_ > 0 || idle_interval_usec_ > 0) {
  11683. #endif
  11684. auto val = detail::select_read(svr_sock_, idle_interval_sec_,
  11685. idle_interval_usec_);
  11686. if (val == 0) { // Timeout
  11687. task_queue->on_idle();
  11688. continue;
  11689. }
  11690. #ifndef _WIN32
  11691. }
  11692. #endif
  11693. #if defined _WIN32
  11694. // sockets connected via WASAccept inherit flags NO_HANDLE_INHERIT,
  11695. // OVERLAPPED
  11696. socket_t sock = WSAAccept(svr_sock_, nullptr, nullptr, nullptr, 0);
  11697. #elif defined SOCK_CLOEXEC
  11698. socket_t sock = accept4(svr_sock_, nullptr, nullptr, SOCK_CLOEXEC);
  11699. #else
  11700. socket_t sock = accept(svr_sock_, nullptr, nullptr);
  11701. #endif
  11702. if (sock == INVALID_SOCKET) {
  11703. // NOTE: Winsock reports failures through WSAGetLastError() and never
  11704. // touches the CRT errno, so the two have to be asked platform by
  11705. // platform rather than by testing errno here.
  11706. if (detail::is_accept_resource_error()) {
  11707. // The per-process descriptor limit or the network stack's buffer
  11708. // space has been reached. Try to accept new connections after a
  11709. // short sleep.
  11710. std::this_thread::sleep_for(std::chrono::microseconds{1});
  11711. continue;
  11712. } else if (detail::is_accept_transient_error()) {
  11713. continue;
  11714. }
  11715. // Take the descriptor out of svr_sock_ before closing it: a later
  11716. // stop() would otherwise shutdown()/close() a value the OS may have
  11717. // reused, and keep_alive() watches svr_sock_ to notice the server is
  11718. // gone. The exchange also settles the race with a concurrent stop(),
  11719. // since whichever side takes the descriptor closes it exactly once.
  11720. auto listen_sock = svr_sock_.exchange(INVALID_SOCKET);
  11721. if (listen_sock != INVALID_SOCKET) {
  11722. detail::close_socket(listen_sock);
  11723. ret = false;
  11724. output_error_log(Error::Connection, nullptr);
  11725. } else {
  11726. ; // The server socket was closed by user.
  11727. }
  11728. break;
  11729. }
  11730. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_RCVTIMEO,
  11731. read_timeout_sec_, read_timeout_usec_);
  11732. detail::set_socket_opt_time(sock, SOL_SOCKET, SO_SNDTIMEO,
  11733. write_timeout_sec_, write_timeout_usec_);
  11734. if (tcp_nodelay_) { set_socket_opt(sock, IPPROTO_TCP, TCP_NODELAY, 1); }
  11735. if (!task_queue->enqueue(
  11736. [this, sock]() { process_and_close_socket(sock); })) {
  11737. output_error_log(Error::ResourceExhaustion, nullptr);
  11738. detail::shutdown_socket(sock);
  11739. detail::close_socket(sock);
  11740. }
  11741. }
  11742. task_queue->shutdown();
  11743. }
  11744. is_decommissioned = !ret;
  11745. return ret;
  11746. }
  11747. inline bool Server::routing(Request &req, Response &res, Stream &strm) {
  11748. if (pre_routing_handler_ &&
  11749. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  11750. return true;
  11751. }
  11752. // File handler
  11753. if ((req.method == "GET" || req.method == "HEAD") &&
  11754. handle_file_request(req, res)) {
  11755. return true;
  11756. }
  11757. const auto *custom = find_custom_entry(req.method);
  11758. // The second clause mirrors what expect_content() does unconditionally for
  11759. // POST/PUT/PATCH/DELETE: a content reader route fires even when the request
  11760. // carries no body. Without it a body-less PROPFIND (RFC 4918 treats one as
  11761. // `allprop`) would skip its handler and fall through to 404.
  11762. if (detail::expect_content(req) ||
  11763. (custom && !custom->handlers_for_content_reader.empty())) {
  11764. // Content reader handler
  11765. {
  11766. // Track whether the ContentReader was aborted due to the decompressed
  11767. // payload exceeding `payload_max_length_`.
  11768. // The user handler runs after the lambda returns, so we must restore the
  11769. // 413 status if the handler overwrites it.
  11770. bool content_reader_payload_too_large = false;
  11771. ContentReader reader(
  11772. [&](ContentReceiver receiver) {
  11773. auto result = read_content_with_content_receiver(
  11774. strm, req, res, std::move(receiver), nullptr, nullptr);
  11775. if (!result) {
  11776. output_error_log(Error::Read, &req);
  11777. if (res.status == StatusCode::PayloadTooLarge_413) {
  11778. content_reader_payload_too_large = true;
  11779. }
  11780. }
  11781. return result;
  11782. },
  11783. [&](FormDataHeader header, ContentReceiver receiver) {
  11784. auto result = read_content_with_content_receiver(
  11785. strm, req, res, nullptr, std::move(header),
  11786. std::move(receiver));
  11787. if (!result) {
  11788. output_error_log(Error::Read, &req);
  11789. if (res.status == StatusCode::PayloadTooLarge_413) {
  11790. content_reader_payload_too_large = true;
  11791. }
  11792. }
  11793. return result;
  11794. });
  11795. bool dispatched = false;
  11796. if (req.method == "POST") {
  11797. dispatched = dispatch_request_for_content_reader(
  11798. req, res, std::move(reader), post_handlers_for_content_reader_);
  11799. } else if (req.method == "PUT") {
  11800. dispatched = dispatch_request_for_content_reader(
  11801. req, res, std::move(reader), put_handlers_for_content_reader_);
  11802. } else if (req.method == "PATCH") {
  11803. dispatched = dispatch_request_for_content_reader(
  11804. req, res, std::move(reader), patch_handlers_for_content_reader_);
  11805. } else if (req.method == "DELETE") {
  11806. dispatched = dispatch_request_for_content_reader(
  11807. req, res, std::move(reader), delete_handlers_for_content_reader_);
  11808. } else if (custom) {
  11809. dispatched = dispatch_request_for_content_reader(
  11810. req, res, std::move(reader), custom->handlers_for_content_reader);
  11811. }
  11812. if (dispatched) {
  11813. if (content_reader_payload_too_large) {
  11814. // Enforce the limit: override any status the handler may have set
  11815. // and return false so the error path sends a plain 413 response.
  11816. res.status = StatusCode::PayloadTooLarge_413;
  11817. res.body.clear();
  11818. res.content_length_ = 0;
  11819. res.content_provider_ = nullptr;
  11820. return false;
  11821. }
  11822. return true;
  11823. }
  11824. }
  11825. // NOTE: `req.body` is not read here. For a regular handler the body is
  11826. // read inside dispatch_request(), after the route has matched and the
  11827. // pre-request handler has approved the request, so that a rejected
  11828. // request (e.g. failed authentication) never forces us to buffer a
  11829. // potentially large body.
  11830. }
  11831. // Regular handler
  11832. if (req.method == "GET" || req.method == "HEAD") {
  11833. return dispatch_request(req, res, get_handlers_, strm);
  11834. } else if (req.method == "POST") {
  11835. return dispatch_request(req, res, post_handlers_, strm);
  11836. } else if (req.method == "PUT") {
  11837. return dispatch_request(req, res, put_handlers_, strm);
  11838. } else if (req.method == "DELETE") {
  11839. return dispatch_request(req, res, delete_handlers_, strm);
  11840. } else if (req.method == "OPTIONS") {
  11841. return dispatch_request(req, res, options_handlers_, strm);
  11842. } else if (req.method == "PATCH") {
  11843. return dispatch_request(req, res, patch_handlers_, strm);
  11844. } else if (custom) {
  11845. return dispatch_request(req, res, custom->handlers, strm);
  11846. }
  11847. res.status = StatusCode::BadRequest_400;
  11848. return false;
  11849. }
  11850. inline bool Server::dispatch_request(Request &req, Response &res,
  11851. const Handlers &handlers, Stream &strm) {
  11852. for (const auto &x : handlers) {
  11853. const auto &matcher = x.first;
  11854. const auto &handler = x.second;
  11855. if (matcher->match(req)) {
  11856. req.matched_route = matcher->pattern();
  11857. // Run the pre-request handler before reading the body so a rejected
  11858. // request (e.g. failed authentication) never forces us to buffer a
  11859. // potentially large body. `req.matched_route` is available here.
  11860. if (pre_request_handler_ &&
  11861. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  11862. return true;
  11863. }
  11864. // The route matched and the request was approved; read the body now.
  11865. if (detail::expect_content(req) && !read_content(strm, req, res)) {
  11866. output_error_log(Error::Read, &req);
  11867. return false;
  11868. }
  11869. handler(req, res);
  11870. return true;
  11871. }
  11872. }
  11873. return false;
  11874. }
  11875. // Decides the content coding for a response served straight from a file. Both
  11876. // the ETag, which has to name the representation actually sent, and
  11877. // `apply_static_file_compression()` go through this, so the two cannot drift
  11878. // apart.
  11879. inline detail::EncodingType
  11880. Server::static_file_encoding(const Request &req, const Response &res,
  11881. const std::string &content_type,
  11882. size_t length) const {
  11883. if (!static_file_compression_) { return detail::EncodingType::None; }
  11884. // Nothing to compress, and an empty file already answers with
  11885. // `Content-Length: 0`. Checked on its own so that a zero floor still cannot
  11886. // turn an empty body into a 20-byte gzip stream.
  11887. if (length == 0) { return detail::EncodingType::None; }
  11888. // A file that already fits in a single packet gains nothing from being made
  11889. // smaller, since it still travels in that one segment, and a file of a few
  11890. // bytes comes out larger than it went in.
  11891. if (length < static_file_compression_min_length_) {
  11892. return detail::EncodingType::None;
  11893. }
  11894. // RFC 9110 applies Range to the representation after content coding, so a
  11895. // compressed 206 would mean compressing the whole file and then slicing it.
  11896. // Serve ranges from the identity representation instead.
  11897. if (!req.ranges.empty()) { return detail::EncodingType::None; }
  11898. if (static_file_compression_max_length_ > 0 &&
  11899. length > static_file_compression_max_length_) {
  11900. return detail::EncodingType::None;
  11901. }
  11902. return detail::encoding_type(req, res, content_type);
  11903. }
  11904. // Compresses a file-backed content provider into `res.body` and takes over the
  11905. // framing headers. Returns false when the response is left untouched.
  11906. inline bool Server::apply_static_file_compression(const Request &req,
  11907. Response &res) const {
  11908. auto type = res.content_coding_;
  11909. if (type == detail::EncodingType::None || !res.content_provider_) {
  11910. return false;
  11911. }
  11912. auto compressor = detail::make_compressor(type);
  11913. if (!compressor) { return false; }
  11914. output_pre_compression_log(req, res);
  11915. std::string compressed;
  11916. if (!detail::compress_content_provider(res.content_provider_,
  11917. res.content_length_, *compressor,
  11918. compressed)) {
  11919. return false;
  11920. }
  11921. res.body.swap(compressed);
  11922. // The provider was consumed in full, so a resource releaser registered with
  11923. // it should hear about a success when the response goes away.
  11924. res.content_provider_success_ = true;
  11925. res.content_provider_ = nullptr;
  11926. res.content_length_ = 0;
  11927. res.content_coding_ = detail::EncodingType::None;
  11928. res.set_header("Content-Encoding", detail::encoding_name(type));
  11929. res.set_header("Vary", "Accept-Encoding");
  11930. res.set_header("Content-Length", std::to_string(res.body.size()));
  11931. return true;
  11932. }
  11933. inline void Server::apply_ranges(const Request &req, Response &res,
  11934. std::string &content_type,
  11935. std::string &boundary) const {
  11936. // A known-length content provider leaves `res.body` empty, so the compressor
  11937. // at the end of this function never runs for one (issue #2545). A file-backed
  11938. // provider is fully readable right here, so compress it and answer with an
  11939. // ordinary body: `Content-Length` and HEAD keep working, and the response
  11940. // takes the same path as `set_content()` from here on. Range requests never
  11941. // get a content coding, so `Content-Range` still names identity bytes and
  11942. // none of the framing below applies.
  11943. if (apply_static_file_compression(req, res)) { return; }
  11944. if (req.ranges.size() > 1 && res.status == StatusCode::PartialContent_206) {
  11945. auto it = res.headers.find("Content-Type");
  11946. if (it != res.headers.end()) {
  11947. content_type = it->second;
  11948. res.headers.erase(it);
  11949. }
  11950. boundary = detail::make_multipart_data_boundary();
  11951. res.set_header("Content-Type",
  11952. "multipart/byteranges; boundary=" + boundary);
  11953. }
  11954. auto type = detail::encoding_type(req, res);
  11955. if (res.body.empty()) {
  11956. if (res.content_length_ > 0) {
  11957. size_t length = 0;
  11958. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11959. length = res.content_length_;
  11960. } else if (req.ranges.size() == 1) {
  11961. auto offset_and_length = detail::get_range_offset_and_length(
  11962. req.ranges[0], res.content_length_);
  11963. length = offset_and_length.second;
  11964. auto content_range = detail::make_content_range_header_field(
  11965. offset_and_length, res.content_length_);
  11966. res.set_header("Content-Range", content_range);
  11967. } else {
  11968. length = detail::get_multipart_ranges_data_length(
  11969. req, boundary, content_type, res.content_length_);
  11970. }
  11971. res.set_header("Content-Length", std::to_string(length));
  11972. } else {
  11973. if (res.content_provider_) {
  11974. if (res.is_chunked_content_provider_) {
  11975. res.set_header("Transfer-Encoding", "chunked");
  11976. res.content_coding_ = type;
  11977. if (type != detail::EncodingType::None) {
  11978. res.set_header("Content-Encoding", detail::encoding_name(type));
  11979. res.set_header("Vary", "Accept-Encoding");
  11980. }
  11981. }
  11982. }
  11983. }
  11984. } else {
  11985. if (req.ranges.empty() || res.status != StatusCode::PartialContent_206) {
  11986. ;
  11987. } else if (req.ranges.size() == 1) {
  11988. auto offset_and_length =
  11989. detail::get_range_offset_and_length(req.ranges[0], res.body.size());
  11990. auto offset = offset_and_length.first;
  11991. auto length = offset_and_length.second;
  11992. auto content_range = detail::make_content_range_header_field(
  11993. offset_and_length, res.body.size());
  11994. res.set_header("Content-Range", content_range);
  11995. assert(offset + length <= res.body.size());
  11996. res.body = res.body.substr(offset, length);
  11997. } else {
  11998. std::string data;
  11999. detail::make_multipart_ranges_data(req, res, boundary, content_type,
  12000. res.body.size(), data);
  12001. res.body.swap(data);
  12002. }
  12003. if (type != detail::EncodingType::None) {
  12004. output_pre_compression_log(req, res);
  12005. if (auto compressor = detail::make_compressor(type)) {
  12006. std::string compressed;
  12007. if (compressor->compress(res.body.data(), res.body.size(), true,
  12008. [&](const char *data, size_t data_len) {
  12009. compressed.append(data, data_len);
  12010. return true;
  12011. })) {
  12012. res.body.swap(compressed);
  12013. res.set_header("Content-Encoding", detail::encoding_name(type));
  12014. res.set_header("Vary", "Accept-Encoding");
  12015. }
  12016. }
  12017. }
  12018. res.content_length_ = res.body.size();
  12019. res.set_header("Content-Length", std::to_string(res.content_length_));
  12020. }
  12021. }
  12022. inline bool Server::dispatch_request_for_content_reader(
  12023. Request &req, Response &res, ContentReader content_reader,
  12024. const HandlersForContentReader &handlers) const {
  12025. for (const auto &x : handlers) {
  12026. const auto &matcher = x.first;
  12027. const auto &handler = x.second;
  12028. if (matcher->match(req)) {
  12029. req.matched_route = matcher->pattern();
  12030. if (!pre_request_handler_ ||
  12031. pre_request_handler_(req, res) != HandlerResponse::Handled) {
  12032. handler(req, res, content_reader);
  12033. }
  12034. return true;
  12035. }
  12036. }
  12037. return false;
  12038. }
  12039. inline std::string
  12040. get_client_ip(const std::string &x_forwarded_for,
  12041. const std::vector<std::string> &trusted_proxies) {
  12042. // X-Forwarded-For is a comma-separated list per RFC 7239
  12043. std::vector<std::string> ip_list;
  12044. detail::split(x_forwarded_for.data(),
  12045. x_forwarded_for.data() + x_forwarded_for.size(), ',',
  12046. [&](const char *b, const char *e) {
  12047. auto r = detail::trim(b, e, 0, static_cast<size_t>(e - b));
  12048. ip_list.emplace_back(std::string(b + r.first, b + r.second));
  12049. });
  12050. // A malformed X-Forwarded-For (empty, comma-only, whitespace-only) yields
  12051. // no segments. Signal "no client IP derived" with an empty string so the
  12052. // caller can fall back to the connection-level remote address.
  12053. if (ip_list.empty()) { return std::string(); }
  12054. // Each hop appends the address it received the request from, so the rightmost
  12055. // entries are the ones written by our own infrastructure while the leftmost
  12056. // are whatever the original client chose to send. Walk from the right and
  12057. // skip trusted proxies; the first address that is not a trusted proxy is the
  12058. // furthest point still attributable to a real hop, i.e. the client. Scanning
  12059. // from the left instead lets a client forge an arbitrary address by following
  12060. // it with a trusted proxy's address, which the left-to-right scan then
  12061. // returned as the client.
  12062. for (size_t i = ip_list.size(); i-- > 0;) {
  12063. const auto &ip = ip_list[i];
  12064. auto is_trusted_proxy =
  12065. std::any_of(trusted_proxies.begin(), trusted_proxies.end(),
  12066. [&](const std::string &proxy) { return ip == proxy; });
  12067. if (!is_trusted_proxy) { return ip; }
  12068. }
  12069. // Every hop was a trusted proxy; fall back to the first entry.
  12070. return ip_list.front();
  12071. }
  12072. inline bool
  12073. Server::process_request(Stream &strm, const std::string &remote_addr,
  12074. int remote_port, const std::string &local_addr,
  12075. int local_port, bool close_connection,
  12076. bool &connection_closed,
  12077. const std::function<void(Request &)> &setup_request,
  12078. bool *websocket_upgraded) {
  12079. std::array<char, 2048> buf{};
  12080. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12081. // Connection has been closed on client
  12082. if (!line_reader.getline()) { return false; }
  12083. Request req;
  12084. req.start_time_ = std::chrono::steady_clock::now();
  12085. req.remote_addr = remote_addr;
  12086. req.remote_port = remote_port;
  12087. req.local_addr = local_addr;
  12088. req.local_port = local_port;
  12089. Response res;
  12090. res.version = "HTTP/1.1";
  12091. res.headers = default_headers_;
  12092. // Request line and headers
  12093. if (!parse_request_line(line_reader.ptr(), req)) {
  12094. res.status = StatusCode::BadRequest_400;
  12095. output_error_log(Error::InvalidRequestLine, &req);
  12096. return write_response(strm, close_connection, req, res);
  12097. }
  12098. // Request headers
  12099. if (!detail::read_headers(strm, req.headers)) {
  12100. res.status = StatusCode::BadRequest_400;
  12101. output_error_log(Error::InvalidHeaders, &req);
  12102. return write_response(strm, close_connection, req, res);
  12103. }
  12104. // RFC 9112 §6.3: Reject requests whose framing is ambiguous, which would
  12105. // otherwise let an intermediary and this parser disagree on where the body
  12106. // ends and enable request smuggling. Two cases: a non-zero Content-Length
  12107. // alongside any Transfer-Encoding (Content-Length: 0 is tolerated for
  12108. // compatibility with existing clients), and a Transfer-Encoding whose final
  12109. // coding is not chunked, which leaves the body length undeterminable. The
  12110. // latter must not fall through to the "no body" path, or the body bytes are
  12111. // parsed as the next request on a persistent connection.
  12112. if (detail::has_conflicting_content_length(req.headers) ||
  12113. (req.has_header("Transfer-Encoding") &&
  12114. !detail::is_chunked_transfer_encoding(req.headers))) {
  12115. connection_closed = true;
  12116. res.status = StatusCode::BadRequest_400;
  12117. return write_response(strm, close_connection, req, res);
  12118. }
  12119. // Check if the request URI doesn't exceed the limit
  12120. if (req.target.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  12121. connection_closed = true;
  12122. res.status = StatusCode::UriTooLong_414;
  12123. output_error_log(Error::ExceedUriMaxLength, &req);
  12124. return write_response(strm, close_connection, req, res);
  12125. }
  12126. if (detail::has_header_token(req.headers, "Connection", "close")) {
  12127. connection_closed = true;
  12128. }
  12129. if (req.version == "HTTP/1.0" &&
  12130. !detail::has_header_token(req.headers, "Connection", "keep-alive")) {
  12131. connection_closed = true;
  12132. }
  12133. // Only honor X-Forwarded-For if the peer on the actual TCP connection is
  12134. // itself a trusted proxy. Otherwise any direct client could spoof
  12135. // remote_addr simply by sending an arbitrary X-Forwarded-For header.
  12136. auto is_trusted_peer = std::any_of(
  12137. trusted_proxies_.begin(), trusted_proxies_.end(),
  12138. [&](const std::string &proxy) { return proxy == remote_addr; });
  12139. if (is_trusted_peer && req.has_header("X-Forwarded-For")) {
  12140. // Some proxies append the address they observed as a separate
  12141. // X-Forwarded-For field line instead of extending the one the client sent
  12142. // (e.g. HAProxy's "option forwardfor"), so the whole combined value has to
  12143. // be scanned. Reading only the first occurrence would hand back the
  12144. // client-supplied, and therefore forgeable, value.
  12145. auto x_forwarded_for =
  12146. detail::get_combined_header_value(req.headers, "X-Forwarded-For");
  12147. auto derived = get_client_ip(x_forwarded_for, trusted_proxies_);
  12148. req.remote_addr = derived.empty() ? remote_addr : derived;
  12149. } else {
  12150. req.remote_addr = remote_addr;
  12151. }
  12152. req.remote_port = remote_port;
  12153. req.local_addr = local_addr;
  12154. req.local_port = local_port;
  12155. if (req.has_header("Accept")) {
  12156. auto accept_header =
  12157. detail::get_combined_header_value(req.headers, "Accept");
  12158. if (!detail::parse_accept_header(accept_header, req.accept_content_types)) {
  12159. connection_closed = true;
  12160. res.status = StatusCode::BadRequest_400;
  12161. output_error_log(Error::HTTPParsing, &req);
  12162. return write_response(strm, close_connection, req, res);
  12163. }
  12164. }
  12165. if (req.has_header("Range")) {
  12166. const auto &range_header_value = req.get_header_value("Range");
  12167. if (!detail::parse_range_header(range_header_value, req.ranges)) {
  12168. connection_closed = true;
  12169. res.status = StatusCode::RangeNotSatisfiable_416;
  12170. output_error_log(Error::InvalidRangeHeader, &req);
  12171. return write_response(strm, close_connection, req, res);
  12172. }
  12173. }
  12174. if (setup_request) { setup_request(req); }
  12175. // RFC 9110 10.1.1: Expect is a comma-separated list whose value is
  12176. // case-insensitive, and a 100-continue expectation in an HTTP/1.0 request
  12177. // must be ignored. An expectation we do not recognize is left alone; the
  12178. // 417 the section allows for one is a MAY, not a requirement.
  12179. //
  12180. // `100 Continue` itself is deferred until the body is actually read (see
  12181. // read_content_core), so a request rejected by a later handler never
  12182. // invites the client to send a body nobody will read.
  12183. if (req.version != "HTTP/1.0" &&
  12184. detail::has_header_token(req.headers, "Expect", "100-continue")) {
  12185. int status = StatusCode::Continue_100;
  12186. if (expect_100_continue_handler_) {
  12187. status = expect_100_continue_handler_(req, res);
  12188. }
  12189. if (status == StatusCode::Continue_100) {
  12190. req.expect_100_continue_pending_ = true;
  12191. } else {
  12192. if (res.status == -1) { res.status = status; }
  12193. connection_closed = true;
  12194. return write_response(strm, true, req, res);
  12195. }
  12196. }
  12197. // Setup `is_connection_closed` method
  12198. auto sock = strm.socket();
  12199. req.is_connection_closed = [sock]() {
  12200. return !detail::is_socket_alive(sock);
  12201. };
  12202. // WebSocket upgrade
  12203. // Run pre_routing_handler_ and pre_request_handler_ before upgrading so
  12204. // that authentication and other middleware can reject the request with an
  12205. // HTTP response (e.g., 401) before the protocol switches.
  12206. if (detail::is_websocket_upgrade(req)) {
  12207. if (pre_routing_handler_ &&
  12208. pre_routing_handler_(req, res) == HandlerResponse::Handled) {
  12209. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12210. return write_response_with_content(strm, close_connection, req, res);
  12211. }
  12212. // Find matching WebSocket handler
  12213. for (const auto &entry : websocket_handlers_) {
  12214. if (entry.matcher->match(req)) {
  12215. req.matched_route = entry.matcher->pattern();
  12216. if (pre_request_handler_ &&
  12217. pre_request_handler_(req, res) == HandlerResponse::Handled) {
  12218. if (res.status == -1) { res.status = StatusCode::OK_200; }
  12219. return write_response_with_content(strm, close_connection, req, res);
  12220. }
  12221. // Compute accept key
  12222. auto client_key = req.get_header_value("Sec-WebSocket-Key");
  12223. auto accept_key = detail::websocket_accept_key(client_key);
  12224. // Negotiate subprotocol
  12225. std::string selected_subprotocol;
  12226. if (entry.sub_protocol_selector) {
  12227. auto protocol_header = detail::get_combined_header_value(
  12228. req.headers, "Sec-WebSocket-Protocol");
  12229. if (!protocol_header.empty()) {
  12230. std::vector<std::string> protocols;
  12231. detail::split(protocol_header.data(),
  12232. protocol_header.data() + protocol_header.size(), ',',
  12233. [&](const char *b, const char *e) {
  12234. protocols.emplace_back(b, e);
  12235. });
  12236. selected_subprotocol = entry.sub_protocol_selector(protocols);
  12237. }
  12238. }
  12239. // Send 101 Switching Protocols
  12240. std::string handshake_response = "HTTP/1.1 101 Switching Protocols\r\n"
  12241. "Upgrade: websocket\r\n"
  12242. "Connection: Upgrade\r\n"
  12243. "Sec-WebSocket-Accept: " +
  12244. accept_key + "\r\n";
  12245. if (!selected_subprotocol.empty()) {
  12246. if (!detail::fields::is_field_value(selected_subprotocol)) {
  12247. return false;
  12248. }
  12249. handshake_response +=
  12250. "Sec-WebSocket-Protocol: " + selected_subprotocol + "\r\n";
  12251. }
  12252. handshake_response += "\r\n";
  12253. if (strm.write(handshake_response.data(), handshake_response.size()) <
  12254. 0) {
  12255. return false;
  12256. }
  12257. connection_closed = true;
  12258. if (websocket_upgraded) { *websocket_upgraded = true; }
  12259. {
  12260. #ifdef CPPHTTPLIB_SSL_ENABLED
  12261. if (req.ssl) {
  12262. // wss: the heartbeat ping thread and the read path enter the same
  12263. // TLS session from different threads. Hand the WebSocket a stream
  12264. // that serializes every TLS call, so the shared SSLSocketStream on
  12265. // the plain HTTP/HTTPS paths stays untouched.
  12266. auto ws_strm =
  12267. std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  12268. strm.socket(), const_cast<tls::session_t>(req.ssl),
  12269. CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND, 0,
  12270. write_timeout_sec_, write_timeout_usec_));
  12271. ws::WebSocket ws(std::move(ws_strm), req, true,
  12272. websocket_ping_interval_sec_,
  12273. websocket_max_missed_pongs_);
  12274. entry.handler(req, ws);
  12275. return true;
  12276. }
  12277. #endif
  12278. // Use WebSocket-specific read timeout instead of HTTP timeout
  12279. strm.set_read_timeout(CPPHTTPLIB_WEBSOCKET_SERVER_READ_TIMEOUT_SECOND,
  12280. 0);
  12281. ws::WebSocket ws(strm, req, true, websocket_ping_interval_sec_,
  12282. websocket_max_missed_pongs_);
  12283. entry.handler(req, ws);
  12284. }
  12285. return true;
  12286. }
  12287. }
  12288. // No matching handler - fall through to 404
  12289. }
  12290. // Routing
  12291. auto routed = false;
  12292. #ifdef CPPHTTPLIB_NO_EXCEPTIONS
  12293. routed = routing(req, res, strm);
  12294. #else
  12295. try {
  12296. routed = routing(req, res, strm);
  12297. } catch (std::exception &) {
  12298. if (exception_handler_) {
  12299. auto ep = std::current_exception();
  12300. exception_handler_(req, res, ep);
  12301. routed = true;
  12302. } else {
  12303. res.status = StatusCode::InternalServerError_500;
  12304. }
  12305. } catch (...) {
  12306. if (exception_handler_) {
  12307. auto ep = std::current_exception();
  12308. exception_handler_(req, res, ep);
  12309. routed = true;
  12310. } else {
  12311. res.status = StatusCode::InternalServerError_500;
  12312. }
  12313. }
  12314. #endif
  12315. auto ret = false;
  12316. if (routed) {
  12317. if (res.status == -1) {
  12318. res.status = req.ranges.empty() ? StatusCode::OK_200
  12319. : StatusCode::PartialContent_206;
  12320. }
  12321. // Serve file content by using a content provider
  12322. auto file_open_error = false;
  12323. if (!res.file_content_path_.empty()) {
  12324. const auto &path = res.file_content_path_;
  12325. auto mm = std::make_shared<detail::mmap>(path.c_str());
  12326. if (!mm->is_open()) {
  12327. res.body.clear();
  12328. res.content_length_ = 0;
  12329. res.content_provider_ = nullptr;
  12330. res.status = StatusCode::NotFound_404;
  12331. output_error_log(Error::OpenFile, &req);
  12332. file_open_error = true;
  12333. } else {
  12334. auto content_type = res.file_content_content_type_;
  12335. if (content_type.empty()) {
  12336. content_type = detail::find_content_type(
  12337. path, file_extension_and_mimetype_map_, default_file_mimetype_);
  12338. }
  12339. detail::set_file_content_provider(
  12340. res, mm, content_type,
  12341. static_file_encoding(req, res, content_type, mm->size()));
  12342. }
  12343. }
  12344. if (file_open_error) {
  12345. ret = write_response(strm, close_connection, req, res);
  12346. } else if (detail::range_error(req, res)) {
  12347. res.body.clear();
  12348. res.content_length_ = 0;
  12349. res.content_provider_ = nullptr;
  12350. res.status = StatusCode::RangeNotSatisfiable_416;
  12351. ret = write_response(strm, close_connection, req, res);
  12352. } else {
  12353. ret = write_response_with_content(strm, close_connection, req, res);
  12354. }
  12355. } else {
  12356. if (res.status == -1) { res.status = StatusCode::NotFound_404; }
  12357. ret = write_response(strm, close_connection, req, res);
  12358. }
  12359. // Drain any unconsumed framed body to prevent request smuggling on
  12360. // keep-alive. Without framing there is no body to drain — reading would
  12361. // consume the next request (issue #2450). If the response has committed the
  12362. // connection to close, there is no next request to protect.
  12363. if (!req.body_consumed_ && detail::has_framed_body(req)) {
  12364. if (detail::has_header_token(res.headers, "Connection", "close")) {
  12365. connection_closed = true;
  12366. } else {
  12367. int dummy_status;
  12368. if (!detail::read_content(
  12369. strm, req, payload_max_length_, dummy_status, nullptr,
  12370. [](const char *, size_t, size_t, size_t) { return true; },
  12371. false)) {
  12372. connection_closed = true;
  12373. }
  12374. }
  12375. }
  12376. return ret;
  12377. }
  12378. inline bool Server::is_valid() const { return !has_invalid_registration_; }
  12379. inline bool Server::process_and_close_socket(socket_t sock) {
  12380. std::string remote_addr;
  12381. int remote_port = 0;
  12382. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  12383. std::string local_addr;
  12384. int local_port = 0;
  12385. detail::get_local_ip_and_port(sock, local_addr, local_port);
  12386. bool websocket_upgraded = false;
  12387. auto ret = serve_guarded([&]() {
  12388. return detail::process_server_socket(
  12389. svr_sock_, sock, keep_alive_max_count_, keep_alive_timeout_sec_,
  12390. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12391. write_timeout_usec_,
  12392. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  12393. return process_request(strm, remote_addr, remote_port, local_addr,
  12394. local_port, close_connection,
  12395. connection_closed, nullptr,
  12396. &websocket_upgraded);
  12397. });
  12398. });
  12399. detail::drain_and_close_socket(sock);
  12400. return ret;
  12401. }
  12402. inline void Server::output_log(const Request &req, const Response &res) const {
  12403. if (logger_) {
  12404. std::lock_guard<std::mutex> guard(logger_mutex_);
  12405. logger_(req, res);
  12406. }
  12407. }
  12408. inline void Server::output_pre_compression_log(const Request &req,
  12409. const Response &res) const {
  12410. if (pre_compression_logger_) {
  12411. std::lock_guard<std::mutex> guard(logger_mutex_);
  12412. pre_compression_logger_(req, res);
  12413. }
  12414. }
  12415. inline void Server::output_error_log(const Error &err,
  12416. const Request *req) const {
  12417. if (error_logger_) {
  12418. std::lock_guard<std::mutex> guard(logger_mutex_);
  12419. error_logger_(err, req);
  12420. }
  12421. }
  12422. /*
  12423. * Group 5: ClientImpl and Client (Universal) implementation
  12424. */
  12425. // HTTP client implementation
  12426. inline ClientImpl::ClientImpl(const std::string &host)
  12427. : ClientImpl(host, 80, std::string(), std::string()) {}
  12428. inline ClientImpl::ClientImpl(const std::string &host, int port)
  12429. : ClientImpl(host, port, std::string(), std::string()) {}
  12430. inline ClientImpl::ClientImpl(const std::string &host, int port,
  12431. const std::string &client_cert_path,
  12432. const std::string &client_key_path)
  12433. : host_(detail::escape_abstract_namespace_unix_domain(host)), port_(port),
  12434. client_cert_path_(client_cert_path), client_key_path_(client_key_path) {}
  12435. inline ClientImpl::~ClientImpl() {
  12436. // Wait until all the requests in flight are handled.
  12437. size_t retry_count = 10;
  12438. while (retry_count-- > 0) {
  12439. {
  12440. std::lock_guard<std::mutex> guard(socket_mutex_);
  12441. if (socket_requests_in_flight_ == 0) { break; }
  12442. }
  12443. std::this_thread::sleep_for(std::chrono::milliseconds{1});
  12444. }
  12445. std::lock_guard<std::mutex> guard(socket_mutex_);
  12446. shutdown_socket(socket_);
  12447. close_socket(socket_);
  12448. }
  12449. inline bool ClientImpl::is_valid() const { return true; }
  12450. inline void ClientImpl::copy_settings(const ClientImpl &rhs) {
  12451. client_cert_path_ = rhs.client_cert_path_;
  12452. client_key_path_ = rhs.client_key_path_;
  12453. connection_timeout_sec_ = rhs.connection_timeout_sec_;
  12454. read_timeout_sec_ = rhs.read_timeout_sec_;
  12455. read_timeout_usec_ = rhs.read_timeout_usec_;
  12456. write_timeout_sec_ = rhs.write_timeout_sec_;
  12457. write_timeout_usec_ = rhs.write_timeout_usec_;
  12458. max_timeout_msec_ = rhs.max_timeout_msec_;
  12459. basic_auth_username_ = rhs.basic_auth_username_;
  12460. basic_auth_password_ = rhs.basic_auth_password_;
  12461. bearer_token_auth_token_ = rhs.bearer_token_auth_token_;
  12462. keep_alive_ = rhs.keep_alive_;
  12463. follow_location_ = rhs.follow_location_;
  12464. path_encode_ = rhs.path_encode_;
  12465. address_family_ = rhs.address_family_;
  12466. tcp_nodelay_ = rhs.tcp_nodelay_;
  12467. ipv6_v6only_ = rhs.ipv6_v6only_;
  12468. socket_options_ = rhs.socket_options_;
  12469. compress_ = rhs.compress_;
  12470. decompress_ = rhs.decompress_;
  12471. payload_max_length_ = rhs.payload_max_length_;
  12472. has_payload_max_length_ = rhs.has_payload_max_length_;
  12473. interface_ = rhs.interface_;
  12474. proxy_host_ = rhs.proxy_host_;
  12475. proxy_port_ = rhs.proxy_port_;
  12476. proxy_basic_auth_username_ = rhs.proxy_basic_auth_username_;
  12477. proxy_basic_auth_password_ = rhs.proxy_basic_auth_password_;
  12478. proxy_bearer_token_auth_token_ = rhs.proxy_bearer_token_auth_token_;
  12479. no_proxy_entries_ = rhs.no_proxy_entries_;
  12480. logger_ = rhs.logger_;
  12481. error_logger_ = rhs.error_logger_;
  12482. #ifdef CPPHTTPLIB_SSL_ENABLED
  12483. digest_auth_username_ = rhs.digest_auth_username_;
  12484. digest_auth_password_ = rhs.digest_auth_password_;
  12485. proxy_digest_auth_username_ = rhs.proxy_digest_auth_username_;
  12486. proxy_digest_auth_password_ = rhs.proxy_digest_auth_password_;
  12487. ca_cert_file_path_ = rhs.ca_cert_file_path_;
  12488. ca_cert_dir_path_ = rhs.ca_cert_dir_path_;
  12489. server_certificate_verification_ = rhs.server_certificate_verification_;
  12490. server_hostname_verification_ = rhs.server_hostname_verification_;
  12491. system_ca_mode_ = rhs.system_ca_mode_;
  12492. #endif
  12493. }
  12494. inline bool
  12495. ClientImpl::is_proxy_enabled_for_host(const std::string &host) const {
  12496. if (proxy_host_.empty() || proxy_port_ == -1) { return false; }
  12497. if (no_proxy_entries_.empty()) { return true; }
  12498. // host_ is const so its normalized form is invariant; cache it. The
  12499. // cross-host path (setup_redirect_client passing next_host) re-normalizes.
  12500. if (host == host_) {
  12501. if (!host_normalized_valid_) {
  12502. host_normalized_ = detail::normalize_target(host_);
  12503. host_normalized_valid_ = true;
  12504. }
  12505. return !detail::host_matches_no_proxy(host_normalized_, no_proxy_entries_);
  12506. }
  12507. auto target = detail::normalize_target(host);
  12508. return !detail::host_matches_no_proxy(target, no_proxy_entries_);
  12509. }
  12510. inline socket_t ClientImpl::create_client_socket(Error &error) const {
  12511. if (is_proxy_enabled_for_host(host_)) {
  12512. return detail::create_client_socket(
  12513. proxy_host_, std::string(), proxy_port_, address_family_, tcp_nodelay_,
  12514. ipv6_v6only_, socket_options_, connection_timeout_sec_,
  12515. connection_timeout_usec_, read_timeout_sec_, read_timeout_usec_,
  12516. write_timeout_sec_, write_timeout_usec_, interface_, error);
  12517. }
  12518. // Check is custom IP or hostname specified for host_
  12519. std::string connect_host;
  12520. std::string ip;
  12521. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  12522. return detail::create_client_socket(
  12523. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  12524. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  12525. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12526. write_timeout_usec_, interface_, error);
  12527. }
  12528. inline bool ClientImpl::create_and_connect_socket(Socket &socket,
  12529. Error &error) {
  12530. auto sock = create_client_socket(error);
  12531. if (sock == INVALID_SOCKET) { return false; }
  12532. socket.sock = sock;
  12533. return true;
  12534. }
  12535. inline bool ClientImpl::ensure_socket_connection(Socket &socket, Error &error) {
  12536. return create_and_connect_socket(socket, error);
  12537. }
  12538. inline bool ClientImpl::setup_proxy_connection(
  12539. Socket & /*socket*/,
  12540. std::chrono::time_point<std::chrono::steady_clock> /*start_time*/,
  12541. Response & /*res*/, bool & /*success*/, Error & /*error*/) {
  12542. return true;
  12543. }
  12544. inline void ClientImpl::shutdown_ssl(Socket & /*socket*/,
  12545. bool /*shutdown_gracefully*/) {
  12546. // If there are any requests in flight from threads other than us, then it's
  12547. // a thread-unsafe race because individual ssl* objects are not thread-safe.
  12548. assert(socket_requests_in_flight_ == 0 ||
  12549. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12550. }
  12551. inline void ClientImpl::shutdown_socket(Socket &socket) const {
  12552. if (socket.sock == INVALID_SOCKET) { return; }
  12553. detail::shutdown_socket(socket.sock);
  12554. }
  12555. inline void ClientImpl::close_socket(Socket &socket) {
  12556. // If there are requests in flight in another thread, usually closing
  12557. // the socket will be fine and they will simply receive an error when
  12558. // using the closed socket, but it is still a bug since rarely the OS
  12559. // may reassign the socket id to be used for a new socket, and then
  12560. // suddenly they will be operating on a live socket that is different
  12561. // than the one they intended!
  12562. assert(socket_requests_in_flight_ == 0 ||
  12563. socket_requests_are_from_thread_ == std::this_thread::get_id());
  12564. // It is also a bug if this happens while SSL is still active
  12565. #ifdef CPPHTTPLIB_SSL_ENABLED
  12566. assert(socket.ssl == nullptr);
  12567. #endif
  12568. if (socket.sock == INVALID_SOCKET) { return; }
  12569. detail::close_socket(socket.sock);
  12570. socket.sock = INVALID_SOCKET;
  12571. }
  12572. inline void ClientImpl::disconnect(bool gracefully) {
  12573. shutdown_ssl(socket_, gracefully);
  12574. shutdown_socket(socket_);
  12575. close_socket(socket_);
  12576. }
  12577. inline bool ClientImpl::read_response_line(Stream &strm, const Request &req,
  12578. Response &res,
  12579. bool skip_100_continue) const {
  12580. std::array<char, 2048> buf{};
  12581. detail::stream_line_reader line_reader(strm, buf.data(), buf.size());
  12582. if (!line_reader.getline()) { return false; }
  12583. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12584. res.reason)) {
  12585. return req.method == "CONNECT";
  12586. }
  12587. // Ignore '100 Continue' (only when not using Expect: 100-continue explicitly)
  12588. while (skip_100_continue && res.status == StatusCode::Continue_100) {
  12589. if (!line_reader.getline()) { return false; } // CRLF
  12590. if (!line_reader.getline()) { return false; } // next response line
  12591. if (!detail::parse_status_line(line_reader.ptr(), res.version, res.status,
  12592. res.reason)) {
  12593. return false;
  12594. }
  12595. }
  12596. return true;
  12597. }
  12598. inline bool ClientImpl::send(Request &req, Response &res, Error &error) {
  12599. std::lock_guard<std::recursive_mutex> request_mutex_guard(request_mutex_);
  12600. auto ret = send_(req, res, error);
  12601. if (error == Error::SSLPeerCouldBeClosed_) {
  12602. assert(!ret);
  12603. ret = send_(req, res, error);
  12604. // If still failing with SSLPeerCouldBeClosed_, convert to Read error
  12605. if (error == Error::SSLPeerCouldBeClosed_) { error = Error::Read; }
  12606. }
  12607. return ret;
  12608. }
  12609. inline bool ClientImpl::send_(Request &req, Response &res, Error &error) {
  12610. {
  12611. std::lock_guard<std::mutex> guard(socket_mutex_);
  12612. // Set this to false immediately - if it ever gets set to true by the end
  12613. // of the request, we know another thread instructed us to close the
  12614. // socket.
  12615. socket_should_be_closed_when_request_is_done_ = false;
  12616. auto is_alive = false;
  12617. if (socket_.is_open()) {
  12618. is_alive = detail::is_socket_alive(socket_.sock);
  12619. #ifdef CPPHTTPLIB_SSL_ENABLED
  12620. if (is_alive && is_ssl()) {
  12621. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12622. is_alive = false;
  12623. }
  12624. }
  12625. #endif
  12626. if (!is_alive) {
  12627. // Peer seems gone — non-graceful shutdown to avoid SIGPIPE.
  12628. disconnect(/*gracefully=*/false);
  12629. }
  12630. }
  12631. if (!is_alive) {
  12632. if (!ensure_socket_connection(socket_, error)) {
  12633. output_error_log(error, &req);
  12634. return false;
  12635. }
  12636. {
  12637. auto success = true;
  12638. if (!setup_proxy_connection(socket_, req.start_time_, res, success,
  12639. error)) {
  12640. if (!success) { output_error_log(error, &req); }
  12641. return success;
  12642. }
  12643. }
  12644. }
  12645. // Mark the current socket as being in use so that it cannot be closed by
  12646. // anyone else while this request is ongoing, even though we will be
  12647. // releasing the mutex.
  12648. if (socket_requests_in_flight_ > 1) {
  12649. assert(socket_requests_are_from_thread_ == std::this_thread::get_id());
  12650. }
  12651. socket_requests_in_flight_ += 1;
  12652. socket_requests_are_from_thread_ = std::this_thread::get_id();
  12653. }
  12654. for (const auto &header : default_headers_) {
  12655. if (req.headers.find(header.first) == req.headers.end()) {
  12656. req.headers.insert(header);
  12657. }
  12658. }
  12659. auto ret = false;
  12660. auto close_connection = !keep_alive_;
  12661. auto se = detail::scope_exit([&]() {
  12662. // Briefly lock mutex in order to mark that a request is no longer ongoing
  12663. std::lock_guard<std::mutex> guard(socket_mutex_);
  12664. socket_requests_in_flight_ -= 1;
  12665. if (socket_requests_in_flight_ <= 0) {
  12666. assert(socket_requests_in_flight_ == 0);
  12667. socket_requests_are_from_thread_ = std::thread::id();
  12668. }
  12669. if (socket_should_be_closed_when_request_is_done_ || close_connection ||
  12670. !ret) {
  12671. disconnect(/*gracefully=*/true);
  12672. }
  12673. });
  12674. ret = process_socket(socket_, req.start_time_, [&](Stream &strm) {
  12675. return handle_request(strm, req, res, close_connection, error);
  12676. });
  12677. if (!ret) {
  12678. if (error == Error::Success) {
  12679. error = Error::Unknown;
  12680. output_error_log(error, &req);
  12681. }
  12682. }
  12683. return ret;
  12684. }
  12685. inline Result ClientImpl::send(const Request &req) {
  12686. auto req2 = req;
  12687. return send_(std::move(req2));
  12688. }
  12689. inline Result ClientImpl::send_(Request &&req) {
  12690. auto res = detail::make_unique<Response>();
  12691. auto error = Error::Success;
  12692. auto ret = send(req, *res, error);
  12693. #ifdef CPPHTTPLIB_SSL_ENABLED
  12694. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers),
  12695. last_ssl_error_, last_backend_error_};
  12696. #else
  12697. return Result{ret ? std::move(res) : nullptr, error, std::move(req.headers)};
  12698. #endif
  12699. }
  12700. inline void ClientImpl::prepare_default_headers(Request &r, bool for_stream,
  12701. const std::string &ct) {
  12702. (void)for_stream;
  12703. // Default headers are meant for the origin and may carry its credentials, so
  12704. // keep them off the CONNECT request the proxy reads.
  12705. if (r.method != "CONNECT") {
  12706. for (const auto &header : default_headers_) {
  12707. if (!r.has_header(header.first)) { r.headers.insert(header); }
  12708. }
  12709. }
  12710. // RFC 9110 5.3 recommends sending control data such as Host first, so
  12711. // prepend it rather than appending it after the caller's own fields.
  12712. if (!r.has_header("Host")) {
  12713. r.headers.emplace_front(
  12714. "Host", detail::make_default_host_header_value(host_, port_, is_ssl(),
  12715. address_family_));
  12716. }
  12717. if (!r.has_header("Accept")) { r.headers.emplace("Accept", "*/*"); }
  12718. if (!r.content_receiver) {
  12719. if (!r.has_header("Accept-Encoding")) {
  12720. std::string accept_encoding;
  12721. #ifdef CPPHTTPLIB_BROTLI_SUPPORT
  12722. accept_encoding = "br";
  12723. #endif
  12724. #ifdef CPPHTTPLIB_ZLIB_SUPPORT
  12725. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12726. accept_encoding += "gzip, deflate";
  12727. #endif
  12728. #ifdef CPPHTTPLIB_ZSTD_SUPPORT
  12729. if (!accept_encoding.empty()) { accept_encoding += ", "; }
  12730. accept_encoding += "zstd";
  12731. #endif
  12732. r.set_header("Accept-Encoding", accept_encoding);
  12733. }
  12734. detail::add_default_user_agent_header(r);
  12735. }
  12736. if (!r.body.empty()) {
  12737. if (!ct.empty() && !r.has_header("Content-Type")) {
  12738. r.headers.emplace("Content-Type", ct);
  12739. }
  12740. if (!r.has_header("Content-Length")) {
  12741. r.headers.emplace("Content-Length", std::to_string(r.body.size()));
  12742. }
  12743. }
  12744. }
  12745. inline ClientImpl::StreamHandle
  12746. ClientImpl::open_stream(const std::string &method, const std::string &path,
  12747. const Params &params, const Headers &headers,
  12748. const std::string &body,
  12749. const std::string &content_type) {
  12750. StreamHandle handle;
  12751. handle.response = detail::make_unique<Response>();
  12752. handle.error = Error::Success;
  12753. // Encode the target exactly like the buffered send path does, so that the
  12754. // same `path` produces the same request line through either API.
  12755. auto raw_query_path =
  12756. params.empty() ? path : append_query_params(path, params);
  12757. auto query_path = detail::encode_request_target(raw_query_path, path_encode_);
  12758. handle.connection_ = detail::make_unique<ClientConnection>();
  12759. {
  12760. std::lock_guard<std::mutex> guard(socket_mutex_);
  12761. auto is_alive = false;
  12762. if (socket_.is_open()) {
  12763. is_alive = detail::is_socket_alive(socket_.sock);
  12764. #ifdef CPPHTTPLIB_SSL_ENABLED
  12765. if (is_alive && is_ssl()) {
  12766. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  12767. is_alive = false;
  12768. }
  12769. }
  12770. #endif
  12771. if (!is_alive) { disconnect(/*gracefully=*/false); }
  12772. }
  12773. if (!is_alive) {
  12774. if (!ensure_socket_connection(socket_, handle.error)) {
  12775. handle.response.reset();
  12776. return handle;
  12777. }
  12778. {
  12779. auto success = true;
  12780. auto start_time = std::chrono::steady_clock::now();
  12781. if (!setup_proxy_connection(socket_, start_time, *handle.response,
  12782. success, handle.error)) {
  12783. if (!success) { handle.response.reset(); }
  12784. return handle;
  12785. }
  12786. }
  12787. }
  12788. transfer_socket_ownership_to_handle(handle);
  12789. }
  12790. #ifdef CPPHTTPLIB_SSL_ENABLED
  12791. if (is_ssl() && handle.connection_->session) {
  12792. handle.socket_stream_ = detail::make_unique<detail::SSLSocketStream>(
  12793. handle.connection_->sock, handle.connection_->session,
  12794. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  12795. write_timeout_usec_);
  12796. } else {
  12797. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12798. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12799. write_timeout_sec_, write_timeout_usec_);
  12800. }
  12801. #else
  12802. handle.socket_stream_ = detail::make_unique<detail::SocketStream>(
  12803. handle.connection_->sock, read_timeout_sec_, read_timeout_usec_,
  12804. write_timeout_sec_, write_timeout_usec_);
  12805. #endif
  12806. handle.stream_ = handle.socket_stream_.get();
  12807. Request req;
  12808. req.method = method;
  12809. req.path = query_path;
  12810. req.headers = headers;
  12811. req.body = body;
  12812. prepare_default_headers(req, true, content_type);
  12813. auto &strm = *handle.stream_;
  12814. // Build the request line and headers in memory first, like write_request()
  12815. // does, so that a rejected header leaves nothing on the wire.
  12816. {
  12817. detail::BufferStream bstrm;
  12818. if (detail::write_request_line(bstrm, req.method, req.path) < 0) {
  12819. handle.error = Error::Write;
  12820. handle.response.reset();
  12821. return handle;
  12822. }
  12823. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  12824. handle.error)) {
  12825. handle.response.reset();
  12826. return handle;
  12827. }
  12828. const auto &data = bstrm.get_buffer();
  12829. if (!detail::write_data(strm, data.data(), data.size())) {
  12830. handle.error = Error::Write;
  12831. handle.response.reset();
  12832. return handle;
  12833. }
  12834. }
  12835. if (!body.empty()) {
  12836. if (strm.write(body.data(), body.size()) < 0) {
  12837. handle.error = Error::Write;
  12838. handle.response.reset();
  12839. return handle;
  12840. }
  12841. }
  12842. if (!read_response_line(strm, req, *handle.response) ||
  12843. !detail::read_headers(strm, handle.response->headers)) {
  12844. handle.error = Error::Read;
  12845. handle.response.reset();
  12846. return handle;
  12847. }
  12848. // Same framing check as ClientImpl::process_request(). A HEAD or bodyless
  12849. // (204/304) response legitimately carries framing headers with no body.
  12850. if (method != "HEAD" &&
  12851. handle.response->status != StatusCode::NoContent_204 &&
  12852. handle.response->status != StatusCode::NotModified_304 &&
  12853. detail::has_conflicting_content_length(handle.response->headers)) {
  12854. handle.error = Error::Read;
  12855. handle.response.reset();
  12856. return handle;
  12857. }
  12858. handle.body_reader_.stream = handle.stream_;
  12859. handle.body_reader_.payload_max_length = payload_max_length_;
  12860. if (handle.response->has_header("Content-Length")) {
  12861. bool is_invalid = false;
  12862. auto content_length = detail::get_header_value_u64(
  12863. handle.response->headers, "Content-Length", 0, 0, is_invalid);
  12864. if (is_invalid) {
  12865. handle.error = Error::Read;
  12866. handle.response.reset();
  12867. return handle;
  12868. }
  12869. handle.body_reader_.has_content_length = true;
  12870. handle.body_reader_.content_length = content_length;
  12871. }
  12872. handle.body_reader_.chunked =
  12873. detail::is_chunked_transfer_encoding(handle.response->headers);
  12874. auto content_encoding = detail::get_combined_header_value(
  12875. handle.response->headers, "Content-Encoding");
  12876. if (!content_encoding.empty()) {
  12877. // Same policy as prepare_content_receiver(): reject a coding we know about
  12878. // but were not built with, pass an unrecognized one through as-is.
  12879. handle.decompressor_ = detail::create_decompressor(content_encoding);
  12880. if (!handle.decompressor_) {
  12881. if (detail::is_known_content_encoding(content_encoding)) {
  12882. handle.error = Error::UnsupportedContentEncoding;
  12883. handle.response.reset();
  12884. return handle;
  12885. }
  12886. } else if (!handle.decompressor_->is_valid()) {
  12887. handle.error = Error::Compression;
  12888. handle.response.reset();
  12889. return handle;
  12890. }
  12891. }
  12892. return handle;
  12893. }
  12894. inline ssize_t ClientImpl::StreamHandle::read(char *buf, size_t len) {
  12895. if (!is_valid() || !response) { return -1; }
  12896. if (decompressor_) { return read_with_decompression(buf, len); }
  12897. auto n = detail::read_body_content(stream_, body_reader_, buf, len);
  12898. if (n <= 0 && body_reader_.chunked && !trailers_parsed_ && stream_) {
  12899. trailers_parsed_ = true;
  12900. if (body_reader_.chunked_decoder) {
  12901. if (!body_reader_.chunked_decoder->parse_trailers_into(
  12902. response->trailers, response->headers)) {
  12903. return n;
  12904. }
  12905. } else {
  12906. detail::ChunkedDecoder dec(*stream_);
  12907. if (!dec.parse_trailers_into(response->trailers, response->headers)) {
  12908. return n;
  12909. }
  12910. }
  12911. }
  12912. return n;
  12913. }
  12914. inline ssize_t ClientImpl::StreamHandle::read_with_decompression(char *buf,
  12915. size_t len) {
  12916. if (decompress_offset_ < decompress_buffer_.size()) {
  12917. auto available = decompress_buffer_.size() - decompress_offset_;
  12918. auto to_copy = (std::min)(len, available);
  12919. std::memcpy(buf, decompress_buffer_.data() + decompress_offset_, to_copy);
  12920. decompress_offset_ += to_copy;
  12921. decompressed_bytes_read_ += to_copy;
  12922. return static_cast<ssize_t>(to_copy);
  12923. }
  12924. decompress_buffer_.clear();
  12925. decompress_offset_ = 0;
  12926. constexpr size_t kDecompressionBufferSize = 8192;
  12927. char compressed_buf[kDecompressionBufferSize];
  12928. while (true) {
  12929. auto n = detail::read_body_content(stream_, body_reader_, compressed_buf,
  12930. sizeof(compressed_buf));
  12931. if (n <= 0) { return n; }
  12932. bool decompress_ok = decompressor_->decompress(
  12933. compressed_buf, static_cast<size_t>(n),
  12934. [this](const char *data, size_t data_len) {
  12935. decompress_buffer_.append(data, data_len);
  12936. auto limit = body_reader_.payload_max_length;
  12937. if (decompressed_bytes_read_ + decompress_buffer_.size() > limit) {
  12938. return false;
  12939. }
  12940. return true;
  12941. });
  12942. if (!decompress_ok) {
  12943. body_reader_.last_error = Error::Read;
  12944. return -1;
  12945. }
  12946. if (!decompress_buffer_.empty()) { break; }
  12947. }
  12948. auto to_copy = (std::min)(len, decompress_buffer_.size());
  12949. std::memcpy(buf, decompress_buffer_.data(), to_copy);
  12950. decompress_offset_ = to_copy;
  12951. decompressed_bytes_read_ += to_copy;
  12952. return static_cast<ssize_t>(to_copy);
  12953. }
  12954. inline void ClientImpl::StreamHandle::parse_trailers_if_needed() {
  12955. if (!response || !stream_ || !body_reader_.chunked || trailers_parsed_) {
  12956. return;
  12957. }
  12958. trailers_parsed_ = true;
  12959. const auto bufsiz = 128;
  12960. char line_buf[bufsiz];
  12961. detail::stream_line_reader line_reader(*stream_, line_buf, bufsiz);
  12962. if (!line_reader.getline()) { return; }
  12963. if (!detail::parse_trailers(line_reader, response->trailers,
  12964. response->headers)) {
  12965. return;
  12966. }
  12967. }
  12968. namespace detail {
  12969. inline ChunkedDecoder::ChunkedDecoder(Stream &s) : strm(s) {}
  12970. inline ssize_t ChunkedDecoder::read_payload(char *buf, size_t len,
  12971. size_t &out_chunk_offset,
  12972. size_t &out_chunk_total) {
  12973. if (finished) { return 0; }
  12974. if (chunk_remaining == 0) {
  12975. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  12976. if (!lr.getline()) { return -1; }
  12977. // Everything below is bounded by eol rather than by the buffer's NUL, so
  12978. // the line terminator is never mistaken for line content.
  12979. const char *eol = lr.ptr() + lr.size();
  12980. if (lr.end_with_crlf()) {
  12981. eol -= 2;
  12982. } else if (eol != lr.ptr() && eol[-1] == '\n') {
  12983. // Only reachable under CPPHTTPLIB_ALLOW_LF_AS_LINE_TERMINATOR, where
  12984. // getline() ends the line on a bare LF. That LF is the terminator, so it
  12985. // has to come off here or the check below would reject the line.
  12986. eol -= 1;
  12987. }
  12988. // RFC 9112 §7.1: chunk-size = 1*HEXDIG
  12989. const char *p = lr.ptr();
  12990. int v = 0;
  12991. if (p == eol || !is_hex(*p, v)) { return -1; }
  12992. size_t chunk_len = 0;
  12993. constexpr size_t chunk_len_max = (std::numeric_limits<size_t>::max)();
  12994. for (; p < eol && is_hex(*p, v); ++p) {
  12995. if (chunk_len > (chunk_len_max >> 4)) { return -1; }
  12996. chunk_len = (chunk_len << 4) | static_cast<size_t>(v);
  12997. }
  12998. while (p < eol && is_space_or_tab(*p)) {
  12999. ++p;
  13000. }
  13001. // RFC 9112 §7.1.1: only a chunk-ext may sit between the size and the line
  13002. // terminator, and it is built from tokens and quoted-strings, so it never
  13003. // holds a CR, LF or any other control character. getline() reads up to the
  13004. // CRLF, so a bare LF left in here would be swallowed as extension text
  13005. // while an intermediary that ends the line on it delimits the chunks
  13006. // differently, and the two disagree on where the body ends (request
  13007. // smuggling).
  13008. if (p < eol && *p != ';') { return -1; }
  13009. for (; p < eol; ++p) {
  13010. if (!is_space_or_tab(*p) && !fields::is_field_vchar(*p)) { return -1; }
  13011. }
  13012. if (chunk_len == 0) {
  13013. chunk_remaining = 0;
  13014. finished = true;
  13015. out_chunk_offset = 0;
  13016. out_chunk_total = 0;
  13017. return 0;
  13018. }
  13019. chunk_remaining = chunk_len;
  13020. last_chunk_total = chunk_remaining;
  13021. last_chunk_offset = 0;
  13022. }
  13023. auto to_read = (std::min)(chunk_remaining, len);
  13024. auto n = strm.read(buf, to_read);
  13025. if (n <= 0) { return -1; }
  13026. auto offset_before = last_chunk_offset;
  13027. last_chunk_offset += static_cast<size_t>(n);
  13028. chunk_remaining -= static_cast<size_t>(n);
  13029. out_chunk_offset = offset_before;
  13030. out_chunk_total = last_chunk_total;
  13031. if (chunk_remaining == 0) {
  13032. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13033. if (!lr.getline()) { return -1; }
  13034. if (std::strcmp(lr.ptr(), "\r\n") != 0) { return -1; }
  13035. }
  13036. return n;
  13037. }
  13038. inline bool ChunkedDecoder::parse_trailers_into(Headers &dest,
  13039. const Headers &src_headers) {
  13040. stream_line_reader lr(strm, line_buf, sizeof(line_buf));
  13041. if (!lr.getline()) { return false; }
  13042. return parse_trailers(lr, dest, src_headers);
  13043. }
  13044. } // namespace detail
  13045. inline void
  13046. ClientImpl::transfer_socket_ownership_to_handle(StreamHandle &handle) {
  13047. handle.connection_->sock = socket_.sock;
  13048. #ifdef CPPHTTPLIB_SSL_ENABLED
  13049. handle.connection_->session = socket_.ssl;
  13050. socket_.ssl = nullptr;
  13051. #endif
  13052. socket_.sock = INVALID_SOCKET;
  13053. }
  13054. inline bool ClientImpl::handle_request(Stream &strm, Request &req,
  13055. Response &res, bool close_connection,
  13056. Error &error) {
  13057. if (req.path.empty()) {
  13058. error = Error::Connection;
  13059. output_error_log(error, &req);
  13060. return false;
  13061. }
  13062. auto req_save = req;
  13063. bool ret;
  13064. if (!is_ssl() && is_proxy_enabled_for_host(host_)) {
  13065. auto req2 = req;
  13066. req2.path = "http://" +
  13067. detail::make_host_and_port_string(host_, port_, false) +
  13068. req.path;
  13069. ret = process_request(strm, req2, res, close_connection, error);
  13070. req = std::move(req2);
  13071. req.path = req_save.path;
  13072. } else {
  13073. ret = process_request(strm, req, res, close_connection, error);
  13074. }
  13075. if (!ret) { return false; }
  13076. if (detail::has_header_token(res.headers, "Connection", "close") ||
  13077. (res.version == "HTTP/1.0" && res.reason != "Connection established")) {
  13078. // NOTE: this requires a not-entirely-obvious chain of calls to be correct
  13079. // for this to be safe.
  13080. // This is safe to call because handle_request is only called by send_
  13081. // which locks the request mutex during the process. It would be a bug
  13082. // to call it from a different thread since it's a thread-safety issue
  13083. // to do these things to the socket if another thread is using the socket.
  13084. std::lock_guard<std::mutex> guard(socket_mutex_);
  13085. disconnect(/*gracefully=*/true);
  13086. }
  13087. if (300 < res.status && res.status < 400 && follow_location_) {
  13088. req = std::move(req_save);
  13089. ret = redirect(req, res, error);
  13090. }
  13091. #ifdef CPPHTTPLIB_SSL_ENABLED
  13092. if ((res.status == StatusCode::Unauthorized_401 ||
  13093. res.status == StatusCode::ProxyAuthenticationRequired_407) &&
  13094. req.authorization_count_ < 5) {
  13095. auto is_proxy = res.status == StatusCode::ProxyAuthenticationRequired_407;
  13096. // Only retry when the 407 actually came from a proxy hop: plain HTTP
  13097. // through an enabled proxy. HTTPS via CONNECT tunnels the 407 from the
  13098. // origin (#2457); direct/bypassed origins have no proxy hop at all.
  13099. if (is_proxy && !(!is_ssl() && is_proxy_enabled_for_host(host_))) {
  13100. return ret;
  13101. }
  13102. const auto &username =
  13103. is_proxy ? proxy_digest_auth_username_ : digest_auth_username_;
  13104. const auto &password =
  13105. is_proxy ? proxy_digest_auth_password_ : digest_auth_password_;
  13106. if (!username.empty() && !password.empty()) {
  13107. std::map<std::string, std::string> auth;
  13108. if (detail::parse_www_authenticate(res, auth, is_proxy)) {
  13109. Request new_req = req;
  13110. new_req.authorization_count_ += 1;
  13111. new_req.headers.erase(is_proxy ? "Proxy-Authorization"
  13112. : "Authorization");
  13113. new_req.headers.insert(detail::make_digest_authentication_header(
  13114. req, auth, new_req.authorization_count_, detail::random_string(10),
  13115. username, password, is_proxy));
  13116. Response new_res;
  13117. ret = send(new_req, new_res, error);
  13118. if (ret) { res = std::move(new_res); }
  13119. }
  13120. }
  13121. }
  13122. #endif
  13123. return ret;
  13124. }
  13125. inline bool ClientImpl::redirect(Request &req, Response &res, Error &error) {
  13126. if (req.redirect_count_ == 0) {
  13127. error = Error::ExceedRedirectCount;
  13128. output_error_log(error, &req);
  13129. return false;
  13130. }
  13131. auto location = res.get_header_value("location");
  13132. if (location.empty()) { return false; }
  13133. detail::UrlComponents uc;
  13134. if (!detail::parse_url(location, uc)) { return false; }
  13135. // Only follow http/https redirects
  13136. if (!uc.scheme.empty() && uc.scheme != "http" && uc.scheme != "https") {
  13137. return false;
  13138. }
  13139. auto scheme = is_ssl() ? "https" : "http";
  13140. auto next_scheme = std::move(uc.scheme);
  13141. auto next_host = std::move(uc.host);
  13142. auto port_str = std::move(uc.port);
  13143. auto next_path = std::move(uc.path);
  13144. auto next_query = std::move(uc.query);
  13145. auto next_port = port_;
  13146. if (!port_str.empty()) {
  13147. if (!detail::parse_port(port_str, next_port)) { return false; }
  13148. } else if (!next_scheme.empty()) {
  13149. next_port = next_scheme == "https" ? 443 : 80;
  13150. }
  13151. if (next_scheme.empty()) { next_scheme = scheme; }
  13152. if (next_host.empty()) { next_host = host_; }
  13153. if (next_path.empty()) { next_path = "/"; }
  13154. auto path = decode_path_component(next_path) + next_query;
  13155. // Same host redirect - use current client
  13156. if (next_scheme == scheme && next_host == host_ && next_port == port_) {
  13157. return detail::redirect(*this, req, res, path, location, error);
  13158. }
  13159. // Cross-host/scheme redirect - create new client with robust setup
  13160. return create_redirect_client(next_scheme, next_host, next_port, req, res,
  13161. path, location, error);
  13162. }
  13163. // New method for robust redirect client creation
  13164. inline bool ClientImpl::create_redirect_client(
  13165. const std::string &scheme, const std::string &host, int port, Request &req,
  13166. Response &res, const std::string &path, const std::string &location,
  13167. Error &error) {
  13168. // Determine if we need SSL
  13169. auto need_ssl = (scheme == "https");
  13170. // Clean up request headers that are host/client specific
  13171. // Remove headers that should not be carried over to new host
  13172. auto headers_to_remove = std::vector<std::string>{
  13173. "Host", "Proxy-Authorization", "Authorization", "Cookie", "Cookie2"};
  13174. for (const auto &header_name : headers_to_remove) {
  13175. auto it = req.headers.find(header_name);
  13176. while (it != req.headers.end()) {
  13177. it = req.headers.erase(it);
  13178. it = req.headers.find(header_name);
  13179. }
  13180. }
  13181. // Create appropriate client type and handle redirect
  13182. if (need_ssl) {
  13183. #ifdef CPPHTTPLIB_SSL_ENABLED
  13184. // Create SSL client for HTTPS redirect
  13185. SSLClient redirect_client(host, port);
  13186. // Setup basic client configuration first
  13187. setup_redirect_client(redirect_client);
  13188. redirect_client.enable_server_certificate_verification(
  13189. server_certificate_verification_);
  13190. redirect_client.enable_server_hostname_verification(
  13191. server_hostname_verification_);
  13192. redirect_client.system_ca_mode_ = system_ca_mode_;
  13193. // Transfer CA certificate to redirect client
  13194. if (!ca_cert_pem_.empty()) {
  13195. redirect_client.load_ca_cert_store(ca_cert_pem_.c_str(),
  13196. ca_cert_pem_.size());
  13197. }
  13198. if (!ca_cert_file_path_.empty()) {
  13199. redirect_client.set_ca_cert_path(ca_cert_file_path_, ca_cert_dir_path_);
  13200. }
  13201. // Client certificates are set through constructor for SSLClient
  13202. // NOTE: SSLClient constructor already takes client_cert_path and
  13203. // client_key_path so we need to create it properly if client certs are
  13204. // needed
  13205. // Execute the redirect
  13206. return detail::redirect(redirect_client, req, res, path, location, error);
  13207. #else
  13208. // SSL not supported - set appropriate error
  13209. error = Error::SSLConnection;
  13210. output_error_log(error, &req);
  13211. return false;
  13212. #endif
  13213. } else {
  13214. // HTTP redirect
  13215. ClientImpl redirect_client(host, port);
  13216. // Setup client with robust configuration
  13217. setup_redirect_client(redirect_client);
  13218. // Execute the redirect
  13219. return detail::redirect(redirect_client, req, res, path, location, error);
  13220. }
  13221. }
  13222. // New method for robust client setup (based on basic_manual_redirect.cpp
  13223. // logic)
  13224. template <typename ClientType>
  13225. inline void ClientImpl::setup_redirect_client(ClientType &client) {
  13226. // Copy basic settings first
  13227. client.set_connection_timeout(connection_timeout_sec_);
  13228. client.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13229. client.set_write_timeout(write_timeout_sec_, write_timeout_usec_);
  13230. client.set_keep_alive(keep_alive_);
  13231. client.set_follow_location(
  13232. true); // Enable redirects to handle multi-step redirects
  13233. client.set_path_encode(path_encode_);
  13234. client.set_compress(compress_);
  13235. client.set_decompress(decompress_);
  13236. // NOTE: Authentication credentials (basic auth, bearer token, digest auth)
  13237. // are intentionally NOT copied to the redirect client. Per RFC 9110 Section
  13238. // 15.4, credentials must not be forwarded when redirecting to a different
  13239. // host. This function is only called for cross-host redirects; same-host
  13240. // redirects are handled directly in ClientImpl::redirect().
  13241. // Copy the proxy configuration unconditionally; the per-target bypass is
  13242. // re-evaluated at send time, so a later hop to a non-bypassed host can
  13243. // still use the proxy.
  13244. client.no_proxy_entries_ = no_proxy_entries_;
  13245. if (!proxy_host_.empty() && proxy_port_ != -1) {
  13246. client.set_proxy(proxy_host_, proxy_port_);
  13247. if (!proxy_basic_auth_username_.empty()) {
  13248. client.set_proxy_basic_auth(proxy_basic_auth_username_,
  13249. proxy_basic_auth_password_);
  13250. }
  13251. if (!proxy_bearer_token_auth_token_.empty()) {
  13252. client.set_proxy_bearer_token_auth(proxy_bearer_token_auth_token_);
  13253. }
  13254. #ifdef CPPHTTPLIB_SSL_ENABLED
  13255. if (!proxy_digest_auth_username_.empty()) {
  13256. client.set_proxy_digest_auth(proxy_digest_auth_username_,
  13257. proxy_digest_auth_password_);
  13258. }
  13259. #endif
  13260. }
  13261. // Copy network and socket settings
  13262. client.set_address_family(address_family_);
  13263. client.set_tcp_nodelay(tcp_nodelay_);
  13264. client.set_ipv6_v6only(ipv6_v6only_);
  13265. if (socket_options_) { client.set_socket_options(socket_options_); }
  13266. if (!interface_.empty()) { client.set_interface(interface_); }
  13267. // Copy logging and headers
  13268. if (logger_) { client.set_logger(logger_); }
  13269. if (error_logger_) { client.set_error_logger(error_logger_); }
  13270. // NOTE: DO NOT copy default_headers_ as they may contain stale Host headers
  13271. // Each new client should generate its own headers based on its target host
  13272. }
  13273. inline bool ClientImpl::write_content_with_provider(Stream &strm,
  13274. const Request &req,
  13275. Error &error) const {
  13276. auto is_shutting_down = []() { return false; };
  13277. if (req.is_chunked_content_provider_) {
  13278. auto compressor = compress_ ? detail::create_compressor().first
  13279. : std::unique_ptr<detail::compressor>();
  13280. if (!compressor) {
  13281. compressor = detail::make_unique<detail::nocompressor>();
  13282. }
  13283. return detail::write_content_chunked(strm, req.content_provider_,
  13284. is_shutting_down, *compressor, error);
  13285. } else {
  13286. return detail::write_content_with_progress(
  13287. strm, req.content_provider_, 0, req.content_length_, is_shutting_down,
  13288. req.upload_progress, error);
  13289. }
  13290. }
  13291. inline bool ClientImpl::write_request(Stream &strm, Request &req,
  13292. bool close_connection, Error &error,
  13293. bool skip_body, bool &rejected_locally) {
  13294. rejected_locally = false;
  13295. // Prepare additional headers
  13296. if (close_connection) {
  13297. if (!req.has_header("Connection")) {
  13298. req.set_header("Connection", "close");
  13299. }
  13300. }
  13301. std::string ct_for_defaults;
  13302. if (!req.has_header("Content-Type") && !req.body.empty()) {
  13303. ct_for_defaults = "text/plain";
  13304. }
  13305. prepare_default_headers(req, false, ct_for_defaults);
  13306. if (req.body.empty()) {
  13307. if (req.content_provider_) {
  13308. if (!req.is_chunked_content_provider_) {
  13309. if (!req.has_header("Content-Length")) {
  13310. auto length = std::to_string(req.content_length_);
  13311. req.set_header("Content-Length", length);
  13312. }
  13313. }
  13314. } else {
  13315. if (req.method == "POST" || req.method == "PUT" ||
  13316. req.method == "PATCH") {
  13317. req.set_header("Content-Length", "0");
  13318. }
  13319. }
  13320. }
  13321. // A CONNECT request is read by the proxy; everything sent through the tunnel
  13322. // it opens is read by the origin. Each credential goes only to its own hop.
  13323. auto is_connect = req.method == "CONNECT";
  13324. if (!is_connect && !req.has_header("Authorization")) {
  13325. if (!basic_auth_password_.empty() || !basic_auth_username_.empty()) {
  13326. req.headers.insert(make_basic_authentication_header(
  13327. basic_auth_username_, basic_auth_password_, false));
  13328. } else if (!bearer_token_auth_token_.empty()) {
  13329. req.headers.insert(make_bearer_token_authentication_header(
  13330. bearer_token_auth_token_, false));
  13331. }
  13332. }
  13333. // Proxy-Authorization is only sent when the proxy reads this message —
  13334. // otherwise NO_PROXY-matched requests, and requests inside a TLS tunnel,
  13335. // would leak proxy credentials to the destination server.
  13336. if (is_proxy_enabled_for_host(host_) && (!is_ssl() || is_connect)) {
  13337. if (!proxy_basic_auth_username_.empty() &&
  13338. !proxy_basic_auth_password_.empty() &&
  13339. !req.has_header("Proxy-Authorization")) {
  13340. req.headers.insert(make_basic_authentication_header(
  13341. proxy_basic_auth_username_, proxy_basic_auth_password_, true));
  13342. }
  13343. if (!proxy_bearer_token_auth_token_.empty() &&
  13344. !req.has_header("Proxy-Authorization")) {
  13345. req.headers.insert(make_bearer_token_authentication_header(
  13346. proxy_bearer_token_auth_token_, true));
  13347. }
  13348. }
  13349. // Request line and headers
  13350. {
  13351. detail::BufferStream bstrm;
  13352. // Extract the query from req.path. The encoding itself is delegated to
  13353. // `encode_request_target`; the raw query is still needed here to decide
  13354. // between populating `req.params` from it and falling back to building a
  13355. // query out of caller-supplied `req.params`.
  13356. auto query_pos = req.path.find('?');
  13357. auto query_part = query_pos == std::string::npos
  13358. ? std::string()
  13359. : req.path.substr(query_pos + 1);
  13360. auto path_with_query =
  13361. detail::encode_request_target(req.path, path_encode_);
  13362. if (!query_part.empty()) {
  13363. // The query already came in through `req.path`; still populate
  13364. // `req.params` for handlers/users who read them.
  13365. detail::parse_query_text(query_part, req.params);
  13366. } else if (!req.params.empty()) {
  13367. // No query in `req.path`; build one from `req.params` so existing
  13368. // callers that pass `Params` separately continue to work.
  13369. path_with_query = append_query_params(path_with_query, req.params);
  13370. }
  13371. // Write request line and headers
  13372. if (detail::write_request_line(bstrm, req.method, path_with_query) < 0) {
  13373. // A rejected method (not a token, e.g. carrying CR/LF) or target (e.g.
  13374. // CR/LF smuggled in via a decoded redirect Location under
  13375. // set_path_encode(false)) must fail the request cleanly instead of
  13376. // emitting a request-line-less, header-injecting request.
  13377. error = Error::Write;
  13378. rejected_locally = true;
  13379. output_error_log(error, &req);
  13380. return false;
  13381. }
  13382. if (!detail::check_and_write_headers(bstrm, req.headers, header_writer_,
  13383. error)) {
  13384. rejected_locally = true;
  13385. output_error_log(error, &req);
  13386. return false;
  13387. }
  13388. // Flush buffer
  13389. auto &data = bstrm.get_buffer();
  13390. if (!detail::write_data(strm, data.data(), data.size())) {
  13391. error = Error::Write;
  13392. output_error_log(error, &req);
  13393. return false;
  13394. }
  13395. }
  13396. // After sending request line and headers, wait briefly for an early server
  13397. // response (e.g. 4xx) and avoid sending a potentially large request body
  13398. // unnecessarily. This workaround is only enabled on Windows because Unix
  13399. // platforms surface write errors (EPIPE) earlier; on Windows kernel send
  13400. // buffering can accept large writes even when the peer already responded.
  13401. // Check the stream first (which covers SSL via `is_readable()`), then
  13402. // fall back to select on the socket. Only perform the wait for very large
  13403. // request bodies to avoid interfering with normal small requests and
  13404. // reduce side-effects. Poll briefly (up to 50ms as default) for an early
  13405. // response. Skip this check when using Expect: 100-continue, as the protocol
  13406. // handles early responses properly.
  13407. #if defined(_WIN32)
  13408. if (!skip_body &&
  13409. req.body.size() > CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_THRESHOLD &&
  13410. req.path.size() > CPPHTTPLIB_REQUEST_URI_MAX_LENGTH) {
  13411. auto start = std::chrono::high_resolution_clock::now();
  13412. for (;;) {
  13413. // Prefer socket-level readiness to avoid SSL_pending() false-positives
  13414. // from SSL internals. If the underlying socket is readable, assume an
  13415. // early response may be present.
  13416. auto sock = strm.socket();
  13417. if (sock != INVALID_SOCKET && detail::select_read(sock, 0, 0) > 0) {
  13418. return false;
  13419. }
  13420. // Fallback to stream-level check for non-socket streams or when the
  13421. // socket isn't reporting readable. Avoid using `is_readable()` for
  13422. // SSL, since `SSL_pending()` may report buffered records that do not
  13423. // indicate a complete application-level response yet.
  13424. if (!is_ssl() && strm.is_readable()) { return false; }
  13425. auto now = std::chrono::high_resolution_clock::now();
  13426. auto elapsed =
  13427. std::chrono::duration_cast<std::chrono::milliseconds>(now - start)
  13428. .count();
  13429. if (elapsed >= CPPHTTPLIB_WAIT_EARLY_SERVER_RESPONSE_TIMEOUT_MSECOND) {
  13430. break;
  13431. }
  13432. std::this_thread::sleep_for(std::chrono::milliseconds(1));
  13433. }
  13434. }
  13435. #endif
  13436. // Body
  13437. if (skip_body) { return true; }
  13438. return write_request_body(strm, req, error);
  13439. }
  13440. inline bool ClientImpl::write_request_body(Stream &strm, Request &req,
  13441. Error &error) {
  13442. if (req.body.empty()) {
  13443. return write_content_with_provider(strm, req, error);
  13444. }
  13445. if (req.upload_progress) {
  13446. auto body_size = req.body.size();
  13447. size_t written = 0;
  13448. auto data = req.body.data();
  13449. while (written < body_size) {
  13450. size_t to_write = (std::min)(CPPHTTPLIB_SEND_BUFSIZ, body_size - written);
  13451. if (!detail::write_data(strm, data + written, to_write)) {
  13452. error = Error::Write;
  13453. output_error_log(error, &req);
  13454. return false;
  13455. }
  13456. written += to_write;
  13457. if (!req.upload_progress(written, body_size)) {
  13458. error = Error::Canceled;
  13459. output_error_log(error, &req);
  13460. return false;
  13461. }
  13462. }
  13463. } else {
  13464. if (!detail::write_data(strm, req.body.data(), req.body.size())) {
  13465. error = Error::Write;
  13466. output_error_log(error, &req);
  13467. return false;
  13468. }
  13469. }
  13470. return true;
  13471. }
  13472. inline std::unique_ptr<Response>
  13473. ClientImpl::send_with_content_provider_and_receiver(
  13474. Request &req, const char *body, size_t content_length,
  13475. ContentProvider content_provider,
  13476. ContentProviderWithoutLength content_provider_without_length,
  13477. const std::string &content_type, ContentReceiver content_receiver,
  13478. Error &error) {
  13479. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  13480. auto enc = compress_
  13481. ? detail::create_compressor()
  13482. : std::pair<std::unique_ptr<detail::compressor>, const char *>(
  13483. nullptr, nullptr);
  13484. if (enc.second) { req.set_header("Content-Encoding", enc.second); }
  13485. if (enc.first && !content_provider_without_length) {
  13486. auto &compressor = enc.first;
  13487. if (content_provider) {
  13488. auto ok = true;
  13489. auto finished = false;
  13490. size_t offset = 0;
  13491. DataSink data_sink;
  13492. data_sink.write = [&](const char *data, size_t data_len) -> bool {
  13493. if (ok) {
  13494. auto last = offset + data_len == content_length;
  13495. auto ret = compressor->compress(
  13496. data, data_len, last,
  13497. [&](const char *compressed_data, size_t compressed_data_len) {
  13498. req.body.append(compressed_data, compressed_data_len);
  13499. return true;
  13500. });
  13501. if (ret) {
  13502. offset += data_len;
  13503. } else {
  13504. ok = false;
  13505. }
  13506. }
  13507. return ok;
  13508. };
  13509. // As in detail::write_content_with_progress(): the body is framed by
  13510. // content_length, so a provider that finishes early has truncated it.
  13511. // Stop and report that instead of calling the provider forever.
  13512. data_sink.done = [&]() { finished = true; };
  13513. while (ok && !finished && offset < content_length) {
  13514. if (!content_provider(offset, content_length - offset, data_sink)) {
  13515. error = Error::Canceled;
  13516. output_error_log(error, &req);
  13517. return nullptr;
  13518. }
  13519. }
  13520. // A short body here means either the provider stopped early or the
  13521. // compressor gave up. The branch below reports a failing compressor as
  13522. // Error::Compression, so keep the two distinguishable.
  13523. if (offset < content_length) {
  13524. error = ok ? Error::Write : Error::Compression;
  13525. output_error_log(error, &req);
  13526. return nullptr;
  13527. }
  13528. } else {
  13529. if (!compressor->compress(body, content_length, true,
  13530. [&](const char *data, size_t data_len) {
  13531. req.body.append(data, data_len);
  13532. return true;
  13533. })) {
  13534. error = Error::Compression;
  13535. output_error_log(error, &req);
  13536. return nullptr;
  13537. }
  13538. }
  13539. } else {
  13540. if (content_provider) {
  13541. req.content_length_ = content_length;
  13542. req.content_provider_ = std::move(content_provider);
  13543. req.is_chunked_content_provider_ = false;
  13544. } else if (content_provider_without_length) {
  13545. req.content_length_ = 0;
  13546. req.content_provider_ = detail::ContentProviderAdapter(
  13547. std::move(content_provider_without_length));
  13548. req.is_chunked_content_provider_ = true;
  13549. req.set_header("Transfer-Encoding", "chunked");
  13550. } else {
  13551. req.body.assign(body, content_length);
  13552. }
  13553. }
  13554. if (content_receiver) {
  13555. req.content_receiver =
  13556. [content_receiver](const char *data, size_t data_length,
  13557. size_t /*offset*/, size_t /*total_length*/) {
  13558. return content_receiver(data, data_length);
  13559. };
  13560. }
  13561. auto res = detail::make_unique<Response>();
  13562. return send(req, *res, error) ? std::move(res) : nullptr;
  13563. }
  13564. inline Result ClientImpl::send_with_content_provider_and_receiver(
  13565. const std::string &method, const std::string &path, const Headers &headers,
  13566. const char *body, size_t content_length, ContentProvider content_provider,
  13567. ContentProviderWithoutLength content_provider_without_length,
  13568. const std::string &content_type, ContentReceiver content_receiver,
  13569. UploadProgress progress) {
  13570. Request req;
  13571. req.method = method;
  13572. req.headers = headers;
  13573. req.path = path;
  13574. req.upload_progress = std::move(progress);
  13575. if (max_timeout_msec_ > 0) {
  13576. req.start_time_ = std::chrono::steady_clock::now();
  13577. }
  13578. auto error = Error::Success;
  13579. auto res = send_with_content_provider_and_receiver(
  13580. req, body, content_length, std::move(content_provider),
  13581. std::move(content_provider_without_length), content_type,
  13582. std::move(content_receiver), error);
  13583. #ifdef CPPHTTPLIB_SSL_ENABLED
  13584. return Result{std::move(res), error, std::move(req.headers), last_ssl_error_,
  13585. last_backend_error_};
  13586. #else
  13587. return Result{std::move(res), error, std::move(req.headers)};
  13588. #endif
  13589. }
  13590. inline void ClientImpl::output_log(const Request &req,
  13591. const Response &res) const {
  13592. if (logger_) {
  13593. std::lock_guard<std::mutex> guard(logger_mutex_);
  13594. logger_(req, res);
  13595. }
  13596. }
  13597. inline void ClientImpl::output_error_log(const Error &err,
  13598. const Request *req) const {
  13599. if (error_logger_) {
  13600. std::lock_guard<std::mutex> guard(logger_mutex_);
  13601. error_logger_(err, req);
  13602. }
  13603. }
  13604. inline bool ClientImpl::process_request(Stream &strm, Request &req,
  13605. Response &res, bool close_connection,
  13606. Error &error) {
  13607. // Auto-add Expect: 100-continue for large bodies
  13608. if (CPPHTTPLIB_EXPECT_100_THRESHOLD > 0 && !req.has_header("Expect")) {
  13609. auto body_size = req.body.empty() ? req.content_length_ : req.body.size();
  13610. if (body_size >= CPPHTTPLIB_EXPECT_100_THRESHOLD) {
  13611. req.set_header("Expect", "100-continue");
  13612. }
  13613. }
  13614. // Check for Expect: 100-continue
  13615. auto expect_100_continue =
  13616. detail::has_header_token(req.headers, "Expect", "100-continue");
  13617. // Send request (skip body if using Expect: 100-continue)
  13618. auto rejected_locally = false;
  13619. auto write_request_success =
  13620. write_request(strm, req, close_connection, error, expect_100_continue,
  13621. rejected_locally);
  13622. // A failed write normally still reads the response below, since the server
  13623. // may have answered early (e.g. 413/414) and closed while the body was being
  13624. // sent. A request rejected before any byte reached the socket gets no such
  13625. // response, and waiting for one would block until the read timeout.
  13626. if (rejected_locally) { return false; }
  13627. #ifdef CPPHTTPLIB_SSL_ENABLED
  13628. if (is_ssl() && !expect_100_continue) {
  13629. auto is_proxy_enabled = is_proxy_enabled_for_host(host_);
  13630. if (!is_proxy_enabled) {
  13631. if (tls::is_peer_closed(socket_.ssl, socket_.sock)) {
  13632. error = Error::SSLPeerCouldBeClosed_;
  13633. output_error_log(error, &req);
  13634. return false;
  13635. }
  13636. }
  13637. }
  13638. #endif
  13639. // Handle Expect: 100-continue.
  13640. //
  13641. // Wait for an interim/early response by attempting to read the status line
  13642. // under a short timeout, instead of trusting raw socket readability. Over
  13643. // TLS, post-handshake records (e.g. session tickets) make the socket
  13644. // readable without any HTTP response being available; relying on
  13645. // `select_read` there caused the body to be withheld forever and the
  13646. // request to fail with `Read` (#2458). If no status line arrives within the
  13647. // timeout, send the body anyway (matching curl's behavior).
  13648. auto status_line_read = false;
  13649. if (expect_100_continue && write_request_success) {
  13650. if (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND > 0) {
  13651. time_t sec = CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND / 1000;
  13652. time_t usec = (CPPHTTPLIB_EXPECT_100_TIMEOUT_MSECOND % 1000) * 1000;
  13653. strm.set_read_timeout(sec, usec);
  13654. status_line_read = read_response_line(strm, req, res, false);
  13655. strm.set_read_timeout(read_timeout_sec_, read_timeout_usec_);
  13656. }
  13657. if (!status_line_read) {
  13658. // No interim response within the timeout: send the body and handle the
  13659. // response as usual.
  13660. if (!write_request_body(strm, req, error)) { return false; }
  13661. expect_100_continue = false; // Switch to normal response handling
  13662. }
  13663. }
  13664. // Receive response and headers
  13665. // When using Expect: 100-continue, don't auto-skip `100 Continue` response
  13666. if ((!status_line_read &&
  13667. !read_response_line(strm, req, res, !expect_100_continue)) ||
  13668. !detail::read_headers(strm, res.headers)) {
  13669. if (write_request_success) { error = Error::Read; }
  13670. output_error_log(error, &req);
  13671. return false;
  13672. }
  13673. if (!write_request_success) { return false; }
  13674. // Handle Expect: 100-continue response
  13675. if (expect_100_continue) {
  13676. if (res.status == StatusCode::Continue_100) {
  13677. // Server accepted, send the body
  13678. if (!write_request_body(strm, req, error)) { return false; }
  13679. // Read the actual response
  13680. res.headers.clear();
  13681. res.body.clear();
  13682. if (!read_response_line(strm, req, res) ||
  13683. !detail::read_headers(strm, res.headers)) {
  13684. error = Error::Read;
  13685. output_error_log(error, &req);
  13686. return false;
  13687. }
  13688. }
  13689. // If not 100 Continue, server returned an error; proceed with that response
  13690. }
  13691. // Body
  13692. if ((res.status != StatusCode::NoContent_204) && req.method != "HEAD" &&
  13693. req.method != "CONNECT") {
  13694. // Reject ambiguous framing (RFC 9112 §6.3). Unlike a request, a response
  13695. // whose final transfer coding is not chunked is not ambiguous: its body
  13696. // runs until the server closes the connection, so it is not rejected.
  13697. // HEAD/204 are excluded above and a 304 carries no body.
  13698. if (res.status != StatusCode::NotModified_304 &&
  13699. detail::has_conflicting_content_length(res.headers)) {
  13700. error = Error::Read;
  13701. output_error_log(error, &req);
  13702. return false;
  13703. }
  13704. auto redirect = 300 < res.status && res.status < 400 &&
  13705. res.status != StatusCode::NotModified_304 &&
  13706. follow_location_;
  13707. if (req.response_handler && !redirect) {
  13708. if (!req.response_handler(res)) {
  13709. error = Error::Canceled;
  13710. output_error_log(error, &req);
  13711. return false;
  13712. }
  13713. }
  13714. auto out =
  13715. req.content_receiver
  13716. ? static_cast<ContentReceiverWithProgress>(
  13717. [&](const char *buf, size_t n, size_t off, size_t len) {
  13718. if (redirect) { return true; }
  13719. auto ret = req.content_receiver(buf, n, off, len);
  13720. if (!ret) {
  13721. error = Error::Canceled;
  13722. output_error_log(error, &req);
  13723. }
  13724. return ret;
  13725. })
  13726. : static_cast<ContentReceiverWithProgress>(
  13727. [&](const char *buf, size_t n, size_t /*off*/,
  13728. size_t /*len*/) {
  13729. assert(res.body.size() + n <= res.body.max_size());
  13730. if (payload_max_length_ > 0 &&
  13731. (res.body.size() >= payload_max_length_ ||
  13732. n > payload_max_length_ - res.body.size())) {
  13733. return false;
  13734. }
  13735. res.body.append(buf, n);
  13736. return true;
  13737. });
  13738. auto progress = [&](size_t current, size_t total) {
  13739. if (!req.download_progress || redirect) { return true; }
  13740. auto ret = req.download_progress(current, total);
  13741. if (!ret) {
  13742. error = Error::Canceled;
  13743. output_error_log(error, &req);
  13744. }
  13745. return ret;
  13746. };
  13747. if (res.has_header("Content-Length")) {
  13748. if (!req.content_receiver) {
  13749. auto len = res.get_header_value_u64("Content-Length");
  13750. if (len > res.body.max_size()) {
  13751. error = Error::Read;
  13752. output_error_log(error, &req);
  13753. return false;
  13754. }
  13755. // Cap the reservation by payload_max_length_ to avoid OOM when a
  13756. // hostile or malformed server sends an enormous Content-Length.
  13757. // The actual body read below is bounded by payload_max_length_,
  13758. // so reserving more than that is never useful.
  13759. auto reserve_len = static_cast<size_t>(len);
  13760. if (payload_max_length_ > 0 && reserve_len > payload_max_length_) {
  13761. reserve_len = payload_max_length_;
  13762. }
  13763. res.body.reserve(reserve_len);
  13764. }
  13765. }
  13766. if (res.status != StatusCode::NotModified_304) {
  13767. auto content_status = 0;
  13768. auto max_length = (!has_payload_max_length_ && req.content_receiver)
  13769. ? (std::numeric_limits<size_t>::max)()
  13770. : payload_max_length_;
  13771. if (!detail::read_content(strm, res, max_length, content_status,
  13772. std::move(progress), std::move(out),
  13773. decompress_)) {
  13774. if (error != Error::Canceled) {
  13775. // Tell the caller apart from a plain read failure when the body could
  13776. // not be decoded because of its Content-Encoding.
  13777. switch (content_status) {
  13778. case StatusCode::UnsupportedMediaType_415:
  13779. error = Error::UnsupportedContentEncoding;
  13780. break;
  13781. case StatusCode::InternalServerError_500:
  13782. error = Error::Compression;
  13783. break;
  13784. default: error = Error::Read; break;
  13785. }
  13786. }
  13787. output_error_log(error, &req);
  13788. return false;
  13789. }
  13790. }
  13791. }
  13792. // Log
  13793. output_log(req, res);
  13794. return true;
  13795. }
  13796. inline ContentProviderWithoutLength ClientImpl::get_multipart_content_provider(
  13797. const std::string &boundary, const UploadFormDataItems &items,
  13798. const FormDataProviderItems &provider_items) const {
  13799. size_t cur_item = 0;
  13800. size_t cur_start = 0;
  13801. // cur_item and cur_start are copied to within the std::function and
  13802. // maintain state between successive calls
  13803. return [&, cur_item, cur_start](size_t offset,
  13804. DataSink &sink) mutable -> bool {
  13805. if (!offset && !items.empty()) {
  13806. sink.os << detail::serialize_multipart_formdata(items, boundary, false);
  13807. return true;
  13808. } else if (cur_item < provider_items.size()) {
  13809. if (!cur_start) {
  13810. const auto &begin = detail::serialize_multipart_formdata_item_begin(
  13811. provider_items[cur_item], boundary);
  13812. offset += begin.size();
  13813. cur_start = offset;
  13814. sink.os << begin;
  13815. }
  13816. DataSink cur_sink;
  13817. auto has_data = true;
  13818. cur_sink.write = sink.write;
  13819. // Forward is_writable so a provider item asking whether it may keep
  13820. // going gets the outer sink's answer rather than the default `true`.
  13821. cur_sink.is_writable = sink.is_writable;
  13822. cur_sink.done = [&]() { has_data = false; };
  13823. if (!provider_items[cur_item].provider(offset - cur_start, cur_sink)) {
  13824. return false;
  13825. }
  13826. if (!has_data) {
  13827. sink.os << detail::serialize_multipart_formdata_item_end();
  13828. cur_item++;
  13829. cur_start = 0;
  13830. }
  13831. return true;
  13832. } else {
  13833. sink.os << detail::serialize_multipart_formdata_finish(boundary);
  13834. sink.done();
  13835. return true;
  13836. }
  13837. };
  13838. }
  13839. inline bool ClientImpl::process_socket(
  13840. const Socket &socket,
  13841. std::chrono::time_point<std::chrono::steady_clock> start_time,
  13842. std::function<bool(Stream &strm)> callback) {
  13843. return detail::process_client_socket(
  13844. socket.sock, read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  13845. write_timeout_usec_, max_timeout_msec_, start_time, std::move(callback));
  13846. }
  13847. inline bool ClientImpl::is_ssl() const { return false; }
  13848. inline Result ClientImpl::Get(const std::string &path,
  13849. DownloadProgress progress) {
  13850. return Get(path, Headers(), std::move(progress));
  13851. }
  13852. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13853. DownloadProgress progress) {
  13854. return Get(path, params, Headers(), std::move(progress));
  13855. }
  13856. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13857. const Headers &headers,
  13858. DownloadProgress progress) {
  13859. if (params.empty()) { return Get(path, headers); }
  13860. std::string path_with_query = append_query_params(path, params);
  13861. return Get(path_with_query, headers, std::move(progress));
  13862. }
  13863. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13864. DownloadProgress progress) {
  13865. Request req;
  13866. req.method = "GET";
  13867. req.path = path;
  13868. req.headers = headers;
  13869. req.download_progress = std::move(progress);
  13870. if (max_timeout_msec_ > 0) {
  13871. req.start_time_ = std::chrono::steady_clock::now();
  13872. }
  13873. return send_(std::move(req));
  13874. }
  13875. inline Result ClientImpl::Get(const std::string &path,
  13876. ContentReceiver content_receiver,
  13877. DownloadProgress progress) {
  13878. return Get(path, Headers(), nullptr, std::move(content_receiver),
  13879. std::move(progress));
  13880. }
  13881. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13882. ContentReceiver content_receiver,
  13883. DownloadProgress progress) {
  13884. return Get(path, headers, nullptr, std::move(content_receiver),
  13885. std::move(progress));
  13886. }
  13887. inline Result ClientImpl::Get(const std::string &path,
  13888. ResponseHandler response_handler,
  13889. ContentReceiver content_receiver,
  13890. DownloadProgress progress) {
  13891. return Get(path, Headers(), std::move(response_handler),
  13892. std::move(content_receiver), std::move(progress));
  13893. }
  13894. inline Result ClientImpl::Get(const std::string &path, const Headers &headers,
  13895. ResponseHandler response_handler,
  13896. ContentReceiver content_receiver,
  13897. DownloadProgress progress) {
  13898. Request req;
  13899. req.method = "GET";
  13900. req.path = path;
  13901. req.headers = headers;
  13902. req.response_handler = std::move(response_handler);
  13903. req.content_receiver =
  13904. [content_receiver](const char *data, size_t data_length,
  13905. size_t /*offset*/, size_t /*total_length*/) {
  13906. return content_receiver(data, data_length);
  13907. };
  13908. req.download_progress = std::move(progress);
  13909. if (max_timeout_msec_ > 0) {
  13910. req.start_time_ = std::chrono::steady_clock::now();
  13911. }
  13912. return send_(std::move(req));
  13913. }
  13914. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13915. const Headers &headers,
  13916. ContentReceiver content_receiver,
  13917. DownloadProgress progress) {
  13918. return Get(path, params, headers, nullptr, std::move(content_receiver),
  13919. std::move(progress));
  13920. }
  13921. inline Result ClientImpl::Get(const std::string &path, const Params &params,
  13922. const Headers &headers,
  13923. ResponseHandler response_handler,
  13924. ContentReceiver content_receiver,
  13925. DownloadProgress progress) {
  13926. if (params.empty()) {
  13927. return Get(path, headers, std::move(response_handler),
  13928. std::move(content_receiver), std::move(progress));
  13929. }
  13930. std::string path_with_query = append_query_params(path, params);
  13931. return Get(path_with_query, headers, std::move(response_handler),
  13932. std::move(content_receiver), std::move(progress));
  13933. }
  13934. inline Result ClientImpl::Head(const std::string &path) {
  13935. return Head(path, Headers());
  13936. }
  13937. inline Result ClientImpl::Head(const std::string &path,
  13938. const Headers &headers) {
  13939. Request req;
  13940. req.method = "HEAD";
  13941. req.headers = headers;
  13942. req.path = path;
  13943. if (max_timeout_msec_ > 0) {
  13944. req.start_time_ = std::chrono::steady_clock::now();
  13945. }
  13946. return send_(std::move(req));
  13947. }
  13948. inline Result ClientImpl::Post(const std::string &path) {
  13949. return Post(path, std::string(), std::string());
  13950. }
  13951. inline Result ClientImpl::Post(const std::string &path,
  13952. const Headers &headers) {
  13953. return Post(path, headers, nullptr, 0, std::string());
  13954. }
  13955. inline Result ClientImpl::Post(const std::string &path, const char *body,
  13956. size_t content_length,
  13957. const std::string &content_type,
  13958. UploadProgress progress) {
  13959. return Post(path, Headers(), body, content_length, content_type, progress);
  13960. }
  13961. inline Result ClientImpl::Post(const std::string &path, const std::string &body,
  13962. const std::string &content_type,
  13963. UploadProgress progress) {
  13964. return Post(path, Headers(), body, content_type, progress);
  13965. }
  13966. inline Result ClientImpl::Post(const std::string &path, const Params &params) {
  13967. return Post(path, Headers(), params);
  13968. }
  13969. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13970. ContentProvider content_provider,
  13971. const std::string &content_type,
  13972. UploadProgress progress) {
  13973. return Post(path, Headers(), content_length, std::move(content_provider),
  13974. content_type, progress);
  13975. }
  13976. inline Result ClientImpl::Post(const std::string &path, size_t content_length,
  13977. ContentProvider content_provider,
  13978. const std::string &content_type,
  13979. ContentReceiver content_receiver,
  13980. UploadProgress progress) {
  13981. return Post(path, Headers(), content_length, std::move(content_provider),
  13982. content_type, std::move(content_receiver), progress);
  13983. }
  13984. inline Result ClientImpl::Post(const std::string &path,
  13985. ContentProviderWithoutLength content_provider,
  13986. const std::string &content_type,
  13987. UploadProgress progress) {
  13988. return Post(path, Headers(), std::move(content_provider), content_type,
  13989. progress);
  13990. }
  13991. inline Result ClientImpl::Post(const std::string &path,
  13992. ContentProviderWithoutLength content_provider,
  13993. const std::string &content_type,
  13994. ContentReceiver content_receiver,
  13995. UploadProgress progress) {
  13996. return Post(path, Headers(), std::move(content_provider), content_type,
  13997. std::move(content_receiver), progress);
  13998. }
  13999. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14000. const Params &params) {
  14001. auto query = detail::params_to_query_str(params);
  14002. return Post(path, headers, query, "application/x-www-form-urlencoded");
  14003. }
  14004. inline Result ClientImpl::Post(const std::string &path,
  14005. const UploadFormDataItems &items,
  14006. UploadProgress progress) {
  14007. return Post(path, Headers(), items, progress);
  14008. }
  14009. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14010. const UploadFormDataItems &items,
  14011. UploadProgress progress) {
  14012. const auto &boundary = detail::make_multipart_data_boundary();
  14013. const auto &content_type =
  14014. detail::serialize_multipart_formdata_get_content_type(boundary);
  14015. auto content_length = detail::get_multipart_content_length(items, boundary);
  14016. return Post(path, headers, content_length,
  14017. detail::make_multipart_content_provider(items, boundary),
  14018. content_type, progress);
  14019. }
  14020. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14021. const UploadFormDataItems &items,
  14022. const std::string &boundary,
  14023. UploadProgress progress) {
  14024. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14025. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14026. }
  14027. const auto &content_type =
  14028. detail::serialize_multipart_formdata_get_content_type(boundary);
  14029. auto content_length = detail::get_multipart_content_length(items, boundary);
  14030. return Post(path, headers, content_length,
  14031. detail::make_multipart_content_provider(items, boundary),
  14032. content_type, progress);
  14033. }
  14034. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14035. const char *body, size_t content_length,
  14036. const std::string &content_type,
  14037. UploadProgress progress) {
  14038. return send_with_content_provider_and_receiver(
  14039. "POST", path, headers, body, content_length, nullptr, nullptr,
  14040. content_type, nullptr, progress);
  14041. }
  14042. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14043. const std::string &body,
  14044. const std::string &content_type,
  14045. UploadProgress progress) {
  14046. return send_with_content_provider_and_receiver(
  14047. "POST", path, headers, body.data(), body.size(), nullptr, nullptr,
  14048. content_type, nullptr, progress);
  14049. }
  14050. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14051. size_t content_length,
  14052. ContentProvider content_provider,
  14053. const std::string &content_type,
  14054. UploadProgress progress) {
  14055. return send_with_content_provider_and_receiver(
  14056. "POST", path, headers, nullptr, content_length,
  14057. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14058. }
  14059. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14060. size_t content_length,
  14061. ContentProvider content_provider,
  14062. const std::string &content_type,
  14063. ContentReceiver content_receiver,
  14064. DownloadProgress progress) {
  14065. return send_with_content_provider_and_receiver(
  14066. "POST", path, headers, nullptr, content_length,
  14067. std::move(content_provider), nullptr, content_type,
  14068. std::move(content_receiver), std::move(progress));
  14069. }
  14070. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14071. ContentProviderWithoutLength content_provider,
  14072. const std::string &content_type,
  14073. UploadProgress progress) {
  14074. return send_with_content_provider_and_receiver(
  14075. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14076. content_type, nullptr, progress);
  14077. }
  14078. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14079. ContentProviderWithoutLength content_provider,
  14080. const std::string &content_type,
  14081. ContentReceiver content_receiver,
  14082. DownloadProgress progress) {
  14083. return send_with_content_provider_and_receiver(
  14084. "POST", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14085. content_type, std::move(content_receiver), std::move(progress));
  14086. }
  14087. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14088. const UploadFormDataItems &items,
  14089. const FormDataProviderItems &provider_items,
  14090. UploadProgress progress) {
  14091. const auto &boundary = detail::make_multipart_data_boundary();
  14092. const auto &content_type =
  14093. detail::serialize_multipart_formdata_get_content_type(boundary);
  14094. return send_with_content_provider_and_receiver(
  14095. "POST", path, headers, nullptr, 0, nullptr,
  14096. get_multipart_content_provider(boundary, items, provider_items),
  14097. content_type, nullptr, progress);
  14098. }
  14099. inline Result ClientImpl::Post(const std::string &path, const Headers &headers,
  14100. const std::string &body,
  14101. const std::string &content_type,
  14102. ContentReceiver content_receiver,
  14103. DownloadProgress progress) {
  14104. Request req;
  14105. req.method = "POST";
  14106. req.path = path;
  14107. req.headers = headers;
  14108. req.body = body;
  14109. req.content_receiver =
  14110. [content_receiver](const char *data, size_t data_length,
  14111. size_t /*offset*/, size_t /*total_length*/) {
  14112. return content_receiver(data, data_length);
  14113. };
  14114. req.download_progress = std::move(progress);
  14115. if (max_timeout_msec_ > 0) {
  14116. req.start_time_ = std::chrono::steady_clock::now();
  14117. }
  14118. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14119. return send_(std::move(req));
  14120. }
  14121. inline Result ClientImpl::Put(const std::string &path) {
  14122. return Put(path, std::string(), std::string());
  14123. }
  14124. inline Result ClientImpl::Put(const std::string &path, const Headers &headers) {
  14125. return Put(path, headers, nullptr, 0, std::string());
  14126. }
  14127. inline Result ClientImpl::Put(const std::string &path, const char *body,
  14128. size_t content_length,
  14129. const std::string &content_type,
  14130. UploadProgress progress) {
  14131. return Put(path, Headers(), body, content_length, content_type, progress);
  14132. }
  14133. inline Result ClientImpl::Put(const std::string &path, const std::string &body,
  14134. const std::string &content_type,
  14135. UploadProgress progress) {
  14136. return Put(path, Headers(), body, content_type, progress);
  14137. }
  14138. inline Result ClientImpl::Put(const std::string &path, const Params &params) {
  14139. return Put(path, Headers(), params);
  14140. }
  14141. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14142. ContentProvider content_provider,
  14143. const std::string &content_type,
  14144. UploadProgress progress) {
  14145. return Put(path, Headers(), content_length, std::move(content_provider),
  14146. content_type, progress);
  14147. }
  14148. inline Result ClientImpl::Put(const std::string &path, size_t content_length,
  14149. ContentProvider content_provider,
  14150. const std::string &content_type,
  14151. ContentReceiver content_receiver,
  14152. UploadProgress progress) {
  14153. return Put(path, Headers(), content_length, std::move(content_provider),
  14154. content_type, std::move(content_receiver), progress);
  14155. }
  14156. inline Result ClientImpl::Put(const std::string &path,
  14157. ContentProviderWithoutLength content_provider,
  14158. const std::string &content_type,
  14159. UploadProgress progress) {
  14160. return Put(path, Headers(), std::move(content_provider), content_type,
  14161. progress);
  14162. }
  14163. inline Result ClientImpl::Put(const std::string &path,
  14164. ContentProviderWithoutLength content_provider,
  14165. const std::string &content_type,
  14166. ContentReceiver content_receiver,
  14167. UploadProgress progress) {
  14168. return Put(path, Headers(), std::move(content_provider), content_type,
  14169. std::move(content_receiver), progress);
  14170. }
  14171. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14172. const Params &params) {
  14173. auto query = detail::params_to_query_str(params);
  14174. return Put(path, headers, query, "application/x-www-form-urlencoded");
  14175. }
  14176. inline Result ClientImpl::Put(const std::string &path,
  14177. const UploadFormDataItems &items,
  14178. UploadProgress progress) {
  14179. return Put(path, Headers(), items, progress);
  14180. }
  14181. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14182. const UploadFormDataItems &items,
  14183. UploadProgress progress) {
  14184. const auto &boundary = detail::make_multipart_data_boundary();
  14185. const auto &content_type =
  14186. detail::serialize_multipart_formdata_get_content_type(boundary);
  14187. auto content_length = detail::get_multipart_content_length(items, boundary);
  14188. return Put(path, headers, content_length,
  14189. detail::make_multipart_content_provider(items, boundary),
  14190. content_type, progress);
  14191. }
  14192. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14193. const UploadFormDataItems &items,
  14194. const std::string &boundary,
  14195. UploadProgress progress) {
  14196. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14197. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14198. }
  14199. const auto &content_type =
  14200. detail::serialize_multipart_formdata_get_content_type(boundary);
  14201. auto content_length = detail::get_multipart_content_length(items, boundary);
  14202. return Put(path, headers, content_length,
  14203. detail::make_multipart_content_provider(items, boundary),
  14204. content_type, progress);
  14205. }
  14206. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14207. const char *body, size_t content_length,
  14208. const std::string &content_type,
  14209. UploadProgress progress) {
  14210. return send_with_content_provider_and_receiver(
  14211. "PUT", path, headers, body, content_length, nullptr, nullptr,
  14212. content_type, nullptr, progress);
  14213. }
  14214. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14215. const std::string &body,
  14216. const std::string &content_type,
  14217. UploadProgress progress) {
  14218. return send_with_content_provider_and_receiver(
  14219. "PUT", path, headers, body.data(), body.size(), nullptr, nullptr,
  14220. content_type, nullptr, progress);
  14221. }
  14222. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14223. size_t content_length,
  14224. ContentProvider content_provider,
  14225. const std::string &content_type,
  14226. UploadProgress progress) {
  14227. return send_with_content_provider_and_receiver(
  14228. "PUT", path, headers, nullptr, content_length,
  14229. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14230. }
  14231. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14232. size_t content_length,
  14233. ContentProvider content_provider,
  14234. const std::string &content_type,
  14235. ContentReceiver content_receiver,
  14236. UploadProgress progress) {
  14237. return send_with_content_provider_and_receiver(
  14238. "PUT", path, headers, nullptr, content_length,
  14239. std::move(content_provider), nullptr, content_type,
  14240. std::move(content_receiver), progress);
  14241. }
  14242. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14243. ContentProviderWithoutLength content_provider,
  14244. const std::string &content_type,
  14245. UploadProgress progress) {
  14246. return send_with_content_provider_and_receiver(
  14247. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14248. content_type, nullptr, progress);
  14249. }
  14250. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14251. ContentProviderWithoutLength content_provider,
  14252. const std::string &content_type,
  14253. ContentReceiver content_receiver,
  14254. UploadProgress progress) {
  14255. return send_with_content_provider_and_receiver(
  14256. "PUT", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14257. content_type, std::move(content_receiver), progress);
  14258. }
  14259. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14260. const UploadFormDataItems &items,
  14261. const FormDataProviderItems &provider_items,
  14262. UploadProgress progress) {
  14263. const auto &boundary = detail::make_multipart_data_boundary();
  14264. const auto &content_type =
  14265. detail::serialize_multipart_formdata_get_content_type(boundary);
  14266. return send_with_content_provider_and_receiver(
  14267. "PUT", path, headers, nullptr, 0, nullptr,
  14268. get_multipart_content_provider(boundary, items, provider_items),
  14269. content_type, nullptr, progress);
  14270. }
  14271. inline Result ClientImpl::Put(const std::string &path, const Headers &headers,
  14272. const std::string &body,
  14273. const std::string &content_type,
  14274. ContentReceiver content_receiver,
  14275. DownloadProgress progress) {
  14276. Request req;
  14277. req.method = "PUT";
  14278. req.path = path;
  14279. req.headers = headers;
  14280. req.body = body;
  14281. req.content_receiver =
  14282. [content_receiver](const char *data, size_t data_length,
  14283. size_t /*offset*/, size_t /*total_length*/) {
  14284. return content_receiver(data, data_length);
  14285. };
  14286. req.download_progress = std::move(progress);
  14287. if (max_timeout_msec_ > 0) {
  14288. req.start_time_ = std::chrono::steady_clock::now();
  14289. }
  14290. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14291. return send_(std::move(req));
  14292. }
  14293. inline Result ClientImpl::Patch(const std::string &path) {
  14294. return Patch(path, std::string(), std::string());
  14295. }
  14296. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14297. UploadProgress progress) {
  14298. return Patch(path, headers, nullptr, 0, std::string(), progress);
  14299. }
  14300. inline Result ClientImpl::Patch(const std::string &path, const char *body,
  14301. size_t content_length,
  14302. const std::string &content_type,
  14303. UploadProgress progress) {
  14304. return Patch(path, Headers(), body, content_length, content_type, progress);
  14305. }
  14306. inline Result ClientImpl::Patch(const std::string &path,
  14307. const std::string &body,
  14308. const std::string &content_type,
  14309. UploadProgress progress) {
  14310. return Patch(path, Headers(), body, content_type, progress);
  14311. }
  14312. inline Result ClientImpl::Patch(const std::string &path, const Params &params) {
  14313. return Patch(path, Headers(), params);
  14314. }
  14315. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14316. ContentProvider content_provider,
  14317. const std::string &content_type,
  14318. UploadProgress progress) {
  14319. return Patch(path, Headers(), content_length, std::move(content_provider),
  14320. content_type, progress);
  14321. }
  14322. inline Result ClientImpl::Patch(const std::string &path, size_t content_length,
  14323. ContentProvider content_provider,
  14324. const std::string &content_type,
  14325. ContentReceiver content_receiver,
  14326. UploadProgress progress) {
  14327. return Patch(path, Headers(), content_length, std::move(content_provider),
  14328. content_type, std::move(content_receiver), progress);
  14329. }
  14330. inline Result ClientImpl::Patch(const std::string &path,
  14331. ContentProviderWithoutLength content_provider,
  14332. const std::string &content_type,
  14333. UploadProgress progress) {
  14334. return Patch(path, Headers(), std::move(content_provider), content_type,
  14335. progress);
  14336. }
  14337. inline Result ClientImpl::Patch(const std::string &path,
  14338. ContentProviderWithoutLength content_provider,
  14339. const std::string &content_type,
  14340. ContentReceiver content_receiver,
  14341. UploadProgress progress) {
  14342. return Patch(path, Headers(), std::move(content_provider), content_type,
  14343. std::move(content_receiver), progress);
  14344. }
  14345. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14346. const Params &params) {
  14347. auto query = detail::params_to_query_str(params);
  14348. return Patch(path, headers, query, "application/x-www-form-urlencoded");
  14349. }
  14350. inline Result ClientImpl::Patch(const std::string &path,
  14351. const UploadFormDataItems &items,
  14352. UploadProgress progress) {
  14353. return Patch(path, Headers(), items, progress);
  14354. }
  14355. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14356. const UploadFormDataItems &items,
  14357. UploadProgress progress) {
  14358. const auto &boundary = detail::make_multipart_data_boundary();
  14359. const auto &content_type =
  14360. detail::serialize_multipart_formdata_get_content_type(boundary);
  14361. auto content_length = detail::get_multipart_content_length(items, boundary);
  14362. return Patch(path, headers, content_length,
  14363. detail::make_multipart_content_provider(items, boundary),
  14364. content_type, progress);
  14365. }
  14366. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14367. const UploadFormDataItems &items,
  14368. const std::string &boundary,
  14369. UploadProgress progress) {
  14370. if (!detail::is_multipart_boundary_chars_valid(boundary)) {
  14371. return Result{nullptr, Error::UnsupportedMultipartBoundaryChars};
  14372. }
  14373. const auto &content_type =
  14374. detail::serialize_multipart_formdata_get_content_type(boundary);
  14375. auto content_length = detail::get_multipart_content_length(items, boundary);
  14376. return Patch(path, headers, content_length,
  14377. detail::make_multipart_content_provider(items, boundary),
  14378. content_type, progress);
  14379. }
  14380. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14381. const char *body, size_t content_length,
  14382. const std::string &content_type,
  14383. UploadProgress progress) {
  14384. return send_with_content_provider_and_receiver(
  14385. "PATCH", path, headers, body, content_length, nullptr, nullptr,
  14386. content_type, nullptr, progress);
  14387. }
  14388. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14389. const std::string &body,
  14390. const std::string &content_type,
  14391. UploadProgress progress) {
  14392. return send_with_content_provider_and_receiver(
  14393. "PATCH", path, headers, body.data(), body.size(), nullptr, nullptr,
  14394. content_type, nullptr, progress);
  14395. }
  14396. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14397. size_t content_length,
  14398. ContentProvider content_provider,
  14399. const std::string &content_type,
  14400. UploadProgress progress) {
  14401. return send_with_content_provider_and_receiver(
  14402. "PATCH", path, headers, nullptr, content_length,
  14403. std::move(content_provider), nullptr, content_type, nullptr, progress);
  14404. }
  14405. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14406. size_t content_length,
  14407. ContentProvider content_provider,
  14408. const std::string &content_type,
  14409. ContentReceiver content_receiver,
  14410. UploadProgress progress) {
  14411. return send_with_content_provider_and_receiver(
  14412. "PATCH", path, headers, nullptr, content_length,
  14413. std::move(content_provider), nullptr, content_type,
  14414. std::move(content_receiver), progress);
  14415. }
  14416. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14417. ContentProviderWithoutLength content_provider,
  14418. const std::string &content_type,
  14419. UploadProgress progress) {
  14420. return send_with_content_provider_and_receiver(
  14421. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14422. content_type, nullptr, progress);
  14423. }
  14424. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14425. ContentProviderWithoutLength content_provider,
  14426. const std::string &content_type,
  14427. ContentReceiver content_receiver,
  14428. UploadProgress progress) {
  14429. return send_with_content_provider_and_receiver(
  14430. "PATCH", path, headers, nullptr, 0, nullptr, std::move(content_provider),
  14431. content_type, std::move(content_receiver), progress);
  14432. }
  14433. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14434. const UploadFormDataItems &items,
  14435. const FormDataProviderItems &provider_items,
  14436. UploadProgress progress) {
  14437. const auto &boundary = detail::make_multipart_data_boundary();
  14438. const auto &content_type =
  14439. detail::serialize_multipart_formdata_get_content_type(boundary);
  14440. return send_with_content_provider_and_receiver(
  14441. "PATCH", path, headers, nullptr, 0, nullptr,
  14442. get_multipart_content_provider(boundary, items, provider_items),
  14443. content_type, nullptr, progress);
  14444. }
  14445. inline Result ClientImpl::Patch(const std::string &path, const Headers &headers,
  14446. const std::string &body,
  14447. const std::string &content_type,
  14448. ContentReceiver content_receiver,
  14449. DownloadProgress progress) {
  14450. Request req;
  14451. req.method = "PATCH";
  14452. req.path = path;
  14453. req.headers = headers;
  14454. req.body = body;
  14455. req.content_receiver =
  14456. [content_receiver](const char *data, size_t data_length,
  14457. size_t /*offset*/, size_t /*total_length*/) {
  14458. return content_receiver(data, data_length);
  14459. };
  14460. req.download_progress = std::move(progress);
  14461. if (max_timeout_msec_ > 0) {
  14462. req.start_time_ = std::chrono::steady_clock::now();
  14463. }
  14464. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14465. return send_(std::move(req));
  14466. }
  14467. inline Result ClientImpl::Delete(const std::string &path,
  14468. DownloadProgress progress) {
  14469. return Delete(path, Headers(), std::string(), std::string(), progress);
  14470. }
  14471. inline Result ClientImpl::Delete(const std::string &path,
  14472. const Headers &headers,
  14473. DownloadProgress progress) {
  14474. return Delete(path, headers, std::string(), std::string(), progress);
  14475. }
  14476. inline Result ClientImpl::Delete(const std::string &path, const char *body,
  14477. size_t content_length,
  14478. const std::string &content_type,
  14479. DownloadProgress progress) {
  14480. return Delete(path, Headers(), body, content_length, content_type, progress);
  14481. }
  14482. inline Result ClientImpl::Delete(const std::string &path,
  14483. const std::string &body,
  14484. const std::string &content_type,
  14485. DownloadProgress progress) {
  14486. return Delete(path, Headers(), body.data(), body.size(), content_type,
  14487. progress);
  14488. }
  14489. inline Result ClientImpl::Delete(const std::string &path,
  14490. const Headers &headers,
  14491. const std::string &body,
  14492. const std::string &content_type,
  14493. DownloadProgress progress) {
  14494. return Delete(path, headers, body.data(), body.size(), content_type,
  14495. progress);
  14496. }
  14497. inline Result ClientImpl::Delete(const std::string &path, const Params &params,
  14498. DownloadProgress progress) {
  14499. return Delete(path, Headers(), params, progress);
  14500. }
  14501. inline Result ClientImpl::Delete(const std::string &path,
  14502. const Headers &headers, const Params &params,
  14503. DownloadProgress progress) {
  14504. auto query = detail::params_to_query_str(params);
  14505. return Delete(path, headers, query, "application/x-www-form-urlencoded",
  14506. progress);
  14507. }
  14508. inline Result ClientImpl::Delete(const std::string &path,
  14509. const Headers &headers, const char *body,
  14510. size_t content_length,
  14511. const std::string &content_type,
  14512. DownloadProgress progress) {
  14513. Request req;
  14514. req.method = "DELETE";
  14515. req.headers = headers;
  14516. req.path = path;
  14517. req.download_progress = std::move(progress);
  14518. if (max_timeout_msec_ > 0) {
  14519. req.start_time_ = std::chrono::steady_clock::now();
  14520. }
  14521. if (!content_type.empty()) { req.set_header("Content-Type", content_type); }
  14522. req.body.assign(body, content_length);
  14523. return send_(std::move(req));
  14524. }
  14525. inline Result ClientImpl::Options(const std::string &path) {
  14526. return Options(path, Headers());
  14527. }
  14528. inline Result ClientImpl::Options(const std::string &path,
  14529. const Headers &headers) {
  14530. Request req;
  14531. req.method = "OPTIONS";
  14532. req.headers = headers;
  14533. req.path = path;
  14534. if (max_timeout_msec_ > 0) {
  14535. req.start_time_ = std::chrono::steady_clock::now();
  14536. }
  14537. return send_(std::move(req));
  14538. }
  14539. inline void ClientImpl::stop() {
  14540. std::lock_guard<std::mutex> guard(socket_mutex_);
  14541. // If there is anything ongoing right now, the ONLY thread-safe thing we can
  14542. // do is to shutdown_socket, so that threads using this socket suddenly
  14543. // discover they can't read/write any more and error out. Everything else
  14544. // (closing the socket, shutting ssl down) is unsafe because these actions
  14545. // are not thread-safe.
  14546. if (socket_requests_in_flight_ > 0) {
  14547. shutdown_socket(socket_);
  14548. // Aside from that, we set a flag for the socket to be closed when we're
  14549. // done.
  14550. socket_should_be_closed_when_request_is_done_ = true;
  14551. return;
  14552. }
  14553. disconnect(/*gracefully=*/true);
  14554. }
  14555. inline std::string ClientImpl::host() const { return host_; }
  14556. inline int ClientImpl::port() const { return port_; }
  14557. inline size_t ClientImpl::is_socket_open() const {
  14558. std::lock_guard<std::mutex> guard(socket_mutex_);
  14559. return socket_.is_open();
  14560. }
  14561. inline socket_t ClientImpl::socket() const { return socket_.sock; }
  14562. inline void ClientImpl::set_connection_timeout(time_t sec, time_t usec) {
  14563. connection_timeout_sec_ = sec;
  14564. connection_timeout_usec_ = usec;
  14565. }
  14566. inline void ClientImpl::set_read_timeout(time_t sec, time_t usec) {
  14567. read_timeout_sec_ = sec;
  14568. read_timeout_usec_ = usec;
  14569. }
  14570. inline void ClientImpl::set_write_timeout(time_t sec, time_t usec) {
  14571. write_timeout_sec_ = sec;
  14572. write_timeout_usec_ = usec;
  14573. }
  14574. inline void ClientImpl::set_max_timeout(time_t msec) {
  14575. max_timeout_msec_ = msec;
  14576. }
  14577. inline void ClientImpl::set_basic_auth(const std::string &username,
  14578. const std::string &password) {
  14579. basic_auth_username_ = username;
  14580. basic_auth_password_ = password;
  14581. }
  14582. inline void ClientImpl::set_bearer_token_auth(const std::string &token) {
  14583. bearer_token_auth_token_ = token;
  14584. }
  14585. inline void ClientImpl::set_keep_alive(bool on) { keep_alive_ = on; }
  14586. inline void ClientImpl::set_follow_location(bool on) { follow_location_ = on; }
  14587. inline void ClientImpl::set_path_encode(bool on) { path_encode_ = on; }
  14588. inline void
  14589. ClientImpl::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  14590. addr_map_ = std::move(addr_map);
  14591. }
  14592. inline void ClientImpl::set_default_headers(Headers headers) {
  14593. default_headers_ = std::move(headers);
  14594. }
  14595. inline void ClientImpl::set_header_writer(
  14596. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  14597. header_writer_ = writer;
  14598. }
  14599. inline void ClientImpl::set_address_family(int family) {
  14600. address_family_ = family;
  14601. }
  14602. inline void ClientImpl::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  14603. inline void ClientImpl::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  14604. inline void ClientImpl::set_socket_options(SocketOptions socket_options) {
  14605. socket_options_ = std::move(socket_options);
  14606. }
  14607. inline void ClientImpl::set_compress(bool on) { compress_ = on; }
  14608. inline void ClientImpl::set_decompress(bool on) { decompress_ = on; }
  14609. inline void ClientImpl::set_payload_max_length(size_t length) {
  14610. payload_max_length_ = length;
  14611. has_payload_max_length_ = true;
  14612. }
  14613. inline void ClientImpl::set_interface(const std::string &intf) {
  14614. interface_ = intf;
  14615. }
  14616. inline void ClientImpl::set_proxy(const std::string &host, int port) {
  14617. proxy_host_ = host;
  14618. proxy_port_ = port;
  14619. std::lock_guard<std::mutex> guard(socket_mutex_);
  14620. disconnect(/*gracefully=*/true);
  14621. }
  14622. inline void ClientImpl::set_proxy_basic_auth(const std::string &username,
  14623. const std::string &password) {
  14624. proxy_basic_auth_username_ = username;
  14625. proxy_basic_auth_password_ = password;
  14626. }
  14627. inline void ClientImpl::set_proxy_bearer_token_auth(const std::string &token) {
  14628. proxy_bearer_token_auth_token_ = token;
  14629. }
  14630. inline void ClientImpl::set_no_proxy(const std::vector<std::string> &patterns) {
  14631. std::vector<detail::NoProxyEntry> parsed;
  14632. parsed.reserve(patterns.size());
  14633. for (const auto &p : patterns) {
  14634. auto trimmed = detail::trim_copy(p);
  14635. if (trimmed.empty()) { continue; }
  14636. detail::NoProxyEntry entry;
  14637. if (detail::parse_no_proxy_entry(trimmed, entry)) {
  14638. parsed.push_back(std::move(entry));
  14639. }
  14640. }
  14641. no_proxy_entries_ = std::move(parsed);
  14642. std::lock_guard<std::mutex> guard(socket_mutex_);
  14643. disconnect(/*gracefully=*/true);
  14644. }
  14645. #ifdef CPPHTTPLIB_SSL_ENABLED
  14646. inline void ClientImpl::set_digest_auth(const std::string &username,
  14647. const std::string &password) {
  14648. digest_auth_username_ = username;
  14649. digest_auth_password_ = password;
  14650. }
  14651. inline void ClientImpl::set_ca_cert_path(const std::string &ca_cert_file_path,
  14652. const std::string &ca_cert_dir_path) {
  14653. ca_cert_file_path_ = ca_cert_file_path;
  14654. ca_cert_dir_path_ = ca_cert_dir_path;
  14655. }
  14656. inline void ClientImpl::set_proxy_digest_auth(const std::string &username,
  14657. const std::string &password) {
  14658. proxy_digest_auth_username_ = username;
  14659. proxy_digest_auth_password_ = password;
  14660. }
  14661. inline void ClientImpl::enable_server_certificate_verification(bool enabled) {
  14662. server_certificate_verification_ = enabled;
  14663. }
  14664. inline void ClientImpl::enable_server_hostname_verification(bool enabled) {
  14665. server_hostname_verification_ = enabled;
  14666. }
  14667. inline void ClientImpl::enable_system_ca(bool enabled) {
  14668. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  14669. }
  14670. #endif
  14671. inline void ClientImpl::set_logger(Logger logger) {
  14672. logger_ = std::move(logger);
  14673. }
  14674. inline void ClientImpl::set_error_logger(ErrorLogger error_logger) {
  14675. error_logger_ = std::move(error_logger);
  14676. }
  14677. /*
  14678. * SSL/TLS Common Implementation
  14679. */
  14680. inline ClientConnection::~ClientConnection() {
  14681. #ifdef CPPHTTPLIB_SSL_ENABLED
  14682. if (session) {
  14683. tls::shutdown(session, true);
  14684. tls::free_session(session);
  14685. session = nullptr;
  14686. }
  14687. #endif
  14688. if (sock != INVALID_SOCKET) {
  14689. detail::close_socket(sock);
  14690. sock = INVALID_SOCKET;
  14691. }
  14692. }
  14693. // Universal client implementation
  14694. inline Client::Client(const std::string &scheme_host_port)
  14695. : Client(scheme_host_port, std::string(), std::string()) {}
  14696. inline Client::Client(const std::string &scheme_host_port,
  14697. const std::string &client_cert_path,
  14698. const std::string &client_key_path) {
  14699. detail::UrlComponents uc;
  14700. if (detail::parse_url(scheme_host_port, uc) && !uc.host.empty()) {
  14701. auto &scheme = uc.scheme;
  14702. #ifdef CPPHTTPLIB_SSL_ENABLED
  14703. if (!scheme.empty() && (scheme != "http" && scheme != "https")) {
  14704. #else
  14705. if (!scheme.empty() && scheme != "http") {
  14706. #endif
  14707. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  14708. std::string msg = "'" + scheme + "' scheme is not supported.";
  14709. throw std::invalid_argument(msg);
  14710. #endif
  14711. return;
  14712. }
  14713. auto is_ssl = scheme == "https";
  14714. auto host = std::move(uc.host);
  14715. auto port = is_ssl ? 443 : 80;
  14716. if (!uc.port.empty() && !detail::parse_port(uc.port, port)) { return; }
  14717. if (is_ssl) {
  14718. #ifdef CPPHTTPLIB_SSL_ENABLED
  14719. cli_ = detail::make_unique<SSLClient>(host, port, client_cert_path,
  14720. client_key_path);
  14721. is_ssl_ = is_ssl;
  14722. #endif
  14723. } else {
  14724. cli_ = detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14725. client_key_path);
  14726. }
  14727. } else {
  14728. // NOTE: Update TEST(UniversalClientImplTest, Ipv6LiteralAddress)
  14729. // if port param below changes.
  14730. cli_ = detail::make_unique<ClientImpl>(scheme_host_port, 80,
  14731. client_cert_path, client_key_path);
  14732. }
  14733. }
  14734. inline Client::Client(const std::string &host, int port)
  14735. : Client(host, port, std::string(), std::string()) {}
  14736. inline Client::Client(const std::string &host, int port,
  14737. const std::string &client_cert_path,
  14738. const std::string &client_key_path)
  14739. : cli_(detail::make_unique<ClientImpl>(host, port, client_cert_path,
  14740. client_key_path)) {}
  14741. inline Client::~Client() = default;
  14742. inline bool Client::is_valid() const {
  14743. return cli_ != nullptr && cli_->is_valid();
  14744. }
  14745. inline Result Client::Get(const std::string &path, DownloadProgress progress) {
  14746. return cli_->Get(path, std::move(progress));
  14747. }
  14748. inline Result Client::Get(const std::string &path, const Headers &headers,
  14749. DownloadProgress progress) {
  14750. return cli_->Get(path, headers, std::move(progress));
  14751. }
  14752. inline Result Client::Get(const std::string &path,
  14753. ContentReceiver content_receiver,
  14754. DownloadProgress progress) {
  14755. return cli_->Get(path, std::move(content_receiver), std::move(progress));
  14756. }
  14757. inline Result Client::Get(const std::string &path, const Headers &headers,
  14758. ContentReceiver content_receiver,
  14759. DownloadProgress progress) {
  14760. return cli_->Get(path, headers, std::move(content_receiver),
  14761. std::move(progress));
  14762. }
  14763. inline Result Client::Get(const std::string &path,
  14764. ResponseHandler response_handler,
  14765. ContentReceiver content_receiver,
  14766. DownloadProgress progress) {
  14767. return cli_->Get(path, std::move(response_handler),
  14768. std::move(content_receiver), std::move(progress));
  14769. }
  14770. inline Result Client::Get(const std::string &path, const Headers &headers,
  14771. ResponseHandler response_handler,
  14772. ContentReceiver content_receiver,
  14773. DownloadProgress progress) {
  14774. return cli_->Get(path, headers, std::move(response_handler),
  14775. std::move(content_receiver), std::move(progress));
  14776. }
  14777. inline Result Client::Get(const std::string &path, const Params &params,
  14778. DownloadProgress progress) {
  14779. return cli_->Get(path, params, std::move(progress));
  14780. }
  14781. inline Result Client::Get(const std::string &path, const Params &params,
  14782. const Headers &headers, DownloadProgress progress) {
  14783. return cli_->Get(path, params, headers, std::move(progress));
  14784. }
  14785. inline Result Client::Get(const std::string &path, const Params &params,
  14786. const Headers &headers,
  14787. ContentReceiver content_receiver,
  14788. DownloadProgress progress) {
  14789. return cli_->Get(path, params, headers, std::move(content_receiver),
  14790. std::move(progress));
  14791. }
  14792. inline Result Client::Get(const std::string &path, const Params &params,
  14793. const Headers &headers,
  14794. ResponseHandler response_handler,
  14795. ContentReceiver content_receiver,
  14796. DownloadProgress progress) {
  14797. return cli_->Get(path, params, headers, std::move(response_handler),
  14798. std::move(content_receiver), std::move(progress));
  14799. }
  14800. inline Result Client::Head(const std::string &path) { return cli_->Head(path); }
  14801. inline Result Client::Head(const std::string &path, const Headers &headers) {
  14802. return cli_->Head(path, headers);
  14803. }
  14804. inline Result Client::Post(const std::string &path) { return cli_->Post(path); }
  14805. inline Result Client::Post(const std::string &path, const Headers &headers) {
  14806. return cli_->Post(path, headers);
  14807. }
  14808. inline Result Client::Post(const std::string &path, const char *body,
  14809. size_t content_length,
  14810. const std::string &content_type,
  14811. UploadProgress progress) {
  14812. return cli_->Post(path, body, content_length, content_type, progress);
  14813. }
  14814. inline Result Client::Post(const std::string &path, const Headers &headers,
  14815. const char *body, size_t content_length,
  14816. const std::string &content_type,
  14817. UploadProgress progress) {
  14818. return cli_->Post(path, headers, body, content_length, content_type,
  14819. progress);
  14820. }
  14821. inline Result Client::Post(const std::string &path, const std::string &body,
  14822. const std::string &content_type,
  14823. UploadProgress progress) {
  14824. return cli_->Post(path, body, content_type, progress);
  14825. }
  14826. inline Result Client::Post(const std::string &path, const Headers &headers,
  14827. const std::string &body,
  14828. const std::string &content_type,
  14829. UploadProgress progress) {
  14830. return cli_->Post(path, headers, body, content_type, progress);
  14831. }
  14832. inline Result Client::Post(const std::string &path, size_t content_length,
  14833. ContentProvider content_provider,
  14834. const std::string &content_type,
  14835. UploadProgress progress) {
  14836. return cli_->Post(path, content_length, std::move(content_provider),
  14837. content_type, progress);
  14838. }
  14839. inline Result Client::Post(const std::string &path, size_t content_length,
  14840. ContentProvider content_provider,
  14841. const std::string &content_type,
  14842. ContentReceiver content_receiver,
  14843. UploadProgress progress) {
  14844. return cli_->Post(path, content_length, std::move(content_provider),
  14845. content_type, std::move(content_receiver), progress);
  14846. }
  14847. inline Result Client::Post(const std::string &path,
  14848. ContentProviderWithoutLength content_provider,
  14849. const std::string &content_type,
  14850. UploadProgress progress) {
  14851. return cli_->Post(path, std::move(content_provider), content_type, progress);
  14852. }
  14853. inline Result Client::Post(const std::string &path,
  14854. ContentProviderWithoutLength content_provider,
  14855. const std::string &content_type,
  14856. ContentReceiver content_receiver,
  14857. UploadProgress progress) {
  14858. return cli_->Post(path, std::move(content_provider), content_type,
  14859. std::move(content_receiver), progress);
  14860. }
  14861. inline Result Client::Post(const std::string &path, const Headers &headers,
  14862. size_t content_length,
  14863. ContentProvider content_provider,
  14864. const std::string &content_type,
  14865. UploadProgress progress) {
  14866. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14867. content_type, progress);
  14868. }
  14869. inline Result Client::Post(const std::string &path, const Headers &headers,
  14870. size_t content_length,
  14871. ContentProvider content_provider,
  14872. const std::string &content_type,
  14873. ContentReceiver content_receiver,
  14874. DownloadProgress progress) {
  14875. return cli_->Post(path, headers, content_length, std::move(content_provider),
  14876. content_type, std::move(content_receiver), progress);
  14877. }
  14878. inline Result Client::Post(const std::string &path, const Headers &headers,
  14879. ContentProviderWithoutLength content_provider,
  14880. const std::string &content_type,
  14881. UploadProgress progress) {
  14882. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14883. progress);
  14884. }
  14885. inline Result Client::Post(const std::string &path, const Headers &headers,
  14886. ContentProviderWithoutLength content_provider,
  14887. const std::string &content_type,
  14888. ContentReceiver content_receiver,
  14889. DownloadProgress progress) {
  14890. return cli_->Post(path, headers, std::move(content_provider), content_type,
  14891. std::move(content_receiver), progress);
  14892. }
  14893. inline Result Client::Post(const std::string &path, const Params &params) {
  14894. return cli_->Post(path, params);
  14895. }
  14896. inline Result Client::Post(const std::string &path, const Headers &headers,
  14897. const Params &params) {
  14898. return cli_->Post(path, headers, params);
  14899. }
  14900. inline Result Client::Post(const std::string &path,
  14901. const UploadFormDataItems &items,
  14902. UploadProgress progress) {
  14903. return cli_->Post(path, items, progress);
  14904. }
  14905. inline Result Client::Post(const std::string &path, const Headers &headers,
  14906. const UploadFormDataItems &items,
  14907. UploadProgress progress) {
  14908. return cli_->Post(path, headers, items, progress);
  14909. }
  14910. inline Result Client::Post(const std::string &path, const Headers &headers,
  14911. const UploadFormDataItems &items,
  14912. const std::string &boundary,
  14913. UploadProgress progress) {
  14914. return cli_->Post(path, headers, items, boundary, progress);
  14915. }
  14916. inline Result Client::Post(const std::string &path, const Headers &headers,
  14917. const UploadFormDataItems &items,
  14918. const FormDataProviderItems &provider_items,
  14919. UploadProgress progress) {
  14920. return cli_->Post(path, headers, items, provider_items, progress);
  14921. }
  14922. inline Result Client::Post(const std::string &path, const Headers &headers,
  14923. const std::string &body,
  14924. const std::string &content_type,
  14925. ContentReceiver content_receiver,
  14926. DownloadProgress progress) {
  14927. return cli_->Post(path, headers, body, content_type,
  14928. std::move(content_receiver), progress);
  14929. }
  14930. inline Result Client::Put(const std::string &path) { return cli_->Put(path); }
  14931. inline Result Client::Put(const std::string &path, const Headers &headers) {
  14932. return cli_->Put(path, headers);
  14933. }
  14934. inline Result Client::Put(const std::string &path, const char *body,
  14935. size_t content_length,
  14936. const std::string &content_type,
  14937. UploadProgress progress) {
  14938. return cli_->Put(path, body, content_length, content_type, progress);
  14939. }
  14940. inline Result Client::Put(const std::string &path, const Headers &headers,
  14941. const char *body, size_t content_length,
  14942. const std::string &content_type,
  14943. UploadProgress progress) {
  14944. return cli_->Put(path, headers, body, content_length, content_type, progress);
  14945. }
  14946. inline Result Client::Put(const std::string &path, const std::string &body,
  14947. const std::string &content_type,
  14948. UploadProgress progress) {
  14949. return cli_->Put(path, body, content_type, progress);
  14950. }
  14951. inline Result Client::Put(const std::string &path, const Headers &headers,
  14952. const std::string &body,
  14953. const std::string &content_type,
  14954. UploadProgress progress) {
  14955. return cli_->Put(path, headers, body, content_type, progress);
  14956. }
  14957. inline Result Client::Put(const std::string &path, size_t content_length,
  14958. ContentProvider content_provider,
  14959. const std::string &content_type,
  14960. UploadProgress progress) {
  14961. return cli_->Put(path, content_length, std::move(content_provider),
  14962. content_type, progress);
  14963. }
  14964. inline Result Client::Put(const std::string &path, size_t content_length,
  14965. ContentProvider content_provider,
  14966. const std::string &content_type,
  14967. ContentReceiver content_receiver,
  14968. UploadProgress progress) {
  14969. return cli_->Put(path, content_length, std::move(content_provider),
  14970. content_type, std::move(content_receiver), progress);
  14971. }
  14972. inline Result Client::Put(const std::string &path,
  14973. ContentProviderWithoutLength content_provider,
  14974. const std::string &content_type,
  14975. UploadProgress progress) {
  14976. return cli_->Put(path, std::move(content_provider), content_type, progress);
  14977. }
  14978. inline Result Client::Put(const std::string &path,
  14979. ContentProviderWithoutLength content_provider,
  14980. const std::string &content_type,
  14981. ContentReceiver content_receiver,
  14982. UploadProgress progress) {
  14983. return cli_->Put(path, std::move(content_provider), content_type,
  14984. std::move(content_receiver), progress);
  14985. }
  14986. inline Result Client::Put(const std::string &path, const Headers &headers,
  14987. size_t content_length,
  14988. ContentProvider content_provider,
  14989. const std::string &content_type,
  14990. UploadProgress progress) {
  14991. return cli_->Put(path, headers, content_length, std::move(content_provider),
  14992. content_type, progress);
  14993. }
  14994. inline Result Client::Put(const std::string &path, const Headers &headers,
  14995. size_t content_length,
  14996. ContentProvider content_provider,
  14997. const std::string &content_type,
  14998. ContentReceiver content_receiver,
  14999. UploadProgress progress) {
  15000. return cli_->Put(path, headers, content_length, std::move(content_provider),
  15001. content_type, std::move(content_receiver), progress);
  15002. }
  15003. inline Result Client::Put(const std::string &path, const Headers &headers,
  15004. ContentProviderWithoutLength content_provider,
  15005. const std::string &content_type,
  15006. UploadProgress progress) {
  15007. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15008. progress);
  15009. }
  15010. inline Result Client::Put(const std::string &path, const Headers &headers,
  15011. ContentProviderWithoutLength content_provider,
  15012. const std::string &content_type,
  15013. ContentReceiver content_receiver,
  15014. UploadProgress progress) {
  15015. return cli_->Put(path, headers, std::move(content_provider), content_type,
  15016. std::move(content_receiver), progress);
  15017. }
  15018. inline Result Client::Put(const std::string &path, const Params &params) {
  15019. return cli_->Put(path, params);
  15020. }
  15021. inline Result Client::Put(const std::string &path, const Headers &headers,
  15022. const Params &params) {
  15023. return cli_->Put(path, headers, params);
  15024. }
  15025. inline Result Client::Put(const std::string &path,
  15026. const UploadFormDataItems &items,
  15027. UploadProgress progress) {
  15028. return cli_->Put(path, items, progress);
  15029. }
  15030. inline Result Client::Put(const std::string &path, const Headers &headers,
  15031. const UploadFormDataItems &items,
  15032. UploadProgress progress) {
  15033. return cli_->Put(path, headers, items, progress);
  15034. }
  15035. inline Result Client::Put(const std::string &path, const Headers &headers,
  15036. const UploadFormDataItems &items,
  15037. const std::string &boundary,
  15038. UploadProgress progress) {
  15039. return cli_->Put(path, headers, items, boundary, progress);
  15040. }
  15041. inline Result Client::Put(const std::string &path, const Headers &headers,
  15042. const UploadFormDataItems &items,
  15043. const FormDataProviderItems &provider_items,
  15044. UploadProgress progress) {
  15045. return cli_->Put(path, headers, items, provider_items, progress);
  15046. }
  15047. inline Result Client::Put(const std::string &path, const Headers &headers,
  15048. const std::string &body,
  15049. const std::string &content_type,
  15050. ContentReceiver content_receiver,
  15051. DownloadProgress progress) {
  15052. return cli_->Put(path, headers, body, content_type, content_receiver,
  15053. progress);
  15054. }
  15055. inline Result Client::Patch(const std::string &path) {
  15056. return cli_->Patch(path);
  15057. }
  15058. inline Result Client::Patch(const std::string &path, const Headers &headers) {
  15059. return cli_->Patch(path, headers);
  15060. }
  15061. inline Result Client::Patch(const std::string &path, const char *body,
  15062. size_t content_length,
  15063. const std::string &content_type,
  15064. UploadProgress progress) {
  15065. return cli_->Patch(path, body, content_length, content_type, progress);
  15066. }
  15067. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15068. const char *body, size_t content_length,
  15069. const std::string &content_type,
  15070. UploadProgress progress) {
  15071. return cli_->Patch(path, headers, body, content_length, content_type,
  15072. progress);
  15073. }
  15074. inline Result Client::Patch(const std::string &path, const std::string &body,
  15075. const std::string &content_type,
  15076. UploadProgress progress) {
  15077. return cli_->Patch(path, body, content_type, progress);
  15078. }
  15079. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15080. const std::string &body,
  15081. const std::string &content_type,
  15082. UploadProgress progress) {
  15083. return cli_->Patch(path, headers, body, content_type, progress);
  15084. }
  15085. inline Result Client::Patch(const std::string &path, size_t content_length,
  15086. ContentProvider content_provider,
  15087. const std::string &content_type,
  15088. UploadProgress progress) {
  15089. return cli_->Patch(path, content_length, std::move(content_provider),
  15090. content_type, progress);
  15091. }
  15092. inline Result Client::Patch(const std::string &path, size_t content_length,
  15093. ContentProvider content_provider,
  15094. const std::string &content_type,
  15095. ContentReceiver content_receiver,
  15096. UploadProgress progress) {
  15097. return cli_->Patch(path, content_length, std::move(content_provider),
  15098. content_type, std::move(content_receiver), progress);
  15099. }
  15100. inline Result Client::Patch(const std::string &path,
  15101. ContentProviderWithoutLength content_provider,
  15102. const std::string &content_type,
  15103. UploadProgress progress) {
  15104. return cli_->Patch(path, std::move(content_provider), content_type, progress);
  15105. }
  15106. inline Result Client::Patch(const std::string &path,
  15107. ContentProviderWithoutLength content_provider,
  15108. const std::string &content_type,
  15109. ContentReceiver content_receiver,
  15110. UploadProgress progress) {
  15111. return cli_->Patch(path, std::move(content_provider), content_type,
  15112. std::move(content_receiver), progress);
  15113. }
  15114. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15115. size_t content_length,
  15116. ContentProvider content_provider,
  15117. const std::string &content_type,
  15118. UploadProgress progress) {
  15119. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15120. content_type, progress);
  15121. }
  15122. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15123. size_t content_length,
  15124. ContentProvider content_provider,
  15125. const std::string &content_type,
  15126. ContentReceiver content_receiver,
  15127. UploadProgress progress) {
  15128. return cli_->Patch(path, headers, content_length, std::move(content_provider),
  15129. content_type, std::move(content_receiver), progress);
  15130. }
  15131. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15132. ContentProviderWithoutLength content_provider,
  15133. const std::string &content_type,
  15134. UploadProgress progress) {
  15135. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15136. progress);
  15137. }
  15138. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15139. ContentProviderWithoutLength content_provider,
  15140. const std::string &content_type,
  15141. ContentReceiver content_receiver,
  15142. UploadProgress progress) {
  15143. return cli_->Patch(path, headers, std::move(content_provider), content_type,
  15144. std::move(content_receiver), progress);
  15145. }
  15146. inline Result Client::Patch(const std::string &path, const Params &params) {
  15147. return cli_->Patch(path, params);
  15148. }
  15149. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15150. const Params &params) {
  15151. return cli_->Patch(path, headers, params);
  15152. }
  15153. inline Result Client::Patch(const std::string &path,
  15154. const UploadFormDataItems &items,
  15155. UploadProgress progress) {
  15156. return cli_->Patch(path, items, progress);
  15157. }
  15158. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15159. const UploadFormDataItems &items,
  15160. UploadProgress progress) {
  15161. return cli_->Patch(path, headers, items, progress);
  15162. }
  15163. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15164. const UploadFormDataItems &items,
  15165. const std::string &boundary,
  15166. UploadProgress progress) {
  15167. return cli_->Patch(path, headers, items, boundary, progress);
  15168. }
  15169. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15170. const UploadFormDataItems &items,
  15171. const FormDataProviderItems &provider_items,
  15172. UploadProgress progress) {
  15173. return cli_->Patch(path, headers, items, provider_items, progress);
  15174. }
  15175. inline Result Client::Patch(const std::string &path, const Headers &headers,
  15176. const std::string &body,
  15177. const std::string &content_type,
  15178. ContentReceiver content_receiver,
  15179. DownloadProgress progress) {
  15180. return cli_->Patch(path, headers, body, content_type, content_receiver,
  15181. progress);
  15182. }
  15183. inline Result Client::Delete(const std::string &path,
  15184. DownloadProgress progress) {
  15185. return cli_->Delete(path, progress);
  15186. }
  15187. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15188. DownloadProgress progress) {
  15189. return cli_->Delete(path, headers, progress);
  15190. }
  15191. inline Result Client::Delete(const std::string &path, const char *body,
  15192. size_t content_length,
  15193. const std::string &content_type,
  15194. DownloadProgress progress) {
  15195. return cli_->Delete(path, body, content_length, content_type, progress);
  15196. }
  15197. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15198. const char *body, size_t content_length,
  15199. const std::string &content_type,
  15200. DownloadProgress progress) {
  15201. return cli_->Delete(path, headers, body, content_length, content_type,
  15202. progress);
  15203. }
  15204. inline Result Client::Delete(const std::string &path, const std::string &body,
  15205. const std::string &content_type,
  15206. DownloadProgress progress) {
  15207. return cli_->Delete(path, body, content_type, progress);
  15208. }
  15209. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15210. const std::string &body,
  15211. const std::string &content_type,
  15212. DownloadProgress progress) {
  15213. return cli_->Delete(path, headers, body, content_type, progress);
  15214. }
  15215. inline Result Client::Delete(const std::string &path, const Params &params,
  15216. DownloadProgress progress) {
  15217. return cli_->Delete(path, params, progress);
  15218. }
  15219. inline Result Client::Delete(const std::string &path, const Headers &headers,
  15220. const Params &params, DownloadProgress progress) {
  15221. return cli_->Delete(path, headers, params, progress);
  15222. }
  15223. inline Result Client::Options(const std::string &path) {
  15224. return cli_->Options(path);
  15225. }
  15226. inline Result Client::Options(const std::string &path, const Headers &headers) {
  15227. return cli_->Options(path, headers);
  15228. }
  15229. inline ClientImpl::StreamHandle
  15230. Client::open_stream(const std::string &method, const std::string &path,
  15231. const Params &params, const Headers &headers,
  15232. const std::string &body, const std::string &content_type) {
  15233. return cli_->open_stream(method, path, params, headers, body, content_type);
  15234. }
  15235. inline bool Client::send(Request &req, Response &res, Error &error) {
  15236. return cli_->send(req, res, error);
  15237. }
  15238. inline Result Client::send(const Request &req) { return cli_->send(req); }
  15239. inline void Client::stop() { cli_->stop(); }
  15240. inline std::string Client::host() const { return cli_->host(); }
  15241. inline int Client::port() const { return cli_->port(); }
  15242. inline size_t Client::is_socket_open() const { return cli_->is_socket_open(); }
  15243. inline socket_t Client::socket() const { return cli_->socket(); }
  15244. inline void
  15245. Client::set_hostname_addr_map(std::map<std::string, std::string> addr_map) {
  15246. cli_->set_hostname_addr_map(std::move(addr_map));
  15247. }
  15248. inline void Client::set_default_headers(Headers headers) {
  15249. cli_->set_default_headers(std::move(headers));
  15250. }
  15251. inline void Client::set_header_writer(
  15252. std::function<ssize_t(Stream &, Headers &)> const &writer) {
  15253. cli_->set_header_writer(writer);
  15254. }
  15255. inline void Client::set_address_family(int family) {
  15256. cli_->set_address_family(family);
  15257. }
  15258. inline void Client::set_tcp_nodelay(bool on) { cli_->set_tcp_nodelay(on); }
  15259. inline void Client::set_socket_options(SocketOptions socket_options) {
  15260. cli_->set_socket_options(std::move(socket_options));
  15261. }
  15262. inline void Client::set_connection_timeout(time_t sec, time_t usec) {
  15263. cli_->set_connection_timeout(sec, usec);
  15264. }
  15265. inline void Client::set_read_timeout(time_t sec, time_t usec) {
  15266. cli_->set_read_timeout(sec, usec);
  15267. }
  15268. inline void Client::set_write_timeout(time_t sec, time_t usec) {
  15269. cli_->set_write_timeout(sec, usec);
  15270. }
  15271. inline void Client::set_basic_auth(const std::string &username,
  15272. const std::string &password) {
  15273. cli_->set_basic_auth(username, password);
  15274. }
  15275. inline void Client::set_bearer_token_auth(const std::string &token) {
  15276. cli_->set_bearer_token_auth(token);
  15277. }
  15278. inline void Client::set_keep_alive(bool on) { cli_->set_keep_alive(on); }
  15279. inline void Client::set_follow_location(bool on) {
  15280. cli_->set_follow_location(on);
  15281. }
  15282. inline void Client::set_path_encode(bool on) { cli_->set_path_encode(on); }
  15283. inline void Client::set_compress(bool on) { cli_->set_compress(on); }
  15284. inline void Client::set_decompress(bool on) { cli_->set_decompress(on); }
  15285. inline void Client::set_payload_max_length(size_t length) {
  15286. cli_->set_payload_max_length(length);
  15287. }
  15288. inline void Client::set_interface(const std::string &intf) {
  15289. cli_->set_interface(intf);
  15290. }
  15291. inline void Client::set_proxy(const std::string &host, int port) {
  15292. cli_->set_proxy(host, port);
  15293. }
  15294. inline void Client::set_proxy_basic_auth(const std::string &username,
  15295. const std::string &password) {
  15296. cli_->set_proxy_basic_auth(username, password);
  15297. }
  15298. inline void Client::set_proxy_bearer_token_auth(const std::string &token) {
  15299. cli_->set_proxy_bearer_token_auth(token);
  15300. }
  15301. inline void Client::set_no_proxy(const std::vector<std::string> &patterns) {
  15302. cli_->set_no_proxy(patterns);
  15303. }
  15304. inline void Client::set_logger(Logger logger) {
  15305. cli_->set_logger(std::move(logger));
  15306. }
  15307. inline void Client::set_error_logger(ErrorLogger error_logger) {
  15308. cli_->set_error_logger(std::move(error_logger));
  15309. }
  15310. /*
  15311. * Group 6: SSL Server and Client implementation
  15312. */
  15313. #ifdef CPPHTTPLIB_SSL_ENABLED
  15314. // SSL HTTP server implementation
  15315. inline SSLServer::SSLServer(const char *cert_path, const char *private_key_path,
  15316. const char *client_ca_cert_file_path,
  15317. const char *client_ca_cert_dir_path,
  15318. const char *private_key_password) {
  15319. using namespace tls;
  15320. ctx_ = create_server_context();
  15321. if (!ctx_) { return; }
  15322. // Load server certificate and private key
  15323. if (!set_server_cert_file(ctx_, cert_path, private_key_path,
  15324. private_key_password)) {
  15325. last_ssl_error_ = static_cast<int>(get_error());
  15326. free_context(ctx_);
  15327. ctx_ = nullptr;
  15328. return;
  15329. }
  15330. // Load client CA certificates for client authentication
  15331. if (client_ca_cert_file_path || client_ca_cert_dir_path) {
  15332. if (!set_client_ca_file(ctx_, client_ca_cert_file_path,
  15333. client_ca_cert_dir_path)) {
  15334. last_ssl_error_ = static_cast<int>(get_error());
  15335. free_context(ctx_);
  15336. ctx_ = nullptr;
  15337. return;
  15338. }
  15339. // Enable client certificate verification
  15340. set_verify_client(ctx_, true);
  15341. }
  15342. }
  15343. inline SSLServer::SSLServer(const PemMemory &pem) {
  15344. using namespace tls;
  15345. ctx_ = create_server_context();
  15346. if (ctx_) {
  15347. if (!set_server_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15348. pem.private_key_password)) {
  15349. last_ssl_error_ = static_cast<int>(get_error());
  15350. free_context(ctx_);
  15351. ctx_ = nullptr;
  15352. } else if (pem.client_ca_pem && pem.client_ca_pem_len > 0) {
  15353. if (!load_ca_pem(ctx_, pem.client_ca_pem, pem.client_ca_pem_len)) {
  15354. last_ssl_error_ = static_cast<int>(get_error());
  15355. free_context(ctx_);
  15356. ctx_ = nullptr;
  15357. } else {
  15358. set_verify_client(ctx_, true);
  15359. }
  15360. }
  15361. }
  15362. }
  15363. inline SSLServer::SSLServer(const tls::ContextSetupCallback &setup_callback) {
  15364. using namespace tls;
  15365. ctx_ = create_server_context();
  15366. if (ctx_) {
  15367. if (!setup_callback(ctx_)) {
  15368. free_context(ctx_);
  15369. ctx_ = nullptr;
  15370. }
  15371. }
  15372. }
  15373. inline SSLServer::~SSLServer() {
  15374. if (ctx_) { tls::free_context(ctx_); }
  15375. }
  15376. inline bool SSLServer::is_valid() const {
  15377. return ctx_ != nullptr && Server::is_valid();
  15378. }
  15379. inline bool SSLServer::process_and_close_socket(socket_t sock) {
  15380. using namespace tls;
  15381. // Create TLS session with mutex protection
  15382. session_t session = nullptr;
  15383. {
  15384. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15385. session = create_session(static_cast<ctx_t>(ctx_), sock);
  15386. }
  15387. if (!session) {
  15388. last_ssl_error_ = static_cast<int>(get_error());
  15389. detail::shutdown_socket(sock);
  15390. detail::close_socket(sock);
  15391. return false;
  15392. }
  15393. // Use scope_exit to ensure cleanup on all paths (including exceptions)
  15394. bool handshake_done = false;
  15395. bool ret = false;
  15396. bool websocket_upgraded = false;
  15397. auto cleanup = detail::scope_exit([&] {
  15398. if (handshake_done) { shutdown(session, !websocket_upgraded && ret); }
  15399. free_session(session);
  15400. detail::shutdown_socket(sock);
  15401. detail::close_socket(sock);
  15402. });
  15403. // Perform TLS accept handshake with timeout
  15404. TlsError tls_err;
  15405. if (!accept_nonblocking(session, sock, read_timeout_sec_, read_timeout_usec_,
  15406. &tls_err)) {
  15407. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15408. // Map TlsError to legacy ssl_error for backward compatibility
  15409. if (tls_err.code == ErrorCode::WantRead) {
  15410. last_ssl_error_ = SSL_ERROR_WANT_READ;
  15411. } else if (tls_err.code == ErrorCode::WantWrite) {
  15412. last_ssl_error_ = SSL_ERROR_WANT_WRITE;
  15413. } else {
  15414. last_ssl_error_ = SSL_ERROR_SSL;
  15415. }
  15416. #else
  15417. last_ssl_error_ = static_cast<int>(get_error());
  15418. #endif
  15419. return false;
  15420. }
  15421. handshake_done = true;
  15422. std::string remote_addr;
  15423. int remote_port = 0;
  15424. detail::get_remote_ip_and_port(sock, remote_addr, remote_port);
  15425. std::string local_addr;
  15426. int local_port = 0;
  15427. detail::get_local_ip_and_port(sock, local_addr, local_port);
  15428. ret = serve_guarded([&]() {
  15429. return detail::process_server_socket_ssl(
  15430. svr_sock_, session, sock, keep_alive_max_count_,
  15431. keep_alive_timeout_sec_, read_timeout_sec_, read_timeout_usec_,
  15432. write_timeout_sec_, write_timeout_usec_,
  15433. [&](Stream &strm, bool close_connection, bool &connection_closed) {
  15434. return process_request(
  15435. strm, remote_addr, remote_port, local_addr, local_port,
  15436. close_connection, connection_closed,
  15437. [&](Request &req) { req.ssl = session; }, &websocket_upgraded);
  15438. });
  15439. });
  15440. return ret;
  15441. }
  15442. inline bool SSLServer::update_certs_pem(const char *cert_pem,
  15443. const char *key_pem,
  15444. const char *client_ca_pem,
  15445. const char *password) {
  15446. if (!ctx_) { return false; }
  15447. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15448. if (!tls::update_server_cert(ctx_, cert_pem, key_pem, password)) {
  15449. return false;
  15450. }
  15451. if (client_ca_pem) {
  15452. return tls::update_server_client_ca(ctx_, client_ca_pem);
  15453. }
  15454. return true;
  15455. }
  15456. // SSL HTTP client implementation
  15457. inline SSLClient::~SSLClient() {
  15458. // Make sure to shut down SSL since shutdown_ssl will resolve to the
  15459. // base function rather than the derived function once we get to the
  15460. // base class destructor, and won't free the SSL (causing a leak).
  15461. // This must happen before the context is freed below: some backends
  15462. // (e.g. mbedTLS) have the SSL session borrow a raw pointer into the
  15463. // context, so freeing the context first leaves close_notify reading
  15464. // freed memory.
  15465. shutdown_ssl_impl(socket_, true);
  15466. if (ctx_) {
  15467. tls::free_context(ctx_);
  15468. ctx_ = nullptr;
  15469. }
  15470. }
  15471. inline bool SSLClient::is_valid() const { return ctx_ != nullptr; }
  15472. inline void SSLClient::shutdown_ssl(Socket &socket, bool shutdown_gracefully) {
  15473. shutdown_ssl_impl(socket, shutdown_gracefully);
  15474. }
  15475. inline void SSLClient::shutdown_ssl_impl(Socket &socket,
  15476. bool shutdown_gracefully) {
  15477. if (socket.sock == INVALID_SOCKET) {
  15478. assert(socket.ssl == nullptr);
  15479. return;
  15480. }
  15481. if (socket.ssl) {
  15482. tls::shutdown(socket.ssl, shutdown_gracefully);
  15483. {
  15484. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15485. tls::free_session(socket.ssl);
  15486. }
  15487. socket.ssl = nullptr;
  15488. }
  15489. assert(socket.ssl == nullptr);
  15490. }
  15491. inline bool SSLClient::process_socket(
  15492. const Socket &socket,
  15493. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15494. std::function<bool(Stream &strm)> callback) {
  15495. assert(socket.ssl);
  15496. return detail::process_client_socket_ssl(
  15497. socket.ssl, socket.sock, read_timeout_sec_, read_timeout_usec_,
  15498. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_, start_time,
  15499. std::move(callback));
  15500. }
  15501. inline bool SSLClient::is_ssl() const { return true; }
  15502. inline bool SSLClient::create_and_connect_socket(Socket &socket, Error &error) {
  15503. if (!is_valid()) {
  15504. error = Error::SSLConnection;
  15505. return false;
  15506. }
  15507. return ClientImpl::create_and_connect_socket(socket, error);
  15508. }
  15509. inline bool SSLClient::setup_proxy_connection(
  15510. Socket &socket,
  15511. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15512. Response &res, bool &success, Error &error) {
  15513. if (!is_proxy_enabled_for_host(host_)) { return true; }
  15514. if (!connect_with_proxy(socket, start_time, res, success, error)) {
  15515. return false;
  15516. }
  15517. if (!initialize_ssl(socket, error)) {
  15518. success = false;
  15519. return false;
  15520. }
  15521. return true;
  15522. }
  15523. // Assumes that socket_mutex_ is locked and that there are no requests in
  15524. // flight
  15525. inline bool SSLClient::connect_with_proxy(
  15526. Socket &socket,
  15527. std::chrono::time_point<std::chrono::steady_clock> start_time,
  15528. Response &res, bool &success, Error &error) {
  15529. success = true;
  15530. Response proxy_res;
  15531. if (!detail::process_client_socket(
  15532. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15533. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15534. start_time, [&](Stream &strm) {
  15535. Request req2;
  15536. req2.method = "CONNECT";
  15537. req2.path =
  15538. detail::make_host_and_port_string_always_port(host_, port_);
  15539. if (max_timeout_msec_ > 0) {
  15540. req2.start_time_ = std::chrono::steady_clock::now();
  15541. }
  15542. return process_request(strm, req2, proxy_res, false, error);
  15543. })) {
  15544. // Thread-safe to close everything because we are assuming there are no
  15545. // requests in flight
  15546. shutdown_ssl(socket, true);
  15547. shutdown_socket(socket);
  15548. close_socket(socket);
  15549. success = false;
  15550. return false;
  15551. }
  15552. if (proxy_res.status == StatusCode::ProxyAuthenticationRequired_407) {
  15553. if (!proxy_digest_auth_username_.empty() &&
  15554. !proxy_digest_auth_password_.empty()) {
  15555. std::map<std::string, std::string> auth;
  15556. if (detail::parse_www_authenticate(proxy_res, auth, true)) {
  15557. // Close the current socket and create a new one for the authenticated
  15558. // request
  15559. shutdown_ssl(socket, true);
  15560. shutdown_socket(socket);
  15561. close_socket(socket);
  15562. // Create a new socket for the authenticated CONNECT request
  15563. if (!ensure_socket_connection(socket, error)) {
  15564. success = false;
  15565. output_error_log(error, nullptr);
  15566. return false;
  15567. }
  15568. proxy_res = Response();
  15569. if (!detail::process_client_socket(
  15570. socket.sock, read_timeout_sec_, read_timeout_usec_,
  15571. write_timeout_sec_, write_timeout_usec_, max_timeout_msec_,
  15572. start_time, [&](Stream &strm) {
  15573. Request req3;
  15574. req3.method = "CONNECT";
  15575. req3.path = detail::make_host_and_port_string_always_port(
  15576. host_, port_);
  15577. req3.headers.insert(detail::make_digest_authentication_header(
  15578. req3, auth, 1, detail::random_string(10),
  15579. proxy_digest_auth_username_, proxy_digest_auth_password_,
  15580. true));
  15581. if (max_timeout_msec_ > 0) {
  15582. req3.start_time_ = std::chrono::steady_clock::now();
  15583. }
  15584. return process_request(strm, req3, proxy_res, false, error);
  15585. })) {
  15586. // Thread-safe to close everything because we are assuming there are
  15587. // no requests in flight
  15588. shutdown_ssl(socket, true);
  15589. shutdown_socket(socket);
  15590. close_socket(socket);
  15591. success = false;
  15592. return false;
  15593. }
  15594. }
  15595. }
  15596. }
  15597. // If status code is not 200, proxy request is failed.
  15598. // Set error to ProxyConnection and return proxy response
  15599. // as the response of the request
  15600. if (proxy_res.status != StatusCode::OK_200) {
  15601. error = Error::ProxyConnection;
  15602. output_error_log(error, nullptr);
  15603. res = std::move(proxy_res);
  15604. // Thread-safe to close everything because we are assuming there are
  15605. // no requests in flight
  15606. shutdown_ssl(socket, true);
  15607. shutdown_socket(socket);
  15608. close_socket(socket);
  15609. return false;
  15610. }
  15611. return true;
  15612. }
  15613. inline bool SSLClient::ensure_socket_connection(Socket &socket, Error &error) {
  15614. if (!ClientImpl::ensure_socket_connection(socket, error)) { return false; }
  15615. if (is_proxy_enabled_for_host(host_)) { return true; }
  15616. if (!initialize_ssl(socket, error)) {
  15617. shutdown_socket(socket);
  15618. close_socket(socket);
  15619. return false;
  15620. }
  15621. return true;
  15622. }
  15623. // SSL HTTP client implementation
  15624. inline SSLClient::SSLClient(const std::string &host)
  15625. : SSLClient(host, 443, std::string(), std::string()) {}
  15626. inline SSLClient::SSLClient(const std::string &host, int port)
  15627. : SSLClient(host, port, std::string(), std::string()) {}
  15628. inline void SSLClient::init_ctx() {
  15629. ctx_ = tls::create_client_context();
  15630. if (ctx_) { tls::set_min_version(ctx_, tls::Version::TLS1_2); }
  15631. }
  15632. inline void SSLClient::reset_ctx_on_error() {
  15633. last_backend_error_ = tls::get_error();
  15634. tls::free_context(ctx_);
  15635. ctx_ = nullptr;
  15636. }
  15637. inline SSLClient::SSLClient(const std::string &host, int port,
  15638. const std::string &client_cert_path,
  15639. const std::string &client_key_path,
  15640. const std::string &private_key_password)
  15641. : ClientImpl(host, port, client_cert_path, client_key_path) {
  15642. init_ctx();
  15643. if (!ctx_) { return; }
  15644. if (!client_cert_path.empty() && !client_key_path.empty()) {
  15645. const char *password =
  15646. private_key_password.empty() ? nullptr : private_key_password.c_str();
  15647. if (!tls::set_client_cert_file(ctx_, client_cert_path.c_str(),
  15648. client_key_path.c_str(), password)) {
  15649. reset_ctx_on_error();
  15650. }
  15651. }
  15652. }
  15653. inline SSLClient::SSLClient(const std::string &host, int port,
  15654. const PemMemory &pem)
  15655. : ClientImpl(host, port) {
  15656. init_ctx();
  15657. if (!ctx_) { return; }
  15658. if (pem.cert_pem && pem.key_pem) {
  15659. if (!tls::set_client_cert_pem(ctx_, pem.cert_pem, pem.key_pem,
  15660. pem.private_key_password)) {
  15661. reset_ctx_on_error();
  15662. }
  15663. }
  15664. }
  15665. inline void SSLClient::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15666. if (ca_cert_store && ctx_) {
  15667. // set_ca_store takes ownership of ca_cert_store
  15668. tls::set_ca_store(ctx_, ca_cert_store);
  15669. ca_cert_store_set_ = true;
  15670. } else if (ca_cert_store) {
  15671. tls::free_ca_store(ca_cert_store);
  15672. }
  15673. }
  15674. inline void
  15675. SSLClient::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15676. if (!ctx_) { return; }
  15677. tls::set_verify_callback(ctx_, verifier);
  15678. }
  15679. inline void SSLClient::set_session_verifier(
  15680. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15681. session_verifier_ = std::move(verifier);
  15682. }
  15683. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15684. inline void SSLClient::enable_windows_certificate_verification(bool enabled) {
  15685. enable_windows_cert_verification_ = enabled;
  15686. }
  15687. #endif
  15688. inline void SSLClient::load_ca_cert_store(const char *ca_cert,
  15689. std::size_t size) {
  15690. if (ctx_ && ca_cert && size > 0) {
  15691. ca_cert_pem_.assign(ca_cert, size); // Store for redirect transfer
  15692. tls::load_ca_pem(ctx_, ca_cert, size);
  15693. }
  15694. }
  15695. inline bool SSLClient::load_certs() {
  15696. auto ret = true;
  15697. // call_once rather than the plain flag WebSocketClient::create_stream() uses:
  15698. // one client is shared across concurrent requests here.
  15699. std::call_once(initialize_cert_, [&]() {
  15700. std::lock_guard<std::mutex> guard(ctx_mutex_);
  15701. ret = detail::load_client_ca_config(
  15702. ctx_, ca_cert_file_path_, ca_cert_dir_path_,
  15703. !ca_cert_pem_.empty() || ca_cert_store_set_, system_ca_mode_,
  15704. last_backend_error_);
  15705. });
  15706. return ret;
  15707. }
  15708. inline bool SSLClient::initialize_ssl(Socket &socket, Error &error) {
  15709. // Load CA certificates if server verification is enabled
  15710. if (server_certificate_verification_) {
  15711. if (!load_certs()) {
  15712. error = Error::SSLLoadingCerts;
  15713. output_error_log(error, nullptr);
  15714. return false;
  15715. }
  15716. }
  15717. detail::ClientTlsSessionOptions options;
  15718. options.server_hostname_verification = server_hostname_verification_;
  15719. options.session_verifier = session_verifier_;
  15720. options.ctx_mutex = &ctx_mutex_;
  15721. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15722. // Skip Schannel when a custom CA cert is specified, as the Windows
  15723. // certificate store would not know about user-provided CA certificates.
  15724. // Also skip when system CA trust is explicitly disabled.
  15725. options.windows_cert_verification =
  15726. enable_windows_cert_verification_ &&
  15727. system_ca_mode_ != SystemCAMode::Disabled && ca_cert_file_path_.empty() &&
  15728. ca_cert_dir_path_.empty() && ca_cert_pem_.empty() && !ca_cert_store_set_;
  15729. #endif
  15730. tls::session_t session = nullptr;
  15731. // Use scope_exit to ensure session is freed on error paths
  15732. bool success = false;
  15733. auto session_guard = detail::scope_exit([&] {
  15734. if (!success) { tls::free_session(session); }
  15735. });
  15736. detail::ClientTlsSessionError tls_error;
  15737. if (!detail::setup_client_tls_session(
  15738. host_, ctx_, session, socket.sock, server_certificate_verification_,
  15739. connection_timeout_sec_, connection_timeout_usec_, &tls_error,
  15740. options)) {
  15741. error = tls_error.error;
  15742. last_ssl_error_ = tls_error.ssl_error;
  15743. last_backend_error_ = tls_error.backend_error;
  15744. output_error_log(error, nullptr);
  15745. return false;
  15746. }
  15747. success = true;
  15748. socket.ssl = session;
  15749. return true;
  15750. }
  15751. inline void Client::set_digest_auth(const std::string &username,
  15752. const std::string &password) {
  15753. cli_->set_digest_auth(username, password);
  15754. }
  15755. inline void Client::set_proxy_digest_auth(const std::string &username,
  15756. const std::string &password) {
  15757. cli_->set_proxy_digest_auth(username, password);
  15758. }
  15759. inline void Client::enable_server_certificate_verification(bool enabled) {
  15760. cli_->enable_server_certificate_verification(enabled);
  15761. }
  15762. inline void Client::enable_server_hostname_verification(bool enabled) {
  15763. cli_->enable_server_hostname_verification(enabled);
  15764. }
  15765. inline void Client::enable_system_ca(bool enabled) {
  15766. cli_->enable_system_ca(enabled);
  15767. }
  15768. #ifdef CPPHTTPLIB_WINDOWS_AUTOMATIC_ROOT_CERTIFICATES_UPDATE
  15769. inline void Client::enable_windows_certificate_verification(bool enabled) {
  15770. if (is_ssl_) {
  15771. static_cast<SSLClient &>(*cli_).enable_windows_certificate_verification(
  15772. enabled);
  15773. }
  15774. }
  15775. #endif
  15776. inline void Client::set_ca_cert_path(const std::string &ca_cert_file_path,
  15777. const std::string &ca_cert_dir_path) {
  15778. cli_->set_ca_cert_path(ca_cert_file_path, ca_cert_dir_path);
  15779. }
  15780. inline void Client::set_ca_cert_store(tls::ca_store_t ca_cert_store) {
  15781. if (is_ssl_) {
  15782. static_cast<SSLClient &>(*cli_).set_ca_cert_store(ca_cert_store);
  15783. } else if (ca_cert_store) {
  15784. tls::free_ca_store(ca_cert_store);
  15785. }
  15786. }
  15787. inline void Client::load_ca_cert_store(const char *ca_cert, std::size_t size) {
  15788. if (is_ssl_) {
  15789. // Use the PEM-based path so the CA data is retained for redirect transfer
  15790. static_cast<SSLClient &>(*cli_).load_ca_cert_store(ca_cert, size);
  15791. }
  15792. }
  15793. inline void
  15794. Client::set_server_certificate_verifier(tls::VerifyCallback verifier) {
  15795. if (is_ssl_) {
  15796. static_cast<SSLClient &>(*cli_).set_server_certificate_verifier(
  15797. std::move(verifier));
  15798. }
  15799. }
  15800. inline void Client::set_session_verifier(
  15801. std::function<SSLVerifierResponse(tls::session_t)> verifier) {
  15802. if (is_ssl_) {
  15803. static_cast<SSLClient &>(*cli_).set_session_verifier(std::move(verifier));
  15804. }
  15805. }
  15806. inline tls::ctx_t Client::tls_context() const {
  15807. if (is_ssl_) { return static_cast<SSLClient &>(*cli_).tls_context(); }
  15808. return nullptr;
  15809. }
  15810. #endif // CPPHTTPLIB_SSL_ENABLED
  15811. /*
  15812. * Group 7: TLS abstraction layer - Common API
  15813. */
  15814. #ifdef CPPHTTPLIB_SSL_ENABLED
  15815. namespace tls {
  15816. // Helper for PeerCert construction
  15817. inline PeerCert get_peer_cert_from_session(const_session_t session) {
  15818. return PeerCert(get_peer_cert(session));
  15819. }
  15820. namespace impl {
  15821. inline VerifyCallback &get_verify_callback() {
  15822. static thread_local VerifyCallback callback;
  15823. return callback;
  15824. }
  15825. inline VerifyCallback &get_mbedtls_verify_callback() {
  15826. static thread_local VerifyCallback callback;
  15827. return callback;
  15828. }
  15829. // Check if a string is an IPv4 address
  15830. inline bool is_ipv4_address(const std::string &str) {
  15831. int dots = 0;
  15832. for (char c : str) {
  15833. if (c == '.') {
  15834. dots++;
  15835. } else if (!detail::is_ascii_digit(c)) {
  15836. return false;
  15837. }
  15838. }
  15839. return dots == 3;
  15840. }
  15841. // Parse IPv4 address string to bytes
  15842. inline bool parse_ipv4(const std::string &str, unsigned char *out) {
  15843. const char *p = str.c_str();
  15844. for (int i = 0; i < 4; i++) {
  15845. if (i > 0) {
  15846. if (*p != '.') { return false; }
  15847. p++;
  15848. }
  15849. int val = 0;
  15850. int digits = 0;
  15851. while (detail::is_ascii_digit(*p)) {
  15852. val = val * 10 + (*p - '0');
  15853. if (val > 255) { return false; }
  15854. p++;
  15855. digits++;
  15856. }
  15857. if (digits == 0) { return false; }
  15858. // Reject leading zeros (e.g., "01.002.03.04") to prevent ambiguity
  15859. if (digits > 1 && *(p - digits) == '0') { return false; }
  15860. out[i] = static_cast<unsigned char>(val);
  15861. }
  15862. return *p == '\0';
  15863. }
  15864. // Parse an IP literal (IPv4 or IPv6) into raw network-order bytes.
  15865. // `out` must have room for at least 16 bytes. Returns the address length
  15866. // (4 for IPv4, 16 for IPv6) on success, or 0 if the string is not an IP
  15867. // literal. Used to match a host against iPAddress SANs the same way the
  15868. // OpenSSL backend does via X509_check_ip.
  15869. inline size_t parse_ip_address(const std::string &str, unsigned char *out) {
  15870. if (is_ipv4_address(str)) { return parse_ipv4(str, out) ? 4 : 0; }
  15871. struct in6_addr addr6 = {};
  15872. if (inet_pton(AF_INET6, str.c_str(), &addr6) == 1) {
  15873. memcpy(out, &addr6, 16);
  15874. return 16;
  15875. }
  15876. return 0;
  15877. }
  15878. #ifdef _WIN32
  15879. // Enumerate Windows system certificates and call callback with DER data
  15880. template <typename Callback>
  15881. inline bool enumerate_windows_system_certs(Callback cb) {
  15882. bool loaded = false;
  15883. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  15884. for (auto store_name : store_names) {
  15885. HCERTSTORE hStore = CertOpenSystemStoreW(0, store_name);
  15886. if (hStore) {
  15887. PCCERT_CONTEXT pContext = nullptr;
  15888. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  15889. nullptr) {
  15890. if (cb(pContext->pbCertEncoded, pContext->cbCertEncoded)) {
  15891. loaded = true;
  15892. }
  15893. }
  15894. CertCloseStore(hStore, 0);
  15895. }
  15896. }
  15897. return loaded;
  15898. }
  15899. #endif
  15900. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  15901. // Enumerate macOS Keychain certificates and call callback with DER data
  15902. template <typename Callback>
  15903. inline bool enumerate_macos_keychain_certs(Callback cb) {
  15904. bool loaded = false;
  15905. const SecTrustSettingsDomain domains[] = {
  15906. kSecTrustSettingsDomainSystem,
  15907. kSecTrustSettingsDomainAdmin,
  15908. kSecTrustSettingsDomainUser,
  15909. };
  15910. for (auto domain : domains) {
  15911. CFArrayRef certs = nullptr;
  15912. OSStatus status = SecTrustSettingsCopyCertificates(domain, &certs);
  15913. if (status != errSecSuccess || !certs) {
  15914. if (certs) CFRelease(certs);
  15915. continue;
  15916. }
  15917. CFIndex count = CFArrayGetCount(certs);
  15918. for (CFIndex i = 0; i < count; i++) {
  15919. SecCertificateRef cert =
  15920. (SecCertificateRef)CFArrayGetValueAtIndex(certs, i);
  15921. CFDataRef data = SecCertificateCopyData(cert);
  15922. if (data) {
  15923. if (cb(CFDataGetBytePtr(data),
  15924. static_cast<size_t>(CFDataGetLength(data)))) {
  15925. loaded = true;
  15926. }
  15927. CFRelease(data);
  15928. }
  15929. }
  15930. CFRelease(certs);
  15931. }
  15932. return loaded;
  15933. }
  15934. #endif
  15935. #if !defined(_WIN32) && !(defined(__APPLE__) && \
  15936. defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN))
  15937. // Common CA certificate file paths on Linux/Unix
  15938. inline const char **system_ca_paths() {
  15939. static const char *paths[] = {
  15940. "/etc/ssl/certs/ca-certificates.crt", // Debian/Ubuntu
  15941. "/etc/pki/tls/certs/ca-bundle.crt", // RHEL/CentOS
  15942. "/etc/ssl/ca-bundle.pem", // OpenSUSE
  15943. "/etc/pki/tls/cacert.pem", // OpenELEC
  15944. "/etc/ssl/cert.pem", // Alpine, FreeBSD
  15945. nullptr};
  15946. return paths;
  15947. }
  15948. // Common CA certificate directory paths on Linux/Unix
  15949. inline const char **system_ca_dirs() {
  15950. static const char *dirs[] = {"/etc/ssl/certs", // Debian/Ubuntu
  15951. "/etc/pki/tls/certs", // RHEL/CentOS
  15952. "/usr/share/ca-certificates", // Other
  15953. nullptr};
  15954. return dirs;
  15955. }
  15956. #endif
  15957. } // namespace impl
  15958. inline bool set_client_ca_file(ctx_t ctx, const char *ca_file,
  15959. const char *ca_dir) {
  15960. if (!ctx) { return false; }
  15961. bool success = true;
  15962. if (ca_file && *ca_file) {
  15963. if (!load_ca_file(ctx, ca_file)) { success = false; }
  15964. }
  15965. if (ca_dir && *ca_dir) {
  15966. if (!load_ca_dir(ctx, ca_dir)) { success = false; }
  15967. }
  15968. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  15969. // Set CA list for client certificate request (CertificateRequest message)
  15970. if (ca_file && *ca_file) {
  15971. auto list = SSL_load_client_CA_file(ca_file);
  15972. if (list) { SSL_CTX_set_client_CA_list(static_cast<SSL_CTX *>(ctx), list); }
  15973. }
  15974. #endif
  15975. return success;
  15976. }
  15977. inline bool set_server_cert_pem(ctx_t ctx, const char *cert, const char *key,
  15978. const char *password) {
  15979. return set_client_cert_pem(ctx, cert, key, password);
  15980. }
  15981. inline bool set_server_cert_file(ctx_t ctx, const char *cert_path,
  15982. const char *key_path, const char *password) {
  15983. return set_client_cert_file(ctx, cert_path, key_path, password);
  15984. }
  15985. // PeerCert implementation
  15986. inline PeerCert::PeerCert() = default;
  15987. inline PeerCert::PeerCert(cert_t cert) : cert_(cert) {}
  15988. inline PeerCert::PeerCert(PeerCert &&other) noexcept : cert_(other.cert_) {
  15989. other.cert_ = nullptr;
  15990. }
  15991. inline PeerCert &PeerCert::operator=(PeerCert &&other) noexcept {
  15992. if (this != &other) {
  15993. if (cert_) { free_cert(cert_); }
  15994. cert_ = other.cert_;
  15995. other.cert_ = nullptr;
  15996. }
  15997. return *this;
  15998. }
  15999. inline PeerCert::~PeerCert() {
  16000. if (cert_) { free_cert(cert_); }
  16001. }
  16002. inline PeerCert::operator bool() const { return cert_ != nullptr; }
  16003. inline std::string PeerCert::subject_cn() const {
  16004. return cert_ ? get_cert_subject_cn(cert_) : std::string();
  16005. }
  16006. inline std::string PeerCert::issuer_name() const {
  16007. return cert_ ? get_cert_issuer_name(cert_) : std::string();
  16008. }
  16009. inline bool PeerCert::check_hostname(const char *hostname) const {
  16010. return cert_ ? verify_hostname(cert_, hostname) : false;
  16011. }
  16012. inline std::vector<SanEntry> PeerCert::sans() const {
  16013. std::vector<SanEntry> result;
  16014. if (cert_) { get_cert_sans(cert_, result); }
  16015. return result;
  16016. }
  16017. inline bool PeerCert::validity(time_t &not_before, time_t &not_after) const {
  16018. return cert_ ? get_cert_validity(cert_, not_before, not_after) : false;
  16019. }
  16020. inline std::string PeerCert::serial() const {
  16021. return cert_ ? get_cert_serial(cert_) : std::string();
  16022. }
  16023. // VerifyContext method implementations
  16024. inline std::string VerifyContext::subject_cn() const {
  16025. return cert ? get_cert_subject_cn(cert) : std::string();
  16026. }
  16027. inline std::string VerifyContext::issuer_name() const {
  16028. return cert ? get_cert_issuer_name(cert) : std::string();
  16029. }
  16030. inline bool VerifyContext::check_hostname(const char *hostname) const {
  16031. return cert ? verify_hostname(cert, hostname) : false;
  16032. }
  16033. inline std::vector<SanEntry> VerifyContext::sans() const {
  16034. std::vector<SanEntry> result;
  16035. if (cert) { get_cert_sans(cert, result); }
  16036. return result;
  16037. }
  16038. inline bool VerifyContext::validity(time_t &not_before,
  16039. time_t &not_after) const {
  16040. return cert ? get_cert_validity(cert, not_before, not_after) : false;
  16041. }
  16042. inline std::string VerifyContext::serial() const {
  16043. return cert ? get_cert_serial(cert) : std::string();
  16044. }
  16045. // TlsError static method implementation
  16046. inline std::string TlsError::verify_error_to_string(long error_code) {
  16047. return verify_error_string(error_code);
  16048. }
  16049. } // namespace tls
  16050. // Request::peer_cert() implementation
  16051. inline tls::PeerCert Request::peer_cert() const {
  16052. return tls::get_peer_cert_from_session(ssl);
  16053. }
  16054. // Request::sni() implementation
  16055. inline std::string Request::sni() const {
  16056. if (!ssl) { return std::string(); }
  16057. const char *s = tls::get_sni(ssl);
  16058. return s ? std::string(s) : std::string();
  16059. }
  16060. #endif // CPPHTTPLIB_SSL_ENABLED
  16061. /*
  16062. * Group 8: TLS abstraction layer - OpenSSL backend
  16063. */
  16064. /*
  16065. * OpenSSL Backend Implementation
  16066. */
  16067. #ifdef CPPHTTPLIB_OPENSSL_SUPPORT
  16068. namespace tls {
  16069. namespace impl {
  16070. // Helper to map OpenSSL SSL_get_error to ErrorCode
  16071. inline ErrorCode map_ssl_error(int ssl_error, int &out_errno) {
  16072. switch (ssl_error) {
  16073. case SSL_ERROR_NONE: return ErrorCode::Success;
  16074. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  16075. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  16076. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  16077. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  16078. case SSL_ERROR_SSL:
  16079. default: return ErrorCode::Fatal;
  16080. }
  16081. }
  16082. // Helper: Create client CA list from PEM string
  16083. // Returns a new STACK_OF(X509_NAME)* or nullptr on failure
  16084. // Caller takes ownership of returned list
  16085. inline STACK_OF(X509_NAME) *
  16086. create_client_ca_list_from_pem(const char *ca_pem) {
  16087. if (!ca_pem) { return nullptr; }
  16088. auto ca_list = sk_X509_NAME_new_null();
  16089. if (!ca_list) { return nullptr; }
  16090. BIO *bio = BIO_new_mem_buf(ca_pem, -1);
  16091. if (!bio) {
  16092. sk_X509_NAME_pop_free(ca_list, X509_NAME_free);
  16093. return nullptr;
  16094. }
  16095. X509 *cert = nullptr;
  16096. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16097. nullptr) {
  16098. const X509_NAME *name = X509_get_subject_name(cert);
  16099. if (name) {
  16100. sk_X509_NAME_push(ca_list, X509_NAME_dup(const_cast<X509_NAME *>(name)));
  16101. }
  16102. X509_free(cert);
  16103. }
  16104. BIO_free(bio);
  16105. return ca_list;
  16106. }
  16107. // OpenSSL verify callback wrapper
  16108. inline int openssl_verify_callback(int preverify_ok, X509_STORE_CTX *ctx) {
  16109. auto &callback = get_verify_callback();
  16110. if (!callback) { return preverify_ok; }
  16111. // Get SSL object from X509_STORE_CTX
  16112. auto ssl = static_cast<SSL *>(
  16113. X509_STORE_CTX_get_ex_data(ctx, SSL_get_ex_data_X509_STORE_CTX_idx()));
  16114. if (!ssl) { return preverify_ok; }
  16115. // Get current certificate and depth
  16116. auto cert = X509_STORE_CTX_get_current_cert(ctx);
  16117. int depth = X509_STORE_CTX_get_error_depth(ctx);
  16118. int error = X509_STORE_CTX_get_error(ctx);
  16119. // Build context
  16120. VerifyContext verify_ctx;
  16121. verify_ctx.session = static_cast<session_t>(ssl);
  16122. verify_ctx.cert = static_cast<cert_t>(cert);
  16123. verify_ctx.depth = depth;
  16124. verify_ctx.preverify_ok = (preverify_ok != 0);
  16125. verify_ctx.error_code = error;
  16126. verify_ctx.error_string =
  16127. (error != X509_V_OK) ? X509_verify_cert_error_string(error) : nullptr;
  16128. return callback(verify_ctx) ? 1 : 0;
  16129. }
  16130. // X509_STORE_get0_objects is deprecated since OpenSSL 4.0 because it is not
  16131. // thread-safe; X509_STORE_get1_objects (OpenSSL 3.3+) returns a snapshot
  16132. // that must be released with release_store_objects
  16133. #if !defined(OPENSSL_IS_BORINGSSL) && !defined(LIBRESSL_VERSION_NUMBER) && \
  16134. OPENSSL_VERSION_NUMBER >= 0x30300000L
  16135. #define CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16136. #endif
  16137. inline STACK_OF(X509_OBJECT) * get_store_objects(X509_STORE *store) {
  16138. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16139. return X509_STORE_get1_objects(store);
  16140. #else
  16141. return X509_STORE_get0_objects(store);
  16142. #endif
  16143. }
  16144. inline void release_store_objects(STACK_OF(X509_OBJECT) * objs) {
  16145. #ifdef CPPHTTPLIB_HAS_X509_STORE_GET1_OBJECTS
  16146. sk_X509_OBJECT_pop_free(objs, X509_OBJECT_free);
  16147. #else
  16148. (void)objs; // get0 variant returns an internal pointer; nothing to free
  16149. #endif
  16150. }
  16151. } // namespace impl
  16152. inline ctx_t create_client_context() {
  16153. SSL_CTX *ctx = SSL_CTX_new(TLS_client_method());
  16154. if (ctx) {
  16155. // Disable auto-retry to properly handle non-blocking I/O
  16156. SSL_CTX_clear_mode(ctx, SSL_MODE_AUTO_RETRY);
  16157. // Set minimum TLS version
  16158. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16159. }
  16160. return static_cast<ctx_t>(ctx);
  16161. }
  16162. inline void free_context(ctx_t ctx) {
  16163. if (ctx) { SSL_CTX_free(static_cast<SSL_CTX *>(ctx)); }
  16164. }
  16165. inline bool set_min_version(ctx_t ctx, Version version) {
  16166. if (!ctx) return false;
  16167. return SSL_CTX_set_min_proto_version(static_cast<SSL_CTX *>(ctx),
  16168. static_cast<int>(version)) == 1;
  16169. }
  16170. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  16171. if (!ctx || !pem || len == 0) return false;
  16172. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16173. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16174. if (!store) return false;
  16175. auto bio = BIO_new_mem_buf(pem, static_cast<int>(len));
  16176. if (!bio) return false;
  16177. bool ok = true;
  16178. X509 *cert = nullptr;
  16179. while ((cert = PEM_read_bio_X509(bio, nullptr, nullptr, nullptr)) !=
  16180. nullptr) {
  16181. if (X509_STORE_add_cert(store, cert) != 1) {
  16182. // Ignore duplicate errors
  16183. auto err = ERR_peek_last_error();
  16184. if (ERR_GET_REASON(err) != X509_R_CERT_ALREADY_IN_HASH_TABLE) {
  16185. ok = false;
  16186. }
  16187. }
  16188. X509_free(cert);
  16189. if (!ok) break;
  16190. }
  16191. BIO_free(bio);
  16192. // Clear any "no more certificates" errors
  16193. ERR_clear_error();
  16194. return ok;
  16195. }
  16196. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  16197. if (!ctx || !file_path) return false;
  16198. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), file_path,
  16199. nullptr) == 1;
  16200. }
  16201. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  16202. if (!ctx || !dir_path) return false;
  16203. return SSL_CTX_load_verify_locations(static_cast<SSL_CTX *>(ctx), nullptr,
  16204. dir_path) == 1;
  16205. }
  16206. inline bool load_system_certs(ctx_t ctx) {
  16207. if (!ctx) return false;
  16208. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16209. #ifdef _WIN32
  16210. // Windows: Load from system certificate store (ROOT and CA)
  16211. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16212. if (!store) return false;
  16213. bool loaded_any = false;
  16214. static const wchar_t *store_names[] = {L"ROOT", L"CA"};
  16215. for (auto store_name : store_names) {
  16216. auto hStore = CertOpenSystemStoreW(NULL, store_name);
  16217. if (!hStore) continue;
  16218. PCCERT_CONTEXT pContext = nullptr;
  16219. while ((pContext = CertEnumCertificatesInStore(hStore, pContext)) !=
  16220. nullptr) {
  16221. const unsigned char *data = pContext->pbCertEncoded;
  16222. auto x509 = d2i_X509(nullptr, &data, pContext->cbCertEncoded);
  16223. if (x509) {
  16224. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16225. X509_free(x509);
  16226. }
  16227. }
  16228. CertCloseStore(hStore, 0);
  16229. }
  16230. return loaded_any;
  16231. #elif defined(__APPLE__)
  16232. #ifdef CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN
  16233. // macOS: Load from Keychain
  16234. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16235. if (!store) return false;
  16236. bool loaded_any = false;
  16237. const SecTrustSettingsDomain domains[] = {
  16238. kSecTrustSettingsDomainSystem,
  16239. kSecTrustSettingsDomainAdmin,
  16240. kSecTrustSettingsDomainUser,
  16241. };
  16242. for (auto domain : domains) {
  16243. CFArrayRef certs = nullptr;
  16244. if (SecTrustSettingsCopyCertificates(domain, &certs) != errSecSuccess ||
  16245. !certs) {
  16246. if (certs) CFRelease(certs);
  16247. continue;
  16248. }
  16249. auto count = CFArrayGetCount(certs);
  16250. for (CFIndex i = 0; i < count; i++) {
  16251. auto cert = reinterpret_cast<SecCertificateRef>(
  16252. const_cast<void *>(CFArrayGetValueAtIndex(certs, i)));
  16253. CFDataRef der = SecCertificateCopyData(cert);
  16254. if (der) {
  16255. const unsigned char *data = CFDataGetBytePtr(der);
  16256. auto x509 = d2i_X509(nullptr, &data, CFDataGetLength(der));
  16257. if (x509) {
  16258. if (X509_STORE_add_cert(store, x509) == 1) { loaded_any = true; }
  16259. X509_free(x509);
  16260. }
  16261. CFRelease(der);
  16262. }
  16263. }
  16264. CFRelease(certs);
  16265. }
  16266. return loaded_any || SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16267. #else
  16268. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16269. #endif
  16270. #else
  16271. // Other Unix: use default verify paths
  16272. return SSL_CTX_set_default_verify_paths(ssl_ctx) == 1;
  16273. #endif
  16274. }
  16275. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  16276. const char *password) {
  16277. if (!ctx || !cert || !key) return false;
  16278. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16279. // Load certificate
  16280. auto cert_bio = BIO_new_mem_buf(cert, -1);
  16281. if (!cert_bio) return false;
  16282. auto x509 = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16283. BIO_free(cert_bio);
  16284. if (!x509) return false;
  16285. auto cert_ok = SSL_CTX_use_certificate(ssl_ctx, x509) == 1;
  16286. X509_free(x509);
  16287. if (!cert_ok) return false;
  16288. // Load private key
  16289. auto key_bio = BIO_new_mem_buf(key, -1);
  16290. if (!key_bio) return false;
  16291. auto pkey = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16292. password ? const_cast<char *>(password)
  16293. : nullptr);
  16294. BIO_free(key_bio);
  16295. if (!pkey) return false;
  16296. auto key_ok = SSL_CTX_use_PrivateKey(ssl_ctx, pkey) == 1;
  16297. EVP_PKEY_free(pkey);
  16298. return key_ok && SSL_CTX_check_private_key(ssl_ctx) == 1;
  16299. }
  16300. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  16301. const char *key_path, const char *password) {
  16302. if (!ctx || !cert_path || !key_path) return false;
  16303. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16304. if (password && password[0] != '\0') {
  16305. SSL_CTX_set_default_passwd_cb_userdata(
  16306. ssl_ctx, reinterpret_cast<void *>(const_cast<char *>(password)));
  16307. }
  16308. return SSL_CTX_use_certificate_chain_file(ssl_ctx, cert_path) == 1 &&
  16309. SSL_CTX_use_PrivateKey_file(ssl_ctx, key_path, SSL_FILETYPE_PEM) == 1;
  16310. }
  16311. inline ctx_t create_server_context() {
  16312. SSL_CTX *ctx = SSL_CTX_new(TLS_server_method());
  16313. if (ctx) {
  16314. SSL_CTX_set_options(ctx, SSL_OP_NO_COMPRESSION |
  16315. SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION);
  16316. SSL_CTX_set_min_proto_version(ctx, TLS1_2_VERSION);
  16317. }
  16318. return static_cast<ctx_t>(ctx);
  16319. }
  16320. inline void set_verify_client(ctx_t ctx, bool require) {
  16321. if (!ctx) return;
  16322. SSL_CTX_set_verify(static_cast<SSL_CTX *>(ctx),
  16323. require
  16324. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  16325. : SSL_VERIFY_NONE,
  16326. nullptr);
  16327. }
  16328. inline session_t create_session(ctx_t ctx, socket_t sock) {
  16329. if (!ctx || sock == INVALID_SOCKET) return nullptr;
  16330. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16331. SSL *ssl = SSL_new(ssl_ctx);
  16332. if (!ssl) return nullptr;
  16333. // Disable auto-retry for proper non-blocking I/O handling
  16334. SSL_clear_mode(ssl, SSL_MODE_AUTO_RETRY);
  16335. auto bio = BIO_new_socket(static_cast<int>(sock), BIO_NOCLOSE);
  16336. if (!bio) {
  16337. SSL_free(ssl);
  16338. return nullptr;
  16339. }
  16340. SSL_set_bio(ssl, bio, bio);
  16341. return static_cast<session_t>(ssl);
  16342. }
  16343. inline void free_session(session_t session) {
  16344. if (session) { SSL_free(static_cast<SSL *>(session)); }
  16345. }
  16346. inline bool set_sni(session_t session, const char *hostname,
  16347. bool /*verify_hostname*/) {
  16348. if (!session || !hostname) return false;
  16349. auto ssl = static_cast<SSL *>(session);
  16350. // Set SNI (Server Name Indication) only - does not enable verification.
  16351. // OpenSSL never binds identity checking to SNI (that happens post-
  16352. // handshake in setup_client_tls_session()), so verify_hostname is unused.
  16353. #if defined(OPENSSL_IS_BORINGSSL)
  16354. return SSL_set_tlsext_host_name(ssl, hostname) == 1;
  16355. #else
  16356. // Direct call instead of macro to suppress -Wold-style-cast warning
  16357. return SSL_ctrl(ssl, SSL_CTRL_SET_TLSEXT_HOSTNAME, TLSEXT_NAMETYPE_host_name,
  16358. static_cast<void *>(const_cast<char *>(hostname))) == 1;
  16359. #endif
  16360. }
  16361. inline TlsError connect(session_t session) {
  16362. if (!session) { return TlsError(); }
  16363. auto ssl = static_cast<SSL *>(session);
  16364. auto ret = SSL_connect(ssl);
  16365. TlsError err;
  16366. if (ret == 1) {
  16367. err.code = ErrorCode::Success;
  16368. } else {
  16369. auto ssl_err = SSL_get_error(ssl, ret);
  16370. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16371. err.backend_code = ERR_get_error();
  16372. }
  16373. return err;
  16374. }
  16375. inline TlsError accept(session_t session) {
  16376. if (!session) { return TlsError(); }
  16377. auto ssl = static_cast<SSL *>(session);
  16378. auto ret = SSL_accept(ssl);
  16379. TlsError err;
  16380. if (ret == 1) {
  16381. err.code = ErrorCode::Success;
  16382. } else {
  16383. auto ssl_err = SSL_get_error(ssl, ret);
  16384. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16385. err.backend_code = ERR_get_error();
  16386. }
  16387. return err;
  16388. }
  16389. inline bool connect_nonblocking(session_t session, socket_t sock,
  16390. time_t timeout_sec, time_t timeout_usec,
  16391. TlsError *err) {
  16392. if (!session) {
  16393. if (err) { err->code = ErrorCode::Fatal; }
  16394. return false;
  16395. }
  16396. auto ssl = static_cast<SSL *>(session);
  16397. auto bio = SSL_get_rbio(ssl);
  16398. // Set non-blocking mode for handshake
  16399. detail::set_nonblocking(sock, true);
  16400. if (bio) { BIO_set_nbio(bio, 1); }
  16401. auto cleanup = detail::scope_exit([&]() {
  16402. // Restore blocking mode after handshake
  16403. if (bio) { BIO_set_nbio(bio, 0); }
  16404. detail::set_nonblocking(sock, false);
  16405. });
  16406. auto res = 0;
  16407. while ((res = SSL_connect(ssl)) != 1) {
  16408. auto ssl_err = SSL_get_error(ssl, res);
  16409. switch (ssl_err) {
  16410. case SSL_ERROR_WANT_READ:
  16411. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16412. continue;
  16413. }
  16414. break;
  16415. case SSL_ERROR_WANT_WRITE:
  16416. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16417. continue;
  16418. }
  16419. break;
  16420. default: break;
  16421. }
  16422. if (err) {
  16423. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16424. err->backend_code = ERR_get_error();
  16425. }
  16426. return false;
  16427. }
  16428. if (err) { err->code = ErrorCode::Success; }
  16429. return true;
  16430. }
  16431. inline bool accept_nonblocking(session_t session, socket_t sock,
  16432. time_t timeout_sec, time_t timeout_usec,
  16433. TlsError *err) {
  16434. if (!session) {
  16435. if (err) { err->code = ErrorCode::Fatal; }
  16436. return false;
  16437. }
  16438. auto ssl = static_cast<SSL *>(session);
  16439. auto bio = SSL_get_rbio(ssl);
  16440. // Set non-blocking mode for handshake
  16441. detail::set_nonblocking(sock, true);
  16442. if (bio) { BIO_set_nbio(bio, 1); }
  16443. auto cleanup = detail::scope_exit([&]() {
  16444. // Restore blocking mode after handshake
  16445. if (bio) { BIO_set_nbio(bio, 0); }
  16446. detail::set_nonblocking(sock, false);
  16447. });
  16448. auto res = 0;
  16449. while ((res = SSL_accept(ssl)) != 1) {
  16450. auto ssl_err = SSL_get_error(ssl, res);
  16451. switch (ssl_err) {
  16452. case SSL_ERROR_WANT_READ:
  16453. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  16454. continue;
  16455. }
  16456. break;
  16457. case SSL_ERROR_WANT_WRITE:
  16458. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  16459. continue;
  16460. }
  16461. break;
  16462. default: break;
  16463. }
  16464. if (err) {
  16465. err->code = impl::map_ssl_error(ssl_err, err->sys_errno);
  16466. err->backend_code = ERR_get_error();
  16467. }
  16468. return false;
  16469. }
  16470. if (err) { err->code = ErrorCode::Success; }
  16471. return true;
  16472. }
  16473. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  16474. if (!session || !buf) {
  16475. err.code = ErrorCode::Fatal;
  16476. return -1;
  16477. }
  16478. auto ssl = static_cast<SSL *>(session);
  16479. constexpr auto max_len =
  16480. static_cast<size_t>((std::numeric_limits<int>::max)());
  16481. if (len > max_len) { len = max_len; }
  16482. auto ret = SSL_read(ssl, buf, static_cast<int>(len));
  16483. if (ret > 0) {
  16484. err.code = ErrorCode::Success;
  16485. return ret;
  16486. }
  16487. auto ssl_err = SSL_get_error(ssl, ret);
  16488. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16489. if (err.code == ErrorCode::PeerClosed) {
  16490. return 0;
  16491. } // Gracefully handle the peer closed state.
  16492. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16493. return -1;
  16494. }
  16495. inline ssize_t write(session_t session, const void *buf, size_t len,
  16496. TlsError &err) {
  16497. if (!session || !buf) {
  16498. err.code = ErrorCode::Fatal;
  16499. return -1;
  16500. }
  16501. auto ssl = static_cast<SSL *>(session);
  16502. auto ret = SSL_write(ssl, buf, static_cast<int>(len));
  16503. if (ret > 0) {
  16504. err.code = ErrorCode::Success;
  16505. return ret;
  16506. }
  16507. auto ssl_err = SSL_get_error(ssl, ret);
  16508. err.code = impl::map_ssl_error(ssl_err, err.sys_errno);
  16509. if (err.code == ErrorCode::Fatal) { err.backend_code = ERR_get_error(); }
  16510. return -1;
  16511. }
  16512. inline int pending(const_session_t session) {
  16513. if (!session) return 0;
  16514. return SSL_pending(static_cast<SSL *>(const_cast<void *>(session)));
  16515. }
  16516. inline void shutdown(session_t session, bool graceful) {
  16517. if (!session) return;
  16518. auto ssl = static_cast<SSL *>(session);
  16519. if (graceful) {
  16520. // Send close_notify without waiting for the peer's. The connection is
  16521. // closed right after this, so a unidirectional shutdown is enough, and an
  16522. // idle peer that never answers would otherwise hold this thread until the
  16523. // read timeout. The other backends do not wait either.
  16524. SSL_shutdown(ssl);
  16525. }
  16526. }
  16527. inline bool is_peer_closed(session_t session, socket_t sock) {
  16528. if (!session) return true;
  16529. // Temporarily set socket to non-blocking to avoid blocking on SSL_peek
  16530. detail::set_nonblocking(sock, true);
  16531. auto se = detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  16532. auto ssl = static_cast<SSL *>(session);
  16533. char buf;
  16534. auto ret = SSL_peek(ssl, &buf, 1);
  16535. if (ret > 0) return false;
  16536. auto err = SSL_get_error(ssl, ret);
  16537. return err == SSL_ERROR_ZERO_RETURN;
  16538. }
  16539. inline cert_t get_peer_cert(const_session_t session) {
  16540. if (!session) return nullptr;
  16541. return static_cast<cert_t>(SSL_get1_peer_certificate(
  16542. static_cast<SSL *>(const_cast<void *>(session))));
  16543. }
  16544. inline void free_cert(cert_t cert) {
  16545. if (cert) { X509_free(static_cast<X509 *>(cert)); }
  16546. }
  16547. inline bool verify_hostname(cert_t cert, const char *hostname) {
  16548. if (!cert || !hostname) return false;
  16549. auto x509 = static_cast<X509 *>(cert);
  16550. // Use X509_check_ip_asc for IP addresses, X509_check_host for DNS names
  16551. if (detail::is_ip_address(hostname)) {
  16552. return X509_check_ip_asc(x509, hostname, 0) == 1;
  16553. }
  16554. return X509_check_host(x509, hostname, strlen(hostname), 0, nullptr) == 1;
  16555. }
  16556. inline uint64_t hostname_mismatch_code() {
  16557. return static_cast<uint64_t>(X509_V_ERR_HOSTNAME_MISMATCH);
  16558. }
  16559. inline long get_verify_result(const_session_t session) {
  16560. if (!session) return X509_V_ERR_UNSPECIFIED;
  16561. return SSL_get_verify_result(static_cast<SSL *>(const_cast<void *>(session)));
  16562. }
  16563. inline std::string get_cert_subject_cn(cert_t cert) {
  16564. if (!cert) return "";
  16565. auto x509 = static_cast<X509 *>(cert);
  16566. auto subject_name = X509_get_subject_name(x509);
  16567. if (!subject_name) return "";
  16568. // X509_NAME_get_text_by_NID is deprecated since OpenSSL 4.0
  16569. auto idx = X509_NAME_get_index_by_NID(subject_name, NID_commonName, -1);
  16570. if (idx < 0) return "";
  16571. auto entry = X509_NAME_get_entry(subject_name, idx);
  16572. if (!entry) return "";
  16573. auto data = X509_NAME_ENTRY_get_data(entry);
  16574. if (!data) return "";
  16575. return std::string(
  16576. reinterpret_cast<const char *>(ASN1_STRING_get0_data(data)),
  16577. static_cast<size_t>(ASN1_STRING_length(data)));
  16578. }
  16579. inline std::string get_cert_issuer_name(cert_t cert) {
  16580. if (!cert) return "";
  16581. auto x509 = static_cast<X509 *>(cert);
  16582. auto issuer_name = X509_get_issuer_name(x509);
  16583. if (!issuer_name) return "";
  16584. char buf[256];
  16585. X509_NAME_oneline(issuer_name, buf, sizeof(buf));
  16586. return std::string(buf);
  16587. }
  16588. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  16589. sans.clear();
  16590. if (!cert) return false;
  16591. auto x509 = static_cast<X509 *>(cert);
  16592. auto names = static_cast<GENERAL_NAMES *>(
  16593. X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  16594. if (!names) return true; // No SANs is valid
  16595. auto count = sk_GENERAL_NAME_num(names);
  16596. for (decltype(count) i = 0; i < count; i++) {
  16597. auto gen = sk_GENERAL_NAME_value(names, i);
  16598. if (!gen) continue;
  16599. SanEntry entry;
  16600. switch (gen->type) {
  16601. case GEN_DNS:
  16602. entry.type = SanType::DNS;
  16603. if (gen->d.dNSName) {
  16604. entry.value = std::string(
  16605. reinterpret_cast<const char *>(
  16606. ASN1_STRING_get0_data(gen->d.dNSName)),
  16607. static_cast<size_t>(ASN1_STRING_length(gen->d.dNSName)));
  16608. }
  16609. break;
  16610. case GEN_IPADD:
  16611. entry.type = SanType::IP;
  16612. if (gen->d.iPAddress) {
  16613. auto data = ASN1_STRING_get0_data(gen->d.iPAddress);
  16614. auto len = ASN1_STRING_length(gen->d.iPAddress);
  16615. if (len == 4) {
  16616. // IPv4
  16617. char buf[INET_ADDRSTRLEN];
  16618. inet_ntop(AF_INET, data, buf, sizeof(buf));
  16619. entry.value = buf;
  16620. } else if (len == 16) {
  16621. // IPv6
  16622. char buf[INET6_ADDRSTRLEN];
  16623. inet_ntop(AF_INET6, data, buf, sizeof(buf));
  16624. entry.value = buf;
  16625. }
  16626. }
  16627. break;
  16628. case GEN_EMAIL:
  16629. entry.type = SanType::EMAIL;
  16630. if (gen->d.rfc822Name) {
  16631. entry.value = std::string(
  16632. reinterpret_cast<const char *>(
  16633. ASN1_STRING_get0_data(gen->d.rfc822Name)),
  16634. static_cast<size_t>(ASN1_STRING_length(gen->d.rfc822Name)));
  16635. }
  16636. break;
  16637. case GEN_URI:
  16638. entry.type = SanType::URI;
  16639. if (gen->d.uniformResourceIdentifier) {
  16640. entry.value = std::string(
  16641. reinterpret_cast<const char *>(
  16642. ASN1_STRING_get0_data(gen->d.uniformResourceIdentifier)),
  16643. static_cast<size_t>(
  16644. ASN1_STRING_length(gen->d.uniformResourceIdentifier)));
  16645. }
  16646. break;
  16647. default: entry.type = SanType::OTHER; break;
  16648. }
  16649. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  16650. }
  16651. GENERAL_NAMES_free(names);
  16652. return true;
  16653. }
  16654. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  16655. time_t &not_after) {
  16656. if (!cert) return false;
  16657. auto x509 = static_cast<X509 *>(cert);
  16658. auto nb = X509_get0_notBefore(x509);
  16659. auto na = X509_get0_notAfter(x509);
  16660. if (!nb || !na) return false;
  16661. ASN1_TIME *epoch = ASN1_TIME_new();
  16662. if (!epoch) return false;
  16663. auto se = detail::scope_exit([&] { ASN1_TIME_free(epoch); });
  16664. if (!ASN1_TIME_set(epoch, 0)) return false;
  16665. int pday, psec;
  16666. if (!ASN1_TIME_diff(&pday, &psec, epoch, nb)) return false;
  16667. not_before = 86400 * (time_t)pday + psec;
  16668. if (!ASN1_TIME_diff(&pday, &psec, epoch, na)) return false;
  16669. not_after = 86400 * (time_t)pday + psec;
  16670. return true;
  16671. }
  16672. inline std::string get_cert_serial(cert_t cert) {
  16673. if (!cert) return "";
  16674. auto x509 = static_cast<X509 *>(cert);
  16675. auto serial = X509_get_serialNumber(x509);
  16676. if (!serial) return "";
  16677. auto bn = ASN1_INTEGER_to_BN(serial, nullptr);
  16678. if (!bn) return "";
  16679. auto hex = BN_bn2hex(bn);
  16680. BN_free(bn);
  16681. if (!hex) return "";
  16682. std::string result(hex);
  16683. OPENSSL_free(hex);
  16684. return result;
  16685. }
  16686. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  16687. if (!cert) return false;
  16688. auto x509 = static_cast<X509 *>(cert);
  16689. auto len = i2d_X509(x509, nullptr);
  16690. if (len < 0) return false;
  16691. der.resize(static_cast<size_t>(len));
  16692. auto p = der.data();
  16693. i2d_X509(x509, &p);
  16694. return true;
  16695. }
  16696. inline const char *get_sni(const_session_t session) {
  16697. if (!session) return nullptr;
  16698. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16699. return SSL_get_servername(ssl, TLSEXT_NAMETYPE_host_name);
  16700. }
  16701. inline uint64_t peek_error() { return ERR_peek_last_error(); }
  16702. inline uint64_t get_error() { return ERR_get_error(); }
  16703. inline std::string error_string(uint64_t code) {
  16704. char buf[256];
  16705. ERR_error_string_n(static_cast<unsigned long>(code), buf, sizeof(buf));
  16706. return std::string(buf);
  16707. }
  16708. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  16709. auto mem = BIO_new_mem_buf(pem, static_cast<int>(len));
  16710. if (!mem) { return nullptr; }
  16711. auto mem_guard = detail::scope_exit([&] { BIO_free_all(mem); });
  16712. auto inf = PEM_X509_INFO_read_bio(mem, nullptr, nullptr, nullptr);
  16713. if (!inf) { return nullptr; }
  16714. auto store = X509_STORE_new();
  16715. if (store) {
  16716. for (auto i = 0; i < static_cast<int>(sk_X509_INFO_num(inf)); i++) {
  16717. auto itmp = sk_X509_INFO_value(inf, i);
  16718. if (!itmp) { continue; }
  16719. if (itmp->x509) { X509_STORE_add_cert(store, itmp->x509); }
  16720. if (itmp->crl) { X509_STORE_add_crl(store, itmp->crl); }
  16721. }
  16722. }
  16723. sk_X509_INFO_pop_free(inf, X509_INFO_free);
  16724. return static_cast<ca_store_t>(store);
  16725. }
  16726. inline void free_ca_store(ca_store_t store) {
  16727. if (store) { X509_STORE_free(static_cast<X509_STORE *>(store)); }
  16728. }
  16729. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  16730. if (!ctx || !store) { return false; }
  16731. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16732. auto x509_store = static_cast<X509_STORE *>(store);
  16733. // Check if same store is already set
  16734. if (SSL_CTX_get_cert_store(ssl_ctx) == x509_store) { return true; }
  16735. // SSL_CTX_set_cert_store takes ownership and frees the old store
  16736. SSL_CTX_set_cert_store(ssl_ctx, x509_store);
  16737. return true;
  16738. }
  16739. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  16740. certs.clear();
  16741. if (!ctx) { return 0; }
  16742. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16743. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16744. if (!store) { return 0; }
  16745. auto objs = impl::get_store_objects(store);
  16746. if (!objs) { return 0; }
  16747. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16748. auto count = sk_X509_OBJECT_num(objs);
  16749. for (decltype(count) i = 0; i < count; i++) {
  16750. auto obj = sk_X509_OBJECT_value(objs, i);
  16751. if (!obj) { continue; }
  16752. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16753. auto x509 = X509_OBJECT_get0_X509(obj);
  16754. if (x509) {
  16755. // Increment reference count so caller can free it
  16756. X509_up_ref(x509);
  16757. certs.push_back(static_cast<cert_t>(x509));
  16758. }
  16759. }
  16760. }
  16761. return certs.size();
  16762. }
  16763. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  16764. std::vector<std::string> names;
  16765. if (!ctx) { return names; }
  16766. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16767. auto store = SSL_CTX_get_cert_store(ssl_ctx);
  16768. if (!store) { return names; }
  16769. auto objs = impl::get_store_objects(store);
  16770. if (!objs) { return names; }
  16771. auto se = detail::scope_exit([&] { impl::release_store_objects(objs); });
  16772. auto count = sk_X509_OBJECT_num(objs);
  16773. for (decltype(count) i = 0; i < count; i++) {
  16774. auto obj = sk_X509_OBJECT_value(objs, i);
  16775. if (!obj) { continue; }
  16776. if (X509_OBJECT_get_type(obj) == X509_LU_X509) {
  16777. auto x509 = X509_OBJECT_get0_X509(obj);
  16778. if (x509) {
  16779. auto subject = X509_get_subject_name(x509);
  16780. if (subject) {
  16781. char buf[512];
  16782. X509_NAME_oneline(subject, buf, sizeof(buf));
  16783. names.push_back(buf);
  16784. }
  16785. }
  16786. }
  16787. }
  16788. return names;
  16789. }
  16790. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  16791. const char *key_pem, const char *password) {
  16792. if (!ctx || !cert_pem || !key_pem) { return false; }
  16793. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16794. // Load certificate from PEM
  16795. auto cert_bio = BIO_new_mem_buf(cert_pem, -1);
  16796. if (!cert_bio) { return false; }
  16797. auto cert = PEM_read_bio_X509(cert_bio, nullptr, nullptr, nullptr);
  16798. BIO_free(cert_bio);
  16799. if (!cert) { return false; }
  16800. // Load private key from PEM
  16801. auto key_bio = BIO_new_mem_buf(key_pem, -1);
  16802. if (!key_bio) {
  16803. X509_free(cert);
  16804. return false;
  16805. }
  16806. auto key = PEM_read_bio_PrivateKey(key_bio, nullptr, nullptr,
  16807. password ? const_cast<char *>(password)
  16808. : nullptr);
  16809. BIO_free(key_bio);
  16810. if (!key) {
  16811. X509_free(cert);
  16812. return false;
  16813. }
  16814. // Update certificate and key
  16815. auto ret = SSL_CTX_use_certificate(ssl_ctx, cert) == 1 &&
  16816. SSL_CTX_use_PrivateKey(ssl_ctx, key) == 1;
  16817. X509_free(cert);
  16818. EVP_PKEY_free(key);
  16819. return ret;
  16820. }
  16821. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  16822. if (!ctx || !ca_pem) { return false; }
  16823. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16824. // Create new X509_STORE from PEM
  16825. auto store = create_ca_store(ca_pem, strlen(ca_pem));
  16826. if (!store) { return false; }
  16827. // SSL_CTX_set_cert_store takes ownership
  16828. SSL_CTX_set_cert_store(ssl_ctx, static_cast<X509_STORE *>(store));
  16829. // Set client CA list for client certificate request
  16830. auto ca_list = impl::create_client_ca_list_from_pem(ca_pem);
  16831. if (ca_list) {
  16832. // SSL_CTX_set_client_CA_list takes ownership of ca_list
  16833. SSL_CTX_set_client_CA_list(ssl_ctx, ca_list);
  16834. }
  16835. return true;
  16836. }
  16837. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  16838. if (!ctx) { return false; }
  16839. auto ssl_ctx = static_cast<SSL_CTX *>(ctx);
  16840. impl::get_verify_callback() = std::move(callback);
  16841. if (impl::get_verify_callback()) {
  16842. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, impl::openssl_verify_callback);
  16843. } else {
  16844. SSL_CTX_set_verify(ssl_ctx, SSL_VERIFY_PEER, nullptr);
  16845. }
  16846. return true;
  16847. }
  16848. inline long get_verify_error(const_session_t session) {
  16849. if (!session) { return -1; }
  16850. auto ssl = static_cast<SSL *>(const_cast<void *>(session));
  16851. return SSL_get_verify_result(ssl);
  16852. }
  16853. inline std::string verify_error_string(long error_code) {
  16854. if (error_code == X509_V_OK) { return ""; }
  16855. const char *str = X509_verify_cert_error_string(static_cast<int>(error_code));
  16856. return str ? str : "unknown error";
  16857. }
  16858. } // namespace tls
  16859. #endif // CPPHTTPLIB_OPENSSL_SUPPORT
  16860. /*
  16861. * Group 9: TLS abstraction layer - Mbed TLS backend
  16862. */
  16863. /*
  16864. * Mbed TLS Backend Implementation
  16865. */
  16866. #ifdef CPPHTTPLIB_MBEDTLS_SUPPORT
  16867. namespace tls {
  16868. namespace impl {
  16869. // Mbed TLS session wrapper
  16870. struct MbedTlsSession {
  16871. mbedtls_ssl_context ssl;
  16872. socket_t sock = INVALID_SOCKET;
  16873. std::string hostname; // For client: set via set_sni
  16874. std::string sni_hostname; // For server: received from client via SNI callback
  16875. // Mbed TLS has no SSL_peek() equivalent, so is_peer_closed() must probe with
  16876. // a real 1-byte mbedtls_ssl_read(). If that probe lands on application data
  16877. // (e.g. a response that arrived while this side was still in its post-write
  16878. // check), the byte is pushed back here and served by the next read().
  16879. unsigned char peeked_byte = 0;
  16880. bool has_peeked_byte = false;
  16881. // Set by set_sni() when the caller disabled hostname verification, so the
  16882. // verify callback can clear the CN/SAN mismatch flag while still enforcing
  16883. // the rest of the chain (Mbed TLS ties SNI and identity checking together;
  16884. // OpenSSL and wolfSSL keep them independent).
  16885. bool suppress_hostname_mismatch = false;
  16886. // Copied from the owning MbedTlsContext at creation. set_sni() uses this to
  16887. // decide which verify callback to install when hostname verification is
  16888. // disabled: mbedtls_verify_callback() when a user callback is genuinely
  16889. // wired for this context, or a self-contained one otherwise, so a session
  16890. // that never opted into a callback never consults the process-wide
  16891. // set_verify_callback() slot (which some other, unrelated client may have
  16892. // populated).
  16893. bool has_verify_callback = false;
  16894. MbedTlsSession() { mbedtls_ssl_init(&ssl); }
  16895. ~MbedTlsSession() { mbedtls_ssl_free(&ssl); }
  16896. MbedTlsSession(const MbedTlsSession &) = delete;
  16897. MbedTlsSession &operator=(const MbedTlsSession &) = delete;
  16898. };
  16899. // Thread-local error code accessor for Mbed TLS (since it doesn't have an error
  16900. // queue)
  16901. inline int &mbedtls_last_error() {
  16902. static thread_local int err = 0;
  16903. return err;
  16904. }
  16905. // Helper to map Mbed TLS error to ErrorCode
  16906. inline ErrorCode map_mbedtls_error(int ret, int &out_errno,
  16907. uint32_t verify_flags) {
  16908. if (ret == 0) { return ErrorCode::Success; }
  16909. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return ErrorCode::WantRead; }
  16910. if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) { return ErrorCode::WantWrite; }
  16911. if (ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY) {
  16912. return ErrorCode::PeerClosed;
  16913. }
  16914. if (ret == MBEDTLS_ERR_NET_CONN_RESET || ret == MBEDTLS_ERR_NET_SEND_FAILED ||
  16915. ret == MBEDTLS_ERR_NET_RECV_FAILED) {
  16916. out_errno = errno;
  16917. return ErrorCode::SyscallError;
  16918. }
  16919. if (ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
  16920. // Unlike OpenSSL/wolfSSL, Mbed TLS folds the CN/SAN identity check into
  16921. // the handshake's chain verification (see set_sni()); a mismatch there
  16922. // is reported the same way as any other verify_flags bit. Report it as
  16923. // HostnameMismatch, matching the other backends and the post-handshake
  16924. // identity check below, but only when naming is the sole problem -
  16925. // if the chain itself is also untrusted/expired/etc., that takes
  16926. // priority over the naming detail.
  16927. if (verify_flags == static_cast<uint32_t>(hostname_mismatch_code())) {
  16928. return ErrorCode::HostnameMismatch;
  16929. }
  16930. return ErrorCode::CertVerifyFailed;
  16931. }
  16932. return ErrorCode::Fatal;
  16933. }
  16934. // Populates a TlsError from a failed (non-zero) mbedtls_ssl_handshake()
  16935. // return value, including the verify-flags-dependent HostnameMismatch
  16936. // mapping; shared by connect() and connect_nonblocking() so the
  16937. // backend_code policy for that mapping only lives in one place.
  16938. inline void fill_mbedtls_tls_error(TlsError &err, mbedtls_ssl_context &ssl,
  16939. int ret) {
  16940. auto verify_flags = mbedtls_ssl_get_verify_result(&ssl);
  16941. err.code = map_mbedtls_error(ret, err.sys_errno, verify_flags);
  16942. err.backend_code = err.code == ErrorCode::HostnameMismatch
  16943. ? static_cast<uint64_t>(verify_flags)
  16944. : static_cast<uint64_t>(-ret);
  16945. }
  16946. // A TLS 1.3 NewSessionTicket (signaled by default on Mbed TLS 4.x) is a
  16947. // non-fatal notification delivered between records, not an error and not
  16948. // application data, so I/O calls that see it should just be retried. Kept in
  16949. // one helper so the retry loops keep an intact "do { } while (...)" instead of
  16950. // splitting the closing brace across an #if.
  16951. inline bool mbedtls_is_session_ticket(int ret) {
  16952. #if defined(MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET)
  16953. return ret == MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
  16954. #else
  16955. (void)ret;
  16956. return false;
  16957. #endif
  16958. }
  16959. // BIO-like send callback for Mbed TLS
  16960. inline int mbedtls_net_send_cb(void *ctx, const unsigned char *buf,
  16961. size_t len) {
  16962. auto sock = *static_cast<socket_t *>(ctx);
  16963. #ifdef _WIN32
  16964. auto ret =
  16965. send(sock, reinterpret_cast<const char *>(buf), static_cast<int>(len), 0);
  16966. if (ret == SOCKET_ERROR) {
  16967. int err = WSAGetLastError();
  16968. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_WRITE; }
  16969. return MBEDTLS_ERR_NET_SEND_FAILED;
  16970. }
  16971. #else
  16972. auto ret = send(sock, buf, len, 0);
  16973. if (ret < 0) {
  16974. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16975. return MBEDTLS_ERR_SSL_WANT_WRITE;
  16976. }
  16977. return MBEDTLS_ERR_NET_SEND_FAILED;
  16978. }
  16979. #endif
  16980. return static_cast<int>(ret);
  16981. }
  16982. // BIO-like recv callback for Mbed TLS
  16983. inline int mbedtls_net_recv_cb(void *ctx, unsigned char *buf, size_t len) {
  16984. auto sock = *static_cast<socket_t *>(ctx);
  16985. #ifdef _WIN32
  16986. auto ret =
  16987. recv(sock, reinterpret_cast<char *>(buf), static_cast<int>(len), 0);
  16988. if (ret == SOCKET_ERROR) {
  16989. int err = WSAGetLastError();
  16990. if (err == WSAEWOULDBLOCK) { return MBEDTLS_ERR_SSL_WANT_READ; }
  16991. return MBEDTLS_ERR_NET_RECV_FAILED;
  16992. }
  16993. #else
  16994. auto ret = recv(sock, buf, len, 0);
  16995. if (ret < 0) {
  16996. if (errno == EAGAIN || errno == EWOULDBLOCK) {
  16997. return MBEDTLS_ERR_SSL_WANT_READ;
  16998. }
  16999. return MBEDTLS_ERR_NET_RECV_FAILED;
  17000. }
  17001. #endif
  17002. if (ret == 0) { return MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY; }
  17003. return static_cast<int>(ret);
  17004. }
  17005. // MbedTlsContext constructor/destructor implementations
  17006. inline MbedTlsContext::MbedTlsContext() {
  17007. mbedtls_ssl_config_init(&conf);
  17008. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17009. mbedtls_entropy_init(&entropy);
  17010. mbedtls_ctr_drbg_init(&ctr_drbg);
  17011. #endif
  17012. mbedtls_x509_crt_init(&ca_chain);
  17013. mbedtls_x509_crt_init(&own_cert);
  17014. mbedtls_pk_init(&own_key);
  17015. }
  17016. inline MbedTlsContext::~MbedTlsContext() {
  17017. mbedtls_pk_free(&own_key);
  17018. mbedtls_x509_crt_free(&own_cert);
  17019. mbedtls_x509_crt_free(&ca_chain);
  17020. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17021. mbedtls_ctr_drbg_free(&ctr_drbg);
  17022. mbedtls_entropy_free(&entropy);
  17023. #endif
  17024. mbedtls_ssl_config_free(&conf);
  17025. }
  17026. // Thread-local storage for SNI captured during handshake
  17027. // This is needed because the SNI callback doesn't have a way to pass
  17028. // session-specific data before the session is fully set up
  17029. inline std::string &mbedpending_sni() {
  17030. static thread_local std::string sni;
  17031. return sni;
  17032. }
  17033. // SNI callback for Mbed TLS server to capture client's SNI hostname
  17034. inline int mbedtls_sni_callback(void *p_ctx, mbedtls_ssl_context *ssl,
  17035. const unsigned char *name, size_t name_len) {
  17036. (void)p_ctx;
  17037. (void)ssl;
  17038. // Store SNI name in thread-local storage
  17039. // It will be retrieved and stored in the session after handshake
  17040. if (name && name_len > 0) {
  17041. mbedpending_sni().assign(reinterpret_cast<const char *>(name), name_len);
  17042. } else {
  17043. mbedpending_sni().clear();
  17044. }
  17045. return 0; // Accept any SNI
  17046. }
  17047. inline void mbedtls_clear_cn_mismatch(uint32_t *flags) {
  17048. *flags &= ~static_cast<uint32_t>(hostname_mismatch_code());
  17049. }
  17050. // Verify callback used when hostname verification is disabled for a session
  17051. // that has no user-supplied verify callback of its own (MbedTlsSession::
  17052. // has_verify_callback is false). Deliberately does not consult
  17053. // get_verify_callback(): that slot is process-wide, so reading it here would
  17054. // pick up whatever another, unrelated client last installed there.
  17055. inline int mbedtls_mask_hostname_mismatch_callback(void *data,
  17056. mbedtls_x509_crt *, int,
  17057. uint32_t *flags) {
  17058. (void)data;
  17059. mbedtls_clear_cn_mismatch(flags);
  17060. return 0;
  17061. }
  17062. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17063. int cert_depth, uint32_t *flags);
  17064. // MbedTLS verify callback wrapper
  17065. inline int mbedtls_verify_callback(void *data, mbedtls_x509_crt *crt,
  17066. int cert_depth, uint32_t *flags) {
  17067. // data points to the MbedTlsSession
  17068. auto *session = static_cast<MbedTlsSession *>(data);
  17069. // set_sni() disabled hostname verification for this session: drop the
  17070. // CN/SAN mismatch flag so it doesn't fail the chain check below, mirroring
  17071. // the OpenSSL/wolfSSL backends where identity checking is independent of
  17072. // SNI. The final pass/fail decision still comes from the remaining flags
  17073. // (or, below, from the user's own verify callback).
  17074. if (session && session->suppress_hostname_mismatch) {
  17075. mbedtls_clear_cn_mismatch(flags);
  17076. }
  17077. auto &callback = get_verify_callback();
  17078. if (!callback) { return 0; } // Continue with default verification
  17079. // Build context
  17080. VerifyContext verify_ctx;
  17081. verify_ctx.session = static_cast<session_t>(session);
  17082. verify_ctx.cert = static_cast<cert_t>(crt);
  17083. verify_ctx.depth = cert_depth;
  17084. verify_ctx.preverify_ok = (*flags == 0);
  17085. verify_ctx.error_code = static_cast<long>(*flags);
  17086. // Convert Mbed TLS flags to error string
  17087. static thread_local char error_buf[256];
  17088. if (*flags != 0) {
  17089. mbedtls_x509_crt_verify_info(error_buf, sizeof(error_buf), "", *flags);
  17090. verify_ctx.error_string = error_buf;
  17091. } else {
  17092. verify_ctx.error_string = nullptr;
  17093. }
  17094. bool accepted = callback(verify_ctx);
  17095. if (accepted) {
  17096. *flags = 0; // Clear all error flags
  17097. return 0;
  17098. }
  17099. return MBEDTLS_ERR_X509_CERT_VERIFY_FAILED;
  17100. }
  17101. } // namespace impl
  17102. inline ctx_t create_client_context() {
  17103. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17104. if (!ctx) { return nullptr; }
  17105. ctx->is_server = false;
  17106. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17107. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17108. if (!detail::ensure_mbedtls_psa_crypto()) {
  17109. delete ctx;
  17110. return nullptr;
  17111. }
  17112. int ret;
  17113. #else
  17114. // Seed the random number generator
  17115. const char *pers = "httplib_client";
  17116. int ret = mbedtls_ctr_drbg_seed(
  17117. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17118. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17119. if (ret != 0) {
  17120. impl::mbedtls_last_error() = ret;
  17121. delete ctx;
  17122. return nullptr;
  17123. }
  17124. #endif
  17125. // Set up SSL config for client
  17126. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_CLIENT,
  17127. MBEDTLS_SSL_TRANSPORT_STREAM,
  17128. MBEDTLS_SSL_PRESET_DEFAULT);
  17129. if (ret != 0) {
  17130. impl::mbedtls_last_error() = ret;
  17131. delete ctx;
  17132. return nullptr;
  17133. }
  17134. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17135. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17136. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17137. #endif
  17138. // Default: verify peer certificate
  17139. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17140. // Set minimum TLS version to 1.2
  17141. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17142. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17143. #else
  17144. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17145. MBEDTLS_SSL_MINOR_VERSION_3);
  17146. #endif
  17147. return static_cast<ctx_t>(ctx);
  17148. }
  17149. inline ctx_t create_server_context() {
  17150. auto ctx = new (std::nothrow) impl::MbedTlsContext();
  17151. if (!ctx) { return nullptr; }
  17152. ctx->is_server = true;
  17153. #ifdef CPPHTTPLIB_MBEDTLS_V4
  17154. // Mbed TLS 4.x draws randomness from PSA Crypto; just ensure it is ready.
  17155. if (!detail::ensure_mbedtls_psa_crypto()) {
  17156. delete ctx;
  17157. return nullptr;
  17158. }
  17159. int ret;
  17160. #else
  17161. // Seed the random number generator
  17162. const char *pers = "httplib_server";
  17163. int ret = mbedtls_ctr_drbg_seed(
  17164. &ctx->ctr_drbg, mbedtls_entropy_func, &ctx->entropy,
  17165. reinterpret_cast<const unsigned char *>(pers), strlen(pers));
  17166. if (ret != 0) {
  17167. impl::mbedtls_last_error() = ret;
  17168. delete ctx;
  17169. return nullptr;
  17170. }
  17171. #endif
  17172. // Set up SSL config for server
  17173. ret = mbedtls_ssl_config_defaults(&ctx->conf, MBEDTLS_SSL_IS_SERVER,
  17174. MBEDTLS_SSL_TRANSPORT_STREAM,
  17175. MBEDTLS_SSL_PRESET_DEFAULT);
  17176. if (ret != 0) {
  17177. impl::mbedtls_last_error() = ret;
  17178. delete ctx;
  17179. return nullptr;
  17180. }
  17181. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17182. // Set random number generator (Mbed TLS 4.x uses the PSA RNG implicitly)
  17183. mbedtls_ssl_conf_rng(&ctx->conf, mbedtls_ctr_drbg_random, &ctx->ctr_drbg);
  17184. #endif
  17185. // Default: don't verify client
  17186. mbedtls_ssl_conf_authmode(&ctx->conf, MBEDTLS_SSL_VERIFY_NONE);
  17187. // Set minimum TLS version to 1.2
  17188. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17189. mbedtls_ssl_conf_min_tls_version(&ctx->conf, MBEDTLS_SSL_VERSION_TLS1_2);
  17190. #else
  17191. mbedtls_ssl_conf_min_version(&ctx->conf, MBEDTLS_SSL_MAJOR_VERSION_3,
  17192. MBEDTLS_SSL_MINOR_VERSION_3);
  17193. #endif
  17194. // Set SNI callback to capture client's SNI hostname
  17195. mbedtls_ssl_conf_sni(&ctx->conf, impl::mbedtls_sni_callback, nullptr);
  17196. return static_cast<ctx_t>(ctx);
  17197. }
  17198. inline void free_context(ctx_t ctx) {
  17199. if (ctx) { delete static_cast<impl::MbedTlsContext *>(ctx); }
  17200. }
  17201. inline bool set_min_version(ctx_t ctx, Version version) {
  17202. if (!ctx) { return false; }
  17203. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17204. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17205. // Mbed TLS 3.x uses mbedtls_ssl_protocol_version enum
  17206. mbedtls_ssl_protocol_version min_ver = MBEDTLS_SSL_VERSION_TLS1_2;
  17207. if (version >= Version::TLS1_3) {
  17208. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17209. min_ver = MBEDTLS_SSL_VERSION_TLS1_3;
  17210. #endif
  17211. }
  17212. mbedtls_ssl_conf_min_tls_version(&mctx->conf, min_ver);
  17213. #else
  17214. // Mbed TLS 2.x uses major/minor version numbers
  17215. int major = MBEDTLS_SSL_MAJOR_VERSION_3;
  17216. int minor = MBEDTLS_SSL_MINOR_VERSION_3; // TLS 1.2
  17217. if (version >= Version::TLS1_3) {
  17218. #if defined(MBEDTLS_SSL_PROTO_TLS1_3)
  17219. minor = MBEDTLS_SSL_MINOR_VERSION_4; // TLS 1.3
  17220. #else
  17221. minor = MBEDTLS_SSL_MINOR_VERSION_3; // Fall back to TLS 1.2
  17222. #endif
  17223. }
  17224. mbedtls_ssl_conf_min_version(&mctx->conf, major, minor);
  17225. #endif
  17226. return true;
  17227. }
  17228. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  17229. if (!ctx || !pem) { return false; }
  17230. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17231. // mbedtls_x509_crt_parse expects null-terminated string for PEM
  17232. // Add null terminator if not present
  17233. std::string pem_str(pem, len);
  17234. int ret = mbedtls_x509_crt_parse(
  17235. &mctx->ca_chain, reinterpret_cast<const unsigned char *>(pem_str.c_str()),
  17236. pem_str.size() + 1);
  17237. if (ret != 0) {
  17238. impl::mbedtls_last_error() = ret;
  17239. return false;
  17240. }
  17241. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17242. return true;
  17243. }
  17244. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  17245. if (!ctx || !file_path) { return false; }
  17246. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17247. int ret = mbedtls_x509_crt_parse_file(&mctx->ca_chain, file_path);
  17248. if (ret != 0) {
  17249. impl::mbedtls_last_error() = ret;
  17250. return false;
  17251. }
  17252. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17253. return true;
  17254. }
  17255. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  17256. if (!ctx || !dir_path) { return false; }
  17257. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17258. int ret = mbedtls_x509_crt_parse_path(&mctx->ca_chain, dir_path);
  17259. if (ret < 0) { // Returns number of certs on success, negative on error
  17260. impl::mbedtls_last_error() = ret;
  17261. return false;
  17262. }
  17263. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17264. return true;
  17265. }
  17266. inline bool load_system_certs(ctx_t ctx) {
  17267. if (!ctx) { return false; }
  17268. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17269. bool loaded = false;
  17270. #ifdef _WIN32
  17271. loaded = impl::enumerate_windows_system_certs(
  17272. [&](const unsigned char *data, size_t len) {
  17273. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17274. });
  17275. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  17276. loaded = impl::enumerate_macos_keychain_certs(
  17277. [&](const unsigned char *data, size_t len) {
  17278. return mbedtls_x509_crt_parse_der(&mctx->ca_chain, data, len) == 0;
  17279. });
  17280. #else
  17281. for (auto path = impl::system_ca_paths(); *path; ++path) {
  17282. if (mbedtls_x509_crt_parse_file(&mctx->ca_chain, *path) >= 0) {
  17283. loaded = true;
  17284. break;
  17285. }
  17286. }
  17287. if (!loaded) {
  17288. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  17289. if (mbedtls_x509_crt_parse_path(&mctx->ca_chain, *dir) >= 0) {
  17290. loaded = true;
  17291. break;
  17292. }
  17293. }
  17294. }
  17295. #endif
  17296. if (loaded) {
  17297. mbedtls_ssl_conf_ca_chain(&mctx->conf, &mctx->ca_chain, nullptr);
  17298. }
  17299. return loaded;
  17300. }
  17301. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  17302. const char *password) {
  17303. if (!ctx || !cert || !key) { return false; }
  17304. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17305. // Parse certificate
  17306. std::string cert_str(cert);
  17307. int ret = mbedtls_x509_crt_parse(
  17308. &mctx->own_cert,
  17309. reinterpret_cast<const unsigned char *>(cert_str.c_str()),
  17310. cert_str.size() + 1);
  17311. if (ret != 0) {
  17312. impl::mbedtls_last_error() = ret;
  17313. return false;
  17314. }
  17315. // Parse private key
  17316. std::string key_str(key);
  17317. const unsigned char *pwd =
  17318. password ? reinterpret_cast<const unsigned char *>(password) : nullptr;
  17319. size_t pwd_len = password ? strlen(password) : 0;
  17320. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17321. ret = mbedtls_pk_parse_key(
  17322. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17323. key_str.size() + 1, pwd, pwd_len, mbedtls_ctr_drbg_random,
  17324. &mctx->ctr_drbg);
  17325. #else
  17326. ret = mbedtls_pk_parse_key(
  17327. &mctx->own_key, reinterpret_cast<const unsigned char *>(key_str.c_str()),
  17328. key_str.size() + 1, pwd, pwd_len);
  17329. #endif
  17330. if (ret != 0) {
  17331. impl::mbedtls_last_error() = ret;
  17332. return false;
  17333. }
  17334. // Verify that the certificate and private key match.
  17335. // Mbed TLS 4.x: mbedtls_pk_check_pair() reports a spurious mismatch for
  17336. // PSA-backed keys, so skip it and let the handshake surface a real mismatch.
  17337. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17338. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17339. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17340. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17341. #else
  17342. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17343. #endif
  17344. if (ret != 0) {
  17345. impl::mbedtls_last_error() = ret;
  17346. return false;
  17347. }
  17348. #endif
  17349. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17350. if (ret != 0) {
  17351. impl::mbedtls_last_error() = ret;
  17352. return false;
  17353. }
  17354. return true;
  17355. }
  17356. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  17357. const char *key_path, const char *password) {
  17358. if (!ctx || !cert_path || !key_path) { return false; }
  17359. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17360. // Parse certificate file
  17361. int ret = mbedtls_x509_crt_parse_file(&mctx->own_cert, cert_path);
  17362. if (ret != 0) {
  17363. impl::mbedtls_last_error() = ret;
  17364. return false;
  17365. }
  17366. // Parse private key file
  17367. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  17368. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password,
  17369. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17370. #else
  17371. ret = mbedtls_pk_parse_keyfile(&mctx->own_key, key_path, password);
  17372. #endif
  17373. if (ret != 0) {
  17374. impl::mbedtls_last_error() = ret;
  17375. return false;
  17376. }
  17377. // Verify that the certificate and private key match.
  17378. // Mbed TLS 4.x: see set_client_cert() — skip the spurious check_pair.
  17379. #ifndef CPPHTTPLIB_MBEDTLS_V4
  17380. #ifdef CPPHTTPLIB_MBEDTLS_V3
  17381. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key,
  17382. mbedtls_ctr_drbg_random, &mctx->ctr_drbg);
  17383. #else
  17384. ret = mbedtls_pk_check_pair(&mctx->own_cert.pk, &mctx->own_key);
  17385. #endif
  17386. if (ret != 0) {
  17387. impl::mbedtls_last_error() = ret;
  17388. return false;
  17389. }
  17390. #endif
  17391. ret = mbedtls_ssl_conf_own_cert(&mctx->conf, &mctx->own_cert, &mctx->own_key);
  17392. if (ret != 0) {
  17393. impl::mbedtls_last_error() = ret;
  17394. return false;
  17395. }
  17396. return true;
  17397. }
  17398. inline void set_verify_client(ctx_t ctx, bool require) {
  17399. if (!ctx) { return; }
  17400. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17401. mctx->verify_client = require;
  17402. if (require) {
  17403. mbedtls_ssl_conf_authmode(&mctx->conf, MBEDTLS_SSL_VERIFY_REQUIRED);
  17404. } else {
  17405. // If a verify callback is set, use OPTIONAL mode to ensure the callback
  17406. // is called (matching OpenSSL behavior). Otherwise use NONE.
  17407. mbedtls_ssl_conf_authmode(&mctx->conf, mctx->has_verify_callback
  17408. ? MBEDTLS_SSL_VERIFY_OPTIONAL
  17409. : MBEDTLS_SSL_VERIFY_NONE);
  17410. }
  17411. }
  17412. inline session_t create_session(ctx_t ctx, socket_t sock) {
  17413. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  17414. auto mctx = static_cast<impl::MbedTlsContext *>(ctx);
  17415. auto session = new (std::nothrow) impl::MbedTlsSession();
  17416. if (!session) { return nullptr; }
  17417. session->sock = sock;
  17418. int ret = mbedtls_ssl_setup(&session->ssl, &mctx->conf);
  17419. if (ret != 0) {
  17420. impl::mbedtls_last_error() = ret;
  17421. delete session;
  17422. return nullptr;
  17423. }
  17424. // Explicitly opt out of in-handshake hostname verification by default;
  17425. // since Mbed TLS 3.6.4 a client handshake with certificate verification
  17426. // fails outright when no hostname was set. set_sni() installs the real
  17427. // hostname for DNS hosts; for IP hosts (where SNI must not be set) the
  17428. // caller verifies the certificate identity post-handshake via
  17429. // verify_hostname().
  17430. mbedtls_ssl_set_hostname(&session->ssl, nullptr);
  17431. // Set BIO callbacks
  17432. mbedtls_ssl_set_bio(&session->ssl, &session->sock, impl::mbedtls_net_send_cb,
  17433. impl::mbedtls_net_recv_cb, nullptr);
  17434. // Set per-session verify callback with session pointer if callback is
  17435. // registered
  17436. session->has_verify_callback = mctx->has_verify_callback;
  17437. if (mctx->has_verify_callback) {
  17438. mbedtls_ssl_set_verify(&session->ssl, impl::mbedtls_verify_callback,
  17439. session);
  17440. }
  17441. return static_cast<session_t>(session);
  17442. }
  17443. inline void free_session(session_t session) {
  17444. if (session) { delete static_cast<impl::MbedTlsSession *>(session); }
  17445. }
  17446. inline bool set_sni(session_t session, const char *hostname,
  17447. bool verify_hostname) {
  17448. if (!session || !hostname) { return false; }
  17449. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17450. // mbedtls_ssl_set_hostname() both sends the SNI extension and binds the
  17451. // handshake-time CN/SAN check to `hostname`; the two can't be requested
  17452. // independently, so a disabled hostname check is handled below by masking
  17453. // the resulting mismatch flag instead of skipping this call.
  17454. int ret = mbedtls_ssl_set_hostname(&msession->ssl, hostname);
  17455. if (ret != 0) {
  17456. impl::mbedtls_last_error() = ret;
  17457. return false;
  17458. }
  17459. msession->hostname = hostname;
  17460. if (!verify_hostname) {
  17461. msession->suppress_hostname_mismatch = true;
  17462. // If a user verify callback is already wired for this session,
  17463. // mbedtls_verify_callback() masks the mismatch flag itself before
  17464. // consulting it (see suppress_hostname_mismatch above) - reinstalling it
  17465. // here would be redundant. Otherwise install the self-contained masking
  17466. // callback, which never touches the process-wide callback slot.
  17467. if (!msession->has_verify_callback) {
  17468. mbedtls_ssl_set_verify(&msession->ssl,
  17469. impl::mbedtls_mask_hostname_mismatch_callback,
  17470. msession);
  17471. }
  17472. }
  17473. return true;
  17474. }
  17475. inline TlsError connect(session_t session) {
  17476. TlsError err;
  17477. if (!session) {
  17478. err.code = ErrorCode::Fatal;
  17479. return err;
  17480. }
  17481. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17482. int ret;
  17483. do {
  17484. ret = mbedtls_ssl_handshake(&msession->ssl);
  17485. } while (impl::mbedtls_is_session_ticket(ret));
  17486. if (ret == 0) {
  17487. err.code = ErrorCode::Success;
  17488. } else {
  17489. impl::fill_mbedtls_tls_error(err, msession->ssl, ret);
  17490. impl::mbedtls_last_error() = ret;
  17491. }
  17492. return err;
  17493. }
  17494. inline TlsError accept(session_t session) {
  17495. // Same as connect for Mbed TLS - handshake works for both client and server
  17496. auto result = connect(session);
  17497. // After successful handshake, capture SNI from thread-local storage
  17498. if (result.code == ErrorCode::Success && session) {
  17499. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17500. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17501. impl::mbedpending_sni().clear();
  17502. }
  17503. return result;
  17504. }
  17505. inline bool connect_nonblocking(session_t session, socket_t sock,
  17506. time_t timeout_sec, time_t timeout_usec,
  17507. TlsError *err) {
  17508. if (!session) {
  17509. if (err) { err->code = ErrorCode::Fatal; }
  17510. return false;
  17511. }
  17512. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17513. // Set socket to non-blocking mode
  17514. detail::set_nonblocking(sock, true);
  17515. auto cleanup =
  17516. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17517. int ret;
  17518. while ((ret = mbedtls_ssl_handshake(&msession->ssl)) != 0) {
  17519. // Non-fatal TLS 1.3 ticket; retry immediately.
  17520. if (impl::mbedtls_is_session_ticket(ret)) { continue; }
  17521. if (ret == MBEDTLS_ERR_SSL_WANT_READ) {
  17522. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  17523. continue;
  17524. }
  17525. } else if (ret == MBEDTLS_ERR_SSL_WANT_WRITE) {
  17526. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  17527. continue;
  17528. }
  17529. }
  17530. // TlsError or timeout
  17531. if (err) { impl::fill_mbedtls_tls_error(*err, msession->ssl, ret); }
  17532. impl::mbedtls_last_error() = ret;
  17533. return false;
  17534. }
  17535. if (err) { err->code = ErrorCode::Success; }
  17536. return true;
  17537. }
  17538. inline bool accept_nonblocking(session_t session, socket_t sock,
  17539. time_t timeout_sec, time_t timeout_usec,
  17540. TlsError *err) {
  17541. // Same implementation as connect for Mbed TLS
  17542. bool result =
  17543. connect_nonblocking(session, sock, timeout_sec, timeout_usec, err);
  17544. // After successful handshake, capture SNI from thread-local storage
  17545. if (result && session) {
  17546. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17547. msession->sni_hostname = std::move(impl::mbedpending_sni());
  17548. impl::mbedpending_sni().clear();
  17549. }
  17550. return result;
  17551. }
  17552. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  17553. if (!session || !buf) {
  17554. err.code = ErrorCode::Fatal;
  17555. return -1;
  17556. }
  17557. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17558. // Serve a byte consumed by the is_peer_closed() probe before reading more.
  17559. if (msession->has_peeked_byte) {
  17560. if (len == 0) { return 0; }
  17561. auto p = static_cast<unsigned char *>(buf);
  17562. p[0] = msession->peeked_byte;
  17563. msession->has_peeked_byte = false;
  17564. size_t n = 1;
  17565. // Top up with any already-decrypted bytes without risking a block.
  17566. if (len > 1 && mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17567. int extra = mbedtls_ssl_read(&msession->ssl, p + 1, len - 1);
  17568. if (extra > 0) { n += static_cast<size_t>(extra); }
  17569. }
  17570. err.code = ErrorCode::Success;
  17571. return static_cast<ssize_t>(n);
  17572. }
  17573. int ret;
  17574. do {
  17575. ret = mbedtls_ssl_read(&msession->ssl, static_cast<unsigned char *>(buf),
  17576. len);
  17577. } while (impl::mbedtls_is_session_ticket(ret));
  17578. if (ret > 0) {
  17579. err.code = ErrorCode::Success;
  17580. return static_cast<ssize_t>(ret);
  17581. }
  17582. if (ret == 0) {
  17583. err.code = ErrorCode::PeerClosed;
  17584. return 0;
  17585. }
  17586. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17587. err.backend_code = static_cast<uint64_t>(-ret);
  17588. impl::mbedtls_last_error() = ret;
  17589. // mbedTLS signals a clean close_notify via a negative error code rather
  17590. // than 0; surface it as a clean EOF the way OpenSSL/wolfSSL do.
  17591. if (err.code == ErrorCode::PeerClosed) { return 0; }
  17592. return -1;
  17593. }
  17594. inline ssize_t write(session_t session, const void *buf, size_t len,
  17595. TlsError &err) {
  17596. if (!session || !buf) {
  17597. err.code = ErrorCode::Fatal;
  17598. return -1;
  17599. }
  17600. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17601. int ret;
  17602. do {
  17603. ret = mbedtls_ssl_write(&msession->ssl,
  17604. static_cast<const unsigned char *>(buf), len);
  17605. } while (impl::mbedtls_is_session_ticket(ret));
  17606. if (ret > 0) {
  17607. err.code = ErrorCode::Success;
  17608. return static_cast<ssize_t>(ret);
  17609. }
  17610. if (ret == 0) {
  17611. err.code = ErrorCode::PeerClosed;
  17612. return 0;
  17613. }
  17614. err.code = impl::map_mbedtls_error(ret, err.sys_errno, 0);
  17615. err.backend_code = static_cast<uint64_t>(-ret);
  17616. impl::mbedtls_last_error() = ret;
  17617. return -1;
  17618. }
  17619. inline int pending(const_session_t session) {
  17620. if (!session) { return 0; }
  17621. auto msession =
  17622. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17623. return static_cast<int>(mbedtls_ssl_get_bytes_avail(&msession->ssl)) +
  17624. (msession->has_peeked_byte ? 1 : 0);
  17625. }
  17626. inline void shutdown(session_t session, bool graceful) {
  17627. if (!session) { return; }
  17628. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17629. if (graceful) {
  17630. // Try to send close_notify, but don't block forever
  17631. int ret;
  17632. int attempts = 0;
  17633. while ((ret = mbedtls_ssl_close_notify(&msession->ssl)) != 0 &&
  17634. attempts < 3) {
  17635. if (ret != MBEDTLS_ERR_SSL_WANT_READ &&
  17636. ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
  17637. break;
  17638. }
  17639. attempts++;
  17640. }
  17641. }
  17642. }
  17643. inline bool is_peer_closed(session_t session, socket_t sock) {
  17644. if (!session || sock == INVALID_SOCKET) { return true; }
  17645. auto msession = static_cast<impl::MbedTlsSession *>(session);
  17646. // Check if there's already decrypted or pushed-back data available.
  17647. // If so, the connection is definitely alive.
  17648. if (msession->has_peeked_byte ||
  17649. mbedtls_ssl_get_bytes_avail(&msession->ssl) > 0) {
  17650. return false;
  17651. }
  17652. // Set socket to non-blocking to avoid blocking on read
  17653. detail::set_nonblocking(sock, true);
  17654. auto cleanup =
  17655. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  17656. // Probe with a 1-byte read (Mbed TLS has no peek API). If the probe lands
  17657. // on application data — e.g. a response that already arrived — push the
  17658. // byte back so the next read() delivers it instead of losing it.
  17659. unsigned char buf;
  17660. int ret;
  17661. do {
  17662. ret = mbedtls_ssl_read(&msession->ssl, &buf, 1);
  17663. } while (impl::mbedtls_is_session_ticket(ret));
  17664. // If we got data or WANT_READ (would block), connection is alive
  17665. if (ret > 0) {
  17666. msession->peeked_byte = buf;
  17667. msession->has_peeked_byte = true;
  17668. return false;
  17669. }
  17670. if (ret == MBEDTLS_ERR_SSL_WANT_READ) { return false; }
  17671. // If we get a peer close notify or a connection reset, the peer is closed
  17672. return ret == MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY ||
  17673. ret == MBEDTLS_ERR_NET_CONN_RESET || ret == 0;
  17674. }
  17675. inline cert_t get_peer_cert(const_session_t session) {
  17676. if (!session) { return nullptr; }
  17677. auto msession =
  17678. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17679. // Mbed TLS returns a pointer to the internal peer cert chain.
  17680. // WARNING: This pointer is only valid while the session is active.
  17681. // Do not use the certificate after calling free_session().
  17682. const mbedtls_x509_crt *cert = mbedtls_ssl_get_peer_cert(&msession->ssl);
  17683. return const_cast<mbedtls_x509_crt *>(cert);
  17684. }
  17685. inline void free_cert(cert_t cert) {
  17686. // Mbed TLS: peer certificate is owned by the SSL context.
  17687. // No-op here, but callers should still call this for cross-backend
  17688. // portability.
  17689. (void)cert;
  17690. }
  17691. inline bool verify_hostname(cert_t cert, const char *hostname) {
  17692. if (!cert || !hostname) { return false; }
  17693. auto mcert = static_cast<const mbedtls_x509_crt *>(cert);
  17694. std::string host_str(hostname);
  17695. // Check if hostname is an IP address (IPv4 or IPv6)
  17696. unsigned char ip_bytes[16];
  17697. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  17698. auto is_ip = ip_len > 0;
  17699. // Check Subject Alternative Names (SAN)
  17700. // In Mbed TLS 3.x, subject_alt_names contains raw values without ASN.1 tags
  17701. // - DNS names: raw string bytes
  17702. // - IP addresses: raw IP bytes (4 for IPv4, 16 for IPv6)
  17703. const mbedtls_x509_sequence *san = &mcert->subject_alt_names;
  17704. while (san != nullptr && san->buf.p != nullptr && san->buf.len > 0) {
  17705. const unsigned char *p = san->buf.p;
  17706. size_t len = san->buf.len;
  17707. if (is_ip) {
  17708. // For an IP host, only a matching iPAddress SAN of the same family
  17709. // (4 bytes for IPv4, 16 bytes for IPv6) may authenticate it.
  17710. if (len == ip_len && memcmp(p, ip_bytes, ip_len) == 0) { return true; }
  17711. } else {
  17712. // Check if this SAN is a DNS name (printable ASCII string)
  17713. bool is_dns = len > 0;
  17714. for (size_t i = 0; i < len && is_dns; i++) {
  17715. if (p[i] < 32 || p[i] > 126) { is_dns = false; }
  17716. }
  17717. if (is_dns) {
  17718. std::string san_name(reinterpret_cast<const char *>(p), len);
  17719. if (detail::match_hostname(san_name, host_str)) { return true; }
  17720. }
  17721. }
  17722. san = san->next;
  17723. }
  17724. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  17725. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  17726. // the OpenSSL backend's X509_check_ip behaves the same way).
  17727. if (!is_ip) {
  17728. char cn[256];
  17729. int ret = mbedtls_x509_dn_gets(cn, sizeof(cn), &mcert->subject);
  17730. if (ret > 0) {
  17731. std::string cn_str(cn);
  17732. // Look for "CN=" in the DN string
  17733. size_t cn_pos = cn_str.find("CN=");
  17734. if (cn_pos != std::string::npos) {
  17735. size_t start = cn_pos + 3;
  17736. size_t end = cn_str.find(',', start);
  17737. std::string cn_value =
  17738. cn_str.substr(start, end == std::string::npos ? end : end - start);
  17739. if (detail::match_hostname(cn_value, host_str)) { return true; }
  17740. }
  17741. }
  17742. }
  17743. return false;
  17744. }
  17745. inline uint64_t hostname_mismatch_code() {
  17746. return static_cast<uint64_t>(MBEDTLS_X509_BADCERT_CN_MISMATCH);
  17747. }
  17748. inline long get_verify_result(const_session_t session) {
  17749. if (!session) { return -1; }
  17750. auto msession =
  17751. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  17752. uint32_t flags = mbedtls_ssl_get_verify_result(&msession->ssl);
  17753. // Return 0 (X509_V_OK equivalent) if verification passed
  17754. return flags == 0 ? 0 : static_cast<long>(flags);
  17755. }
  17756. inline std::string get_cert_subject_cn(cert_t cert) {
  17757. if (!cert) return "";
  17758. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17759. // Find the CN in the subject
  17760. const mbedtls_x509_name *name = &x509->subject;
  17761. while (name != nullptr) {
  17762. if (MBEDTLS_OID_CMP(MBEDTLS_OID_AT_CN, &name->oid) == 0) {
  17763. return std::string(reinterpret_cast<const char *>(name->val.p),
  17764. name->val.len);
  17765. }
  17766. name = name->next;
  17767. }
  17768. return "";
  17769. }
  17770. inline std::string get_cert_issuer_name(cert_t cert) {
  17771. if (!cert) return "";
  17772. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17773. // Build a human-readable issuer name string
  17774. char buf[512];
  17775. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &x509->issuer);
  17776. if (ret < 0) return "";
  17777. return std::string(buf);
  17778. }
  17779. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  17780. sans.clear();
  17781. if (!cert) return false;
  17782. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17783. // Parse the Subject Alternative Name extension
  17784. const mbedtls_x509_sequence *cur = &x509->subject_alt_names;
  17785. while (cur != nullptr) {
  17786. if (cur->buf.len > 0) {
  17787. // Mbed TLS stores SAN as ASN.1 sequences
  17788. // The tag byte indicates the type
  17789. const unsigned char *p = cur->buf.p;
  17790. size_t len = cur->buf.len;
  17791. // First byte is the tag
  17792. unsigned char tag = *p;
  17793. p++;
  17794. len--;
  17795. // Parse length (simple single-byte length assumed)
  17796. if (len > 0 && *p < 0x80) {
  17797. size_t value_len = *p;
  17798. p++;
  17799. len--;
  17800. if (value_len <= len) {
  17801. SanEntry entry;
  17802. // ASN.1 context tags for GeneralName
  17803. switch (tag & 0x1F) {
  17804. case 2: // dNSName
  17805. entry.type = SanType::DNS;
  17806. entry.value =
  17807. std::string(reinterpret_cast<const char *>(p), value_len);
  17808. break;
  17809. case 7: // iPAddress
  17810. entry.type = SanType::IP;
  17811. if (value_len == 4) {
  17812. // IPv4
  17813. char buf[16];
  17814. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", p[0], p[1], p[2], p[3]);
  17815. entry.value = buf;
  17816. } else if (value_len == 16) {
  17817. // IPv6
  17818. char buf[64];
  17819. snprintf(buf, sizeof(buf),
  17820. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  17821. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  17822. p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7], p[8],
  17823. p[9], p[10], p[11], p[12], p[13], p[14], p[15]);
  17824. entry.value = buf;
  17825. }
  17826. break;
  17827. case 1: // rfc822Name (email)
  17828. entry.type = SanType::EMAIL;
  17829. entry.value =
  17830. std::string(reinterpret_cast<const char *>(p), value_len);
  17831. break;
  17832. case 6: // uniformResourceIdentifier
  17833. entry.type = SanType::URI;
  17834. entry.value =
  17835. std::string(reinterpret_cast<const char *>(p), value_len);
  17836. break;
  17837. default: entry.type = SanType::OTHER; break;
  17838. }
  17839. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  17840. }
  17841. }
  17842. }
  17843. cur = cur->next;
  17844. }
  17845. return true;
  17846. }
  17847. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  17848. time_t &not_after) {
  17849. if (!cert) return false;
  17850. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17851. // Convert mbedtls_x509_time to time_t
  17852. auto to_time_t = [](const mbedtls_x509_time &t) -> time_t {
  17853. struct tm tm_time = {};
  17854. tm_time.tm_year = t.year - 1900;
  17855. tm_time.tm_mon = t.mon - 1;
  17856. tm_time.tm_mday = t.day;
  17857. tm_time.tm_hour = t.hour;
  17858. tm_time.tm_min = t.min;
  17859. tm_time.tm_sec = t.sec;
  17860. #ifdef _WIN32
  17861. return _mkgmtime(&tm_time);
  17862. #else
  17863. return timegm(&tm_time);
  17864. #endif
  17865. };
  17866. not_before = to_time_t(x509->valid_from);
  17867. not_after = to_time_t(x509->valid_to);
  17868. return true;
  17869. }
  17870. inline std::string get_cert_serial(cert_t cert) {
  17871. if (!cert) return "";
  17872. auto x509 = static_cast<mbedtls_x509_crt *>(cert);
  17873. // Convert serial number to hex string
  17874. std::string result;
  17875. result.reserve(x509->serial.len * 2);
  17876. for (size_t i = 0; i < x509->serial.len; i++) {
  17877. char hex[3];
  17878. snprintf(hex, sizeof(hex), "%02X", x509->serial.p[i]);
  17879. result += hex;
  17880. }
  17881. return result;
  17882. }
  17883. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  17884. if (!cert) return false;
  17885. auto crt = static_cast<mbedtls_x509_crt *>(cert);
  17886. if (!crt->raw.p || crt->raw.len == 0) return false;
  17887. der.assign(crt->raw.p, crt->raw.p + crt->raw.len);
  17888. return true;
  17889. }
  17890. inline const char *get_sni(const_session_t session) {
  17891. if (!session) return nullptr;
  17892. auto msession = static_cast<const impl::MbedTlsSession *>(session);
  17893. // For server: return SNI received from client during handshake
  17894. if (!msession->sni_hostname.empty()) {
  17895. return msession->sni_hostname.c_str();
  17896. }
  17897. // For client: return the hostname set via set_sni
  17898. if (!msession->hostname.empty()) { return msession->hostname.c_str(); }
  17899. return nullptr;
  17900. }
  17901. inline uint64_t peek_error() {
  17902. // Mbed TLS doesn't have an error queue, return the last error
  17903. return static_cast<uint64_t>(-impl::mbedtls_last_error());
  17904. }
  17905. inline uint64_t get_error() {
  17906. // Mbed TLS doesn't have an error queue, return and clear the last error
  17907. uint64_t err = static_cast<uint64_t>(-impl::mbedtls_last_error());
  17908. impl::mbedtls_last_error() = 0;
  17909. return err;
  17910. }
  17911. inline std::string error_string(uint64_t code) {
  17912. char buf[256];
  17913. mbedtls_strerror(-static_cast<int>(code), buf, sizeof(buf));
  17914. return std::string(buf);
  17915. }
  17916. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  17917. auto *ca_chain = new (std::nothrow) mbedtls_x509_crt;
  17918. if (!ca_chain) { return nullptr; }
  17919. mbedtls_x509_crt_init(ca_chain);
  17920. // mbedtls_x509_crt_parse expects null-terminated PEM
  17921. int ret = mbedtls_x509_crt_parse(ca_chain,
  17922. reinterpret_cast<const unsigned char *>(pem),
  17923. len + 1); // +1 for null terminator
  17924. if (ret != 0) {
  17925. // Try without +1 in case PEM is already null-terminated
  17926. ret = mbedtls_x509_crt_parse(
  17927. ca_chain, reinterpret_cast<const unsigned char *>(pem), len);
  17928. if (ret != 0) {
  17929. mbedtls_x509_crt_free(ca_chain);
  17930. delete ca_chain;
  17931. return nullptr;
  17932. }
  17933. }
  17934. return static_cast<ca_store_t>(ca_chain);
  17935. }
  17936. inline void free_ca_store(ca_store_t store) {
  17937. if (store) {
  17938. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17939. mbedtls_x509_crt_free(ca_chain);
  17940. delete ca_chain;
  17941. }
  17942. }
  17943. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  17944. if (!ctx || !store) { return false; }
  17945. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17946. auto *ca_chain = static_cast<mbedtls_x509_crt *>(store);
  17947. // Free existing CA chain
  17948. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  17949. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  17950. // Copy the CA chain (deep copy)
  17951. // Parse from the raw data of the source cert
  17952. mbedtls_x509_crt *src = ca_chain;
  17953. while (src != nullptr) {
  17954. int ret = mbedtls_x509_crt_parse_der(&mbed_ctx->ca_chain, src->raw.p,
  17955. src->raw.len);
  17956. if (ret != 0) {
  17957. free_ca_store(store);
  17958. return false;
  17959. }
  17960. src = src->next;
  17961. }
  17962. // This function takes ownership of the store; the chain was deep-copied
  17963. // above, so release the source
  17964. free_ca_store(store);
  17965. // Update the SSL config to use the new CA chain
  17966. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  17967. return true;
  17968. }
  17969. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  17970. certs.clear();
  17971. if (!ctx) { return 0; }
  17972. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17973. // Iterate through the CA chain
  17974. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17975. while (cert != nullptr && cert->raw.len > 0) {
  17976. // Create a copy of the certificate for the caller
  17977. auto *copy = new mbedtls_x509_crt;
  17978. mbedtls_x509_crt_init(copy);
  17979. int ret = mbedtls_x509_crt_parse_der(copy, cert->raw.p, cert->raw.len);
  17980. if (ret == 0) {
  17981. certs.push_back(static_cast<cert_t>(copy));
  17982. } else {
  17983. mbedtls_x509_crt_free(copy);
  17984. delete copy;
  17985. }
  17986. cert = cert->next;
  17987. }
  17988. return certs.size();
  17989. }
  17990. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  17991. std::vector<std::string> names;
  17992. if (!ctx) { return names; }
  17993. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  17994. // Iterate through the CA chain
  17995. mbedtls_x509_crt *cert = &mbed_ctx->ca_chain;
  17996. while (cert != nullptr && cert->raw.len > 0) {
  17997. char buf[512];
  17998. int ret = mbedtls_x509_dn_gets(buf, sizeof(buf), &cert->subject);
  17999. if (ret > 0) { names.push_back(buf); }
  18000. cert = cert->next;
  18001. }
  18002. return names;
  18003. }
  18004. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18005. const char *key_pem, const char *password) {
  18006. if (!ctx || !cert_pem || !key_pem) { return false; }
  18007. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18008. // Free existing certificate and key
  18009. mbedtls_x509_crt_free(&mbed_ctx->own_cert);
  18010. mbedtls_pk_free(&mbed_ctx->own_key);
  18011. mbedtls_x509_crt_init(&mbed_ctx->own_cert);
  18012. mbedtls_pk_init(&mbed_ctx->own_key);
  18013. // Parse certificate PEM
  18014. int ret = mbedtls_x509_crt_parse(
  18015. &mbed_ctx->own_cert, reinterpret_cast<const unsigned char *>(cert_pem),
  18016. strlen(cert_pem) + 1);
  18017. if (ret != 0) {
  18018. impl::mbedtls_last_error() = ret;
  18019. return false;
  18020. }
  18021. // Parse private key PEM
  18022. #if defined(CPPHTTPLIB_MBEDTLS_V3) && !defined(CPPHTTPLIB_MBEDTLS_V4)
  18023. ret = mbedtls_pk_parse_key(
  18024. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18025. strlen(key_pem) + 1,
  18026. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18027. password ? strlen(password) : 0, mbedtls_ctr_drbg_random,
  18028. &mbed_ctx->ctr_drbg);
  18029. #else
  18030. ret = mbedtls_pk_parse_key(
  18031. &mbed_ctx->own_key, reinterpret_cast<const unsigned char *>(key_pem),
  18032. strlen(key_pem) + 1,
  18033. password ? reinterpret_cast<const unsigned char *>(password) : nullptr,
  18034. password ? strlen(password) : 0);
  18035. #endif
  18036. if (ret != 0) {
  18037. impl::mbedtls_last_error() = ret;
  18038. return false;
  18039. }
  18040. // Configure SSL to use the new certificate and key
  18041. ret = mbedtls_ssl_conf_own_cert(&mbed_ctx->conf, &mbed_ctx->own_cert,
  18042. &mbed_ctx->own_key);
  18043. if (ret != 0) {
  18044. impl::mbedtls_last_error() = ret;
  18045. return false;
  18046. }
  18047. return true;
  18048. }
  18049. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  18050. if (!ctx || !ca_pem) { return false; }
  18051. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18052. // Free existing CA chain
  18053. mbedtls_x509_crt_free(&mbed_ctx->ca_chain);
  18054. mbedtls_x509_crt_init(&mbed_ctx->ca_chain);
  18055. // Parse CA PEM
  18056. int ret = mbedtls_x509_crt_parse(
  18057. &mbed_ctx->ca_chain, reinterpret_cast<const unsigned char *>(ca_pem),
  18058. strlen(ca_pem) + 1);
  18059. if (ret != 0) {
  18060. impl::mbedtls_last_error() = ret;
  18061. return false;
  18062. }
  18063. // Update SSL config to use new CA chain
  18064. mbedtls_ssl_conf_ca_chain(&mbed_ctx->conf, &mbed_ctx->ca_chain, nullptr);
  18065. return true;
  18066. }
  18067. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  18068. if (!ctx) { return false; }
  18069. auto *mbed_ctx = static_cast<impl::MbedTlsContext *>(ctx);
  18070. impl::get_verify_callback() = std::move(callback);
  18071. mbed_ctx->has_verify_callback =
  18072. static_cast<bool>(impl::get_verify_callback());
  18073. if (mbed_ctx->has_verify_callback) {
  18074. // Set OPTIONAL mode to ensure callback is called even when verification
  18075. // is disabled (matching OpenSSL behavior where SSL_VERIFY_PEER is set)
  18076. mbedtls_ssl_conf_authmode(&mbed_ctx->conf, MBEDTLS_SSL_VERIFY_OPTIONAL);
  18077. mbedtls_ssl_conf_verify(&mbed_ctx->conf, impl::mbedtls_verify_callback,
  18078. nullptr);
  18079. } else {
  18080. mbedtls_ssl_conf_verify(&mbed_ctx->conf, nullptr, nullptr);
  18081. }
  18082. return true;
  18083. }
  18084. inline long get_verify_error(const_session_t session) {
  18085. if (!session) { return -1; }
  18086. auto *msession =
  18087. static_cast<impl::MbedTlsSession *>(const_cast<void *>(session));
  18088. return static_cast<long>(mbedtls_ssl_get_verify_result(&msession->ssl));
  18089. }
  18090. inline std::string verify_error_string(long error_code) {
  18091. if (error_code == 0) { return ""; }
  18092. char buf[256];
  18093. mbedtls_x509_crt_verify_info(buf, sizeof(buf), "",
  18094. static_cast<uint32_t>(error_code));
  18095. // Remove trailing newline if present
  18096. std::string result(buf);
  18097. while (!result.empty() && (result.back() == '\n' || result.back() == ' ')) {
  18098. result.pop_back();
  18099. }
  18100. return result;
  18101. }
  18102. } // namespace tls
  18103. #endif // CPPHTTPLIB_MBEDTLS_SUPPORT
  18104. /*
  18105. * Group 10: TLS abstraction layer - wolfSSL backend
  18106. */
  18107. /*
  18108. * wolfSSL Backend Implementation
  18109. */
  18110. #ifdef CPPHTTPLIB_WOLFSSL_SUPPORT
  18111. namespace tls {
  18112. namespace impl {
  18113. // wolfSSL session wrapper
  18114. struct WolfSSLSession {
  18115. WOLFSSL *ssl = nullptr;
  18116. socket_t sock = INVALID_SOCKET;
  18117. std::string hostname; // For client: set via set_sni
  18118. std::string sni_hostname; // For server: received from client via SNI callback
  18119. WolfSSLSession() = default;
  18120. ~WolfSSLSession() {
  18121. if (ssl) { wolfSSL_free(ssl); }
  18122. }
  18123. WolfSSLSession(const WolfSSLSession &) = delete;
  18124. WolfSSLSession &operator=(const WolfSSLSession &) = delete;
  18125. };
  18126. // Thread-local error code accessor for wolfSSL
  18127. inline uint64_t &wolfssl_last_error() {
  18128. static thread_local uint64_t err = 0;
  18129. return err;
  18130. }
  18131. // Helper to map wolfSSL error to ErrorCode.
  18132. // ssl_error is the value from wolfSSL_get_error().
  18133. // raw_ret is the raw return value from the wolfSSL call (for low-level error).
  18134. inline ErrorCode map_wolfssl_error(WOLFSSL *ssl, int ssl_error,
  18135. int &out_errno) {
  18136. switch (ssl_error) {
  18137. case SSL_ERROR_NONE: return ErrorCode::Success;
  18138. case SSL_ERROR_WANT_READ: return ErrorCode::WantRead;
  18139. case SSL_ERROR_WANT_WRITE: return ErrorCode::WantWrite;
  18140. case SSL_ERROR_ZERO_RETURN: return ErrorCode::PeerClosed;
  18141. case SSL_ERROR_SYSCALL: out_errno = errno; return ErrorCode::SyscallError;
  18142. default:
  18143. if (ssl) {
  18144. // wolfSSL stores the low-level error code as a negative value.
  18145. // DOMAIN_NAME_MISMATCH (-322) indicates hostname verification failure.
  18146. int low_err = ssl_error; // wolfSSL_get_error returns the low-level code
  18147. if (low_err == DOMAIN_NAME_MISMATCH) {
  18148. return ErrorCode::HostnameMismatch;
  18149. }
  18150. // Check verify result to distinguish cert verification from generic SSL
  18151. // errors.
  18152. long vr = wolfSSL_get_verify_result(ssl);
  18153. if (vr != 0) { return ErrorCode::CertVerifyFailed; }
  18154. }
  18155. return ErrorCode::Fatal;
  18156. }
  18157. }
  18158. // WolfSSLContext constructor/destructor implementations
  18159. inline WolfSSLContext::WolfSSLContext() { wolfSSL_Init(); }
  18160. inline WolfSSLContext::~WolfSSLContext() {
  18161. if (ctx) { wolfSSL_CTX_free(ctx); }
  18162. }
  18163. // Thread-local storage for SNI captured during handshake
  18164. inline std::string &wolfssl_pending_sni() {
  18165. static thread_local std::string sni;
  18166. return sni;
  18167. }
  18168. // SNI callback for wolfSSL server to capture client's SNI hostname
  18169. inline int wolfssl_sni_callback(WOLFSSL *ssl, int *ret, void *exArg) {
  18170. (void)ret;
  18171. (void)exArg;
  18172. void *name_data = nullptr;
  18173. unsigned short name_len =
  18174. wolfSSL_SNI_GetRequest(ssl, WOLFSSL_SNI_HOST_NAME, &name_data);
  18175. if (name_data && name_len > 0) {
  18176. wolfssl_pending_sni().assign(static_cast<const char *>(name_data),
  18177. name_len);
  18178. } else {
  18179. wolfssl_pending_sni().clear();
  18180. }
  18181. return 0; // Continue regardless
  18182. }
  18183. // wolfSSL verify callback wrapper
  18184. inline int wolfssl_verify_callback(int preverify_ok,
  18185. WOLFSSL_X509_STORE_CTX *x509_ctx) {
  18186. auto &callback = get_verify_callback();
  18187. if (!callback) { return preverify_ok; }
  18188. WOLFSSL_X509 *cert = wolfSSL_X509_STORE_CTX_get_current_cert(x509_ctx);
  18189. int depth = wolfSSL_X509_STORE_CTX_get_error_depth(x509_ctx);
  18190. int err = wolfSSL_X509_STORE_CTX_get_error(x509_ctx);
  18191. // Get the WOLFSSL object from the X509_STORE_CTX
  18192. WOLFSSL *ssl = static_cast<WOLFSSL *>(wolfSSL_X509_STORE_CTX_get_ex_data(
  18193. x509_ctx, wolfSSL_get_ex_data_X509_STORE_CTX_idx()));
  18194. VerifyContext verify_ctx;
  18195. verify_ctx.session = static_cast<session_t>(ssl);
  18196. verify_ctx.cert = static_cast<cert_t>(cert);
  18197. verify_ctx.depth = depth;
  18198. verify_ctx.preverify_ok = (preverify_ok != 0);
  18199. verify_ctx.error_code = static_cast<long>(err);
  18200. if (err != 0) {
  18201. verify_ctx.error_string = wolfSSL_X509_verify_cert_error_string(err);
  18202. } else {
  18203. verify_ctx.error_string = nullptr;
  18204. }
  18205. bool accepted = callback(verify_ctx);
  18206. return accepted ? 1 : 0;
  18207. }
  18208. inline void set_wolfssl_password_cb(WOLFSSL_CTX *ctx, const char *password) {
  18209. wolfSSL_CTX_set_default_passwd_cb_userdata(ctx, const_cast<char *>(password));
  18210. wolfSSL_CTX_set_default_passwd_cb(
  18211. ctx, [](char *buf, int size, int /*rwflag*/, void *userdata) -> int {
  18212. auto *pwd = static_cast<const char *>(userdata);
  18213. if (!pwd) return 0;
  18214. auto len = static_cast<int>(strlen(pwd));
  18215. if (len > size) len = size;
  18216. memcpy(buf, pwd, static_cast<size_t>(len));
  18217. return len;
  18218. });
  18219. }
  18220. } // namespace impl
  18221. inline ctx_t create_client_context() {
  18222. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18223. if (!ctx) { return nullptr; }
  18224. ctx->is_server = false;
  18225. WOLFSSL_METHOD *method = wolfTLSv1_2_client_method();
  18226. if (!method) {
  18227. delete ctx;
  18228. return nullptr;
  18229. }
  18230. ctx->ctx = wolfSSL_CTX_new(method);
  18231. if (!ctx->ctx) {
  18232. delete ctx;
  18233. return nullptr;
  18234. }
  18235. // Default: verify peer certificate
  18236. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_PEER, nullptr);
  18237. return static_cast<ctx_t>(ctx);
  18238. }
  18239. inline ctx_t create_server_context() {
  18240. auto ctx = new (std::nothrow) impl::WolfSSLContext();
  18241. if (!ctx) { return nullptr; }
  18242. ctx->is_server = true;
  18243. WOLFSSL_METHOD *method = wolfTLSv1_2_server_method();
  18244. if (!method) {
  18245. delete ctx;
  18246. return nullptr;
  18247. }
  18248. ctx->ctx = wolfSSL_CTX_new(method);
  18249. if (!ctx->ctx) {
  18250. delete ctx;
  18251. return nullptr;
  18252. }
  18253. // Default: don't verify client
  18254. wolfSSL_CTX_set_verify(ctx->ctx, SSL_VERIFY_NONE, nullptr);
  18255. // Enable SNI on server
  18256. wolfSSL_CTX_SNI_SetOptions(ctx->ctx, WOLFSSL_SNI_HOST_NAME,
  18257. WOLFSSL_SNI_CONTINUE_ON_MISMATCH);
  18258. wolfSSL_CTX_set_servername_callback(ctx->ctx, impl::wolfssl_sni_callback);
  18259. return static_cast<ctx_t>(ctx);
  18260. }
  18261. inline void free_context(ctx_t ctx) {
  18262. if (ctx) { delete static_cast<impl::WolfSSLContext *>(ctx); }
  18263. }
  18264. inline bool set_min_version(ctx_t ctx, Version version) {
  18265. if (!ctx) { return false; }
  18266. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18267. int min_ver = WOLFSSL_TLSV1_2;
  18268. if (version >= Version::TLS1_3) { min_ver = WOLFSSL_TLSV1_3; }
  18269. return wolfSSL_CTX_SetMinVersion(wctx->ctx, min_ver) == WOLFSSL_SUCCESS;
  18270. }
  18271. inline bool load_ca_pem(ctx_t ctx, const char *pem, size_t len) {
  18272. if (!ctx || !pem) { return false; }
  18273. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18274. int ret = wolfSSL_CTX_load_verify_buffer(
  18275. wctx->ctx, reinterpret_cast<const unsigned char *>(pem),
  18276. static_cast<long>(len), SSL_FILETYPE_PEM);
  18277. if (ret != SSL_SUCCESS) {
  18278. impl::wolfssl_last_error() =
  18279. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18280. return false;
  18281. }
  18282. wctx->ca_pem_data_.append(pem, len);
  18283. return true;
  18284. }
  18285. inline bool load_ca_file(ctx_t ctx, const char *file_path) {
  18286. if (!ctx || !file_path) { return false; }
  18287. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18288. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, file_path, nullptr);
  18289. if (ret != SSL_SUCCESS) {
  18290. impl::wolfssl_last_error() =
  18291. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18292. return false;
  18293. }
  18294. return true;
  18295. }
  18296. inline bool load_ca_dir(ctx_t ctx, const char *dir_path) {
  18297. if (!ctx || !dir_path) { return false; }
  18298. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18299. int ret = wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, dir_path);
  18300. // wolfSSL may fail if the directory doesn't contain properly hashed certs.
  18301. // Unlike OpenSSL which lazily loads certs from directories, wolfSSL scans
  18302. // immediately. Return true even on failure since the CA file may have
  18303. // already been loaded, matching OpenSSL's lenient behavior.
  18304. (void)ret;
  18305. return true;
  18306. }
  18307. inline bool load_system_certs(ctx_t ctx) {
  18308. if (!ctx) { return false; }
  18309. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18310. bool loaded = false;
  18311. #ifdef _WIN32
  18312. loaded = impl::enumerate_windows_system_certs(
  18313. [&](const unsigned char *data, size_t len) {
  18314. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18315. static_cast<long>(len),
  18316. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18317. });
  18318. #elif defined(__APPLE__) && defined(CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN)
  18319. loaded = impl::enumerate_macos_keychain_certs(
  18320. [&](const unsigned char *data, size_t len) {
  18321. return wolfSSL_CTX_load_verify_buffer(wctx->ctx, data,
  18322. static_cast<long>(len),
  18323. SSL_FILETYPE_ASN1) == SSL_SUCCESS;
  18324. });
  18325. #else
  18326. for (auto path = impl::system_ca_paths(); *path; ++path) {
  18327. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, *path, nullptr) ==
  18328. SSL_SUCCESS) {
  18329. loaded = true;
  18330. break;
  18331. }
  18332. }
  18333. if (!loaded) {
  18334. for (auto dir = impl::system_ca_dirs(); *dir; ++dir) {
  18335. if (wolfSSL_CTX_load_verify_locations(wctx->ctx, nullptr, *dir) ==
  18336. SSL_SUCCESS) {
  18337. loaded = true;
  18338. break;
  18339. }
  18340. }
  18341. }
  18342. #endif
  18343. return loaded;
  18344. }
  18345. inline bool set_client_cert_pem(ctx_t ctx, const char *cert, const char *key,
  18346. const char *password) {
  18347. if (!ctx || !cert || !key) { return false; }
  18348. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18349. // Load certificate
  18350. int ret = wolfSSL_CTX_use_certificate_buffer(
  18351. wctx->ctx, reinterpret_cast<const unsigned char *>(cert),
  18352. static_cast<long>(strlen(cert)), SSL_FILETYPE_PEM);
  18353. if (ret != SSL_SUCCESS) {
  18354. impl::wolfssl_last_error() =
  18355. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18356. return false;
  18357. }
  18358. // Set password callback if password is provided
  18359. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18360. // Load private key
  18361. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  18362. wctx->ctx, reinterpret_cast<const unsigned char *>(key),
  18363. static_cast<long>(strlen(key)), SSL_FILETYPE_PEM);
  18364. if (ret != SSL_SUCCESS) {
  18365. impl::wolfssl_last_error() =
  18366. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18367. return false;
  18368. }
  18369. // Verify that the certificate and private key match
  18370. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18371. }
  18372. inline bool set_client_cert_file(ctx_t ctx, const char *cert_path,
  18373. const char *key_path, const char *password) {
  18374. if (!ctx || !cert_path || !key_path) { return false; }
  18375. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18376. // Load certificate file
  18377. int ret =
  18378. wolfSSL_CTX_use_certificate_file(wctx->ctx, cert_path, SSL_FILETYPE_PEM);
  18379. if (ret != SSL_SUCCESS) {
  18380. impl::wolfssl_last_error() =
  18381. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18382. return false;
  18383. }
  18384. // Set password callback if password is provided
  18385. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  18386. // Load private key file
  18387. ret = wolfSSL_CTX_use_PrivateKey_file(wctx->ctx, key_path, SSL_FILETYPE_PEM);
  18388. if (ret != SSL_SUCCESS) {
  18389. impl::wolfssl_last_error() =
  18390. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18391. return false;
  18392. }
  18393. // Verify that the certificate and private key match
  18394. return wolfSSL_CTX_check_private_key(wctx->ctx) == SSL_SUCCESS;
  18395. }
  18396. inline void set_verify_client(ctx_t ctx, bool require) {
  18397. if (!ctx) { return; }
  18398. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18399. wctx->verify_client = require;
  18400. if (require) {
  18401. wolfSSL_CTX_set_verify(
  18402. wctx->ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
  18403. wctx->has_verify_callback ? impl::wolfssl_verify_callback : nullptr);
  18404. } else {
  18405. if (wctx->has_verify_callback) {
  18406. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  18407. impl::wolfssl_verify_callback);
  18408. } else {
  18409. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_NONE, nullptr);
  18410. }
  18411. }
  18412. }
  18413. inline session_t create_session(ctx_t ctx, socket_t sock) {
  18414. if (!ctx || sock == INVALID_SOCKET) { return nullptr; }
  18415. auto wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18416. auto session = new (std::nothrow) impl::WolfSSLSession();
  18417. if (!session) { return nullptr; }
  18418. session->sock = sock;
  18419. session->ssl = wolfSSL_new(wctx->ctx);
  18420. if (!session->ssl) {
  18421. impl::wolfssl_last_error() =
  18422. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18423. delete session;
  18424. return nullptr;
  18425. }
  18426. wolfSSL_set_fd(session->ssl, static_cast<int>(sock));
  18427. return static_cast<session_t>(session);
  18428. }
  18429. inline void free_session(session_t session) {
  18430. if (session) { delete static_cast<impl::WolfSSLSession *>(session); }
  18431. }
  18432. inline bool set_sni(session_t session, const char *hostname,
  18433. bool verify_hostname) {
  18434. if (!session || !hostname) { return false; }
  18435. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18436. int ret = wolfSSL_UseSNI(wsession->ssl, WOLFSSL_SNI_HOST_NAME, hostname,
  18437. static_cast<word16>(strlen(hostname)));
  18438. if (ret != WOLFSSL_SUCCESS) {
  18439. impl::wolfssl_last_error() =
  18440. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18441. return false;
  18442. }
  18443. // wolfSSL_check_domain_name binds identity checking to the handshake,
  18444. // separately from the SNI extension sent above; skip it when hostname
  18445. // verification is disabled so only the chain is checked, matching OpenSSL.
  18446. if (verify_hostname) { wolfSSL_check_domain_name(wsession->ssl, hostname); }
  18447. wsession->hostname = hostname;
  18448. return true;
  18449. }
  18450. inline TlsError connect(session_t session) {
  18451. TlsError err;
  18452. if (!session) {
  18453. err.code = ErrorCode::Fatal;
  18454. return err;
  18455. }
  18456. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18457. int ret = wolfSSL_connect(wsession->ssl);
  18458. if (ret == SSL_SUCCESS) {
  18459. err.code = ErrorCode::Success;
  18460. } else {
  18461. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18462. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18463. err.backend_code = static_cast<uint64_t>(ssl_error);
  18464. impl::wolfssl_last_error() = err.backend_code;
  18465. }
  18466. return err;
  18467. }
  18468. inline TlsError accept(session_t session) {
  18469. TlsError err;
  18470. if (!session) {
  18471. err.code = ErrorCode::Fatal;
  18472. return err;
  18473. }
  18474. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18475. int ret = wolfSSL_accept(wsession->ssl);
  18476. if (ret == SSL_SUCCESS) {
  18477. err.code = ErrorCode::Success;
  18478. // Capture SNI from thread-local storage after successful handshake
  18479. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18480. impl::wolfssl_pending_sni().clear();
  18481. } else {
  18482. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18483. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18484. err.backend_code = static_cast<uint64_t>(ssl_error);
  18485. impl::wolfssl_last_error() = err.backend_code;
  18486. }
  18487. return err;
  18488. }
  18489. inline bool connect_nonblocking(session_t session, socket_t sock,
  18490. time_t timeout_sec, time_t timeout_usec,
  18491. TlsError *err) {
  18492. if (!session) {
  18493. if (err) { err->code = ErrorCode::Fatal; }
  18494. return false;
  18495. }
  18496. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18497. // Set socket to non-blocking mode
  18498. detail::set_nonblocking(sock, true);
  18499. auto cleanup =
  18500. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18501. int ret;
  18502. while ((ret = wolfSSL_connect(wsession->ssl)) != SSL_SUCCESS) {
  18503. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18504. if (ssl_error == SSL_ERROR_WANT_READ) {
  18505. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18506. continue;
  18507. }
  18508. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18509. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18510. continue;
  18511. }
  18512. }
  18513. // Error or timeout
  18514. if (err) {
  18515. err->code =
  18516. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18517. err->backend_code = static_cast<uint64_t>(ssl_error);
  18518. }
  18519. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18520. return false;
  18521. }
  18522. if (err) { err->code = ErrorCode::Success; }
  18523. return true;
  18524. }
  18525. inline bool accept_nonblocking(session_t session, socket_t sock,
  18526. time_t timeout_sec, time_t timeout_usec,
  18527. TlsError *err) {
  18528. if (!session) {
  18529. if (err) { err->code = ErrorCode::Fatal; }
  18530. return false;
  18531. }
  18532. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18533. // Set socket to non-blocking mode
  18534. detail::set_nonblocking(sock, true);
  18535. auto cleanup =
  18536. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18537. int ret;
  18538. while ((ret = wolfSSL_accept(wsession->ssl)) != SSL_SUCCESS) {
  18539. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18540. if (ssl_error == SSL_ERROR_WANT_READ) {
  18541. if (detail::select_read(sock, timeout_sec, timeout_usec) > 0) {
  18542. continue;
  18543. }
  18544. } else if (ssl_error == SSL_ERROR_WANT_WRITE) {
  18545. if (detail::select_write(sock, timeout_sec, timeout_usec) > 0) {
  18546. continue;
  18547. }
  18548. }
  18549. // Error or timeout
  18550. if (err) {
  18551. err->code =
  18552. impl::map_wolfssl_error(wsession->ssl, ssl_error, err->sys_errno);
  18553. err->backend_code = static_cast<uint64_t>(ssl_error);
  18554. }
  18555. impl::wolfssl_last_error() = static_cast<uint64_t>(ssl_error);
  18556. return false;
  18557. }
  18558. if (err) { err->code = ErrorCode::Success; }
  18559. // Capture SNI from thread-local storage after successful handshake
  18560. wsession->sni_hostname = std::move(impl::wolfssl_pending_sni());
  18561. impl::wolfssl_pending_sni().clear();
  18562. return true;
  18563. }
  18564. inline ssize_t read(session_t session, void *buf, size_t len, TlsError &err) {
  18565. if (!session || !buf) {
  18566. err.code = ErrorCode::Fatal;
  18567. return -1;
  18568. }
  18569. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18570. int ret = wolfSSL_read(wsession->ssl, buf, static_cast<int>(len));
  18571. if (ret > 0) {
  18572. err.code = ErrorCode::Success;
  18573. return static_cast<ssize_t>(ret);
  18574. }
  18575. if (ret == 0) {
  18576. err.code = ErrorCode::PeerClosed;
  18577. return 0;
  18578. }
  18579. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18580. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18581. err.backend_code = static_cast<uint64_t>(ssl_error);
  18582. impl::wolfssl_last_error() = err.backend_code;
  18583. return -1;
  18584. }
  18585. inline ssize_t write(session_t session, const void *buf, size_t len,
  18586. TlsError &err) {
  18587. if (!session || !buf) {
  18588. err.code = ErrorCode::Fatal;
  18589. return -1;
  18590. }
  18591. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18592. int ret = wolfSSL_write(wsession->ssl, buf, static_cast<int>(len));
  18593. if (ret > 0) {
  18594. err.code = ErrorCode::Success;
  18595. return static_cast<ssize_t>(ret);
  18596. }
  18597. // wolfSSL_write returns 0 when the peer has sent a close_notify.
  18598. // Treat this as an error (return -1) so callers don't spin in a
  18599. // write loop adding zero to the offset.
  18600. if (ret == 0) {
  18601. err.code = ErrorCode::PeerClosed;
  18602. return -1;
  18603. }
  18604. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18605. err.code = impl::map_wolfssl_error(wsession->ssl, ssl_error, err.sys_errno);
  18606. err.backend_code = static_cast<uint64_t>(ssl_error);
  18607. impl::wolfssl_last_error() = err.backend_code;
  18608. return -1;
  18609. }
  18610. inline int pending(const_session_t session) {
  18611. if (!session) { return 0; }
  18612. auto wsession =
  18613. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18614. return wolfSSL_pending(wsession->ssl);
  18615. }
  18616. inline void shutdown(session_t session, bool graceful) {
  18617. if (!session) { return; }
  18618. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18619. if (graceful) {
  18620. int ret;
  18621. int attempts = 0;
  18622. while ((ret = wolfSSL_shutdown(wsession->ssl)) != SSL_SUCCESS &&
  18623. attempts < 3) {
  18624. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18625. if (ssl_error != SSL_ERROR_WANT_READ &&
  18626. ssl_error != SSL_ERROR_WANT_WRITE) {
  18627. break;
  18628. }
  18629. attempts++;
  18630. }
  18631. } else {
  18632. wolfSSL_shutdown(wsession->ssl);
  18633. }
  18634. }
  18635. inline bool is_peer_closed(session_t session, socket_t sock) {
  18636. if (!session || sock == INVALID_SOCKET) { return true; }
  18637. auto wsession = static_cast<impl::WolfSSLSession *>(session);
  18638. // Check if there's already decrypted data available
  18639. if (wolfSSL_pending(wsession->ssl) > 0) { return false; }
  18640. // Set socket to non-blocking to avoid blocking on read
  18641. detail::set_nonblocking(sock, true);
  18642. auto cleanup =
  18643. detail::scope_exit([&]() { detail::set_nonblocking(sock, false); });
  18644. // Peek 1 byte to check connection status without consuming data
  18645. unsigned char buf;
  18646. int ret = wolfSSL_peek(wsession->ssl, &buf, 1);
  18647. // If we got data or WANT_READ (would block), connection is alive
  18648. if (ret > 0) { return false; }
  18649. int ssl_error = wolfSSL_get_error(wsession->ssl, ret);
  18650. if (ssl_error == SSL_ERROR_WANT_READ) { return false; }
  18651. return ssl_error == SSL_ERROR_ZERO_RETURN || ssl_error == SSL_ERROR_SYSCALL ||
  18652. ret == 0;
  18653. }
  18654. inline cert_t get_peer_cert(const_session_t session) {
  18655. if (!session) { return nullptr; }
  18656. auto wsession =
  18657. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18658. WOLFSSL_X509 *cert = wolfSSL_get_peer_certificate(wsession->ssl);
  18659. return static_cast<cert_t>(cert);
  18660. }
  18661. inline void free_cert(cert_t cert) {
  18662. if (cert) { wolfSSL_X509_free(static_cast<WOLFSSL_X509 *>(cert)); }
  18663. }
  18664. inline bool verify_hostname(cert_t cert, const char *hostname) {
  18665. if (!cert || !hostname) { return false; }
  18666. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18667. std::string host_str(hostname);
  18668. // Check if hostname is an IP address (IPv4 or IPv6)
  18669. unsigned char ip_bytes[16];
  18670. auto ip_len = impl::parse_ip_address(host_str, ip_bytes);
  18671. auto is_ip = ip_len > 0;
  18672. // Check Subject Alternative Names
  18673. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18674. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18675. if (san_names) {
  18676. int san_count = wolfSSL_sk_num(san_names);
  18677. for (int i = 0; i < san_count; i++) {
  18678. auto *names =
  18679. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18680. if (!names) continue;
  18681. if (!is_ip && names->type == WOLFSSL_GEN_DNS) {
  18682. // DNS name
  18683. unsigned char *dns_name = nullptr;
  18684. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, names->d.dNSName);
  18685. if (dns_name && dns_len > 0) {
  18686. std::string san_name(reinterpret_cast<char *>(dns_name),
  18687. static_cast<size_t>(dns_len));
  18688. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18689. if (detail::match_hostname(san_name, host_str)) {
  18690. wolfSSL_sk_free(san_names);
  18691. return true;
  18692. }
  18693. }
  18694. } else if (is_ip && names->type == WOLFSSL_GEN_IPADD) {
  18695. // IP address: only an iPAddress SAN of the same family (4 bytes for
  18696. // IPv4, 16 bytes for IPv6) may authenticate the host.
  18697. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(names->d.iPAddress);
  18698. auto san_ip_len = wolfSSL_ASN1_STRING_length(names->d.iPAddress);
  18699. if (ip_data && san_ip_len == static_cast<int>(ip_len) &&
  18700. memcmp(ip_data, ip_bytes, ip_len) == 0) {
  18701. wolfSSL_sk_free(san_names);
  18702. return true;
  18703. }
  18704. }
  18705. }
  18706. wolfSSL_sk_free(san_names);
  18707. }
  18708. // Fallback: Check Common Name (CN) in subject. Skipped for IP-literal hosts:
  18709. // an IP identity is only valid via an iPAddress SAN, never the CN (RFC 9110;
  18710. // the OpenSSL backend's X509_check_ip behaves the same way).
  18711. auto subject = is_ip ? nullptr : wolfSSL_X509_get_subject_name(x509);
  18712. if (subject) {
  18713. char cn[256] = {};
  18714. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18715. sizeof(cn));
  18716. if (cn_len > 0) {
  18717. std::string cn_str(cn, static_cast<size_t>(cn_len));
  18718. if (detail::match_hostname(cn_str, host_str)) { return true; }
  18719. }
  18720. }
  18721. return false;
  18722. }
  18723. inline uint64_t hostname_mismatch_code() {
  18724. return static_cast<uint64_t>(DOMAIN_NAME_MISMATCH);
  18725. }
  18726. inline long get_verify_result(const_session_t session) {
  18727. if (!session) { return -1; }
  18728. auto wsession =
  18729. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  18730. long result = wolfSSL_get_verify_result(wsession->ssl);
  18731. return result;
  18732. }
  18733. inline std::string get_cert_subject_cn(cert_t cert) {
  18734. if (!cert) return "";
  18735. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18736. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18737. if (!subject) return "";
  18738. char cn[256] = {};
  18739. int cn_len = wolfSSL_X509_NAME_get_text_by_NID(subject, NID_commonName, cn,
  18740. sizeof(cn));
  18741. if (cn_len <= 0) return "";
  18742. return std::string(cn, static_cast<size_t>(cn_len));
  18743. }
  18744. inline std::string get_cert_issuer_name(cert_t cert) {
  18745. if (!cert) return "";
  18746. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18747. WOLFSSL_X509_NAME *issuer = wolfSSL_X509_get_issuer_name(x509);
  18748. if (!issuer) return "";
  18749. char *name_str = wolfSSL_X509_NAME_oneline(issuer, nullptr, 0);
  18750. if (!name_str) return "";
  18751. std::string result(name_str);
  18752. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18753. return result;
  18754. }
  18755. inline bool get_cert_sans(cert_t cert, std::vector<SanEntry> &sans) {
  18756. sans.clear();
  18757. if (!cert) return false;
  18758. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18759. auto *san_names = static_cast<WOLF_STACK_OF(WOLFSSL_GENERAL_NAME) *>(
  18760. wolfSSL_X509_get_ext_d2i(x509, NID_subject_alt_name, nullptr, nullptr));
  18761. if (!san_names) return true; // No SANs is not an error
  18762. int count = wolfSSL_sk_num(san_names);
  18763. for (int i = 0; i < count; i++) {
  18764. auto *name =
  18765. static_cast<WOLFSSL_GENERAL_NAME *>(wolfSSL_sk_value(san_names, i));
  18766. if (!name) continue;
  18767. SanEntry entry;
  18768. switch (name->type) {
  18769. case WOLFSSL_GEN_DNS: {
  18770. entry.type = SanType::DNS;
  18771. unsigned char *dns_name = nullptr;
  18772. int dns_len = wolfSSL_ASN1_STRING_to_UTF8(&dns_name, name->d.dNSName);
  18773. if (dns_name && dns_len > 0) {
  18774. entry.value = std::string(reinterpret_cast<char *>(dns_name),
  18775. static_cast<size_t>(dns_len));
  18776. XFREE(dns_name, nullptr, DYNAMIC_TYPE_OPENSSL);
  18777. }
  18778. break;
  18779. }
  18780. case WOLFSSL_GEN_IPADD: {
  18781. entry.type = SanType::IP;
  18782. unsigned char *ip_data = wolfSSL_ASN1_STRING_data(name->d.iPAddress);
  18783. int ip_len = wolfSSL_ASN1_STRING_length(name->d.iPAddress);
  18784. if (ip_data && ip_len == 4) {
  18785. char buf[16];
  18786. snprintf(buf, sizeof(buf), "%d.%d.%d.%d", ip_data[0], ip_data[1],
  18787. ip_data[2], ip_data[3]);
  18788. entry.value = buf;
  18789. } else if (ip_data && ip_len == 16) {
  18790. char buf[64];
  18791. snprintf(buf, sizeof(buf),
  18792. "%02x%02x:%02x%02x:%02x%02x:%02x%02x:"
  18793. "%02x%02x:%02x%02x:%02x%02x:%02x%02x",
  18794. ip_data[0], ip_data[1], ip_data[2], ip_data[3], ip_data[4],
  18795. ip_data[5], ip_data[6], ip_data[7], ip_data[8], ip_data[9],
  18796. ip_data[10], ip_data[11], ip_data[12], ip_data[13],
  18797. ip_data[14], ip_data[15]);
  18798. entry.value = buf;
  18799. }
  18800. break;
  18801. }
  18802. case WOLFSSL_GEN_EMAIL:
  18803. entry.type = SanType::EMAIL;
  18804. {
  18805. unsigned char *email = nullptr;
  18806. int email_len = wolfSSL_ASN1_STRING_to_UTF8(&email, name->d.rfc822Name);
  18807. if (email && email_len > 0) {
  18808. entry.value = std::string(reinterpret_cast<char *>(email),
  18809. static_cast<size_t>(email_len));
  18810. XFREE(email, nullptr, DYNAMIC_TYPE_OPENSSL);
  18811. }
  18812. }
  18813. break;
  18814. case WOLFSSL_GEN_URI:
  18815. entry.type = SanType::URI;
  18816. {
  18817. unsigned char *uri = nullptr;
  18818. int uri_len = wolfSSL_ASN1_STRING_to_UTF8(
  18819. &uri, name->d.uniformResourceIdentifier);
  18820. if (uri && uri_len > 0) {
  18821. entry.value = std::string(reinterpret_cast<char *>(uri),
  18822. static_cast<size_t>(uri_len));
  18823. XFREE(uri, nullptr, DYNAMIC_TYPE_OPENSSL);
  18824. }
  18825. }
  18826. break;
  18827. default: entry.type = SanType::OTHER; break;
  18828. }
  18829. if (!entry.value.empty()) { sans.push_back(std::move(entry)); }
  18830. }
  18831. wolfSSL_sk_free(san_names);
  18832. return true;
  18833. }
  18834. inline bool get_cert_validity(cert_t cert, time_t &not_before,
  18835. time_t &not_after) {
  18836. if (!cert) return false;
  18837. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18838. const WOLFSSL_ASN1_TIME *nb = wolfSSL_X509_get_notBefore(x509);
  18839. const WOLFSSL_ASN1_TIME *na = wolfSSL_X509_get_notAfter(x509);
  18840. if (!nb || !na) return false;
  18841. // wolfSSL_ASN1_TIME_to_tm is available
  18842. struct tm tm_nb = {}, tm_na = {};
  18843. if (wolfSSL_ASN1_TIME_to_tm(nb, &tm_nb) != WOLFSSL_SUCCESS) return false;
  18844. if (wolfSSL_ASN1_TIME_to_tm(na, &tm_na) != WOLFSSL_SUCCESS) return false;
  18845. #ifdef _WIN32
  18846. not_before = _mkgmtime(&tm_nb);
  18847. not_after = _mkgmtime(&tm_na);
  18848. #else
  18849. not_before = timegm(&tm_nb);
  18850. not_after = timegm(&tm_na);
  18851. #endif
  18852. return true;
  18853. }
  18854. inline std::string get_cert_serial(cert_t cert) {
  18855. if (!cert) return "";
  18856. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18857. WOLFSSL_ASN1_INTEGER *serial_asn1 = wolfSSL_X509_get_serialNumber(x509);
  18858. if (!serial_asn1) return "";
  18859. // Get the serial number data
  18860. int len = serial_asn1->length;
  18861. unsigned char *data = serial_asn1->data;
  18862. if (!data || len <= 0) return "";
  18863. std::string result;
  18864. result.reserve(static_cast<size_t>(len) * 2);
  18865. for (int i = 0; i < len; i++) {
  18866. char hex[3];
  18867. snprintf(hex, sizeof(hex), "%02X", data[i]);
  18868. result += hex;
  18869. }
  18870. return result;
  18871. }
  18872. inline bool get_cert_der(cert_t cert, std::vector<unsigned char> &der) {
  18873. if (!cert) return false;
  18874. auto x509 = static_cast<WOLFSSL_X509 *>(cert);
  18875. int der_len = 0;
  18876. const unsigned char *der_data = wolfSSL_X509_get_der(x509, &der_len);
  18877. if (!der_data || der_len <= 0) return false;
  18878. der.assign(der_data, der_data + der_len);
  18879. return true;
  18880. }
  18881. inline const char *get_sni(const_session_t session) {
  18882. if (!session) return nullptr;
  18883. auto wsession = static_cast<const impl::WolfSSLSession *>(session);
  18884. // For server: return SNI received from client during handshake
  18885. if (!wsession->sni_hostname.empty()) {
  18886. return wsession->sni_hostname.c_str();
  18887. }
  18888. // For client: return the hostname set via set_sni
  18889. if (!wsession->hostname.empty()) { return wsession->hostname.c_str(); }
  18890. return nullptr;
  18891. }
  18892. inline uint64_t peek_error() {
  18893. return static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18894. }
  18895. inline uint64_t get_error() {
  18896. uint64_t err = impl::wolfssl_last_error();
  18897. impl::wolfssl_last_error() = 0;
  18898. return err;
  18899. }
  18900. inline std::string error_string(uint64_t code) {
  18901. char buf[256];
  18902. wolfSSL_ERR_error_string(static_cast<unsigned long>(code), buf);
  18903. return std::string(buf);
  18904. }
  18905. inline ca_store_t create_ca_store(const char *pem, size_t len) {
  18906. if (!pem || len == 0) { return nullptr; }
  18907. // Validate by attempting to load into a temporary ctx
  18908. WOLFSSL_CTX *tmp_ctx = wolfSSL_CTX_new(wolfTLSv1_2_client_method());
  18909. if (!tmp_ctx) { return nullptr; }
  18910. int ret = wolfSSL_CTX_load_verify_buffer(
  18911. tmp_ctx, reinterpret_cast<const unsigned char *>(pem),
  18912. static_cast<long>(len), SSL_FILETYPE_PEM);
  18913. wolfSSL_CTX_free(tmp_ctx);
  18914. if (ret != SSL_SUCCESS) { return nullptr; }
  18915. return static_cast<ca_store_t>(
  18916. new impl::WolfSSLCAStore{std::string(pem, len)});
  18917. }
  18918. inline void free_ca_store(ca_store_t store) {
  18919. delete static_cast<impl::WolfSSLCAStore *>(store);
  18920. }
  18921. inline bool set_ca_store(ctx_t ctx, ca_store_t store) {
  18922. if (!ctx || !store) { return false; }
  18923. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18924. auto *ca = static_cast<impl::WolfSSLCAStore *>(store);
  18925. int ret = wolfSSL_CTX_load_verify_buffer(
  18926. wctx->ctx, reinterpret_cast<const unsigned char *>(ca->pem_data.data()),
  18927. static_cast<long>(ca->pem_data.size()), SSL_FILETYPE_PEM);
  18928. if (ret == SSL_SUCCESS) { wctx->ca_pem_data_ += ca->pem_data; }
  18929. // This function takes ownership of the store; the PEM data was copied into
  18930. // the context, so release the source
  18931. free_ca_store(store);
  18932. return ret == SSL_SUCCESS;
  18933. }
  18934. inline size_t get_ca_certs(ctx_t ctx, std::vector<cert_t> &certs) {
  18935. certs.clear();
  18936. if (!ctx) { return 0; }
  18937. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18938. if (wctx->ca_pem_data_.empty()) { return 0; }
  18939. const std::string &pem = wctx->ca_pem_data_;
  18940. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18941. const std::string end_marker = "-----END CERTIFICATE-----";
  18942. size_t pos = 0;
  18943. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18944. size_t end_pos = pem.find(end_marker, pos);
  18945. if (end_pos == std::string::npos) { break; }
  18946. end_pos += end_marker.size();
  18947. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18948. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18949. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18950. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18951. if (x509) { certs.push_back(static_cast<cert_t>(x509)); }
  18952. pos = end_pos;
  18953. }
  18954. return certs.size();
  18955. }
  18956. inline std::vector<std::string> get_ca_names(ctx_t ctx) {
  18957. std::vector<std::string> names;
  18958. if (!ctx) { return names; }
  18959. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18960. if (wctx->ca_pem_data_.empty()) { return names; }
  18961. const std::string &pem = wctx->ca_pem_data_;
  18962. const std::string begin_marker = "-----BEGIN CERTIFICATE-----";
  18963. const std::string end_marker = "-----END CERTIFICATE-----";
  18964. size_t pos = 0;
  18965. while ((pos = pem.find(begin_marker, pos)) != std::string::npos) {
  18966. size_t end_pos = pem.find(end_marker, pos);
  18967. if (end_pos == std::string::npos) { break; }
  18968. end_pos += end_marker.size();
  18969. std::string cert_pem = pem.substr(pos, end_pos - pos);
  18970. WOLFSSL_X509 *x509 = wolfSSL_X509_load_certificate_buffer(
  18971. reinterpret_cast<const unsigned char *>(cert_pem.data()),
  18972. static_cast<int>(cert_pem.size()), WOLFSSL_FILETYPE_PEM);
  18973. if (x509) {
  18974. WOLFSSL_X509_NAME *subject = wolfSSL_X509_get_subject_name(x509);
  18975. if (subject) {
  18976. char *name_str = wolfSSL_X509_NAME_oneline(subject, nullptr, 0);
  18977. if (name_str) {
  18978. names.push_back(name_str);
  18979. XFREE(name_str, nullptr, DYNAMIC_TYPE_OPENSSL);
  18980. }
  18981. }
  18982. wolfSSL_X509_free(x509);
  18983. }
  18984. pos = end_pos;
  18985. }
  18986. return names;
  18987. }
  18988. inline bool update_server_cert(ctx_t ctx, const char *cert_pem,
  18989. const char *key_pem, const char *password) {
  18990. if (!ctx || !cert_pem || !key_pem) { return false; }
  18991. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  18992. // Load new certificate
  18993. int ret = wolfSSL_CTX_use_certificate_buffer(
  18994. wctx->ctx, reinterpret_cast<const unsigned char *>(cert_pem),
  18995. static_cast<long>(strlen(cert_pem)), SSL_FILETYPE_PEM);
  18996. if (ret != SSL_SUCCESS) {
  18997. impl::wolfssl_last_error() =
  18998. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  18999. return false;
  19000. }
  19001. // Set password if provided
  19002. if (password) { impl::set_wolfssl_password_cb(wctx->ctx, password); }
  19003. // Load new private key
  19004. ret = wolfSSL_CTX_use_PrivateKey_buffer(
  19005. wctx->ctx, reinterpret_cast<const unsigned char *>(key_pem),
  19006. static_cast<long>(strlen(key_pem)), SSL_FILETYPE_PEM);
  19007. if (ret != SSL_SUCCESS) {
  19008. impl::wolfssl_last_error() =
  19009. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19010. return false;
  19011. }
  19012. return true;
  19013. }
  19014. inline bool update_server_client_ca(ctx_t ctx, const char *ca_pem) {
  19015. if (!ctx || !ca_pem) { return false; }
  19016. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19017. int ret = wolfSSL_CTX_load_verify_buffer(
  19018. wctx->ctx, reinterpret_cast<const unsigned char *>(ca_pem),
  19019. static_cast<long>(strlen(ca_pem)), SSL_FILETYPE_PEM);
  19020. if (ret != SSL_SUCCESS) {
  19021. impl::wolfssl_last_error() =
  19022. static_cast<uint64_t>(wolfSSL_ERR_peek_last_error());
  19023. return false;
  19024. }
  19025. return true;
  19026. }
  19027. inline bool set_verify_callback(ctx_t ctx, VerifyCallback callback) {
  19028. if (!ctx) { return false; }
  19029. auto *wctx = static_cast<impl::WolfSSLContext *>(ctx);
  19030. impl::get_verify_callback() = std::move(callback);
  19031. wctx->has_verify_callback = static_cast<bool>(impl::get_verify_callback());
  19032. if (wctx->has_verify_callback) {
  19033. wolfSSL_CTX_set_verify(wctx->ctx, SSL_VERIFY_PEER,
  19034. impl::wolfssl_verify_callback);
  19035. } else {
  19036. wolfSSL_CTX_set_verify(
  19037. wctx->ctx,
  19038. wctx->verify_client
  19039. ? (SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT)
  19040. : SSL_VERIFY_NONE,
  19041. nullptr);
  19042. }
  19043. return true;
  19044. }
  19045. inline long get_verify_error(const_session_t session) {
  19046. if (!session) { return -1; }
  19047. auto *wsession =
  19048. static_cast<impl::WolfSSLSession *>(const_cast<void *>(session));
  19049. return wolfSSL_get_verify_result(wsession->ssl);
  19050. }
  19051. inline std::string verify_error_string(long error_code) {
  19052. if (error_code == 0) { return ""; }
  19053. const char *str =
  19054. wolfSSL_X509_verify_cert_error_string(static_cast<int>(error_code));
  19055. return str ? std::string(str) : std::string();
  19056. }
  19057. } // namespace tls
  19058. #endif // CPPHTTPLIB_WOLFSSL_SUPPORT
  19059. // WebSocket implementation
  19060. namespace ws {
  19061. inline bool WebSocket::send_frame(Opcode op, const char *data, size_t len,
  19062. bool fin) {
  19063. std::lock_guard<std::mutex> lock(write_mutex_);
  19064. if (closed_) { return false; }
  19065. return detail::write_websocket_frame(strm_, op, data, len, fin, !is_server_);
  19066. }
  19067. inline ReadResult WebSocket::read(std::string &msg) {
  19068. std::unique_lock<std::mutex> read_lock(read_mutex_);
  19069. while (!closed_) {
  19070. Opcode opcode;
  19071. std::string payload;
  19072. bool fin;
  19073. impl::FrameRead r =
  19074. impl::read_websocket_frame(strm_, opcode, payload, fin, is_server_,
  19075. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH);
  19076. // A timeout landed on a frame boundary: the connection is untouched and
  19077. // still usable, so hand control back without closing it. That is only
  19078. // useful to a caller who asked for the timeout; the compile-time default
  19079. // is a backstop against a peer gone quiet, and elapsing it closes the
  19080. // connection so a plain `while (ws.read(msg))` loop ends.
  19081. if (r == impl::FrameRead::Timeout && read_timeout_set_) { return Timeout; }
  19082. if (r != impl::FrameRead::Ok) {
  19083. closed_ = true;
  19084. return Fail;
  19085. }
  19086. switch (opcode) {
  19087. case Opcode::Ping: {
  19088. std::lock_guard<std::mutex> lock(write_mutex_);
  19089. detail::write_websocket_frame(strm_, Opcode::Pong, payload.data(),
  19090. payload.size(), true, !is_server_);
  19091. continue;
  19092. }
  19093. case Opcode::Pong: {
  19094. std::lock_guard<std::mutex> lock(ping_mutex_);
  19095. unacked_pings_ = 0;
  19096. continue;
  19097. }
  19098. case Opcode::Close: {
  19099. if (!closed_.exchange(true)) {
  19100. // Echo close frame back
  19101. std::lock_guard<std::mutex> lock(write_mutex_);
  19102. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19103. payload.size(), true, !is_server_);
  19104. }
  19105. return Fail;
  19106. }
  19107. case Opcode::Text:
  19108. case Opcode::Binary: {
  19109. auto result = opcode == Opcode::Text ? Text : Binary;
  19110. msg = std::move(payload);
  19111. // Handle fragmentation
  19112. if (!fin) {
  19113. while (true) {
  19114. Opcode cont_opcode;
  19115. std::string cont_payload;
  19116. bool cont_fin;
  19117. // A timeout is not reportable here: half of a fragmented message is
  19118. // already in `msg` and read() has no way to resume it, so it is a
  19119. // failure like any other. Timeouts are only ever seen on a message
  19120. // boundary.
  19121. if (impl::read_websocket_frame(
  19122. strm_, cont_opcode, cont_payload, cont_fin, is_server_,
  19123. CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) !=
  19124. impl::FrameRead::Ok) {
  19125. closed_ = true;
  19126. return Fail;
  19127. }
  19128. if (cont_opcode == Opcode::Ping) {
  19129. std::lock_guard<std::mutex> lock(write_mutex_);
  19130. detail::write_websocket_frame(
  19131. strm_, Opcode::Pong, cont_payload.data(), cont_payload.size(),
  19132. true, !is_server_);
  19133. continue;
  19134. }
  19135. if (cont_opcode == Opcode::Pong) {
  19136. std::lock_guard<std::mutex> lock(ping_mutex_);
  19137. unacked_pings_ = 0;
  19138. continue;
  19139. }
  19140. if (cont_opcode == Opcode::Close) {
  19141. if (!closed_.exchange(true)) {
  19142. std::lock_guard<std::mutex> lock(write_mutex_);
  19143. detail::write_websocket_frame(
  19144. strm_, Opcode::Close, cont_payload.data(),
  19145. cont_payload.size(), true, !is_server_);
  19146. }
  19147. return Fail;
  19148. }
  19149. // RFC 6455: continuation frames must use opcode 0x0
  19150. if (cont_opcode != Opcode::Continuation) {
  19151. closed_ = true;
  19152. return Fail;
  19153. }
  19154. msg += cont_payload;
  19155. if (msg.size() > CPPHTTPLIB_WEBSOCKET_MAX_PAYLOAD_LENGTH) {
  19156. closed_ = true;
  19157. return Fail;
  19158. }
  19159. if (cont_fin) { break; }
  19160. }
  19161. }
  19162. // RFC 6455 Section 5.6: text frames must contain valid UTF-8
  19163. if (result == Text && !impl::is_valid_utf8(msg)) {
  19164. // close() takes the read lock to wait for the peer's Close reply, so
  19165. // it must not run while this thread still holds it.
  19166. read_lock.unlock();
  19167. close(CloseStatus::InvalidPayload, "invalid UTF-8");
  19168. return Fail;
  19169. }
  19170. return result;
  19171. }
  19172. default: closed_ = true; return Fail;
  19173. }
  19174. }
  19175. return Fail;
  19176. }
  19177. inline bool WebSocket::send(const std::string &data) {
  19178. return send_frame(Opcode::Text, data.data(), data.size());
  19179. }
  19180. inline bool WebSocket::send(const char *data, size_t len) {
  19181. return send_frame(Opcode::Binary, data, len);
  19182. }
  19183. inline void WebSocket::close(CloseStatus status, const std::string &reason) {
  19184. if (closed_.exchange(true)) { return; }
  19185. ping_cv_.notify_all();
  19186. std::string payload;
  19187. auto code = static_cast<uint16_t>(status);
  19188. payload.push_back(static_cast<char>((code >> 8) & 0xFF));
  19189. payload.push_back(static_cast<char>(code & 0xFF));
  19190. // RFC 6455 Section 5.5: control frame payload must not exceed 125 bytes
  19191. // Close frame has 2-byte status code, so reason is limited to 123 bytes
  19192. payload += reason.substr(0, 123);
  19193. {
  19194. std::lock_guard<std::mutex> lock(write_mutex_);
  19195. detail::write_websocket_frame(strm_, Opcode::Close, payload.data(),
  19196. payload.size(), true, !is_server_);
  19197. }
  19198. // RFC 6455 Section 7.1.1: after sending a Close frame, wait for the peer's
  19199. // Close response before closing the TCP connection.
  19200. //
  19201. // Wait only when no other thread is parsing frames. When one is, it is the
  19202. // thread positioned to see the peer's reply, and reading here would take
  19203. // bytes out of the message it is assembling. Bailing out also leaves the
  19204. // stream, including its read timeout, entirely to that thread.
  19205. std::unique_lock<std::mutex> read_lock(read_mutex_, std::try_to_lock);
  19206. if (!read_lock.owns_lock()) { return; }
  19207. // Use a short timeout to avoid hanging if the peer doesn't respond.
  19208. strm_.set_read_timeout(CPPHTTPLIB_WEBSOCKET_CLOSE_TIMEOUT_SECOND, 0);
  19209. Opcode op;
  19210. std::string resp;
  19211. bool fin;
  19212. while (impl::read_websocket_frame(strm_, op, resp, fin, is_server_, 125) ==
  19213. impl::FrameRead::Ok) {
  19214. if (op == Opcode::Close) { break; }
  19215. }
  19216. }
  19217. inline WebSocket::~WebSocket() {
  19218. {
  19219. std::lock_guard<std::mutex> lock(ping_mutex_);
  19220. closed_ = true;
  19221. }
  19222. ping_cv_.notify_all();
  19223. if (ping_thread_.joinable()) { ping_thread_.join(); }
  19224. }
  19225. inline void WebSocket::start_heartbeat() {
  19226. if (ping_interval_sec_ == 0) { return; }
  19227. ping_thread_ = std::thread([this]() {
  19228. std::unique_lock<std::mutex> lock(ping_mutex_);
  19229. while (!closed_) {
  19230. ping_cv_.wait_for(lock, std::chrono::seconds(ping_interval_sec_));
  19231. if (closed_) { break; }
  19232. // If the peer has failed to respond to the previous pings, give up.
  19233. // RFC 6455 does not define a pong-timeout mechanism; this is an
  19234. // opt-in liveness check controlled by max_missed_pongs_.
  19235. if (max_missed_pongs_ > 0 && unacked_pings_ >= max_missed_pongs_) {
  19236. lock.unlock();
  19237. close(CloseStatus::GoingAway, "pong timeout");
  19238. return;
  19239. }
  19240. lock.unlock();
  19241. if (!send_frame(Opcode::Ping, nullptr, 0)) {
  19242. lock.lock();
  19243. closed_ = true;
  19244. break;
  19245. }
  19246. lock.lock();
  19247. unacked_pings_++;
  19248. }
  19249. });
  19250. }
  19251. inline const Request &WebSocket::request() const { return req_; }
  19252. inline bool WebSocket::is_open() const { return !closed_; }
  19253. inline void WebSocket::set_read_timeout(time_t sec, time_t usec) {
  19254. // 0 waits forever here, as it does for SO_RCVTIMEO. The stream waits with
  19255. // poll(), where 0 would instead mean "return immediately", so hand it the
  19256. // negative poll uses for an unbounded wait.
  19257. if (sec == 0 && usec == 0) { sec = -1; }
  19258. strm_.set_read_timeout(sec, usec);
  19259. read_timeout_set_ = true;
  19260. }
  19261. // WebSocketClient implementation
  19262. inline WebSocketClient::WebSocketClient(
  19263. const std::string &scheme_host_port_path, const Headers &headers)
  19264. : headers_(headers) {
  19265. detail::UrlComponents uc;
  19266. if (detail::parse_url(scheme_host_port_path, uc) && !uc.scheme.empty() &&
  19267. !uc.host.empty() && !uc.path.empty()) {
  19268. auto &scheme = uc.scheme;
  19269. #ifdef CPPHTTPLIB_SSL_ENABLED
  19270. if (scheme != "ws" && scheme != "wss") {
  19271. #else
  19272. if (scheme != "ws") {
  19273. #endif
  19274. #ifndef CPPHTTPLIB_NO_EXCEPTIONS
  19275. std::string msg = "'" + scheme + "' scheme is not supported.";
  19276. throw std::invalid_argument(msg);
  19277. #endif
  19278. return;
  19279. }
  19280. auto is_ssl = scheme == "wss";
  19281. host_ = std::move(uc.host);
  19282. port_ = is_ssl ? 443 : 80;
  19283. if (!uc.port.empty() && !detail::parse_port(uc.port, port_)) { return; }
  19284. path_ = std::move(uc.path);
  19285. if (!uc.query.empty()) { path_ += uc.query; }
  19286. #ifdef CPPHTTPLIB_SSL_ENABLED
  19287. is_ssl_ = is_ssl;
  19288. if (is_ssl_) {
  19289. // The context lives as long as the client so that CA configuration
  19290. // survives reconnects; sessions are created per connection.
  19291. tls_ctx_ = tls::create_client_context();
  19292. if (!tls_ctx_) { return; }
  19293. }
  19294. #else
  19295. if (is_ssl) { return; }
  19296. #endif
  19297. is_valid_ = true;
  19298. }
  19299. }
  19300. #ifdef CPPHTTPLIB_SSL_ENABLED
  19301. inline WebSocketClient::WebSocketClient(
  19302. const std::string &scheme_host_port_path, const PemMemory &pem,
  19303. const Headers &headers)
  19304. : WebSocketClient(scheme_host_port_path, headers) {
  19305. // For ws:// URLs the client certificate is silently ignored, consistent
  19306. // with the TLS-only setters such as set_ca_cert_path().
  19307. if (is_valid_ && is_ssl_ && pem.cert_pem && pem.key_pem) {
  19308. if (!tls::set_client_cert_pem(tls_ctx_, pem.cert_pem, pem.key_pem,
  19309. pem.private_key_password)) {
  19310. tls::free_context(tls_ctx_);
  19311. tls_ctx_ = nullptr;
  19312. is_valid_ = false;
  19313. }
  19314. }
  19315. }
  19316. #endif
  19317. inline WebSocketClient::~WebSocketClient() {
  19318. shutdown_and_close();
  19319. #ifdef CPPHTTPLIB_SSL_ENABLED
  19320. if (tls_ctx_) {
  19321. tls::free_context(tls_ctx_);
  19322. tls_ctx_ = nullptr;
  19323. }
  19324. #endif
  19325. }
  19326. inline bool WebSocketClient::is_valid() const { return is_valid_; }
  19327. inline void WebSocketClient::shutdown_and_close() {
  19328. // Send the close frame while the TLS session is still alive: ws_ holds an
  19329. // SSLSocketStream that keeps a raw pointer to tls_session_, so the session
  19330. // must outlive ws_->close() and ws_.reset() to avoid a use-after-free.
  19331. if (ws_ && ws_->is_open()) { ws_->close(); }
  19332. ws_.reset();
  19333. #ifdef CPPHTTPLIB_SSL_ENABLED
  19334. if (is_ssl_) {
  19335. if (tls_session_) {
  19336. tls::shutdown(tls_session_, true);
  19337. tls::free_session(tls_session_);
  19338. tls_session_ = nullptr;
  19339. }
  19340. }
  19341. #endif
  19342. if (sock_ != INVALID_SOCKET) {
  19343. detail::shutdown_socket(sock_);
  19344. detail::close_socket(sock_);
  19345. sock_ = INVALID_SOCKET;
  19346. }
  19347. }
  19348. inline bool WebSocketClient::create_stream(std::unique_ptr<Stream> &strm,
  19349. Error &error, int &ssl_error,
  19350. uint64_t &ssl_backend_error) {
  19351. // A read timeout of 0 means "wait forever", the way SO_RCVTIMEO reads it.
  19352. // The streams wait with poll(), where 0 instead means "return immediately",
  19353. // so they are given the negative poll uses for an unbounded wait.
  19354. auto unbounded = read_timeout_sec_ == 0 && read_timeout_usec_ == 0;
  19355. time_t strm_read_sec = unbounded ? -1 : read_timeout_sec_;
  19356. time_t strm_read_usec = unbounded ? 0 : read_timeout_usec_;
  19357. // The handshake belongs to establishing the connection, so an unset read
  19358. // timeout leaves it bounded by the connection timeout instead of forever.
  19359. time_t hs_sec = unbounded ? connection_timeout_sec_ : read_timeout_sec_;
  19360. time_t hs_usec = unbounded ? connection_timeout_usec_ : read_timeout_usec_;
  19361. #ifdef CPPHTTPLIB_SSL_ENABLED
  19362. if (is_ssl_) {
  19363. // A plain flag rather than SSLClient::load_certs()'s call_once: connect()
  19364. // is not safe to call concurrently on one client to begin with, since
  19365. // nothing else here is guarded either.
  19366. if (server_certificate_verification_ && !certs_loaded_) {
  19367. uint64_t backend_error = 0;
  19368. detail::load_client_ca_config(tls_ctx_, ca_cert_file_path_,
  19369. ca_cert_dir_path_, custom_ca_loaded_,
  19370. system_ca_mode_, backend_error);
  19371. certs_loaded_ = true;
  19372. }
  19373. detail::ClientTlsSessionOptions options;
  19374. options.server_hostname_verification = server_hostname_verification_;
  19375. detail::ClientTlsSessionError tls_error;
  19376. if (!detail::setup_client_tls_session(host_, tls_ctx_, tls_session_, sock_,
  19377. server_certificate_verification_,
  19378. hs_sec, hs_usec, &tls_error,
  19379. options)) {
  19380. error = tls_error.error;
  19381. ssl_error = tls_error.ssl_error;
  19382. ssl_backend_error = tls_error.backend_error;
  19383. return false;
  19384. }
  19385. strm = std::unique_ptr<Stream>(new detail::WebSocketSSLStream(
  19386. sock_, tls_session_, strm_read_sec, strm_read_usec, write_timeout_sec_,
  19387. write_timeout_usec_));
  19388. return true;
  19389. }
  19390. #else
  19391. (void)error;
  19392. (void)ssl_error;
  19393. (void)ssl_backend_error;
  19394. (void)hs_sec;
  19395. (void)hs_usec;
  19396. #endif
  19397. strm = std::unique_ptr<Stream>(
  19398. new detail::SocketStream(sock_, strm_read_sec, strm_read_usec,
  19399. write_timeout_sec_, write_timeout_usec_));
  19400. return true;
  19401. }
  19402. inline void WebSocketClient::prepare_default_headers(Request &req) {
  19403. #ifdef CPPHTTPLIB_SSL_ENABLED
  19404. auto is_ssl = is_ssl_;
  19405. #else
  19406. auto is_ssl = false;
  19407. #endif
  19408. if (!req.has_header("Host")) {
  19409. req.headers.emplace("Host", detail::make_default_host_header_value(
  19410. host_, port_, is_ssl, address_family_));
  19411. }
  19412. detail::add_default_user_agent_header(req);
  19413. }
  19414. inline Result WebSocketClient::connect() {
  19415. if (!is_valid_) { return Result{Error::Connection, -1, Headers{}}; }
  19416. shutdown_and_close();
  19417. // Check is custom IP or hostname specified for host_
  19418. std::string connect_host;
  19419. std::string ip;
  19420. detail::apply_addr_map(addr_map_, host_, connect_host, ip);
  19421. auto error = Error::Success;
  19422. sock_ = detail::create_client_socket(
  19423. connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
  19424. socket_options_, connection_timeout_sec_, connection_timeout_usec_,
  19425. read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
  19426. write_timeout_usec_, interface_, error);
  19427. if (sock_ == INVALID_SOCKET) {
  19428. if (error == Error::Success) { error = Error::Connection; }
  19429. return Result{error, -1, Headers{}};
  19430. }
  19431. std::unique_ptr<Stream> strm;
  19432. auto stream_error = Error::SSLConnection;
  19433. int ssl_error = 0;
  19434. uint64_t ssl_backend_error = 0;
  19435. if (!create_stream(strm, stream_error, ssl_error, ssl_backend_error)) {
  19436. shutdown_and_close();
  19437. #ifdef CPPHTTPLIB_SSL_ENABLED
  19438. return Result{stream_error, -1, Headers{}, ssl_error, ssl_backend_error};
  19439. #else
  19440. return Result{stream_error, -1, Headers{}};
  19441. #endif
  19442. }
  19443. Request req;
  19444. req.method = "GET";
  19445. req.path = path_;
  19446. req.headers = headers_;
  19447. prepare_default_headers(req);
  19448. detail::WebSocketUpgradeResponse upgrade;
  19449. if (!detail::perform_websocket_handshake(*strm, req, upgrade)) {
  19450. shutdown_and_close();
  19451. return Result{upgrade.error, upgrade.status, std::move(upgrade.headers)};
  19452. }
  19453. subprotocol_ = std::move(upgrade.selected_subprotocol);
  19454. ws_ = std::unique_ptr<WebSocket>(new WebSocket(std::move(strm), req, false,
  19455. websocket_ping_interval_sec_,
  19456. websocket_max_missed_pongs_));
  19457. // The stream was created with the timeout already; tell the WebSocket
  19458. // whether it came from the caller, so read() knows to report it as Timeout.
  19459. ws_->read_timeout_set_ = read_timeout_set_;
  19460. return Result{Error::Success, upgrade.status, std::move(upgrade.headers)};
  19461. }
  19462. inline ReadResult WebSocketClient::read(std::string &msg) {
  19463. if (!ws_) { return Fail; }
  19464. return ws_->read(msg);
  19465. }
  19466. inline bool WebSocketClient::send(const std::string &data) {
  19467. if (!ws_) { return false; }
  19468. return ws_->send(data);
  19469. }
  19470. inline bool WebSocketClient::send(const char *data, size_t len) {
  19471. if (!ws_) { return false; }
  19472. return ws_->send(data, len);
  19473. }
  19474. inline void WebSocketClient::close(CloseStatus status,
  19475. const std::string &reason) {
  19476. if (ws_) { ws_->close(status, reason); }
  19477. }
  19478. inline bool WebSocketClient::is_open() const { return ws_ && ws_->is_open(); }
  19479. inline const std::string &WebSocketClient::subprotocol() const {
  19480. return subprotocol_;
  19481. }
  19482. inline void WebSocketClient::set_read_timeout(time_t sec, time_t usec) {
  19483. read_timeout_sec_ = sec;
  19484. read_timeout_usec_ = usec;
  19485. read_timeout_set_ = true;
  19486. // The members above only seed the next connect(); read() consults the
  19487. // stream, so an already-open connection has to be told directly.
  19488. if (ws_) { ws_->set_read_timeout(sec, usec); }
  19489. }
  19490. inline void WebSocketClient::set_write_timeout(time_t sec, time_t usec) {
  19491. write_timeout_sec_ = sec;
  19492. write_timeout_usec_ = usec;
  19493. }
  19494. inline void WebSocketClient::set_websocket_ping_interval(time_t sec) {
  19495. websocket_ping_interval_sec_ = sec;
  19496. }
  19497. inline void WebSocketClient::set_websocket_max_missed_pongs(int count) {
  19498. websocket_max_missed_pongs_ = count;
  19499. }
  19500. inline void WebSocketClient::set_tcp_nodelay(bool on) { tcp_nodelay_ = on; }
  19501. inline void WebSocketClient::set_address_family(int family) {
  19502. address_family_ = family;
  19503. }
  19504. inline void WebSocketClient::set_ipv6_v6only(bool on) { ipv6_v6only_ = on; }
  19505. inline void WebSocketClient::set_socket_options(SocketOptions socket_options) {
  19506. socket_options_ = std::move(socket_options);
  19507. }
  19508. inline void WebSocketClient::set_connection_timeout(time_t sec, time_t usec) {
  19509. connection_timeout_sec_ = sec;
  19510. connection_timeout_usec_ = usec;
  19511. }
  19512. inline void WebSocketClient::set_interface(const std::string &intf) {
  19513. interface_ = intf;
  19514. }
  19515. inline void WebSocketClient::set_hostname_addr_map(
  19516. std::map<std::string, std::string> addr_map) {
  19517. addr_map_ = std::move(addr_map);
  19518. }
  19519. #ifdef CPPHTTPLIB_SSL_ENABLED
  19520. inline void
  19521. WebSocketClient::set_ca_cert_path(const std::string &ca_cert_file_path,
  19522. const std::string &ca_cert_dir_path) {
  19523. ca_cert_file_path_ = ca_cert_file_path;
  19524. ca_cert_dir_path_ = ca_cert_dir_path;
  19525. }
  19526. inline void WebSocketClient::set_ca_cert_store(tls::ca_store_t store) {
  19527. if (store && tls_ctx_) {
  19528. // set_ca_store takes ownership of store
  19529. tls::set_ca_store(tls_ctx_, store);
  19530. custom_ca_loaded_ = true;
  19531. } else if (store) {
  19532. tls::free_ca_store(store);
  19533. }
  19534. }
  19535. inline void WebSocketClient::load_ca_cert_store(const char *ca_cert,
  19536. std::size_t size) {
  19537. if (tls_ctx_ && ca_cert && size > 0) {
  19538. tls::load_ca_pem(tls_ctx_, ca_cert, size);
  19539. custom_ca_loaded_ = true;
  19540. }
  19541. }
  19542. inline void
  19543. WebSocketClient::enable_server_certificate_verification(bool enabled) {
  19544. server_certificate_verification_ = enabled;
  19545. }
  19546. inline void WebSocketClient::enable_server_hostname_verification(bool enabled) {
  19547. server_hostname_verification_ = enabled;
  19548. }
  19549. inline void WebSocketClient::enable_system_ca(bool enabled) {
  19550. system_ca_mode_ = enabled ? SystemCAMode::Enabled : SystemCAMode::Disabled;
  19551. }
  19552. #endif // CPPHTTPLIB_SSL_ENABLED
  19553. } // namespace ws
  19554. // ----------------------------------------------------------------------------
  19555. } // namespace httplib
  19556. #endif // CPPHTTPLIB_HTTPLIB_H